# UnitTest++ in brief

## Introduction

This little document serves as bare-bones documentation for UnitTest++.

For background, goals and license details, see:

- The UnitTest++ home page
- Release announcement

The documentation, while sparse, aims to be practical, so it should give you enough info to get started using UnitTest++ as fast as possible.

## Building UnitTest++

Building UnitTest++ will be specific to each platform and build environment, but it should be straightforward.

### Building with Visual Studio

If you are using Visual Studio, go for either of the provided .sln files, depending on version. There are no prefabricated solutions for versions earlier than VS.NET 2003, but we have had reports of people building UnitTest++ with at least VS.NET 2002.

### Building with Make

The bundled makefile is written to build with g++. It also needs `sed` installed in the path, and to be able to use the `mv` and `rm` shell commands. The makefile should be usable on most Posix-like platforms.

Do "make all" to generate a library and test executable. A final build step runs all unit tests to make sure that the result works as expected.

### Packaging

You'll probably want to keep the generated library in a shared space in source control, so you can reuse it for multiple test projects. A redistributable package of UnitTest++ would consist of the generated library file, and all of the header files in `UnitTest++/src/` and its per-platform subfolders. The `tests` directory only contains the unit tests for the library, and need not be included.

## Using UnitTest++

The source code for UnitTest++ comes with a full test suite written using UnitTest++. This is a great place to learn techniques for testing. There is one sample .cpp file: `UnitTest++/src/tests/TestUnitTest++.cpp`. It covers most of UnitTest++'s features in an easy-to-grasp context, so start there if you want a quick overview of typical usage.

### Getting started

Listed below is a minimal C++ program to run a failing test through UnitTest++.

      // test.cpp
      #include <UnitTest++.h>

      TEST(FailSpectacularly)
      {
        CHECK(false);
      }

      int main()
      {
        return UnitTest::RunAllTests();
      }

`UnitTest++.h` is a facade header for UnitTest++, so including that should get you all features of the library. All classes and free functions are placed in namespace `UnitTest`, so you need to either qualify their full names (as with `RunAllTests()` in the example) or add a `using namespace UnitTest;` statement in your .cpp files. Note that any mention of UnitTest++ functions and classes in this document assume that the `UnitTest` namespace has been opened.

Compiling and linking this program with UnitTest++'s static library into an executable, and running it, will produce the following output (details may vary):

      .\test.cpp(5): error: Failure in FailSpectacularly: false
      FAILED: 1 out of 1 tests failed (1 failures).
      Test time: 0.00 seconds.

UnitTest++ attempts to report every failure in an IDE-friendly format, depending on platform (e.g. you can double-click it in Visual Studio's error list.) The exit code will be the number of failed tests, so that a failed test run always returns a non-zero exit code.

### Test macros

To add a test, simply put the following code in a .cpp file of your choice:

      TEST(YourTestName)
      {
      }

The `TEST` macro contains enough machinery to turn this slightly odd-looking syntax into legal C++, and automatically register the test in a global list. This test list forms the basis of what is executed by `RunAllTests()`.

If you want to re-use a set of test data for more than one test, or provide setup/teardown for tests, you can use the `TEST_FIXTURE` macro instead. The macro requires that you pass it a class name that it will instantiate, so any setup and teardown code should be in its constructor and destructor.

      struct SomeFixture
      {
        SomeFixture() { /* some setup */ }
        ~SomeFixture() { /* some teardown */ }

        int testData;
      };

      TEST_FIXTURE(SomeFixture, YourTestName)
      {
        int temp = testData;
      }

Note how members of the fixture are used as if they are a part of the test, since the macro-generated test class derives from the provided fixture class.

### Suite macros

Tests can be grouped into suites, using the `SUITE` macro. A suite serves as a namespace for test names, so that the same test name can be used in two difference contexts.

      SUITE(YourSuiteName)
      {
        TEST(YourTestName)
        {
        }

        TEST(YourOtherTestName)
        {
        }
      }

This will place the tests into a C++ namespace called `YourSuiteName`, and make the suite name available to UnitTest++. `RunAllTests()` can be called for a specific suite name, so you can use this to build named groups of tests to be run together.

### Simple check macros

In test cases, we want to check the results of our system under test. UnitTest++ provides a number of check macros that handle comparison and proper failure reporting.

The most basic variety is the boolean `CHECK` macro:

      CHECK(false); // fails

It will fail if the boolean expression evaluates to false.

For equality checks, it's generally better to use `CHECK_EQUAL`:

      CHECK_EQUAL(10, 20); // fails
      CHECK_EQUAL("foo", "bar"); // fails

Note how `CHECK_EQUAL` is overloaded for C strings, so you don't have to resort to `strcmp` or similar. There is no facility for case-insensitive comparison or string searches, so you may have to drop down to a plain boolean `CHECK` with help from the CRT:

      CHECK(std::strstr("zaza", "az") != 0); // succeeds

For floating-point comparison, equality isn't necessarily well-defined, so you should prefer the `CHECK_CLOSE` macro:

      CHECK_CLOSE(3.14, 3.1415, 0.01); // succeeds

All of the macros are tailored to avoid unintended side-effects, for example:

      TEST(CheckMacrosHaveNoSideEffects)
      {
        int i = 4;
        CHECK_EQUAL(5, ++i); // succeeds
        CHECK_EQUAL(5, i); // succeeds
      }

The check macros guarantee that the `++i` expression isn't repeated internally, as demonstrated above.

### Array check macros

There is a set of check macros for array comparison as well:

      const float oned[2] = { 10, 20 };
      CHECK_ARRAY_EQUAL(oned, oned, 2); // succeeds
      CHECK_ARRAY_CLOSE(oned, oned, 2, 0.00); // succeeds

      const float twod[2][3] = { {0, 1, 2}, {2, 3, 4} };
      CHECK_ARRAY2D_CLOSE(twod, twod, 2, 3, 0.00); // succeeds

The array equal macro compares elements using `operator==`, so `CHECK_ARRAY_EQUAL` won't work for an array of C strings, for example.

The array close macros are similar to the regular CHECK_CLOSE macro, and are really only useful for scalar types, that can be compared in terms of a difference between two array elements.

Note that the one-dimensional array macros work for `std::vector` as well, as it can be indexed just as a C array.

### Exception check macros

Finally, there's a `CHECK_THROW` macro, which asserts that its enclosed expression throws the specified type:

      struct TestException {};
      CHECK_THROW(throw TestException(), TestException); // succeeds

UnitTest++ natively catches exceptions if your test code doesn't. So if your code under test throws any exception UnitTest++ will fail the test and report either using the `what()` method for `std::exception` derivatives or just a plain message for unknown exception types.

Should your test or code raise an irrecoverable error (an Access Violation on Win32, for example, or a signal on Linux), UnitTest++ will attempt to map them to an exception and fail the test, just as for other unhandled exceptions.

### Time constraints

UnitTest++ can fail a test if it takes too long to complete, using so-called time constraints.

They come in two flavors; local and global time constraints.

Local time constraints are limited to the current scope, like so:

      TEST(YourTimedTest)
      {
         // Lengthy setup...

         {
            UNITTEST_TIME_CONSTRAINT(50);

            // Do time-critical stuff
         }

         // Lengthy teardown...
      }

The test will fail if the "Do time-critical stuff" block takes longer than 50 ms to complete. The time-consuming setup and teardown are not measured, since the time constraint is scope-bound. It's perfectly valid to have multiple local time constraints in the same test, as long as there is only one per block.

A global time constraint, on the other hand, requires that all of the tests in a test run are faster than a specified amount of time. This allows you, when you run a suite of tests, to ask UnitTest++ to fail it entirely if any test exceeds the global constraint. The max time is passed as a parameter to an overload of `RunAllTests()`.

If you want to use a global time constraint, but have one test that is notoriously slow, you can exempt it from inspection by using the `UNITTEST_TIME_CONSTRAINT_EXEMPT` macro anywhere inside the test body.

      TEST(NotoriouslySlowTest)
      {
         UNITTEST_TIME_CONSTRAINT_EXEMPT();

         // Oh boy, this is going to take a while
         ...
      }

### Test runners

The `RunAllTests()` function has an overload that lets you customize the behavior of the runner, such as global time constraints, custom reporters, which suite to run, etc.

      int RunAllTests(TestReporter& reporter, TestList const& list, char const* suiteName, int const maxTestTimeInMs);

If you attempt to pass custom parameters to `RunAllTests()`, note that the `list` parameter should have the value `Test::GetTestList()`.

The parameterless `RunAllTests()` is a simple wrapper for this one, with sensible defaults.

### Example setup

How to create a new test project varies depending on your environment, but here are some directions on common file structure and usage.

The general idea is that you keep one `Main.cpp` file with the entry-point which calls `RunAllTests()`.

Then you can simply compile and link new .cpp files at will, typically one per test suite.

       + ShaverTests/
       |
       +- Main.cpp
       |
       +- TestBrush.cpp
       +- TestEngine.cpp
       +- TestRazor.cpp

Each of the `Test*.cpp` files will contain one or more `TEST` macro incantations with the associated test code. There are no source-level dependencies between `Main.cpp` and `Test*.cpp`, as the `TEST` macro handles the registration and setup necessary for `RunAllTests()` to find all tests compiled into the same final executable.

UnitTest++ does not require this structure, even if this is how the library itself does it. As long as your test project contains one or more `TESTs` and calls `RunAllTests()` at one point or another, it will be handled by UnitTest++.

It's common to make the generated executable start as a post-build step, so that merely building your test project will run the tests as well. Since the exit code is the count of failures, a failed test will generally break the build, as most build engines will fail a build if any step returns a non-zero exit code.