Testing

Before Testing

After making code changes to a feature branch of the project it is required to rebuild the docker containers. For that it is necessary to close the running containers. If and which docker containers are currently running can be monitored by using the docker ps command or alternatively with:

docker container ls

To fully shut down running docker containers, first go to the firmware_vault/docker_compose_dir directory, then use the command:

docker compose down

The project can now be rebuilt and started up again in the firmware_vault/docker_compose_dir directory using the command:

docker compose up -d --build

note

For docker compose up and docker compose down it is possible to only target specified containers by adding their names at the end of the command. For example:

docker compose down mysql_db frontend api_scheduler executor

Testing of new features and bugfixes can now begin.

Building and starting docker containers is explained in detail in the Installation Page of the Introduction section of the projects documentation. A full list of available containers and their names can also be found in the Installation Page under the Docker Container segment.

Docusaurus Documentation

To test the docusaurus documentation it is not necessary to rebuild any docker containers. Once the firmware_vault_doc container is running it will automatically update changes to the documentation in your active branch. The current state of your documentation can be seen under the URL http://localhost:3000.

To start the firmware_vault_doc container use the following command in the firmware_vault/docs/ directory:

docker run --rm -it -v $(pwd):/docs -p 3000:3000  firmware_vault_doc

A description of the the firmware_vault_doc container starting process can also be viewed in firmware_vault/docs/README.md.

tip

Do not forget to

• update the sidebars.ts to see new files or categories in the sidebar on the left
• update the docusaurus.config.ts to see new categories in the dropdown menu Docs in the top left