KazTest

After being frustrated with the difficulty creating test cases in C++ test frameworks in comparison to say Python, I went and wrote my own.

It's dead simple to use, and uses Python to for test discovery so you don't need to register your test cases with crazy macros!

Usage

Here's a basic example of what a test file looks like:

#include <kaztest/kaztest.h>

class MyTests : public TestCase {
public:
    void set_up() {
        //Do set up stuff
    }

    void tear_down() {
        //Do tear down stuff
    }

    void test_bananas() {
        assert_true(we_have_bananas());
        assert_equal(10, banana_count());
        assert_almost_equal(20.0, average_banana_length(), 0.001f);
    }
};

To use, simply do the following:

• Create a header file for your tests, I tend to prefix mine with test_
• In your header file, include <kaztest/kaztest.h>
• In your header file, create a class that subclasses TestCase
• Write your tests in methods prefixed with test_ you can also override set_up() and tear_down()
• Hook kaztest_gen into your build system. This is a Python file that takes a list of test files as input, and generates a main.cpp file.

For example, to hook kaztest_gen into CMake do the following:

FIND_PACKAGE(KAZTEST REQUIRED)

ADD_CUSTOM_COMMAND(
    OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp 
    COMMAND ${KAZTEST_EXECUTABLE} ${TEST_FILES} ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp
    DEPENDS ${TEST_FILES}
)

ADD_EXECUTABLE(my_tests ${TEST_FILES} ${TEST_SOURCES} ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp)
ADD_TEST(my_suite my_tests)

Where ${TEST_FILES} is a list of your test_X.h test files. You can then run your tests by executing my_tests or running ctest

TODO:

• Make sure the generated executable returns values suitable for ctest (it might already do this)
• Make discovery of tests more robust
• Allow specifying a directory to kaztest_gen, which would then discover all files prefixed with test_ in subdirectories
• Support TestCases inside namespaces