From 4d39d9d40ff9a3359b7aa011c8c7d7abc3d64eeb Mon Sep 17 00:00:00 2001
From: "Rune K. Svendsen" <runesvend@gmail.com>
Date: Sat, 11 Jan 2025 16:44:13 +0100
Subject: [PATCH] CI: ignore failures due to issue #18

---
 .github/workflows/cabal-in-nix-shell.yml | 15 +++++++++++----
 shell.nix                                |  1 +
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/cabal-in-nix-shell.yml b/.github/workflows/cabal-in-nix-shell.yml
index 4f13ed2..d2ecd0d 100644
--- a/.github/workflows/cabal-in-nix-shell.yml
+++ b/.github/workflows/cabal-in-nix-shell.yml
@@ -58,10 +58,17 @@ jobs:
       - name: Build tests
         run: nix-shell --argstr ghcVersion ${{ matrix.ghc }} --argstr ccVersion ${{ matrix.cc }} --run 'cabal build --enable-tests'
 
+        # NOTE: Ignores failures caused by https://github.com/jberthold/packman/issues/18.
+        #       It's not very useful to have failing CI on the master branch, since it makes us miss newly introduced bugs. Therefore, we ignore this known error, while failing in case of other errors in the same test suite or failure of other test suites.
+        #       The condition in human-readable terms is: (all_tests_succeeded || testmthread_logs_contain_issue18_error_string) && other_test_suites_did_not_fail
+        #         The condition "other_test_suites_did_not_fail" is tested by asserting that no log files exist that fit the "*-test-fail.log" pattern while excluding the log file of the "testmthread" test suite (testmthread-test-fail.log).
+        # TODO: Revert this change once that issue is fixed.
       - name: Run tests
-        run: nix-shell --argstr ghcVersion ${{ matrix.ghc }} --argstr ccVersion ${{ matrix.cc }} --run 'cabal test --test-show-details direct' # "--test-show-details direct" makes cabal print test suite output to terminal
+        run: |
+          mkdir ci-logs
+          nix-shell --argstr ghcVersion ${{ matrix.ghc }} --argstr ccVersion ${{ matrix.cc }} --run '(cabal test --test-log="$(pwd)/ci-logs/\$test-suite-test-\$result.log" || grep "testmthread: Contains an unsupported closure type (whose implementation is missing)" ci-logs/testmthread-test-fail.log) && (! find ci-logs ! -name testmthread-test-fail.log -name "*-test-fail.log"|grep .)'
 
-      # Run all tests again showing only the output of failed tests
-      - name: Run failed tests
+      # Print output of failed test cases
+      - name: Print output of failed tests
         if: failure()
-        run: nix-shell --argstr ghcVersion ${{ matrix.ghc }} --argstr ccVersion ${{ matrix.cc }} --run 'cabal test --test-show-details failures'
+        run: nix-shell --argstr ghcVersion ${{ matrix.ghc }} --argstr ccVersion ${{ matrix.cc }} --run 'tail -v -n +1 ci-logs/*-test-fail.log'
diff --git a/shell.nix b/shell.nix
index 60b3dac..fb75c9e 100644
--- a/shell.nix
+++ b/shell.nix
@@ -28,6 +28,7 @@ pkgs.mkShell {
     pkgs.cabal-install
     pkgs.git
     pkgs2405.${ccVersion}
+    pkgs.coreutils
   ];
 }