-
-
Notifications
You must be signed in to change notification settings - Fork 111
Unit Tests
This document describes the naming and location of test files as discussed in our Keyman conference in November 2024. It describes what we aim for in the long-term and isn't completely reflected in our current repo yet.
In order to be able to find tests across our different platforms we use the same file naming pattern across all platforms:
Files containing unit (or other) tests should be named <filename>.tests.<ext>, e.g. tests for foo.ts would go into foo.tests.ts.
(Since unit test files usually contain more than one test we use the plural tests instead of the singular)
| Folder/Test file | Description |
|---|---|
<product>/src/foo.cpp |
Source code for the product |
<product>/tests/foo.tests.cpp |
Automated tests for unit foo.cpp (some places still use <product>/src/tests/) |
<product>/tests/manual/loading.tests.cpp |
Other kinds of tests like manual tests, integration tests etc can go in a sub-folder of <product>/tests. The sub-folder should get a descriptive name that shows what kind of tests it contains |
For our homegrown C/C++ tests, do not use assert(); instead use test_assert.h and test_assert() and friends. (Or convert to GoogleTest, which is better). For more information, see discussion.