Skip to content

Commit

Permalink
DOCS: Document how to execute the tests
Browse files Browse the repository at this point in the history
  • Loading branch information
amilcarlucas committed Jan 27, 2025
1 parent d1a9fe7 commit ab9b53e
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,17 +212,29 @@ We tested using **automated static tests** in both pre-commit hooks and on githu
We tested using **automated dynamic tests** on github CI including automated test coverage reports.
We use [unittest](https://docs.python.org/3/library/unittest.html) to write unit tests for the code.
The tests are easy to run on the command line or in VS code.
When you write new code you must also write tests in the `tests/` directory, there is CI test that only passes if test coverage increases monotonicaly.
When you write new code you must also write tests in the `tests/` directory, there is CI test that only passes if test coverage increases monotonically.

To run the tests either use the python tests plugin in visualstudio code, or execute:

```bash
pytest
```

### Integration testing

The five different sub-applications are first tested independently.

- software update checker
- `python .\ardupilot_methodic_configurator\middleware_software_updates.py`
- flight controller connection GUI
- `python .\ardupilot_methodic_configurator\frontend_tkinter_connection_selection.py`
- vehicle configuration directory selection GUI
- `python .\ardupilot_methodic_configurator\frontend_tkinter_directory_selection.py`
- `python .\ardupilot_methodic_configurator\frontend_tkinter_template_overview.py`
- vehicle component editor GUI
- `python .\ardupilot_methodic_configurator\frontend_tkinter_component_editor.py`
- parameter editor and uploader GUI
- `python .\ardupilot_methodic_configurator\frontend_tkinter_parameter_editor.py`

Only after each one performs 100% as expected, they are integrated and tested together.
This speeds up the development process.
Expand Down

0 comments on commit ab9b53e

Please sign in to comment.