A KISS, non-intrusive cross-platform C unit testing framework
Go to file
Snaipe a7d5ecf69c Refactored redirections and hooks 2015-11-18 16:31:31 +01:00
.cmake/Modules Merge branch 'features/multiple-languages' into bleeding 2015-11-16 20:01:17 +01:00
dependencies Refactored internal headers into its own subdirectory 2015-11-17 16:30:00 +01:00
dev Added find module for criterion 2015-09-09 17:14:45 +02:00
doc Added documentation for --json 2015-11-11 13:26:49 +01:00
include/criterion Refactored redirections and hooks 2015-11-18 16:31:31 +01:00
po Updated line counts for po files 2015-11-11 00:24:58 +01:00
samples Merge branch 'features/multiple-languages' into bleeding 2015-11-16 20:01:17 +01:00
src Refactored tests and assertions implementation to internal/ 2015-11-17 17:33:44 +01:00
test Refactored internal headers into its own subdirectory 2015-11-17 16:30:00 +01:00
.bumpversion.cfg [v2.1.0] Merge branch 'bleeding' (Version release) 2015-09-21 22:35:34 +02:00
.gitignore Refactored redirections and hooks 2015-11-18 16:31:31 +01:00
.gitmodules Added klib dependency 2015-11-10 22:04:25 +01:00
.travis.yml Removed source build for clang on osx travis builds 2015-11-12 18:26:04 +01:00
CMakeLists.txt Refactored redirections and hooks 2015-11-18 16:31:31 +01: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 Added IRC channel to README page 2015-10-05 19:12:58 +02:00
appveyor.yml Merge branch 'features/multiple-languages' into bleeding 2015-11-16 20:01:17 +01:00

README.md

Criterion Logo =========

Unix Build Status Windows Build Status Coverage Status License Version

Analytics

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
IRC channel: #criterion on irc.freenode.net

Misc

Credits

Logo done by Greehm