From 9a0091a508b2d74e24876b8bc7ceea4e5c2b2fb8 Mon Sep 17 00:00:00 2001 From: Kyle Reed Date: Sun, 21 May 2023 20:49:14 -0700 Subject: [PATCH] Created Unit Tests (markdown) --- Unit-Tests.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 Unit-Tests.md diff --git a/Unit-Tests.md b/Unit-Tests.md new file mode 100644 index 0000000..227224d --- /dev/null +++ b/Unit-Tests.md @@ -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`. \ No newline at end of file