stv0g/Criterion
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
A KISS, non-intrusive cross-platform C unit testing framework
565 commits 26 branches 19 tags 3.7 MiB
C 57.9%
C++ 14.8%
CMake 10.1%
Raku 9.5%
Shell 2.6%
Other 5.1%
Find a file
Snaipe a1d28f84e7 Refactored posix-compat.c
2015-09-16 21:00:15 +02:00
.cmake/Modules Specified correct gcov params for codecov script 2015-09-16 01:19:08 +02:00
dependencies Added wingetopt to dependencies 2015-09-06 00:37:30 +02:00
dev Added find module for criterion 2015-09-09 17:14:45 +02:00
doc Fixed documentation on report hook parameters 2015-09-15 19:02:52 +02:00
include/criterion Fixed MinGW header bug where off_t/off64_t is not defined 2015-09-15 23:02:46 +02:00
po [v2.0.0] Merge branch 'bleeding' (Version release) 2015-09-14 04:27:58 +02:00
samples Added coverage reports for all current tests 2015-09-16 01:52:48 +02:00
src Refactored posix-compat.c 2015-09-16 21:00:15 +02:00
test Added asprintf unit tests 2015-09-16 03:54:48 +02:00
.bumpversion.cfg [v2.0.0] Merge branch 'bleeding' (Version release) 2015-09-14 04:27:58 +02:00
.gitignore Gave the gitignore some love. 2015-09-09 17:12:42 +02:00
.gitmodules Added wingetopt to dependencies 2015-09-06 00:37:30 +02:00
.travis.yml Cleaned up CI configs 2015-09-16 01:43:26 +02:00
appveyor.yml Cleaned up CI configs 2015-09-16 01:43:26 +02:00
ChangeLog [v2.0.0] Merge branch 'bleeding' (Version release) 2015-09-14 04:27:58 +02:00
CMakeLists.txt Refactored posix-compat.c 2015-09-16 21:00:15 +02:00
CONTRIBUTING.md Cleaned up sample directory 2015-09-09 02:44:34 +02:00
LICENSE Initial commit 2015-01-31 13:45:12 +01:00
README.md Switched readme coverage status to codecov 2015-09-16 01:19:49 +02:00

README.md

Criterion Logo =========

Unix Build Status Windows Build Status Coverage Status License Version

A dead-simple, yet extensible, C and C++ unit testing framework.

Screencast

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.
  • There is a support for theories alongside tests
  • 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

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.

Getting help

Gitter.im chat room: Join the chat at https://gitter.im/Snaipe/Criterion

Misc

F.A.Q.

Q. What's wrong with other C test frameworks?
A. I worked with CUnit and Check, and I must say that they do their job very well -- the only thing that bugs me is that setting up a test suite from scratch is a pain, it should really be simpler. Most (if not all) high-level languages have test frameworks with automatic test registration, but all the ones for C require you to set up a main, manually register suites, then tests. Criterion tries to fix these shortcomings.

Q. Where has this been tested?
A. Currently, on Linux 2.6.32 and Linux 3.15.7, although it should work on most *nix systems; Mac OS X Yosemite 10.10, FreeBSD 10.0, Windows 7 and 2K.

Credits

Logo done by Greehm