[PATCH v3 0/2] MR661: Draft: tests: Introduce custom test driver.

[Francisco Casas (＠fcasas)]

Basically !427, but in the form of a custom test driver script.

If I am not mistaken, for the driver script to run properly it is necessary to run
"autoreconf" in the source directory and call the configure script again in the build directory.

The output when running tests would be the same we currently have except for tests that don't PASS,
in that case, detailed information for each failing line will appear. Make a failing test to try it!

--
  v3: tests: Get detailed information on failing tests.
      tests: Copy autotool's testsuite driver script.

https://gitlab.winehq.org/wine/vkd3d/-/merge_requests/661

[PATCH v3 1/2] tests: Copy autotool's testsuite driver script.

[Francisco Casas]

From: Francisco Casas

For the driver script to run properly it is necessary to run
"autoreconf" in the source directory and call the configure script again
in the build directory.
---
 Makefile.am          |   3 +
 configure.ac         |   3 +
 tests/test-driver.sh | 153 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 159 insertions(+)
 create mode 100755 tests/test-driver.sh

diff --git a/Makefile.am b/Makefile.am
index cfb225f9c..e19ed3172 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -402,6 +402,8 @@ TEST_EXTENSIONS = .shader_test

if BUILD_TESTS
 check_PROGRAMS = $(vkd3d_tests) $(vkd3d_cross_tests) tests/shader_runner
+dist_noinst_SCRIPTS = tests/test-driver.sh
+dist_check_SCRIPTS = tests/test-driver.sh
 TESTS = $(vkd3d_tests) $(vkd3d_cross_tests) $(vkd3d_shader_tests)
 tests_d3d12_LDADD = $(LDADD) @PTHREAD_LIBS@ @DL_LIBS@
 tests_d3d12_invalid_usage_LDADD = $(LDADD) @DL_LIBS@
@@ -418,6 +420,7 @@ tests_shader_runner_SOURCES = \
 tests_vkd3d_api_LDADD = libvkd3d.la @DL_LIBS@
 tests_vkd3d_shader_api_LDADD = libvkd3d-shader.la
 SHADER_TEST_LOG_COMPILER = tests/shader_runner
+SHADER_TEST_LOG_DRIVER = tests/test-driver.sh
 endif

EXTRA_DIST += $(vkd3d_shader_tests)
diff --git a/configure.ac b/configure.ac
index caceb4455..a821e03f9 100644
--- a/configure.ac
+++ b/configure.ac
@@ -181,6 +181,9 @@ AM_CONDITIONAL([HAVE_WIDL], [test "x$WIDL" != "xno"])
 AM_CONDITIONAL([HAVE_CROSSTARGET32], [test "x$CROSSTARGET32" != "xno"])
 AM_CONDITIONAL([HAVE_CROSSTARGET64], [test "x$CROSSTARGET64" != "xno"])

+AM_COND_IF([BUILD_TESTS],
+           [AC_CONFIG_LINKS([tests/test-driver.sh:tests/test-driver.sh])])
+
 AC_CONFIG_FILES([Makefile])
 AC_OUTPUT

diff --git a/tests/test-driver.sh b/tests/test-driver.sh
new file mode 100755
index 000000000..97b6ea3ef
--- /dev/null
+++ b/tests/test-driver.sh
@@ -0,0 +1,153 @@
+#! /bin/sh
+# test-driver - basic testsuite driver script.
+
+scriptversion=2022-02-13.00; # UTC
+
+# Copyright (C) 2011-2021 Free Software Foundation, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see https://www.gnu.org/licenses/.
+
+# As a special exception to the GNU General Public License, if you
+# distribute this file as part of a program that contains a
+# configuration script generated by Autoconf, you may include it under
+# the same distribution terms that you use for the rest of that program.
+
+# This file is maintained in Automake, please report
+# bugs to  or send patches to
+# .
+
+# Make unconditional expansion of undefined variables an error.  This
+# helps a lot in preventing typo-related bugs.
+set -u
+
+usage_error ()
+{
+  echo "$0: $*" >&2
+  print_usage >&2
+  exit 2
+}
+
+print_usage ()
+{
+  cat <<END
+Usage:
+  test-driver --test-name NAME --log-file PATH --trs-file PATH
+              [--expect-failure {yes|no}] [--color-tests {yes|no}]
+              [--enable-hard-errors {yes|no}] [--]
+              TEST-SCRIPT [TEST-SCRIPT-ARGUMENTS]
+
+The '--test-name', '--log-file' and '--trs-file' options are mandatory.
+See the GNU Automake documentation for information.
+END
+}
+
+test_name= # Used for reporting.
+log_file=  # Where to save the output of the test script.
+trs_file=  # Where to save the metadata of the test run.
+expect_failure=no
+color_tests=no
+enable_hard_errors=yes
+while test $# -gt 0; do
+  case $1 in
+  --help) print_usage; exit $?;;
+  --version) echo "test-driver $scriptversion"; exit $?;;
+  --test-name) test_name=$2; shift;;
+  --log-file) log_file=$2; shift;;
+  --trs-file) trs_file=$2; shift;;
+  --color-tests) color_tests=$2; shift;;
+  --expect-failure) expect_failure=$2; shift;;
+  --enable-hard-errors) enable_hard_errors=$2; shift;;
+  --) shift; break;;
+  -*) usage_error "invalid option: '$1'";;
+   *) break;;
+  esac
+  shift
+done
+
+missing_opts=
+test x"$test_name" = x && missing_opts="$missing_opts --test-name"
+test x"$log_file"  = x && missing_opts="$missing_opts --log-file"
+test x"$trs_file"  = x && missing_opts="$missing_opts --trs-file"
+if test x"$missing_opts" != x; then
+  usage_error "the following mandatory options are missing:$missing_opts"
+fi
+
+if test $# -eq 0; then
+  usage_error "missing argument"
+fi
+
+if test $color_tests = yes; then
+  # Keep this in sync with 'lib/am/check.am:$(am__tty_colors)'.
+  red='' # Red.
+  grn='' # Green.
+  lgn='' # Light green.
+  blu='' # Blue.
+  mgn='' # Magenta.
+  std=''     # No color.
+else
+  red= grn= lgn= blu= mgn= std=
+fi
+
+do_exit='rm -f $log_file $trs_file; (exit $st); exit $st'
+trap "st=129; $do_exit" 1
+trap "st=130; $do_exit" 2
+trap "st=141; $do_exit" 13
+trap "st=143; $do_exit" 15
+
+# Test script is run here. We create the file first, then append to it,
+# to ameliorate tests themselves also writing to the log file. Our tests
+# don't, but others can (automake bug#35762).
+: >"$log_file"
+"$@" >>"$log_file" 2>&1
+estatus=$?
+
+if test $enable_hard_errors = no && test $estatus -eq 99; then
+  tweaked_estatus=1
+else
+  tweaked_estatus=$estatus
+fi
+
+case $tweaked_estatus:$expect_failure in
+  0:yes) col=$red res=XPASS recheck=yes gcopy=yes;;
+  0:*)   col=$grn res=PASS  recheck=no  gcopy=no;;
+  77:*)  col=$blu res=SKIP  recheck=no  gcopy=yes;;
+  99:*)  col=$mgn res=ERROR recheck=yes gcopy=yes;;
+  *:yes) col=$lgn res=XFAIL recheck=no  gcopy=yes;;
+  *:*)   col=$red res=FAIL  recheck=yes gcopy=yes;;
+esac
+
+# Report the test outcome and exit status in the logs, so that one can
+# know whether the test passed or failed simply by looking at the '.log'
+# file, without the need of also peaking into the corresponding '.trs'
+# file (automake bug#11814).
+echo "$res $test_name (exit status: $estatus)" >>"$log_file"
+
+# Report outcome to console.
+echo "${col}${res}${std}: $test_name"
+
+# Register the test result, and other relevant metadata.
+echo ":test-result: $res" > $trs_file
+echo ":global-test-result: $res" >> $trs_file
+echo ":recheck: $recheck" >> $trs_file
+echo ":copy-in-global-log: $gcopy" >> $trs_file
+
+# Local Variables:
+# mode: shell-script
+# sh-indentation: 2
+# eval: (add-hook 'before-save-hook 'time-stamp)
+# time-stamp-start: "scriptversion="
+# time-stamp-format: "%:y-%02m-%02d.%02H"
+# time-stamp-time-zone: "UTC0"
+# time-stamp-end: "; # UTC"
+# End:

[PATCH v3 2/2] tests: Get detailed information on failing tests.

[Francisco Casas]

From: Francisco Casas

---
 tests/test-driver.sh | 102 +++++++++++++++++++++++++++++++++++--------
 1 file changed, 85 insertions(+), 17 deletions(-)

diff --git a/tests/test-driver.sh b/tests/test-driver.sh
index 97b6ea3ef..9f5a0ef84 100755
--- a/tests/test-driver.sh
+++ b/tests/test-driver.sh
@@ -1,8 +1,11 @@
 #! /bin/sh
-# test-driver - basic testsuite driver script.
+# test-driver - basic testsuite driver script. Modified for vkd3d tests.

-scriptversion=2022-02-13.00; # UTC
+scriptversion=2022-02-20.01; # UTC

+# This is a modified version of the test_driver script provided by
+# auto-tools, whose licence is as follows:
+#
 # Copyright (C) 2011-2021 Free Software Foundation, Inc.
 #
 # This program is free software; you can redistribute it and/or modify
@@ -88,15 +91,25 @@ if test $# -eq 0; then
 fi

if test $color_tests = yes; then
-  # Keep this in sync with 'lib/am/check.am:$(am__tty_colors)'.
-  red='' # Red.
-  grn='' # Green.
-  lgn='' # Light green.
-  blu='' # Blue.
-  mgn='' # Magenta.
-  std=''     # No color.
+  color_reset=''
+  color_dark_red=''
+  color_dark_purple=''
+  color_green=''
+  color_yellow=''
+  color_blue=''
+  color_bright_red=''
+  color_bright_purple=''
+  color_fade=''
 else
-  red= grn= lgn= blu= mgn= std=
+  color_reset=
+  color_dark_red=
+  color_dark_purple=
+  color_green=
+  color_yellow=
+  color_blue=
+  color_bright_red=
+  color_bright_purple=
+  color_fade=
 fi

do_exit='rm -f $log_file $trs_file; (exit $st); exit $st'
@@ -119,12 +132,12 @@ else
 fi

case $tweaked_estatus:$expect_failure in
-  0:yes) col=$red res=XPASS recheck=yes gcopy=yes;;
-  0:*)   col=$grn res=PASS  recheck=no  gcopy=no;;
-  77:*)  col=$blu res=SKIP  recheck=no  gcopy=yes;;
-  99:*)  col=$mgn res=ERROR recheck=yes gcopy=yes;;
-  *:yes) col=$lgn res=XFAIL recheck=no  gcopy=yes;;
-  *:*)   col=$red res=FAIL  recheck=yes gcopy=yes;;
+  0:yes) col=$color_dark_red      res=XPASS recheck=yes gcopy=yes;;
+  0:*)   col=$color_green         res=PASS  recheck=no  gcopy=no;;
+  77:*)  col=$color_blue          res=SKIP  recheck=no  gcopy=yes;;
+  99:*)  col=$color_bright_purple res=ERROR recheck=yes gcopy=yes;;
+  *:yes) col=$color_yellow        res=XFAIL recheck=no  gcopy=yes;;
+  *:*)   col=$color_bright_red    res=FAIL  recheck=yes gcopy=yes;;
 esac

# Report the test outcome and exit status in the logs, so that one can
@@ -133,8 +146,63 @@ esac
 # file (automake bug#11814).
 echo "$res $test_name (exit status: $estatus)" >>"$log_file"

+# Give detailed report
+awk_program=$(cat <<'EOF'
+BEGIN {
+    FS = ":"
+}
+
+/: Compiling \S+ shaders with \S+ and executing with \S+/ {
+    n = split($3, arr, " ")
+    shader_models = arr[2]
+    backend = arr[n]
+    gsub(/./, "", backend)
+    str = "<fade>(" shader_models ")" backend "<reset>"
+    printf("#   %-20s\n", str)
+}
+
+/: Test failed:/ {
+    print "<fade>" $4 "<reset>" "[F]"
+}
+
+/: Todo:/ {
+    print "<fade>" $4 "<reset>" "[XF]"
+}
+
+/: Todo succeeded:/ {
+    print "<fade>" $4 "<reset>" "[XP]"
+}
+
+/: Assertion .* failed./ {
+    print "[AF]" $0
+}
+
+EOF
+)
+
+details=$(awk "$awk_program" "$log_file")
+
+# Count number of [XF] tags.
+xfcount=$(echo "$details" | awk '/[XF]/{count++} END{print count}')
+
+details=$(echo "$details" |\
+    sed "s/[F]/$color_bright_red[F]$color_reset/g" |\
+    sed "s/[XF]/$color_yellow[XF]$color_reset/g" |\
+    sed "s/[XP]/$color_dark_red[XP]$color_reset/g" |\
+    sed "s/[AF]/$color_bright_purple[AF]$color_reset/g" |\
+    sed "s/<fade>/$color_fade/g" |\
+    sed "s/<reset>/$color_reset/g" |\
+    tr '\n' ' ' |\
+    tr '#' '\n' |\
+    awk 'NF != 1' )
+
+# If the test passes but has [XF], we will omit details but report number of [XF]
+if [ "$res" = "PASS" ] && [ $xfcount > 0 ]; then
+  details="$color_yellow($xfcount XF)$color_reset"
+fi
+
 # Report outcome to console.
-echo "${col}${res}${std}: $test_name"
+echo "${col}${res}${color_reset}: $test_name $details"

# Register the test result, and other relevant metadata.
 echo ":test-result: $res" > $trs_file