TEST_GROUP(DemoTestGroup)\r\n{\r\n};<\/pre>\nOnce a test group is defined, you can define tests using the TEST()<\/strong> macro:<\/p>\nTEST(DemoTestGroup, UnitTest1)\r\n{\r\n printf(\"Hello from UnitTest1\");\r\n}\r\n\r\nTEST(DemoTestGroup, UnitTest2)\r\n{\r\n printf(\"Hello from UnitTest2\");\r\n}<\/pre>\nOnce you build the project defining the tests, they will appear in the Test Explorer window, organized by test groups: ![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2020\/07\/tests-2.png\")
<\/a>
\nYou can use the Test Explorer window to select and run any arbitrary subset of tests.<\/p>\nIf you are running tests from command line, use the \/testregex <\/strong>argument to filter the tests that are being run. E.g. the following command line will run UnitTest1<\/strong> from both TestGroup1<\/strong> and TestGroup2<\/strong>:<\/p>\nVisualGDB.exe \/runtests TestDemo.vgdbtestcontainer \"\/testregex:(TestGroup1|TestGroup2)::UnitTest1\"<\/pre>\nSetup and Teardown Functions<\/h2>\n
Test groups can define setup and teardown methods as shown below:<\/p>\n
TEST_GROUP(DemoTestGroup)\r\n{\r\n void setup()\r\n {\r\n \/\/...\r\n }\r\n void teardown()\r\n {\r\n \/\/...\r\n }\r\n void TestSetup(TestInstance *)\r\n {\r\n \/\/...\r\n }\r\n void TestTeardown(TestInstance *)\r\n {\r\n \/\/...\r\n }\r\n};<\/pre>\nIf you select one of more tests from a test group, the following will happen:<\/p>\n
\n- The setup()<\/strong> callback will be called once<\/strong> per group before running the first test in the group<\/li>\n
- The teardown()<\/strong> callback will be called once per group after running the last test in the group<\/li>\n
- The TestSetup()<\/strong> and TestTeardown()<\/strong> methods will be called before\/after each test<\/li>\n<\/ul>\n
Assertion Macros<\/h2>\n
TinyEmbeddedTest provides several assertion macros inspired by the CppUTest framework. E.g. CHECK()<\/strong>, CHECK_EQUAL()<\/strong>, etc. The demo test project created by the VisualGDB wizard includes a quick demonstration of all supported assertion macros:<\/p>\nTEST(DemoTestGroup, SuccessfulTest1)\r\n{\r\n CHECK(true);\r\n CHECK_FALSE(false);\r\n CHECK_EQUAL(1, 1);\r\n STRCMP_EQUAL(\"abc\", \"abc\");\r\n STRNCMP_EQUAL(\"abc1\", \"abc2\", 3);\r\n STRCMP_NOCASE_EQUAL(\"abc\", \"ABC\");\r\n STRCMP_CONTAINS(\"123\", \"test123\");\r\n\r\n LONGS_EQUAL(-2, -2);\r\n UNSIGNED_LONGS_EQUAL(3, 3);\r\n UNSIGNED_LONGS_EQUAL_WITHIN(10, 11, 2);\r\n\r\n BYTES_EQUAL(-1, 255);\r\n POINTERS_EQUAL(0, 0);\r\n MEMCMP_EQUAL(\"string\", \"string\", 6);\r\n\r\n DOUBLES_EQUAL(1.0, -1.0, 2);\r\n DOUBLES_NOT_EQUAL(1.0, -1.0, 1);\r\n\r\n FLOATS_EQUAL(1.0F, -1.0F, 2); \r\n FLOATS_NOT_EQUAL(1.0F, -1.0F, 1);\r\n\r\n BITS_EQUAL(0x050, 0xF5F, 0x0F0);\r\n}<\/pre>\nYou can define custom assertion macros as well. If the assertion fails, the macro should call the printf-like ReportTestFailure()<\/strong> function. The message passed to that function will be displayed in the test failure summary in Solution Explorer.<\/p>\nRecovering from Assertion Failures<\/h2>\n
The default TinyEmbeddedTest behavior when a unit test fails is to continue executing the test method, assuming that it will handle this properly. You can change this behavior via VisualGDB Project Properties -> Unit Tests<\/strong>:![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2020\/07\/fail.png\")
<\/a>TinyEmbeddedTest supports 3 different ways of handling a failed test assertion:<\/p>\n\n\n\nMode<\/td>\n Pros<\/td>\n Cons<\/td>\n<\/tr>\n \nTest continues running<\/td>\n Minimum overhead.<\/td>\n Requires extra care when writing tests (e.g. check for null pointers).<\/td>\n<\/tr>\n \nTest ends via setjmp()<\/td>\n No need to handle ‘failed’ case. A failed assertion will automatically abort the rest of the test.<\/td>\n Any allocated memory will leak until the end of test session.<\/td>\n<\/tr>\n \nTest ends via C++ exceptions<\/td>\n Resources allocated via RAII will get freed when aborting the test (i.e. C++ destructors will get called).<\/td>\n Exception support for embedded projects has a considerable memory footprint.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n