add asset bundling (#497)

Author: andiwand

.github/workflows/build_test.yml

@@ -122,16 +122,7 @@ jobs:
             install
             build/test/odr_test
             build/test/Release/odr_test.exe
-            build/_deps/odr.js-src
-          if-no-files-found: error
-          include-hidden-files: true
-
-      # TODO this is only needed because of data files from dependencies; there should be a better solution
-      - name: upload conan directory to github
-        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
-        with:
-          name: conan-${{ matrix.host_profile }}
-          path: ${{ env.CONAN_HOME }}
+            build/data
           if-no-files-found: error
           include-hidden-files: true
 
@@ -226,20 +217,14 @@ jobs:
         with:
           python-version: 3.14
       - name: install python dependencies
-        run: pip install htmlcmp==1.2.1
+        run: pip install htmlcmp==1.2.4
 
       - name: download binaries
         uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
         with:
           name: bin-${{ matrix.host_profile }}
           path: .
 
-      - name: download conan directory
-        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
-        with:
-          name: conan-${{ matrix.host_profile }}
-          path: ${{ env.CONAN_HOME }}
-
       - name: fix artifact permissions
         if: runner.os != 'Windows'
         run:  chmod +x build/test/odr_test

CMakeLists.txt

@@ -17,6 +17,9 @@ option(ODR_CLANG_TIDY "Run clang-tidy static analysis" OFF)
 option(WITH_PDF2HTMLEX "Build with pdf2htmlEX" ON)
 option(WITH_WVWARE "Build with wvWare" ON)
 option(WITH_LIBMAGIC "Build with libmagic" ON)
+option(ODR_BUNDLE_ASSETS "Bundle assets during build and install" ON)
+
+include(GNUInstallDirs)
 
 # TODO defining global compiler flags seems to be bad practice with conan
 # TODO consider using conan profiles
@@ -54,10 +57,6 @@ FetchContent_Declare(odr.js
 )
 FetchContent_MakeAvailable(odr.js)
 
-set(ODR_DATA_PATH "${odr.js_SOURCE_DIR}")
-
-configure_file("src/odr/internal/project_info.cpp.in" "src/odr/internal/project_info.cpp")
-
 set(PRE_CONFIGURE_FILE "src/odr/internal/git_info.cpp.in")
 set(POST_CONFIGURE_FILE "${CMAKE_CURRENT_BINARY_DIR}/src/odr/internal/git_info.cpp")
 if (EXISTS "${PROJECT_SOURCE_DIR}/.git")
@@ -213,6 +212,10 @@ target_link_libraries(odr
         argon2::argon2
 )
 
+set(ODR_BUILD_ODR_DATA_PATH "${CMAKE_CURRENT_BINARY_DIR}/data")
+file(COPY "${odr.js_SOURCE_DIR}/" DESTINATION "${ODR_BUILD_ODR_DATA_PATH}")
+set(ODR_INSTALL_ODR_DATA_PATH "${CMAKE_INSTALL_DATADIR}")
+
 if (WITH_PDF2HTMLEX)
     find_package(pdf2htmlEX REQUIRED)
     find_package(poppler REQUIRED)
@@ -230,6 +233,28 @@ if (WITH_PDF2HTMLEX)
             PRIVATE
             ODR_WITH_PDF2HTMLEX
     )
+
+    if (ODR_BUNDLE_ASSETS)
+        set(ODR_BUILD_FONTCONFIG_DATA_PATH "${ODR_BUILD_ODR_DATA_PATH}/fontconfig")
+        set(ODR_BUILD_POPPLER_DATA_PATH "${ODR_BUILD_ODR_DATA_PATH}/poppler")
+        set(ODR_BUILD_PDF2HTMLEX_DATA_PATH "${ODR_BUILD_ODR_DATA_PATH}/pdf2htmlex")
+
+        file(COPY "${FONTCONFIG_DATA_PATH}/" DESTINATION "${ODR_BUILD_FONTCONFIG_DATA_PATH}")
+        file(COPY "${POPPLER_DATA_PATH}/" DESTINATION "${ODR_BUILD_POPPLER_DATA_PATH}")
+        file(COPY "${PDF2HTMLEX_DATA_PATH}/" DESTINATION "${ODR_BUILD_PDF2HTMLEX_DATA_PATH}")
+
+        set(ODR_INSTALL_FONTCONFIG_DATA_PATH "${ODR_INSTALL_ODR_DATA_PATH}/fontconfig")
+        set(ODR_INSTALL_POPPLER_DATA_PATH "${ODR_INSTALL_ODR_DATA_PATH}/poppler")
+        set(ODR_INSTALL_PDF2HTMLEX_DATA_PATH "${ODR_INSTALL_ODR_DATA_PATH}/pdf2htmlex")
+    else ()
+        set(ODR_BUILD_FONTCONFIG_DATA_PATH "${FONTCONFIG_DATA_PATH}")
+        set(ODR_BUILD_POPPLER_DATA_PATH "${POPPLER_DATA_PATH}")
+        set(ODR_BUILD_PDF2HTMLEX_DATA_PATH "${PDF2HTMLEX_DATA_PATH}")
+
+        set(ODR_INSTALL_FONTCONFIG_DATA_PATH "${FONTCONFIG_DATA_PATH}")
+        set(ODR_INSTALL_POPPLER_DATA_PATH "${POPPLER_DATA_PATH}")
+        set(ODR_INSTALL_PDF2HTMLEX_DATA_PATH "${PDF2HTMLEX_DATA_PATH}")
+    endif ()
 endif ()
 if (WITH_WVWARE)
     find_package(wvware REQUIRED)
@@ -261,8 +286,22 @@ if (WITH_LIBMAGIC)
             PRIVATE
             ODR_WITH_LIBMAGIC
     )
+
+    if (ODR_BUNDLE_ASSETS)
+        set(ODR_BUILD_LIBMAGIC_DATABASE_PATH "${ODR_BUILD_ODR_DATA_PATH}/magic.mgc")
+
+        file(COPY_FILE "${LIBMAGIC_DATABASE_PATH}" "${ODR_BUILD_LIBMAGIC_DATABASE_PATH}")
+
+        set(ODR_INSTALL_LIBMAGIC_DATABASE_PATH "${ODR_INSTALL_ODR_DATA_PATH}/magic.mgc")
+    else ()
+        set(ODR_BUILD_LIBMAGIC_DATABASE_PATH "${LIBMAGIC_DATABASE_PATH}")
+
+        set(ODR_INSTALL_LIBMAGIC_DATABASE_PATH "${LIBMAGIC_DATABASE_PATH}")
+    endif ()
 endif ()
 
+configure_file("src/odr/internal/project_info.cpp.in" "src/odr/internal/project_info.cpp")
+
 if (EXISTS "${PROJECT_SOURCE_DIR}/.git")
     add_dependencies(odr check_git)
 endif ()
@@ -279,8 +318,6 @@ if (ODR_CLANG_TIDY)
     add_subdirectory("static_analysis/clang-tidy")
 endif ()
 
-include(GNUInstallDirs)
-
 install(
         DIRECTORY src/ "${CMAKE_CURRENT_BINARY_DIR}/src/"
         DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
@@ -294,6 +331,6 @@ install(
         ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}"
 )
 install(
-        DIRECTORY "${ODR_DATA_PATH}/"
-        DESTINATION "${CMAKE_INSTALL_DATADIR}"
+        DIRECTORY "${ODR_BUILD_ODR_DATA_PATH}/"
+        DESTINATION "${ODR_INSTALL_ODR_DATA_PATH}"
 )

src/odr/global_params.hpp

@@ -4,7 +4,7 @@
 
 namespace odr {
 
-class GlobalParams {
+class GlobalParams final {
 public:
   static const std::string &odr_core_data_path();
   static const std::string &fontconfig_data_path();

src/odr/internal/git_info.cpp.in

@@ -6,4 +6,4 @@ const char *git_info::commit_hash() noexcept { return "@GIT_HEAD_SHA1@"; }
 
 bool git_info::is_dirty() noexcept { return @GIT_IS_DIRTY@; }
 
-}
+} // namespace odr::internal

src/odr/internal/project_info.cpp.in

@@ -2,58 +2,60 @@
 
 namespace odr::internal {
 
-const char *project_info::version() noexcept { return "${CMAKE_PROJECT_VERSION}"; }
+const char *project_info::version() noexcept {
+  return "${CMAKE_PROJECT_VERSION}";
+}
 
 bool project_info::is_debug() noexcept {
 #ifdef NDEBUG
-    return false;
+  return false;
 #else
-    return true;
+  return true;
 #endif
 }
 
 bool project_info::has_wvware() noexcept {
 #ifdef ODR_WITH_WVWARE
-    return true;
+  return true;
 #else
-    return false;
+  return false;
 #endif
 }
 
-bool project_info::has_pdf2htmlex() noexcept{
+bool project_info::has_pdf2htmlex() noexcept {
 #ifdef ODR_WITH_PDF2HTMLEX
-    return true;
+  return true;
 #else
-    return false;
+  return false;
 #endif
 }
 
-bool project_info::has_libmagic() noexcept{
+bool project_info::has_libmagic() noexcept {
 #ifdef ODR_WITH_LIBMAGIC
-    return true;
+  return true;
 #else
-    return false;
+  return false;
 #endif
 }
 
 const char *project_info::odr_data_path() noexcept {
-  return "${ODR_DATA_PATH}";
+  return "${ODR_INSTALL_ODR_DATA_PATH}";
 }
 
 const char *project_info::fontconfig_data_path() noexcept {
-  return "${FONTCONFIG_DATA_PATH}";
+  return "${ODR_INSTALL_FONTCONFIG_DATA_PATH}";
 }
 
 const char *project_info::poppler_data_path() noexcept {
-        return "${POPPLER_DATA_PATH}";
+  return "${ODR_INSTALL_POPPLER_DATA_PATH}";
 }
 
-const char *project_info::pdf2htmlex_data_path() noexcept{
-        return "${PDF2HTMLEX_DATA_PATH}";
+const char *project_info::pdf2htmlex_data_path() noexcept {
+  return "${ODR_INSTALL_PDF2HTMLEX_DATA_PATH}";
 }
 
-const char *project_info::libmagic_database_path() noexcept{
-        return "${LIBMAGIC_DATABASE_PATH}";
+const char *project_info::libmagic_database_path() noexcept {
+  return "${ODR_INSTALL_LIBMAGIC_DATABASE_PATH}";
 }
 
 } // namespace odr::internal

test/CMakeLists.txt

@@ -2,14 +2,15 @@ find_package(GTest REQUIRED)
 
 include(GoogleTest REQUIRED)
 
-set(ODR_RESOURCE_DIRECTORY "${odr.js_SOURCE_DIR}")
 set(ODR_TEST_DATA_DIRECTORY "${CMAKE_CURRENT_LIST_DIR}/data")
-configure_file("src/test_constants.cpp.in" "src/test_constants.cpp")
+configure_file("src/test_info.cpp.in" "src/test_info.cpp")
 
 enable_testing()
 add_executable(odr_test
+        "src/test_main.cpp"
+
         "src/test_util.cpp"
-        "${CMAKE_CURRENT_BINARY_DIR}/src/test_constants.cpp"
+        "${CMAKE_CURRENT_BINARY_DIR}/src/test_info.cpp"
 
         "src/document_path_test.cpp"
         "src/document_test.cpp"
@@ -61,7 +62,6 @@ target_link_libraries(odr_test
         vincentlaucsb-csv-parser::vincentlaucsb-csv-parser
         uchardet::uchardet
         GTest::gtest
-        GTest::gtest_main
 
         odr
 )

test/src/html_output_test.cpp

@@ -5,6 +5,7 @@
 #include <odr/internal/util/odr_meta_util.hpp>
 #include <odr/internal/util/string_util.hpp>
 
+#include <test_info.hpp>
 #include <test_util.hpp>
 
 #include <filesystem>
@@ -158,7 +159,7 @@ TEST_P(HtmlOutputTests, html_meta) {
 
   const std::string resource_path =
       Path(output_path_prefix).parent().join(RelPath("resources")).string();
-  std::filesystem::copy(TestData::resource_directory(), resource_path,
+  std::filesystem::copy(info::odr_data_path(), resource_path,
                         fs::copy_options::recursive |
                             fs::copy_options::overwrite_existing);
 

test/src/test_constants.cpp.in

@@ -0,0 +1,27 @@
+#include <test_info.hpp>
+
+namespace odr::test {
+
+const char *info::odr_data_path() noexcept {
+  return "${ODR_BUILD_ODR_DATA_PATH}";
+}
+
+const char *info::fontconfig_data_path() noexcept {
+  return "${ODR_BUILD_FONTCONFIG_DATA_PATH}";
+}
+
+const char *info::poppler_data_path() noexcept {
+  return "${ODR_BUILD_POPPLER_DATA_PATH}";
+}
+
+const char *info::pdf2htmlex_data_path() noexcept {
+  return "${ODR_BUILD_PDF2HTMLEX_DATA_PATH}";
+}
+
+const char *info::libmagic_database_path() noexcept {
+  return "${ODR_BUILD_LIBMAGIC_DATABASE_PATH}";
+}
+
+const char *info::odr_test_data_path() noexcept { return "${ODR_TEST_DATA_DIRECTORY}"; }
+
+} // namespace odr::test

test/src/test_info.cpp.in

@@ -0,0 +1,13 @@
+#pragma once
+
+namespace odr::test::info {
+
+const char *odr_data_path() noexcept;
+const char *fontconfig_data_path() noexcept;
+const char *poppler_data_path() noexcept;
+const char *pdf2htmlex_data_path() noexcept;
+const char *libmagic_database_path() noexcept;
+
+const char *odr_test_data_path() noexcept;
+
+} // namespace odr::test::info