reorganisation of the test runner script

run-testsuite.sh

@@ -1,4 +1,12 @@
 #!/bin/bash
+
+# prompt for the xtrace output
+PS4='+ $(date "+%Y-%m-%d %H:%M:%S") ${BASH_SOURCE}:${LINENO}: ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
+# use a new fd (chosen by bash) to redirect the xtrace output
+exec {fd}>&2
+BASH_XTRACEFD=${fd}
+unset fd
+
 set -e
 
 if [ -z "${CGAL_TESTER}" ]; then
@@ -11,8 +19,6 @@ if [ -z "${CGAL_TEST_PLATFORM}" ]; then
     echo "CGAL_TEST_PLATFORM not set. Using HOSTNAME: ${HOSTNAME}"
 fi
 
-# HACK: We depend on this line to easily extract the platform name
-# from the logs.
 echo "CGAL_TEST_PLATFORM=${CGAL_TEST_PLATFORM}"
 
 if [ -z "${CGAL_NUMBER_OF_JOBS}" ]; then
@@ -22,42 +28,47 @@ else
     echo "CGAL_NUMBER_OF_JOBS is ${CGAL_NUMBER_OF_JOBS}."
 fi
 
-declare -a "CGAL_CMAKE_FLAGS=${CGAL_CMAKE_FLAGS}"
-echo "CGAL_CMAKE_FLAGS is ${CGAL_CMAKE_FLAGS[@]}."
-
 # The directory where the release is stored.
-export CGAL_RELEASE_DIR="/mnt/testsuite/"
+export CGAL_RELEASE_DIR="/mnt/testsuite"
 # Directory where CGAL sources are stored.
-CGAL_SRC_DIR="${CGAL_RELEASE_DIR}src/"
+CGAL_SRC_DIR="${CGAL_RELEASE_DIR}/src"
 # Directory where CGAL tests are stored.
-CGAL_TEST_DIR="${CGAL_RELEASE_DIR}test/"
+CGAL_TEST_DIR="${CGAL_RELEASE_DIR}/test"
 # Directory where CGAL data are stored.
-CGAL_DATA_DIR="${CGAL_RELEASE_DIR}data/"
+CGAL_DATA_DIR="${CGAL_RELEASE_DIR}/data"
 # Directory where include/CGAL/version.h can be found.
 CGAL_VERSION_DIR="${CGAL_RELEASE_DIR}"
-if ! [ -f "${CGAL_VERSION_DIR}include/CGAL/version.h" ]; then
-    CGAL_VERSION_DIR="${CGAL_RELEASE_DIR}Installation/"
+if ! [ -f "${CGAL_VERSION_DIR}/include/CGAL/version.h" ]; then
+    CGAL_VERSION_DIR="${CGAL_RELEASE_DIR}/Installation"
 fi
 # Directory Testsuite (if branch build), or CGAL_RELEASE_DIR
-CGAL_TESTSUITE_DIR="${CGAL_RELEASE_DIR}Testsuite/"
+CGAL_TESTSUITE_DIR="${CGAL_RELEASE_DIR}/Testsuite"
 if ! [ -d "${CGAL_TESTSUITE_DIR}" ]; then
     CGAL_TESTSUITE_DIR="${CGAL_RELEASE_DIR}"
 fi
 
 # The directory where testresults are stored.
-CGAL_TESTRESULTS="/mnt/testresults/"
+CGAL_TESTRESULTS="/mnt/testresults"
 
-CGAL_DIR="$HOME/build/src/cmake/platforms/${CGAL_TEST_PLATFORM}/"
+CGAL_DIR="$HOME/build/src/cmake/platforms/${CGAL_TEST_PLATFORM}"
 # The directory where the release is built.
 CGAL_SRC_BUILD_DIR="${CGAL_DIR}"
 # The directory where the tests are built.
-CGAL_TEST_BUILD_DIR="$HOME/build/src/cmake/platforms/${CGAL_TEST_PLATFORM}/test/"
+CGAL_TEST_BUILD_DIR="$HOME/build/src/cmake/platforms/${CGAL_TEST_PLATFORM}/test"
 PLATFORM="$CGAL_TEST_PLATFORM"
 
 export CGAL_DIR
 export CGAL_TEST_PLATFORM
 export CGAL_DATA_DIR
 
+# If the option xtrace (`set -x`) is not set,
+# then set it, and redirect all trace output to a log file.
+BASH_LOG=${CGAL_TESTRESULTS}/bash-xtrace-${CGAL_TEST_PLATFORM}.log
+case "$-" in
+  *x*) ;;
+  *) echo "Redirecting xtrace output to ${BASH_LOG}"; eval "exec ${BASH_XTRACEFD}>${BASH_LOG}"; set -x ;;
+esac
+
 # Create the binary directories
 if [ ! -d "${CGAL_SRC_BUILD_DIR}" ]; then
     mkdir -p "${CGAL_SRC_BUILD_DIR}"
@@ -66,26 +77,45 @@ if [ ! -d "${CGAL_TEST_BUILD_DIR}" ]; then
     mkdir -p "${CGAL_TEST_BUILD_DIR}"
 fi
 
-# Build CGAL. The CGAL_CMAKE_FLAGS used here will affect all other
-# builds using this binary directory.
+CMAKE_LOG_FILE=${CGAL_TESTRESULTS}/cmake-${CGAL_TEST_PLATFORM}.log
+CTEST_LOG_FILE=${CGAL_TESTRESULTS}/ctest-${CGAL_TEST_PLATFORM}.log
+
+rm -f "${CMAKE_LOG_FILE}" "${CTEST_LOG_FILE}"
+
+REDIRECT_TO() {
+  exec 3>&1 4>&2
+  if [ -z "${SHOW_PROGRESS}" ]; then
+    echo "Redirecting stdout and stderr to $1"
+    exec > "$1" 2>&1
+  else
+    exec > >(tee ${1}) 2>&1
+  fi
+  _REDIRECTED=1
+}
+
+REVERT_REDIRECTIONS() {
+  [ -z "$_REDIRECTED" ] && return
+  [ -z "${SHOW_PROGRESS}" ] && echo "Reverting redirections of stdout and stderr"
+  exec 1>&3 3>&- 2>&4 4>&-
+  unset _REDIRECTED
+}
 
 cd "${CGAL_SRC_BUILD_DIR}"
+
+REDIRECT_TO "${CMAKE_LOG_FILE}"
+
 if [ -n "$DOCKERFILE_URL" ]; then
-    echo "Docker image built from ${DOCKERFILE_URL}" | tee "${CGAL_TESTRESULTS}installation-${CGAL_TEST_PLATFORM}.log"
+    echo "Docker image built from ${DOCKERFILE_URL}"
 else
-    echo "Docker container" > ${CGAL_TESTRESULTS}installation-${CGAL_TEST_PLATFORM}.log
+    echo "Docker container"
 fi
 
-cmake ${INIT_FILE:+"-C${INIT_FILE}"} -DBUILD_TESTING=ON -DWITH_tests=ON -DCGAL_TEST_SUITE=ON $CGAL_RELEASE_DIR >${CGAL_TESTRESULTS}installation-${CGAL_TEST_PLATFORM}.log 2>&1 || :
-rm CMakeCache.txt
-CMAKE_OPTS="-DCGAL_TEST_SUITE=ON -DCMAKE_VERBOSE_MAKEFILE=ON -DWITH_tests=ON"
-if [ -z "${SHOW_PROGRESS}" ]; then
-  cmake ${INIT_FILE:+"-C${INIT_FILE}"} -DBUILD_TESTING=ON ${CMAKE_OPTS} $CGAL_RELEASE_DIR >${CGAL_TESTRESULTS}package_installation-${CGAL_TEST_PLATFORM}.log 2>&1 || :
-else
-  cmake ${INIT_FILE:+"-C${INIT_FILE}"} -DBUILD_TESTING=ON ${CMAKE_OPTS} $CGAL_RELEASE_DIR 2>&1 |tee ${CGAL_TESTRESULTS}package_installation-${CGAL_TEST_PLATFORM}.log || :
-fi
+# Configure CGAL.
+cmake ${INIT_FILE:+"-C${INIT_FILE}"} -DBUILD_TESTING=ON -DCGAL_TEST_SUITE=ON -DCMAKE_VERBOSE_MAKEFILE=ON -DWITH_tests=ON "$CGAL_RELEASE_DIR" || _CMAKE_ERROR=$?
+
+REVERT_REDIRECTIONS
 
-LIST_TEST_FILE="${CGAL_TESTRESULTS}list_test_packages"
+LIST_TEST_FILE="${CGAL_TESTRESULTS}/list_test_packages"
 if [ -f ${LIST_TEST_FILE} ]; then
   LIST_TEST_PACKAGES=$(source ${LIST_TEST_FILE})
 fi
@@ -112,35 +142,39 @@ BuildDirectory: ${CGAL_SRC_BUILD_DIR}
 EOF
 
 CTEST_OPTS="-T Start -T Test --timeout 1200 ${DO_NOT_TEST:+-E execution___of__}"
-if [ -z "${SHOW_PROGRESS}" ]; then
-    ctest ${TO_TEST:+-L ${TO_TEST} } ${CTEST_OPTS} -j${CGAL_NUMBER_OF_JOBS} ${KEEP_TESTS:+-FC .}>${CGAL_TESTRESULTS}ctest-${CGAL_TEST_PLATFORM}.log || :
+
+if [ -z "${_CMAKE_ERROR}" ]; then
+  REDIRECT_TO "${CTEST_LOG_FILE}"
+  ctest ${TO_TEST:+-L ${TO_TEST} } ${CTEST_OPTS} -j${CGAL_NUMBER_OF_JOBS} ${KEEP_TESTS:+-FC .} || true
+  REVERT_REDIRECTIONS
+  TAG_DIR=$(awk '/tag: /{print $4F}' "${CTEST_LOG_FILE}")
 else
-    ctest ${TO_TEST:+-L ${TO_TEST} } ${CTEST_OPTS} -j${CGAL_NUMBER_OF_JOBS} ${KEEP_TESTS:+-FC .}|tee ${CGAL_TESTRESULTS}ctest-${CGAL_TEST_PLATFORM}.log || :
+  TAG_DIR="error"
+  mkdir Testing/${TAG_DIR}
 fi
 
-TAG_DIR=$(awk '/^Create new tag: /{print $4F}' ${CGAL_TESTRESULTS}ctest-${CGAL_TEST_PLATFORM}.log)
 cd Testing/${TAG_DIR}
-RESULT_FILE=./"results_${CGAL_TESTER}_${PLATFORM}.txt"
-rm -f "$RESULT_FILE"
+RESULT_FILE=results_${CGAL_TESTER}_${PLATFORM}.txt
+rm -f ./"$RESULT_FILE"
 touch "$RESULT_FILE"
 
-sed -n '/The CXX compiler/s/-- The CXX compiler identification is/COMPILER_VERSION =/p' < "${CGAL_TESTRESULTS}installation-${CGAL_TEST_PLATFORM}.log" |sed -E "s/ = (.*)/\ = '\1\'/">> "$RESULT_FILE"
-sed -n '/CGAL_VERSION /s/#define //p' < "${CGAL_VERSION_DIR}include/CGAL/version.h" >> "$RESULT_FILE"
+sed -n '/The CXX compiler/s/-- The CXX compiler identification is/COMPILER_VERSION =/p' < "${CMAKE_LOG_FILE}" |sed -E "s/ = (.*)/\ = '\1\'/">> "$RESULT_FILE"
+sed -n '/CGAL_VERSION /s/#define //p' < "${CGAL_VERSION_DIR}/include/CGAL/version.h" >> "$RESULT_FILE"
 echo "TESTER ${CGAL_TESTER}" >> "$RESULT_FILE"
 echo "TESTER_NAME ${CGAL_TESTER_NAME}" >> "$RESULT_FILE"
 echo "TESTER_ADDRESS ${CGAL_TESTER_ADDRESS}" >> "$RESULT_FILE"
 echo "CGAL_TEST_PLATFORM ${PLATFORM}" >> "$RESULT_FILE"
-grep -e "^-- Operating system: " "${CGAL_TESTRESULTS}installation-${CGAL_TEST_PLATFORM}.log"|sort -u >> $RESULT_FILE
-grep -e "^-- USING " "${CGAL_TESTRESULTS}installation-${CGAL_TEST_PLATFORM}.log"|sort -u >> $RESULT_FILE
-sed -n '/^-- Third-party library /p' "${CGAL_TESTRESULTS}installation-${CGAL_TEST_PLATFORM}.log" >> $RESULT_FILE
+grep -e "^-- Operating system: " "${CMAKE_LOG_FILE}"|sort -u >> "$RESULT_FILE"
+grep -e "^-- USING " "${CMAKE_LOG_FILE}"|sort -u >> "$RESULT_FILE"
+sed -n '/^-- Third-party library /p' "${CMAKE_LOG_FILE}" >> "$RESULT_FILE"
 # Use sed to get the content of DEBUG or RELEASE CXX FLAGS so that Multi-config platforms do provide their CXXFLAGS to the testsuite page (that greps USING CXXFLAGS to get info)
-sed -i -E 's/(^-- USING )(DEBUG|RELEASE) (CXXFLAGS)/\1\3/' $RESULT_FILE
+sed -i -E 's/(^-- USING )(DEBUG|RELEASE) (CXXFLAGS)/\1\3/' "$RESULT_FILE"
 echo "------------" >> "$RESULT_FILE"
 touch ../../../../../.scm-branch
 if [ -f /mnt/testsuite/.scm-branch ]; then
     cat /mnt/testsuite/.scm-branch >> ../../../../../.scm-branch
 fi
-python3 ${CGAL_TESTSUITE_DIR}test/parse-ctest-dashboard-xml.py $CGAL_TESTER $PLATFORM
+python3 "${CGAL_TESTSUITE_DIR}/test/parse-ctest-dashboard-xml.py" "$CGAL_TESTER" "$PLATFORM"
 
 for file in $(ls|grep _Tests); do
   mv $file "$(echo "$file" | sed 's/_Tests//g')"
@@ -149,13 +183,13 @@ OUTPUT_FILE=results_${CGAL_TESTER}_${PLATFORM}.tar
 TEST_REPORT="TestReport_${CGAL_TESTER}_${PLATFORM}"
 mkdir -p Installation
 chmod 777 Installation
-cat "${CGAL_TESTRESULTS}package_installation-${CGAL_TEST_PLATFORM}.log" >> "Installation/${TEST_REPORT}"
+cat "${CMAKE_LOG_FILE}" >> "Installation/${TEST_REPORT}"
 
 #call the python script to complete the results report.
-python3 ${CGAL_TESTSUITE_DIR}test/post_process_ctest_results.py Installation/${TEST_REPORT} ${TEST_REPORT} results_${CGAL_TESTER}_${PLATFORM}.txt
-rm -f $OUTPUT_FILE $OUTPUT_FILE.gz
+python3 "${CGAL_TESTSUITE_DIR}/test/post_process_ctest_results.py" "Installation/${TEST_REPORT}" "${TEST_REPORT}" "$RESULT_FILE"
+rm -f ./"$OUTPUT_FILE" ./"$OUTPUT_FILE.gz"
 rm ../../../../../.scm-branch
-tar cf $OUTPUT_FILE results_${CGAL_TESTER}_${PLATFORM}.txt */"$TEST_REPORT"
+tar cf $OUTPUT_FILE "$RESULT_FILE" */"$TEST_REPORT"
 echo
 gzip -9f $OUTPUT_FILE
-cp "${OUTPUT_FILE}.gz" "results_${CGAL_TESTER}_${PLATFORM}.txt" "${CGAL_TESTRESULTS}"
+cp "${OUTPUT_FILE}.gz" "$RESULT_FILE" "${CGAL_TESTRESULTS}/"