README.md

Google Test annotations

Overview

This provides a listener for Google Test to insert annotations in recordings made with LiveRecorder or UDB.

If your Google Test integration already has a main function, enabling this should just require the following:

• #include <undo_gtest_annotation.h> before main.
• in main, call:

  testing::UnitTest::GetInstance()->listeners().Append(new undo_annotation::UndoAnnotationListener);

If you don't already have a main function, you'll need to add one. The most basic version is:

GTEST_API_ int
main(int argc, char **argv)
{
    testing::InitGoogleTest(&argc, argv);

    testing::UnitTest::GetInstance()->listeners().Append(new undo_annotation::UndoAnnotationListener);
    return RUN_ALL_TESTS();
}

The header file includes undoex-test-annotations.h, which is included in the undoex path of a UDB release. It also requires the library to be included in the build - it is distributed for both static and dynamic linking.

Examples

The example is a very basic test of the listener, built using cmake. If the undoex header and library files are not in system paths, you can specify the path to them using CMAKE_PREFIX_PATH. Build the example using:

export CMAKE_PREFIX_PATH=/path/to/undo/release/undoex
cmake -S . -B build
cmake --build build

The resulting binary in build/listener_test runs three tests, two that should pass and one that should fail. If a recording is made (using LiveRecorder or UDB) annotations will be inserted. These can be viewed using the info annotations command in UDB. You can also travel directly to the start or endof a test using ugo annotation, for example ugo annotation Fails/run2 u-test-start will go to the start of the failing test in this example.

Limitations

Note that the annotations are inserted at the point in time in the plugin, so when going to the start of a test you will need to step forward to find the actual start of a test. Likewise, when going to the end of a test you will need to step backward.