test: integrate handlebars and boost.url test suite

This change integrates the test suite library developed for handlebars with the test suite library from boost.url that is being used for other tests. With this integration, Handlebars tests are listed among any other tests in the library. The features used for handlebars, such as the expression decomposer and the diff algorithm for golden master tests, have been integrated into the test library from Boost.URL. fix #390
cppalliance · Jul 10, 2023 · 8aa8f80 · 8aa8f80
1 parent fda33b1
commit 8aa8f80
Show file tree

Hide file tree

Showing 17 changed files with 773 additions and 660 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -28,7 +28,7 @@ include(GNUInstallDirs)
 
 option(MRDOX_BUILD_TESTS "Build tests" ${BUILD_TESTING})
 option(MRDOX_BUILD_SHARED "Link shared" OFF)
-option(MRDOX_BUILD_DOCS "Configure install target" OFF)
+option(MRDOX_BUILD_DOCS "Build documentation" OFF)
 option(MRDOX_INSTALL "Configure install target" ON)
 option(MRDOX_PACKAGE "Build install package" ON)
 option(MRDOX_GENERATE_REFERENCE "Generate reference.xml/reference.adoc" ON)
@@ -204,6 +204,7 @@ endif ()
 
 file(GLOB_RECURSE TOOL_SOURCES  CONFIGURE_DEPENDS tool/*.cpp tool/*.hpp)
 add_executable(mrdox ${TOOL_SOURCES})
+target_compile_definitions(mrdox PRIVATE -DMRDOX_TOOL)
 
 target_include_directories(mrdox
     PUBLIC
@@ -225,39 +226,6 @@ if (MRDOX_CLANG)
     )
 endif ()
 
-
-#-------------------------------------------------
-#
-# Tests
-#
-#-------------------------------------------------
-
-file(GLOB TEST_SOURCES CONFIGURE_DEPENDS
-    test/*.cpp
-    test/*.hpp)
-add_executable(mrdox-test ${TEST_SOURCES})
-
-target_include_directories(mrdox-test
-    PRIVATE
-    "${PROJECT_SOURCE_DIR}/include"
-    "${PROJECT_SOURCE_DIR}/lib"
-    "${PROJECT_SOURCE_DIR}/test"
-    "${PROJECT_SOURCE_DIR}/tool"
-)
-
-target_compile_definitions(mrdox PRIVATE -DMRDOX_TOOL)
-target_link_libraries(mrdox-test PUBLIC mrdox-core)
-
-if (MRDOX_CLANG)
-    target_compile_options(
-        mrdox-test
-        PRIVATE
-        -Wno-covered-switch-default
-    )
-endif ()
-
-#-------------------------------------------------------------------------------
-
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 #source_group(TREE ${PROJECT_SOURCE_DIR} PREFIX "" FILES CMakeLists.txt)
 source_group(TREE ${PROJECT_SOURCE_DIR}/include/mrdox PREFIX "include" FILES ${INCLUDES})
@@ -270,8 +238,27 @@ source_group(TREE ${PROJECT_SOURCE_DIR}/source PREFIX "source" FILES ${SOURCES})
 #-------------------------------------------------
 
 if (MRDOX_BUILD_TESTS)
-    # if we run tests, we need the addons in the right place.
+    #-------------------------------------------------
+    # Unit tests
+    #-------------------------------------------------
+    include(CTest)
+    file(GLOB_RECURSE TEST_SUITE_FILES CONFIGURE_DEPENDS test/test_suite/*.cpp test/test_suite/*.hpp)
+    file(GLOB_RECURSE UNIT_TEST_SOURCES CONFIGURE_DEPENDS test/unit/*.cpp test/unit/*.hpp)
+    add_executable(mrdox-test ${TEST_SUITE_FILES} ${UNIT_TEST_SOURCES})
+    target_include_directories(mrdox-test
+            PRIVATE
+            "${PROJECT_SOURCE_DIR}/include"
+            "${PROJECT_SOURCE_DIR}/lib"
+            "${PROJECT_SOURCE_DIR}/tool"
+            "${PROJECT_SOURCE_DIR}/test/test_suite"
+            )
+    target_link_libraries(mrdox-test PUBLIC mrdox-core)
+    if (MRDOX_CLANG)
+        target_compile_options(mrdox-test PRIVATE -Wno-covered-switch-default)
+    endif ()
+    target_compile_definitions(mrdox-test PRIVATE -DMRDOX_UNIT_TEST_DIR="${CMAKE_CURRENT_SOURCE_DIR}/test/unit")
     add_custom_command(
+            # if we run tests, we need the addons in the right place.
             TARGET mrdox-test
             POST_BUILD
             COMMAND ${CMAKE_COMMAND} -E copy
@@ -280,25 +267,28 @@ if (MRDOX_BUILD_TESTS)
             BYPRODUCTS ${CMAKE_BINARY_DIR}/addons
             DEPENDS ${CMAKE_SOURCE_DIR}/addons
     )
+    add_test(NAME mrdox-test COMMAND mrdox-test --action test "${PROJECT_SOURCE_DIR}/test-files/old-tests")
 
-    file(GLOB_RECURSE TEST_SOURCES CONFIGURE_DEPENDS source/*.cpp source/*.hpp)
-    enable_testing()
-    add_test(NAME mrdox-test COMMAND mrdox-test --action test
-            "${PROJECT_SOURCE_DIR}/test-files/old-tests"
-            )
-
+    #-------------------------------------------------
+    # Reference documentation
+    #-------------------------------------------------
     if (MRDOX_GENERATE_REFERENCE)
         # test run
+        file(GLOB_RECURSE REFERENCE_SOURCES CONFIGURE_DEPENDS source/*.cpp source/*.hpp)
+
         set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES ${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES})
         include(mrdox.cmake)
 
-        mrdox(FORMAT adoc CONFIG docs/mrdox.yml SOURCES ${TEST_SOURCES})
-        mrdox(FORMAT xml  CONFIG docs/mrdox.yml SOURCES ${TEST_SOURCES})
+        mrdox(FORMAT adoc CONFIG docs/mrdox.yml SOURCES ${REFERENCE_SOURCES})
+        mrdox(FORMAT xml  CONFIG docs/mrdox.yml SOURCES ${REFERENCE_SOURCES})
 
         add_custom_target(reference_adoc ALL DEPENDS reference.adoc)
         add_custom_target(reference_xml  ALL DEPENDS reference.xml)
     endif()
 
+    #-------------------------------------------------
+    # XML lint
+    #-------------------------------------------------
     find_package(LibXml2)
     if (LibXml2_FOUND)
         find_package(Java REQUIRED Runtime)
@@ -320,7 +310,6 @@ if (MRDOX_BUILD_TESTS)
                      --relaxng ${CMAKE_CURRENT_BINARY_DIR}/mrdox.rng ${XML_SOURCES}
                  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
     endif()
-
 endif()
 
 

diff --git a/include/mrdox/Platform.hpp b/include/mrdox/Platform.hpp
@@ -78,8 +78,10 @@ namespace mrdox {
 # endif
 #endif
 
-#if ! defined(__GNUC__) && defined(_MSC_VER)
-#define FMT_CONSTEVAL
+#ifndef FMT_CONSTEVAL
+# if !defined(__GNUC__) && defined(_MSC_VER)
+#  define FMT_CONSTEVAL
+# endif
 #endif
 
 } // mrdox

diff --git a/include/mrdox/Support/Handlebars.hpp b/include/mrdox/Support/Handlebars.hpp
@@ -34,7 +34,7 @@ struct HandlebarsOptions
 {
     /** Escape HTML entities
      */
-    bool noHTMLEscape = false;
+    bool noEscape = false;
 
     /** Templates will throw rather than ignore missing fields
      */

diff --git a/lib/Support/Handlebars.cpp b/lib/Support/Handlebars.cpp
@@ -131,7 +131,7 @@ escapeExpression(
     std::string_view str,
     HandlebarsOptions opt)
 {
-    if (opt.noHTMLEscape)
+    if (opt.noEscape)
     {
         out << str;
     }
@@ -370,7 +370,7 @@ struct defaultLogger {
         os << ']';
         for (std::size_t i = 0; i < args.size(); ++i) {
             HandlebarsOptions opt;
-            opt.noHTMLEscape = true;
+            opt.noEscape = true;
             format_to(os, args.at(i), opt);
             os << " ";
         }
@@ -1352,7 +1352,7 @@ renderExpression(
         return;
 
     auto opt2 = opt;
-    opt2.noHTMLEscape = tag.forceNoHTMLEscape || opt.noHTMLEscape;
+    opt2.noEscape = tag.forceNoHTMLEscape || opt.noEscape;
 
     auto it = helpers_.find(tag.helper);
     if (it != helpers_.end()) {
@@ -1368,7 +1368,7 @@ renderExpression(
         if (render == HelperBehavior::RENDER_RESULT) {
             format_to(out, res, opt2);
         } else if (render == HelperBehavior::RENDER_RESULT_NOESCAPE) {
-            opt2.noHTMLEscape = true;
+            opt2.noEscape = true;
             format_to(out, res, opt2);
         }
         if (tag.removeRWhitespace) {
@@ -1394,7 +1394,7 @@ renderExpression(
     if (render == HelperBehavior::RENDER_RESULT) {
         format_to(out, res, opt2);
     } else if (render == HelperBehavior::RENDER_RESULT_NOESCAPE) {
-        opt2.noHTMLEscape = true;
+        opt2.noEscape = true;
         format_to(out, res, opt2);
     }
     if (tag.removeRWhitespace) {
@@ -1688,7 +1688,7 @@ renderBlock(
         format_to(out, res, opt);
     } else if (render == HelperBehavior::RENDER_RESULT_NOESCAPE) {
         HandlebarsOptions opt2 = opt;
-        opt2.noHTMLEscape = true;
+        opt2.noEscape = true;
         format_to(out, res, opt2);
     }
 }

diff --git a/test/TestArgs.cpp → test/test_suite/TestArgs.cpp b/test/TestArgs.cpp → test/test_suite/TestArgs.cpp
diff --git a/test/TestArgs.hpp → test/test_suite/TestArgs.hpp b/test/TestArgs.hpp → test/test_suite/TestArgs.hpp
diff --git a/test/TestMain.cpp → test/test_suite/TestMain.cpp b/test/TestMain.cpp → test/test_suite/TestMain.cpp
diff --git a/test/TestRunner.cpp → test/test_suite/TestRunner.cpp b/test/TestRunner.cpp → test/test_suite/TestRunner.cpp
diff --git a/test/TestRunner.hpp → test/test_suite/TestRunner.hpp b/test/TestRunner.hpp → test/test_suite/TestRunner.hpp
diff --git a/test/test_suite/detail/decomposer.cpp b/test/test_suite/detail/decomposer.cpp
@@ -0,0 +1,36 @@
+//
+// Copyright (c) 2023 Alan de Freitas ([email protected])
+//
+// Distributed under the Boost Software License, Version 1.0. (See accompanying
+// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+//
+// Official repository: https://github.com/boostorg/url
+//
+
+#include "decomposer.hpp"
+
+#if __has_include(<cxxabi.h>)
+#include <cxxabi.h>
+#endif
+
+namespace test_suite {
+namespace detail {
+std::string demangle(const char *mangled)
+{
+#if __has_include(<cxxabi.h>)
+    int status;
+    char *demangled = abi::__cxa_demangle(mangled, nullptr, nullptr, &status);
+    std::string result;
+    if (status == 0) {
+        result = demangled;
+    } else {
+        result = mangled;
+    }
+    std::free(demangled);
+    return result;
+#else
+    return mangled;
+#endif
+}
+} // detail
+} // test_suite