stv0g/Criterion
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Added documentation on adding a custom main

Browse source
This commit is contained in:
Snaipe 2015-03-26 23:04:02 +01:00
parent 818243902a
commit 53c38d244e
2 changed files with 42 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/index.rst
View file

@ -9,4 +9,5 @@ Criterion
starter
hooks
env
internal
faq

41
doc/internal.rst Normal file
View file

@ -0,0 +1,41 @@
Changing the internals
======================
Providing your own main
-----------------------
If you are not satisfied with the default CLI or environment variables, you
can define your own main function.
Configuring the test runner
~~~~~~~~~~~~~~~~~~~~~~~~~~~
You'd usually want to configure the test runner before calling it.
Configuration is done by setting fields in a global variable named
``criterion_options`` (include criterion/options.h).
Here is an exhaustive list of these fields:
=================== ================================== ==============================================================
Field Type Description
=================== ================================== ==============================================================
logging_threshold enum criterion_logging_level The logging level
------------------- ---------------------------------- --------------------------------------------------------------
output_provider struct criterion_output_provider * The output provider (see below)
------------------- ---------------------------------- --------------------------------------------------------------
no_early_exit bool True iff the test worker should exit early
------------------- ---------------------------------- --------------------------------------------------------------
always_succeed bool True iff criterion_run_all_tests should always returns 1
------------------- ---------------------------------- --------------------------------------------------------------
use_ascii bool True iff the outputs should use the ASCII charset
------------------- ---------------------------------- --------------------------------------------------------------
fail_fast bool True iff the test runner should abort after the first failure
------------------- ---------------------------------- --------------------------------------------------------------
pattern const char * The pattern of the tests that should be executed
=================== ================================== ==============================================================
Starting the test runner
~~~~~~~~~~~~~~~~~~~~~~~~
The test runner can be called with ``criterion_run_all_tests``. The function
returns 0 if one test or more failed, 1 otherwise.