Add workflow to check determinism (#1164)

A manually dispatched workflow to that runs the CTS, set to require exact
matches to golden files, on macOS, Ubuntu and Windows using arm64
and x86_86 processors, with ktx and libktx compiled with clang and gcc
and, in addition, on macOS AppleClang and on Windows ClangCL and msvc.

Of necessity to avoid a build failure on the macos-15-intel runner, update
the version of zstd included in external/basis_universal/zstd.

The failure arose due to a combination of three factors: zstd_errors.h
was not in `external/basis_universal/zstd` but in `other_Include` which
is marked as a system directory; macos-15-intel has a newer version
installed in `/usr/local/include` which omits declaration of a function
_libktx_ uses; the AppleClang version on that runner was searching
`/usr/local/include` before directories specified with `-isystem`, in
what looks like a bug. The updated version, from basis_universal 2.0,
declares the function that _libktx_ uses in `zstd.h`. Furthermore it
includes `zstd_errors.h` in the same directory nullifying the `-isystem`
and conflicting version problems.

Author: MarkCallow

.github/workflows/check-determinism.yml

@@ -3,55 +3,102 @@
 name: Check Determinism of Encoder Results Across Plaforms and Compilers
 
 # The purpose of this is to show whether the encoding results are
-# deterministic across platforms and compilers. Do this by building
-# and running the library and tools then running the CTS with an
-# option set so it will expect an exact match and won't use ktxdiff.
+# deterministic across platforms and compilers. It does this by building
+# the library and tools then running the CTS with an option set that
+# requires an exact match and won't use ktxdiff.
+#
+# The test is run across macOS, Ubuntu and Windows on both arm64 and x86_64
+# processors using ktx and libktx compiled with clang and gcc. They are,
+# in addition, compiled with AppleClang on macOS and with ClangCL and msvc
+# on Windows.
 
 on:
   workflow_dispatch:
 
+# macOS runners: clang 17, clang 18 available on $(brew --prefix llvm@18)/bin/clang  & gcc-{13,14,15}
+# Linux runners: clang 16, 17, 18 & gcc-{12,13,14}
+# Windows runners: 
 jobs:
   check-determinism:
     strategy:
+      fail-fast: false
       matrix:
-        os: [ macos-latest, macos-15-intel, ubuntu-latest, ubuntu-22.04-arm, windows-latest, windows-11-arm ]
+        os: [ macos-latest, macos-15-intel, ubuntu-latest, ubuntu-24.04-arm, windows-latest, windows-11-arm ]
+        compiler:
+          - [ clang, clang++ ]
+          - [ gcc, g++ ]
         config: [ Release ]
         generator: [ 'Ninja Multi-Config' ]
         exclude:
-          #- os: [ windows-latest, windows-11-arm ]
-          - os: windows-latest
-            generator: 'Ninja Multi-Config'
+          - os: macos-latest
+            compiler: [ gcc, g++ ] # Here gcc is an alias for clang
+          - os: macos-15-intel
+            compiler: [ gcc, g++ ] # ditto
         include:
-          # The NMC generator defaults to using GCC and GCC names dlls with
-          # a "lib" prefix and the import files with both the prefix and a
-          # ".dll.a" extension. I have neither the time nor energy to find out
-          # how to change the behaviour. Use VS.
-          #- os: [ windows-latest, windows-11-arm ]
+          - os: macos-latest
+            compiler: [ gcc-15, g++-15 ]
+            config: Release
+            generator: 'Ninja Multi-Config'
+          - os: macos-latest
+            compiler: [ $(brew --prefix llvm@18)/bin/clang, $(brew --prefix llvm@18)/bin/clang++ ]
+            config: Release
+            generator: 'Ninja Multi-Config'
+          - os: macos-15-intel
+            compiler: [ gcc-15, g++-15 ]
+            config: Release
+            generator: 'Ninja Multi-Config'
+          - os: macos-15-intel
+            compiler: [ $(brew --prefix llvm@18)/bin/clang, $(brew --prefix llvm@18)/bin/clang++ ]
+            config: Release
+            generator: 'Ninja Multi-Config'
           - os: windows-latest
+            config: Release
             generator: 'Visual Studio 17 2022'
+            toolset: v143
+          - os: windows-latest
             config: Release
-            static: OFF
+            generator: 'Visual Studio 17 2022'
+            toolset: CLangCL
+          - os: windows-11-arm
+            config: Release
+            generator: 'Visual Studio 17 2022'
+            toolset: v143
+          - os: windows-11-arm
+            config: Release
+            generator: 'Visual Studio 17 2022'
+            toolset: CLangCL
 
     runs-on: ${{ matrix.os }}
     env:
       GIT_LFS_SKIP_SMUDGE: 1
-      BUILD_DIR: "build"
-      WERROR: ON
+      BUILD_DIR: build
+      STANDARD_OPTIONS: '-D KTX_WERROR=OFF -D LIBKTX_VERSION_READ_ONLY=OFF -D KTX_FEATURE_TOOLS=ON -D KTX_FEATURE_TOOLS_CTS=ON -D KTX_TOOLS_CTS_PRIMARY_PLATFORM=ON -D KTX_FEATURE_TESTS=ON'
 
     steps:
     - uses: actions/checkout@v6
       with:
         # Fetch all history to make sure tags are
         # included (used for version creation)
         fetch-depth: 0
+        # For the CTS submodule.
+        submodules: true
+
+    - name: Set macOS astcenc ISA override for x86_64
+      if: matrix.os == 'macos-15-intel'
+      run: echo ISA_OVERRIDE='-D ASTCENC_ISA_SSE41=ON' >> $GITHUB_ENV
+
+    - name: Configure KTX software build for all but Visual Studio
+      # Without the ${{ }}, this line generates a YAML syntax error. Do not understand why.
+      if: ${{ !startsWith(matrix.generator, 'Visual Studio') }}
+      run: cmake -B ${{ env.BUILD_DIR }} -G "${{ matrix.generator }}" -D CMAKE_C_COMPILER=${{ matrix.compiler[0] }} -D CMAKE_CXX_COMPILER=${{ matrix.compiler[1] }} ${{ env.STANDARD_OPTIONS }} ${{ env.ISA_OVERRIDE }}
 
-    - name: Configure KTX software
-      run: echo 'cmake -B ${{ env.BUILD_DIR }} -G "${{ matrix.generator }}" -D KTX_WERROR=${{ env.WERROR }} -D LIBKTX_VERSION_READ_ONLY=OFF -D KTX_FEATURE_TOOLS=ON -D KTX_FEATURE_TOOLS_CTS=ON -D KTX_TOOLS_CTS_PRIMARY_PLATFORM=ON -D KTX_FEATURE_TESTS ${{ matrix.os }}'
+    - name: Configure KTX software build for Visual Studio build
+      if: startsWith(matrix.generator, 'Visual Studio')
+      run: cmake -B ${{ env.BUILD_DIR }} -G "${{ matrix.generator }}" -T ${{ matrix.toolset }} ${{ env.STANDARD_OPTIONS }}
 
     - name: Build KTX software
-      run: echo 'cmake --build ${{ env.BUILD_DIR }} --config=${{ matrix.config }} --target=ktxtools'
+      run: cmake --build ${{ env.BUILD_DIR }} --config=${{ matrix.config }} --target=ktxtools
 
     - name: Run KTX tools CTS
-      continue-on-error: true
-      run: echo 'ctest --output-on-failure --test-dir ${{ BUILD_DIR }} -C Release -R ktxToolsTest'
+      run: ctest --output-on-failure --test-dir ${{ env.BUILD_DIR }} -C Release -R ktxToolsTest