A KISS, non-intrusive cross-platform C unit testing framework
Go to file
Snaipe 0b38972f4d Used suggested string format from generated POT file 2015-09-27 12:26:01 +02:00
.cmake/Modules Specified correct gcov params for codecov script 2015-09-16 01:19:08 +02:00
dependencies Added sane option defaults when running valgrind 2015-09-26 00:22:21 +02:00
dev Added find module for criterion 2015-09-09 17:14:45 +02:00
doc [Issue #56] Updated screencast 2015-09-25 14:10:58 +02:00
include/criterion Removed deprecated 1.x unprefixed assertion macros 2015-09-24 00:15:32 +02:00
po Used suggested string format from generated POT file 2015-09-27 12:26:01 +02:00
samples Added array-to-criterion_test_param conversion constructor 2015-09-23 21:35:05 +02:00
src Added valgrind error suppression for the runner process 2015-09-26 17:02:28 +02:00
test Removed asprintf::invalid test 2015-09-23 13:30:08 -07:00
.bumpversion.cfg [v2.1.0] Merge branch 'bleeding' (Version release) 2015-09-21 22:35:34 +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 Renamed TESTS cmake option to CTESTS 2015-09-22 00:16:45 +02:00
CMakeLists.txt Added valgrind error suppression for the runner process 2015-09-26 17:02:28 +02:00
CONTRIBUTING.md Updated contribution road map 2015-09-17 00:29:11 +02:00
ChangeLog [v2.1.0] Merge branch 'bleeding' (Version release) 2015-09-21 22:35:34 +02:00
LICENSE Initial commit 2015-01-31 13:45:12 +01:00
README.md Removed readme FAQ [ci skip] 2015-09-23 14:10:30 +02:00
appveyor.yml Fixed invalid platform name for x64 in appveyor config 2015-09-23 00:59:12 +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.
  • 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.

Getting help

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

Misc

Credits

Logo done by Greehm