gtest: basic CMake example of using the gtest annotation

Author: undo-bkenward

gtest_annotations/README.md

@@ -30,6 +30,24 @@ 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](examples/) 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:
+```sh
+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

gtest_annotations/examples/.gitignore

@@ -0,0 +1 @@
+build/*

gtest_annotations/examples/CMakeLists.txt

@@ -0,0 +1,50 @@
+cmake_minimum_required(VERSION 3.14)
+project(basic_undo_gtest_annotation)
+
+set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+include(FetchContent)
+FetchContent_Declare(
+  googletest
+  URL https://github.com/google/googletest/archive/23f642ab2317c632d93326c65efd44671c1d9985.zip
+)
+
+FetchContent_MakeAvailable(googletest)
+
+enable_testing()
+
+add_executable(
+  listener_test
+)
+
+find_library(
+  UNDOEX_LIBRARY
+  NAMES libundoex_pic_x64.a
+)
+
+find_path(
+  UNDOEX_INCLUDE
+  NAMES undoex-test-annotations.h
+)
+
+target_include_directories(
+  listener_test
+  PRIVATE
+  "../"
+  "${UNDOEX_INCLUDE}"
+)
+
+target_sources(
+  listener_test
+  PRIVATE listener_test.cc
+)
+
+target_link_libraries(
+  listener_test
+  GTest::gtest
+  "${UNDOEX_LIBRARY}"
+)
+
+include(GoogleTest)
+gtest_discover_tests(listener_test)

gtest_annotations/examples/listener_test.cc

@@ -0,0 +1,28 @@
+#include <gtest/gtest.h>
+
+#include "undo_gtest_annotation.h"
+
+TEST(BasicTest, Equality)
+{
+    EXPECT_EQ(1, 1);
+    EXPECT_TRUE(1 == 1);
+}
+
+TEST(BasicTest, Addition)
+{
+    EXPECT_TRUE(1 + 1 == 2);
+}
+
+TEST(BasicTest, Fails)
+{
+    EXPECT_TRUE(1 == 2);
+}
+
+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();
+}