tests: replace doctest with googletest (#431)

* tests: replace doctest with googletest

- googletest command-line output lists a nice summary of failed tests at the end, doctest's doesn't
- string test case names in doctest make IDE file structure view useless
- googletest has VS support
- doctest development stalled

other changes:
- get rid of doctest::skip(), all tests run now.
(was only applied to 3 tests: "winding", "mountain", "base1")

* check for test failure

* Revert "check for test failure"

This reverts commit a71d020.

* fix test names to comply with gtest rules

.gitmodules

@@ -10,6 +10,3 @@
 [submodule "3rdparty/pareto"]
 	path = 3rdparty/pareto
 	url = https://github.com/alandefreitas/pareto.git
-[submodule "3rdparty/doctest"]
-	path = 3rdparty/doctest
-	url = https://github.com/doctest/doctest

3rdparty/CMakeLists.txt

@@ -1,7 +1,16 @@
 add_subdirectory(fmt EXCLUDE_FROM_ALL)
-add_subdirectory(doctest EXCLUDE_FROM_ALL)
 add_subdirectory(json EXCLUDE_FROM_ALL)
 add_subdirectory(nanobench EXCLUDE_FROM_ALL)
 
 set(BUILD_WITH_PEDANTIC_WARNINGS OFF CACHE BOOL "prevent pareto from adding /WX" FORCE)
 add_subdirectory(pareto EXCLUDE_FROM_ALL)
+
+include(FetchContent)
+FetchContent_Declare(
+        googletest
+        GIT_REPOSITORY https://github.com/google/googletest.git
+        GIT_TAG        f8d7d77c06936315286eb55f8de22cd23c188571 # v1.14.0
+)
+# For Windows: Prevent overriding the parent project's compiler/linker settings
+set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+FetchContent_MakeAvailable(googletest)

build-appveyor.ps1

@@ -28,7 +28,7 @@ if ( $? -eq $false ) {
   throw "package failed"
 }
 
-.\tests\Release\tests.exe --no-skip
+.\tests\Release\tests.exe
 
 if ( $? -eq $false ) {
   throw "tests failed"

build-linux-64.sh

@@ -36,11 +36,7 @@ export ASAN_OPTIONS=detect_leaks=false
 make -j8 VERBOSE=1 package || exit 1
 
 # run tests
-if [ "$USE_ASAN" != "YES" ]; then
-  ./tests/tests --no-skip || exit 1 # run hidden tests (releaseonly)
-else
-  ./tests/tests || exit 1
-fi
+./tests/tests || exit 1
 
 # check rpath
 readelf -d ./light/light

build-osx.sh

@@ -48,8 +48,4 @@ otool -L ./bspinfo/bspinfo
 otool -L ./bsputil/bsputil
 
 # run tests
-if [ "$USE_ASAN" != "YES" ]; then
-  ./tests/tests --no-skip || exit 1 # run hidden tests (releaseonly)
-else
-  ./tests/tests || exit 1
-fi
+./tests/tests || exit 1

build-windows.ps1

@@ -27,7 +27,7 @@ if ( $? -eq $false ) {
   throw "build failed"
 }
 
-.\tests\tests.exe --no-skip
+.\tests\tests.exe
 
 if ( $? -eq $false ) {
   throw "tests failed"

tests/CMakeLists.txt

@@ -1,5 +1,3 @@
-enable_testing()
-
 add_executable(tests
 		test.cc
 		test_main.cc
@@ -29,9 +27,7 @@ if (NOT EMBREE_TBB_DLL STREQUAL EMBREE_TBB_DLL-NOTFOUND)
 	message(STATUS "Found embree EMBREE_TBB_DLL: ${EMBREE_TBB_DLL}")
 endif()
 
-target_link_libraries(tests libqbsp liblight libvis libbsputil common TBB::tbb TBB::tbbmalloc doctest::doctest fmt::fmt nanobench::nanobench)
-
-target_compile_definitions(tests PRIVATE DOCTEST_CONFIG_SUPER_FAST_ASSERTS)
+target_link_libraries(tests libqbsp liblight libvis libbsputil common TBB::tbb TBB::tbbmalloc GTest::gtest fmt::fmt nanobench::nanobench)
 
 # HACK: copy .dll dependencies
 add_custom_command(TARGET tests POST_BUILD

tests/benchmark.cc

@@ -1,13 +1,13 @@
 #include <nanobench.h>
-#include <doctest/doctest.h>
+#include <gtest/gtest.h>
 #include <vis/vis.hh>
 #include <common/qvec.hh>
 #include <common/polylib.hh>
 
 #include <array>
 #include <vector>
 
-TEST_CASE("winding" * doctest::test_suite("benchmark") * doctest::skip())
+TEST(benchmark, winding)
 {
     ankerl::nanobench::Bench bench;
 
@@ -52,35 +52,35 @@ static void test_polylib(bool check_results)
     ankerl::nanobench::doNotOptimizeAway(back);
 
     if (check_results) {
-        REQUIRE(front);
-        REQUIRE(back);
+        ASSERT_TRUE(front);
+        ASSERT_TRUE(back);
 
-        CHECK(front->size() == 4);
-        CHECK(back->size() == 4);
+        EXPECT_EQ(front->size(), 4);
+        EXPECT_EQ(back->size(), 4);
 
         // check front polygon
-        CHECK(front->at(0) == qvec3d{0, 64, 16});
-        CHECK(front->at(1) == qvec3d{64, 64, 16});
-        CHECK(front->at(2) == qvec3d{64, -64, 16});
-        CHECK(front->at(3) == qvec3d{0, -64, 16});
+        EXPECT_EQ(front->at(0), qvec3d(0, 64, 16));
+        EXPECT_EQ(front->at(1), qvec3d(64, 64, 16));
+        EXPECT_EQ(front->at(2), qvec3d(64, -64, 16));
+        EXPECT_EQ(front->at(3), qvec3d(0, -64, 16));
 
         // check back polygon
-        CHECK(back->at(0) == qvec3d{-64, 64, 16});
-        CHECK(back->at(1) == qvec3d{0, 64, 16});
-        CHECK(back->at(2) == qvec3d{0, -64, 16});
-        CHECK(back->at(3) == qvec3d{-64, -64, 16});
+        EXPECT_EQ(back->at(0), qvec3d(-64, 64, 16));
+        EXPECT_EQ(back->at(1), qvec3d(0, 64, 16));
+        EXPECT_EQ(back->at(2), qvec3d(0, -64, 16));
+        EXPECT_EQ(back->at(3), qvec3d(-64, -64, 16));
     }
 }
 
-TEST_CASE("SplitFace" * doctest::test_suite("benchmark"))
+TEST(benchmark, SplitFace)
 {
     ankerl::nanobench::Bench().run("create and split a face (polylib)", [&]() { test_polylib(false); });
 
     // run with doctest assertions, to validate that they actually work
     test_polylib(true);
 }
 
-TEST_CASE("vis windings")
+TEST(benchmark, visWindings)
 {
     ankerl::nanobench::Bench b;
     b.run("create pstack_t", [&]() {
@@ -143,7 +143,7 @@ TEST_CASE("vis windings")
     });
 }
 
-TEST_CASE("vector math")
+TEST(benchmark, vectorMath)
 {
     ankerl::nanobench::Bench b;
     ankerl::nanobench::Rng rng;