AyTest-Mini is a lightest modern header-only unit testing framework for C++20 and later. It only contains the minimal lines of code required to implement unit testing.
This framework is now fully completed and no further features will be planned to add. If you want to get more features, please consider using other testing frameworks.
To get started, all you need is to download the latest version which is just a single header and include it in your source files (or add this repository as a git submodule).
Suppose we have a pow2 function that we want to test:
#define AYTESTM_CONFIG_MAIN
#include "aytestm.hpp"
int pow2(int x) { return x * x; }
TEST_CASE("case 1") {
CHECK(pow2(1) == 1);
CHECK(pow2(2) == 4);
CHECK(pow2(10) == 100);
CHECK(pow2(1) + 1 == 3);
CHECK_THROWS(pow2(0));
}This will compile to a complete executable program. If you run it, it will execute all test cases (in this example there is just one), report any failures and a summary of how many tests passed and failed.
After compile and run cycle, we will see two test failures. The output will look something like:
AyTest-Mini v1.0.0
--------------------------------------------------------------------------------
../../../tests/main.test.cc(6):
TEST CASE: case 1
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
../../../tests/main.cc(10): FAILED:
CHECK( pow2(1) + 1 == 3 )
../../../tests/main.cc(11): FAILED:
CHECK_THROWS( pow2(0) )
No exception thrown.
================================================================================
test cases: 1 | 1 failed
assertions: 4 | 3 passed | 1 failed
- TEST_CASE( case name, ... )
Any assertion expression must be defined in one test case. Any number of test cases can be defined in an executable program.
TEST_CASE("case 1") {
assertion expression
assertion expression
assertion expression
}- SECTION(...)
Each run through a test case will execute one, and only one, section.
Note that section can not be nested or in a cycle!
TEST_CASE("") {
assertion expression
SECTION("S1") {
assertion expression
assertion expression
}
SECTION("S2") {
assertion expression
assertion expression
}
assertion expression
}The REQUIRE family of macros tests an expression and aborts the test case if it fails.
The CHECK family are equivalent but execution continues in the same test case even if the assertion fails.
- CHECK( expression )
- REQUIRE( expression )
Evaluates the expression and check if the result is true. If an exception is thrown, it is caught, reported, and counted as a failure.
Note that the expression should return a boolean value.
CHECK( 1 + 1 == 2 );
REQUIRE( 1 + 1 != 0 );- CHECK_NOTHROW( expression )
- REQUIRE_NOTHROW( expression )
Expects that no exception is thrown during evaluation of the expression.
CHECK_NOTHROW( [](){}() );
REQUIRE_NOTHROW( [](){}() );- CHECK_THROWS( expression )
- REQUIRE_THROWS( expression )
Expects that an exception (of any type) is be thrown during evaluation of the expression.
CHECK_THROWS( [](){ throw int{0}; }()) );
REQUIRE_THROWS( [](){ throw int{0}; }()) );- CHECK_THROWS_AS( exception type, expression )
- REQUIRE_THROWS_AS( exception type, expression )
Expects that an exception of the specified type is thrown during evaluation of the expression.
CHECK_THROWS_AS( int, [](){ throw int{0}; }() );
REQUIRE_THROWS_AS( int, [](){ throw int{0}; }()) );Macros need to be defined before including the header file.
- Generating default main function
This option can be used to generate a main function automatically.
#define AYTESTM_CONFIG_MAIN- Disabling ANSI color
This option can be used to disable the output of ANSI color code.
#define AYTESTM_DISABLE_ANSI_COLOR- Disabling testing macros
This option can be used to disable the testing macros.
#define AYTESTM_DISABLE_TEST_MACROMaybe you can read Catch2 documentation instead.