Difference between revisions of "Better Unit tests for C++"

From OPeNDAP Documentation
m (More information on CPPUNIT macros)
m (Parts of a CPPUNIT test suite)
Line 14: Line 14:
 
; Test suite definition: This section includes the CPPUNIT macros that define what is run and the implementation of the methods that are called by those macros.
 
; Test suite definition: This section includes the CPPUNIT macros that define what is run and the implementation of the methods that are called by those macros.
 
; A main function to run the the tesuite
 
; A main function to run the the tesuite
 +
 +
== More information on CPPUNIT macros ==
 +
Here are tables of the macros available in CPPUNIT
 +
 +
=== Macros for use in test methods ===
 +
http://cppunit.sourceforge.net/doc/cvs/group___assertions.html#ga2
 +
 +
=== Macros for defining test suites ===
 +
http://cppunit.sourceforge.net/doc/cvs/_helper_macros_8h.html
 +
 +
== An example unit test ==
  
 
Here's an example (a slimmed down version of bes/dispatch/unit-tests/checkT.cc
 
Here's an example (a slimmed down version of bes/dispatch/unit-tests/checkT.cc

Revision as of 22:10, 3 January 2022

We use CPPUNIT for C++ unit tests. But most of our tests don't take advantage of CPPUNIT's best feature - its extensive set of test and assertion macros. This how-to explores some of the macros using a real test that was rewritten to be more useful and easier to read (and a bit shorter).

1 Parts of a CPPUNIT test suite

We want to write test suites and not tests because it is better to run a collection tests where each test runs regardless of whether the previous tests pass or fail. A single test can easily hide multiple (possibly related) problems because it stops running at the first failure. But it's hard to write tests that look for exceptions and other complex conditions without repeating lots of 'boilerplate' code. CPPUNIT macros to the rescue.

It is important to make each test in the test suite independent of the other tests.

But first, the parts of a test suite:

Headers
The CPPUNIT headers, the header for the class under test, headers that header needs and other stuff for the tests
Class definition
Each test suite is a class. The class typically contains an instance (or pointer to) of the class to be tested.
Class constructor and destructor
Often these can be set to the default. If they are used to initialize class members, that initialization will be done once for the entire test suite.
Setup and Teardown methods
These methods are run before and after each test in the test suite.
Test suite definition
This section includes the CPPUNIT macros that define what is run and the implementation of the methods that are called by those macros.
A main function to run the the tesuite

2 More information on CPPUNIT macros

Here are tables of the macros available in CPPUNIT

2.1 Macros for use in test methods

http://cppunit.sourceforge.net/doc/cvs/group___assertions.html#ga2

2.2 Macros for defining test suites

http://cppunit.sourceforge.net/doc/cvs/_helper_macros_8h.html

3 An example unit test

Here's an example (a slimmed down version of bes/dispatch/unit-tests/checkT.cc

// HEADERS
#include <cppunit/TextTestRunner.h>
#include <cppunit/extensions/TestFactoryRegistry.h>
#include <cppunit/extensions/HelperMacros.h>

#include "config.h"

#include "BESUtil.h"

#include "BESForbiddenError.h"
#include "BESNotFoundError.h"

// This pulls in macros for pathnames, e.g., TEST_BUILD_DIR, which is used to
// make tests that use absolute paths but are independent of where they are run.

#include "test_config.h"         

using namespace std;
using namespace CppUnit;

// These globals are used for the debug command line switches. See main().

static bool debug = false;
static bool debug2 = false;

#undef DBG
#define DBG(x) do { if (debug) (x); } while(false)

#undef DBG2
#define DBG2(x) do { if (debug2) (x); } while(false)

class checkT: public TestFixture {

public:
    checkT() = default;

    virtual ~checkT() = default;

    virtual void setUp()
    {
        ...
    }

    // Define the test suite
    CPPUNIT_TEST_SUITE(checkT);

    // See below for more macros, e.g., CPPUNIT_TEST_FAIL(testMethod) or 
    // CPPUNIT_TEST_EXCEPTION(testMethod, ExceptionType)

    CPPUNIT_TEST(simple_test);
    CPPUNIT_TEST(another_simple_test);
    CPPUNIT_TEST(test_slash_path);
    CPPUNIT_TEST(test_sym_link_sym_links_not_allowed);

    CPPUNIT_TEST_SUITE_END();

    // These methods make up the tests suite. There are lots of macros you can
    // use to simplify these methods.

    void simple_test()
    {
        DBG(cerr << "test something simple using an assert" << endl);
        CPPUNIT_ASSERT(string("Hyrax").length() == 5);
    }

    void another_simple_test()
    {
        DBG(cerr << "test something" << endl);
        CPPUNIT_ASSERT_EQUAL_MESSAGE("string("Hyrax").length() should return 5", 5, string("Hyrax").length())
    }

    void test_slash_path()
    {
        DBG(cerr << "checking /" << endl);
        CPPUNIT_ASSERT_NO_THROW_MESSAGE("checking /", BESUtil::check_path("/", "./", true));
    }

    ...
 
    void test_sym_link_sym_links_not_allowed()
    {
        DBG(cerr << "checking /testdir/link_to_nc/, follow_syms = false" << endl);
        CPPUNIT_ASSERT_THROW_MESSAGE("checking /testdir/link_to_nc/, follow_syms = false",
                                     BESUtil::check_path("/testdir/link_to_nc/", "./", false),
                                     BESForbiddenError);
    }

    ...
};

CPPUNIT_TEST_SUITE_REGISTRATION(checkT);

// Here is a sample main() that supports command line arguments and running individual tests by name

int main(int argc, char *argv[]) {
    int option_char;
    while ((option_char = getopt(argc, argv, "dDh")) != EOF) {
        switch (option_char) {
            case 'd':
                debug = true;  // debug is a static global
                break;
            case 'D':
                debug2 = true;  // debug is a static global
                break;
            case 'h': {     // help - show test names
                cerr << "Usage: checkT has the following tests:" << endl;
                const std::vector<Test *> &tests = checkT::suite()->getTests();
                unsigned int prefix_len = checkT::suite()->getName().append("::").length();
                for (auto test: tests) {
                    cerr << test->getName().replace(0, prefix_len, "") << endl;
                }

                return 0;
            }
            default:
                break;
        }
    }

    argc -= optind;
    argv += optind;

    CppUnit::TextTestRunner runner;
    runner.addTest(CppUnit::TestFactoryRegistry::getRegistry().makeTest());

    bool wasSuccessful = true;
    string test = "";
    if (0 == argc) {
        // run them all
        wasSuccessful = runner.run("");
    }
    else {
        int i = 0;
        while (i < argc) {
            DBG(cerr << "Running " << argv[i] << endl);
            test = checkT::suite()->getName().append("::").append(argv[i++]);
            wasSuccessful = wasSuccessful && runner.run(test);
        }
    }

    return wasSuccessful ? 0 : 1;
}