Differences

This shows you the differences between two versions of the page.

--- for_developers:testing [2017/05/24 11:07] – graf
+++ for_developers:testing [2025/06/04 16:03] (current) – [Suppress Logger Output] ursgraf
@@ Line 1: / Line 1: @@
 ====== Testing ======
-We use [[https://github.com/google/googletest|Google Test]] as our test framework. Read [[https://github.com/google/googletest/blob/master/googletest/docs/Primer.md]] to understand how to use the available macros for defining test cases.
+We use [[https://google.github.io/googletest/|Google Test]] as our test framework. Read [[https://google.github.io/googletest/primer.html]] to understand how to use the available macros for defining test cases.
+===== Naming =====
+All the tests must be named in the following manner.
+<code cpp>
+TEST(testName, testMethodName) { ... }
+</code>
+''testName'' should include the name of the package, e.g. controlDeMuxBlock or safetyEventTest. This allows for running only the tests in a certain package. ''testMethodName'' can be any meaningful name to identify the test method.
+===== Running the Tests =====
+Make sure to compile the unit tests with the cmake argument ''-DUSE_TESTS=TRUE''. Navigate to the directory ''test'' of the build directory of eeros and run the tests as follows.:
+<code cpp>
+$ ./unitTests  --library sim                  // run all the tests using the simulator as hal
+$ ./unitTests  -l sim                         // run all the tests using the simulator, short option
+$ ./unitTests  -l flink                       // run all the tests using flink, short option
+$ ./unitTests  -l comedi                      // run all the tests using comedi, short option
+$ ./unitTests  --gtest_filter=control*        // run all the tests in control
+$ ./unitTests  --gtest_filter=math*           // run all the tests in math
+$ ./unitTests  --gtest_filter=mathMatrix*     // run all the tests in math/Matrix
+$ ./unitTests  --gtest_filter=-hal*           // run all the tests without hal
+$ ./unitTests  --gtest_filter=-hal*:saf*      // run all the tests without hal and without safety
+$ ./unitTests  -l sim --gtest_filter=hal*     // run all the tests in hal using the simulator
+</code>
+For the test with the HAL you need to install the [[getting_started:install_wrapper#simulator|]] and set the library path (see [[getting_started:deploy|]]) so that the simulator library can be found. Some safety system tests also need the HAL.
+===== Suppress Logger Output =====
+We do not want to mangle output from control blocks or from the safety system with output from the testing framework. If you test a component which uses the logger framework, make sure to set the default stream logger and to set 'cout' to 'failed' state. This will prevent output to be written to the log.
+<code cpp>
+std::cout.setstate(std::ios_base::badbit);
+eeros::logger::Logger::setDefaultStreamLogger(std::cout);
+</code>
+===== Running the Tests with a Script =====
+You can find a script under ''/scripts'' which builds eeros together with the simulator and runs all the tests.