A KISS, non-intrusive cross-platform C unit testing framework
Go to file
Snaipe 4b093d2a3e Added documentation on logging functions 2016-02-18 00:05:15 +01:00
.cmake Added a pkg-config file for criterion 2016-01-20 22:35:31 +01:00
dependencies Fixed nanomsg config for windows builds 2016-01-17 17:34:46 +01:00
dev Added find module for criterion 2015-09-09 17:14:45 +02:00
doc Added documentation on logging functions 2016-02-18 00:05:15 +01:00
include/criterion Added C++ stream interface for logging 2016-02-18 00:05:15 +01:00
po Merge branch 'features/io-rewrite-nanopb' into bleeding 2016-01-18 01:35:55 +01:00
samples Added C++ stream interface for logging 2016-02-18 00:05:15 +01:00
src Added message splitting on line feed 2016-02-18 00:05:15 +01:00
test Added C++ stream interface for logging 2016-02-18 00:05:15 +01:00
.bumpversion.cfg [v2.2.0] Merge branch 'bleeding' (Version release) 2015-12-08 14:31:59 +01:00
.gitignore Merge branch 'features/io-rewrite-nanopb' into bleeding 2016-01-18 01:35:55 +01:00
.gitmodules Added proper nanomsg-patched submodule 2016-01-15 14:24:02 +01:00
.travis.yml [cmake] Read python name from PYTHON_BIN in cram module 2016-01-20 12:25:34 +01:00
CMakeLists.txt [cmake] Added generator propagation to subprojects 2016-01-18 21:55:22 +01:00
CONTRIBUTING.md Updated contribution road map 2015-09-17 00:29:11 +02:00
ChangeLog [v2.2.0] Merge branch 'bleeding' (Version release) 2015-12-08 14:31:59 +01:00
LICENSE We're in 2016. 2016-01-06 17:35:35 +01:00
README.md [v2.2.0] Merge branch 'bleeding' (Version release) 2015-12-08 14:31:59 +01:00
appveyor.yml [appveyor] Fixed builds not being maked as failed when tests are not passing 2016-01-20 14:03:02 +01:00
debian.copyright [license] Updated license year on missed files 2016-01-18 16:06:54 +01:00
description.txt Added missing files for ppa builds 2015-11-28 14:33:09 +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