Implement uploading output of failed tests (dftbplus#1580)

Author: aradi

.github/workflows/build.yml

@@ -130,9 +130,21 @@ jobs:
         else
           echo "TEST_OMP_PROCS=2" >> $GITHUB_ENV
         fi
-        pushd ${BUILD_DIR}
-        ctest -j ${TEST_OMP_PROCS} --output-on-failure
-        popd
+        echo "TEST_UUID=$(uuidgen)" >> ${GITHUB_ENV}
+        ctest -j ${TEST_OMP_PROCS} --output-on-failure --test-dir ${BUILD_DIR}
+
+    - name: Archive any failed test output
+      if: failure()
+      run: |
+        ./utils/test/collect_failed_output.sh ${BUILD_DIR} ${BUILD_DIR}/failed-tests.${TEST_UUID}.tar
+
+    - name: Upload the archive of failed test output
+      if: failure()
+      uses: actions/upload-artifact@v4
+      with:
+        name: failed-tests.${{ env.TEST_UUID }}.tar
+        path: ${{ env.BUILD_DIR }}/failed-tests.${{ env.TEST_UUID }}.tar
+        retention-days: 2
 
     - name: Install project
       run: cmake --install ${BUILD_DIR}

test/app/dftb+/CMakeLists.txt

@@ -29,14 +29,14 @@ endforeach()
 
 foreach(test IN LISTS tests)
   add_test(
-    NAME dftb+_${test}
+    NAME app/dftb+/${test}
     COMMAND ${srcdir}/bin/autotest2
         -r ${srcdir} -w ${builddir} -d ${srcdir}/bin/tagdiff
         -P "${TEST_RUNNER}" -p "$<TARGET_FILE:dftb+>"
 	-G ${srcdir}/bin/globalpostrun.sh
         -s P,R,C,S ${test})
   set_tests_properties(
-    dftb+_${test}
+    app/dftb+/${test}
     PROPERTIES
     ENVIRONMENT "DFTBPLUS_PARAM_DIR=${PROJECT_SOURCE_DIR}/external")
 endforeach()

test/app/modes/CMakeLists.txt

@@ -29,13 +29,13 @@ endforeach()
 
 foreach(test IN LISTS tests)
   add_test(
-    NAME modes_${test}
+    NAME app/modes/${test}
     COMMAND ${srcdir}/bin/autotest2
         -r ${srcdir} -w ${builddir} -d ${srcdir}/bin/tagdiff
         -P "${MODES_RUNNER}" -p "$<TARGET_FILE:modes>"
         -s P,R,C,S ${test})
   set_tests_properties(
-    modes_${test}
+    app/modes/${test}
     PROPERTIES
     ENVIRONMENT "DFTBPLUS_PARAM_DIR=${PROJECT_SOURCE_DIR}/external")
 endforeach()

test/app/phonons/CMakeLists.txt

@@ -30,10 +30,10 @@ endforeach()
 
 foreach(test IN LISTS tests)
   add_test(
-    NAME phonons_${test}
+    NAME app/phonons/${test}
     COMMAND ${srcdir}/bin/autotest2
         -r ${srcdir} -w ${builddir} -d ${srcdir}/bin/tagdiff
         -P "${TEST_RUNNER}" -p "$<TARGET_FILE:phonons>"
         -s P,R,C,S ${test})
-    set_tests_properties(phonons_${test} PROPERTIES LABELS "phonons/${test}") 
+    set_tests_properties(app/phonons/${test} PROPERTIES LABELS "phonons/${test}")
 endforeach()

utils/test/collect_failed_output.sh

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+#
+# Collect the output of failed tests into a tarball
+#
+# Usage: collect_failed_output.sh <build_dir> <archive_name>
+#
+# build_dir: The build directory where code was built and tested with CMake
+# archive_name: The name of the tarball to create
+#
+# The program assumes that the test names in the failure log are of the form *:<test_name>
+# <test_name> is the name of the test directory that is below <build_dir>/test.
+#
+
+BUILD_DIR="$1"
+ARCHIVE_NAME="$2"
+
+if [ "$#" -ne "2" ]; then
+    echo "Usage: $0 <build_dir> <archive_name>"
+    exit 1
+fi
+
+if [ ! -d ${BUILD_DIR} ]; then
+    echo "No build directory found at ${BUILD_DIR}"
+    exit 0
+fi
+
+TEST_FAILURE_LOG="${BUILD_DIR}/Testing/Temporary/LastTestsFailed.log"
+
+if [ ! -f ${TEST_FAILURE_LOG} ]; then
+    echo "No test failure log found at ${TEST_FAILURE_LOG}"
+    exit 0
+fi
+
+TEST_ROOT_DIR="test"
+
+echo "Checking ${TEST_FAILURE_LOG} for failed tests"
+FAILED_TEST_DIRS=()
+for test in $(cat ${TEST_FAILURE_LOG}); do
+  dir="${TEST_ROOT_DIR}/${test#*:}"
+  if [ -e ${BUILD_DIR}/${dir} ]; then
+    FAILED_TEST_DIRS+=(${dir})
+  else
+    echo "Ignoring non-existent test directory ${dir}"
+  fi
+done
+
+if [ ${#FAILED_TEST_DIRS[@]} -eq 0 ]; then
+    echo "No failed test directories to archive, exiting..."
+    exit 0
+fi
+
+tar -C ${BUILD_DIR} -c -f ${ARCHIVE_NAME} ${FAILED_TEST_DIRS}
+
+echo "Archive with failed test directories created at ${ARCHIVE_NAME}"