Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/electronvector/ctest-unity-example
A scaffold repository that uses CMake to build Unity-based tests
https://github.com/electronvector/ctest-unity-example
Last synced: 6 days ago
JSON representation
A scaffold repository that uses CMake to build Unity-based tests
- Host: GitHub
- URL: https://github.com/electronvector/ctest-unity-example
- Owner: ElectronVector
- Created: 2023-09-27T13:25:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-16T17:34:54.000Z (about 1 year ago)
- Last Synced: 2024-11-11T12:17:04.967Z (2 months ago)
- Language: CMake
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CTest Unity Example
This is a simple example of a C application which can build and run unit tests with CTest.
It uses [Unity](https://github.com/ThrowTheSwitch/Unity) as a test framework.
## Conventions
This application has all of its source files in a folder called `src` and all test files in `test`.
These can be changed in `CMakeLists.txt`.
By convention, test a file named `src/module.c` by adding a test file called `test/test_module.c`.
This file will be built and linked against the source file to execute the tests.
The `test_` is the prefix for a test file name, but this prefix can be changed in `CMakeLists.txt`.
## Adding New Modules and Tests
Add a new module and test by creating three different files:
- `src/.c`
- `src/.h`
- `test/test_`
The test file created should include
## Running CMake
The modern way to build with CMake is to create a build dir with:
```
cmake -S . -B build
```
This tells CMake the source and build directories and then generates the build system.
Then instead of running the built makefiles (or Ninja files) directly, use CMake to run the build tool with the --build option:
```
cmake --build build
```
## Running Tests
After 1) the build system has been generated and 2) the build is run, the tests can be run with CTest.
```shell
ctest --test-dir build
```
The build folder must be supplied to CTest with the `--test-dir` argument so that CTest knows where to find the tests.
## Implementation Details
### Subdirectories
You could put a CMakeLists folder in the test folder and then include it with:
```
add_subdirectory(test)
```
When it is time to run the tests though, you need to run them by speficifing the build subdirectory:
```
ctest --test-dir build/test
```
## To Do
You can use gcc to determine module dependencies like this:
```
gcc -MM test\test_module_1.c -Isrc -Itest
test_module_1.o: test\test_module_1.c src/module.h
```
This could be useful for automatically detecting the files to include in the test executable.