Set recording template (#7)

* Minor: Added ``set_mismatch_template()`` to configure the mismatch HTML template path.
* Minor: Custom mismatch template paths now fail if they cannot be resolved.
* Minor: Added template format validation for ``oldText`` and ``newText`` markers.
* Minor: Added ``in_github_actions()`` to detect when tests run in GitHub Actions.
* Patch: Mismatch errors now include full recording/mismatch payload only in GitHub Actions.
* Patch: Added a test that prints mismatch error output for debugging and CI diagnostics.

Author: mortenvp

.github/workflows/cpp-internal.yml

@@ -1,13 +1,11 @@
 name: C++ Internal
-
 on:
   schedule:
     - cron: 0 1 * * * # Nightly at 01:00 UTC
   push:
     branches:
       - master
   pull_request:
-
 jobs:
   linux_cmake:
     timeout-minutes: 45
@@ -42,18 +40,16 @@ jobs:
       - ${{ matrix.config.runner }}
     name: ${{ matrix.config.name }}
     steps:
-      # This is sometimes needed when running docker builds since these
-      # sometimes produce files with root ownership
       - name: Ensure correct owner of repository
         run: sudo chown -R actions-runner:actions-runner .
       - name: Checkout source code
         uses: actions/checkout@v3
-      - name: Waf Clean
-        run: python3 waf clean --no_resolve
       - name: Waf Configure
         run: python3 waf configure --git_protocol=git@ --cmake_toolchain=${{ matrix.config.toolchain }} --cmake_verbose
       - name: Waf Build
-        run: python3 waf build --run_tests
+        run: python3 waf build
+      - name: Waf Run Tests
+        run: python3 waf --run_tests
 
   valgrind:
     timeout-minutes: 45
@@ -65,37 +61,40 @@ jobs:
     steps:
       - name: Ensure correct owner of repository
         run: sudo chown -R actions-runner:actions-runner .
-
       - name: Checkout source code
         uses: actions/checkout@v3
-
-      - name: Waf Clean
-        run: python3 waf clean --no_resolve
-
       - name: Waf Configure
         run: python3 waf configure --git_protocol=git@ --cmake_toolchain=./resolve_symlinks/toolchains/gcc-toolchain.cmake --cmake_verbose
-
       - name: Waf Build
-        run: python3 waf build --run_tests --ctest_valgrind
-
+        run: python3 waf build
+      - name: Waf Run Tests
+        run: python3 waf --run_tests --ctest_valgrind
   zig_toolchain_build:
     name: Zig Toolchain Build (Docker)
     runs-on: [self-hosted, vm, ubuntu-current]
     container:
-      image: ghcr.io/steinwurf/build-images/zig-cpp:0.14.1
+      image: ghcr.io/steinwurf/build-images/zig-cpp
       options: --user 0:0
-      volumes:
-        - /root/.ssh:/root/.ssh
     steps:
       - name: Checkout source code
         uses: actions/checkout@v4
-      - name: Waf Clean
-        run: python3 waf clean --no_resolve
+        with:
+          persist-credentials: false
+      - name: Configure Github Authentication
+        run: |
+          git config --global credential.helper 'store'
+          git credential approve <<EOF
+          protocol=https
+          host=github.com
+          username=x-access-token
+          password=${{ secrets.GH_ACCESS_TOKEN }}
+          EOF
       - name: Waf Configure with Zig Toolchain
-        run: python3 waf configure --git_protocol=git@ --cmake_toolchain=../resolve_symlinks/toolchains/zig-toolchain-x86_64-linux-musl.cmake --cmake_verbose
+        run: python3 waf configure --git_protocol=https:// --cmake_toolchain=./resolve_symlinks/toolchains/zig-toolchain-x86_64-linux-musl.cmake --cmake_verbose
       - name: Waf Build with Zig Toolchain
-        run: python3 waf build --run_tests
-
+        run: python3 waf build
+      - name: Waf Run Tests
+        run: python3 waf --run_tests
   macos_cmake:
     timeout-minutes: 45
     strategy:
@@ -117,13 +116,12 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Waf Clean
-        run: python3 waf clean --no_resolve
       - name: Waf Configure
         run: python3 waf configure --git_protocol=git@ --cmake_toolchain=${{ matrix.config.toolchain }} --cmake_verbose
       - name: Waf Build
-        run: python3 waf build --run_tests
-
+        run: python3 waf build
+      - name: Waf Run Tests
+        run: python3 waf --run_tests
   windows_cmake:
     timeout-minutes: 45
     strategy:
@@ -133,13 +131,12 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Waf Clean
-        run: python waf clean --no_resolve
       - name: Waf Configure
         run: python waf configure --git_protocol=git@ --cmake_verbose
       - name: Waf Build
-        run: python waf build --run_tests
-
+        run: python waf build
+      - name: Waf Run Tests
+        run: python waf --run_tests
   clang-format:
     timeout-minutes: 45
     name: Clang-Format
@@ -153,7 +150,6 @@ jobs:
         uses: actions/checkout@v3
       - name: Run Clang-format
         run: find ./ -iname *.hpp -o -iname *.cpp -o -iname *.c -o -iname *.h | xargs clang-format --dry-run --Werror
-
   workflow-keepalive:
     if: github.event_name == 'schedule'
     runs-on: [self-hosted, vm, ubuntu-current]
@@ -165,7 +161,6 @@ jobs:
           sudo apt update
           sudo apt install -y gh
       - uses: liskin/gh-workflow-keepalive@v1
-
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
-  cancel-in-progress: true
+  cancel-in-progress: true

.gitignore

@@ -16,6 +16,10 @@ cmake_build
 
 # Python
 *.pyc
+.venv/
+
+# Devbox
+devbox.lock
 
 # Compiled Doxygen documentation
 /doxygen/html

NEWS.rst

@@ -6,7 +6,12 @@ every change, see the Git log.
 
 Latest
 ------
-* tbd
+* Minor: Added ``set_mismatch_template()`` to configure the mismatch HTML template path.
+* Minor: Custom mismatch template paths now fail if they cannot be resolved.
+* Minor: Added template format validation for ``oldText`` and ``newText`` markers.
+* Minor: Added ``in_github_actions()`` to detect when tests run in GitHub Actions.
+* Patch: Mismatch errors now include full recording/mismatch payload only in GitHub Actions.
+* Patch: Added a test that prints mismatch error output for debugging and CI diagnostics.
 
 2.0.0
 -----

README.rst

@@ -8,6 +8,48 @@ Overview
 datarecorder is a simple C++ library that is meant to provide simple helper
 functions to ease sometimes tedious testing tasks.
 
+Build and test
+==============
+
+Configure::
+
+    ./waf configure
+
+Build::
+
+    ./waf build
+
+Run tests::
+
+    ./waf build --run_tests
+
+Mismatch template
+=================
+
+By default, datarecorder will try to find this template:
+
+- ``visualizer/recording_diff.html``
+
+You can override this with::
+
+    recorder.set_mismatch_template("path/to/recording_diff.html");
+
+If the provided path is relative, datarecorder resolves it by searching
+backwards from the current working directory.
+
+If you provide a custom mismatch template path and it cannot be found,
+recording will fail.
+
+Template requirements
+---------------------
+
+The template must contain both of these JavaScript markers (using backticks)::
+
+    const oldText = `...`;
+    const newText = `...`;
+
+These placeholders are replaced with recording data and mismatch data.
+
 License
 -------
 The stub library is released under the BSD license, see the LICENSE.rst file.

devbox.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://raw.githubusercontent.com/jetify-com/devbox/0.16.0/.schema/devbox.schema.json",
+  "packages": [
+    "zig_0_13@latest",
+    "python@3.12.0",
+    "cmake@3.28.3",
+    "ninja@1.11.1",
+    "python312Packages.pip@latest",
+    "clang_18@18.1.8",
+    "gcc@13.3.0"
+  ],
+  "shell": {
+    "init_hook": [
+      "echo 'Welcome to devbox!' > /dev/null"
+    ],
+    "scripts": {
+      "configure": [
+        "python3 waf clean --no_resolve",
+        "python3 waf configure \"$@\""
+      ],
+      "build": [
+        "python3 waf build \"$@\""
+      ],
+      "format": [
+        "find ./test ./src \\( -iname '*.c' -o -iname '*.h' -o -iname '*.cpp' -o -iname '*.hpp' \\) -print0 | xargs -0 clang-format -i"
+      ]
+    }
+  }
+}

lock_version_resolve.json

@@ -15,8 +15,8 @@
         "sha1": "8e016b57dd5361fe7f66ae47f3df42ab634321c5"
     },
     "bourne": {
-        "commit_id": "cf4fed3ea15525a6608722db56f10ff4314c2354",
-        "resolver_info": "11.0.0",
+        "commit_id": "b824b289f1d8cbfeecc26743ea5579e5d3051c8c",
+        "resolver_info": "11.1.0",
         "sha1": "f705097630cc09ecd747eaf3b5eef8966cfa4fba"
     },
     "endian": {
@@ -35,8 +35,8 @@
         "sha1": "5078750ed20c6d6323d27ed96fb2ddebc43bb247"
     },
     "fmt": {
-        "commit_id": "5d5eb0f166979fa523704114620a40b3e9e6bb08",
-        "resolver_info": "5.0.0",
+        "commit_id": "3fba272021d507b310f4d059e3a4c1883b65fbc4",
+        "resolver_info": "5.0.1",
         "sha1": "160978c7e6571cc06d6c8a590e5e0c4f3c826fba"
     },
     "fmt-source": {
@@ -60,13 +60,13 @@
         "sha1": "650d881b8cb6cc1adf354d47d6353db6ec4fd6a5"
     },
     "platform": {
-        "commit_id": "7740600dfa6c8800819737dd85fb89c16c1c0c01",
-        "resolver_info": "6.0.0",
+        "commit_id": "9dacaa6bba5ff933d126620c073ddfe09e993336",
+        "resolver_info": "6.1.0",
         "sha1": "7a014ba5a95cf7f0193213e95d3d2d8fcfa313b7"
     },
     "poke": {
-        "commit_id": "08f354b5e559a03238d57f9cdd3826d2a32190ec",
-        "resolver_info": "17.0.0",
+        "commit_id": "c6175a2954de4fa6bdafaa845d66c0c2990b96b2",
+        "resolver_info": "17.1.3",
         "sha1": "26bfb0923f6668c93d72f6955e9f39d3dba0ce01"
     },
     "protobuf": {
@@ -90,13 +90,13 @@
         "sha1": "67edfd49ad879868b7d6a48b4e72d7f0cd969b46"
     },
     "toolchains": {
-        "commit_id": "d771e98c84304735f43db13d50edffd8e7d5a9d6",
-        "resolver_info": "1.0.5",
+        "commit_id": "655f6d386f0a9d4a0038388fdccb5fbfe463f1b0",
+        "resolver_info": "1.1.0",
         "sha1": "443cb23b0570dffd39283d8679ec393ed809302f"
     },
     "verify": {
-        "commit_id": "27b970938379a5a1bc1c9f4377c2686943763893",
-        "resolver_info": "6.0.4",
+        "commit_id": "42e744725e5a9f9e303da4b53446030a1a20a321",
+        "resolver_info": "6.1.0",
         "sha1": "fed379602b6ea7bd611fc249daffa11b9e593800"
     },
     "zlib-source": {