TheArchive/mayhem-firmware
1
0
Fork 0
mirror of https://github.com/portapack-mayhem/mayhem-firmware.git synced 2024-11-23 18:15:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Created Unit Tests (markdown)

Kyle Reed 2023-05-21 20:49:14 -07:00
parent 7c6e31d714
commit 9a0091a508
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Unit-Tests.md Normal file

@ -0,0 +1,16 @@
## TL;DR;
`cmake --build . --target build_tests && ctest --output-on-failure`
## Tests
* Unit tests are written using the [doctest](https://github.com/doctest/doctest/tree/master) framework.
* Tests are separated into application and baseband depending on which core is targeted.
* Test source is found under `firmware/test/`.
* Tests are not currently integrated with the PR pipeline.
* Tests are not currently built as part of a normal build and must be built manually.
## Building Tests
In your CMake build directory run `cmake --build . --target build_tests` which will build both application and baseband test hosts.
## Running Tests
Once tests are built, from your CMake build directory run `ctest --output-on-failure`.