A KISS, non-intrusive cross-platform C unit testing framework
93e766b3fe
Clang on FreeBSD was complaining:
```csh
[ 26%] Building C object CMakeFiles/criterion.dir/src/core/abort.c.o
[ 30%] Building C object CMakeFiles/criterion.dir/src/core/report.c.o
[ 30%] Building C object CMakeFiles/criterion.dir/src/core/runner.c.o
In file included from /root/projects/Criterion/Criterion/Criterion/src/core/runner.c:29:
/root/projects/Criterion/Criterion/Criterion/dependencies/valgrind/include/valgrind/valgrind.h:6223:29: error: unused
parameter 'format' [-Werror,-Wunused-parameter]
VALGRIND_PRINTF(const char *format, ...)
^
/root/projects/Criterion/Criterion/Criterion/dependencies/valgrind/include/valgrind/valgrind.h:6261:39: error: unused
parameter 'format' [-Werror,-Wunused-parameter]
VALGRIND_PRINTF_BACKTRACE(const char *format, ...)
^
2 errors generated.
```
The other way to fix it was to add a compiler option in CMake:
```cmake
add_compile_options(-Wno-unused-parameter)
```
but this approach disables the check globally.
I am not sure whether there is a way to scope
the compiler option to a subdirectory; especially
in cases where submodule (via `add_subdirectory`)
headers have unsed parameters.
|
||
|---|---|---|
| .cmake/Modules | ||
| dependencies | ||
| dev | ||
| doc | ||
| include/criterion | ||
| po | ||
| samples | ||
| src | ||
| test | ||
| .bumpversion.cfg | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| appveyor.yml | ||
| ChangeLog | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
=========
A dead-simple, yet extensible, C and C++ unit testing framework.
Philosophy
Most test frameworks for C require a lot of boilerplate code to set up tests and test suites -- you need to create a main, then register new test suites, then register the tests within these suits, and finally call the right functions.
This gives the user great control, at the unfortunate cost of simplicity.
Criterion follows the KISS principle, while keeping the control the user would have with other frameworks:
- C99 and C++11 compatible.
- Tests are automatically registered when declared.
- Implements a xUnit framework structure.
- A default entry point is provided, no need to declare a main unless you want to do special handling.
- Test are isolated in their own process, crashes and signals can be reported and tested.
- Unified interface between C and C++: include the criterion header and it just works.
- Supports parameterized tests and theories.
- Progress and statistics can be followed in real time with report hooks.
- TAP output format can be enabled with an option.
- Runs on Linux, FreeBSD, Mac OS X, and Windows (Compiling with MinGW GCC and Visual Studio 2015+).
Downloads
Packages
- Mac OS X:
brew install snaipe/soft/criterion - AUR:
yaourt -S criterion
Binary archives
If you have a different platform, you can still build the library from source
Developer Resources
Documentation
An online documentation is available on ReadTheDocs (PDF | Zip | Epub)
Samples
Sample tests can be found in the sample directory.
- A simple test
- Using multiple suites
- Writing assertions
- Adding test fixtures
- Tests with signals
- Using report hooks
Getting help
Gitter.im chat room: 
Misc
Credits
Logo done by Greehm