README.md

YATF

Branch	Build	Coverage
master
devel

YATF, which stands for Yet Another Test Framework, is an automated test framework for C++. It is designed to be usable in a bare-metal environment and consists only of one header file.

How to use it

// in main.cpp
#include <yatf.hpp>
#include <cstdio>

int main(int argc, const char *argv[]) {
    // you have to provide printf-like function -
    // in this case it's from cstdio
    return yatf::main(printf, argc, argv);
}

// in tests
#include <yatf.hpp>

TEST(suite_name, test_case1) {
    REQUIRE(true);
    REQUIRE_EQ(1, 1);
}

It also supports fixtures, which are passed as a third parameter to the TEST macro:

struct some_fixture {
    int variable = 2;
};

TEST(suite_name, test_case2, some_fixture) {
    variable = 3;
    REQUIRE_EQ(variable, 3);
}

Mocking methods and functions is also available. It's done by simple MOCK macro, which returns a mock_handler objects. Assertions are resolved at the end of theirs scope.

MOCK(int(int, int), sum);

TEST(suite, test) {
    REQUIRE_CALL(sum).for_arguments(2, 3).will_return(4);
    auto result = sum(2, 3);
    REQUIRE_EQ(result, 4);
}