Plugin test cleanup (#1479)

* Autotools plugin test cleanup

* Combines filter, VFD, and VOL plugin tests
* Adds VFD plugin tests to the Autotools
* Implements a uniform shell script naming scheme in test/

* codespell fix

* Changes after code review

1 files changed, 219 insertions, 0 deletions

diff --git a/test/test_use_cases.sh.in b/test/test_use_cases.sh.in
new file mode 100644
index 0000000..fd30afd
--- /dev/null
+++ b/test/test_use_cases.sh.in
@@ -0,0 +1,219 @@
+#! /bin/bash
+#
+# Copyright by The HDF Group.
+# All rights reserved.
+#
+# This file is part of HDF5.  The full HDF5 copyright notice, including
+# terms governing use, modification, and redistribution, is contained in
+# the COPYING file, which can be found at the root of the source code
+# distribution tree, or in https://www.hdfgroup.org/licenses.
+# If you do not have access to either file, you may request a copy from
+# help@hdfgroup.org.
+#
+# Tests the use cases of swmr features.
+#
+# Created:
+#   Albert Cheng, 2013/06/01.
+# Modified:
+#
+
+# This is work in progress.
+# For now, it shows how to run the test cases programs. It only verifies the
+# exit codes are okay (0).
+
+###############################################################################
+## test variables
+###############################################################################
+
+# Number of errors encountered during test run.
+nerrors=0
+
+# Define variables
+verbose=yes
+
+###############################################################################
+## Main
+###############################################################################
+srcdir=@srcdir@
+utils_testdir=@abs_top_builddir@/@H5_UTILS_TEST_BUILDDIR@
+testdir=@abs_top_builddir@/@H5_TEST_BUILDDIR@
+
+# Check to see if the VFD specified by the HDF5_DRIVER environment variable
+# supports SWMR.
+$utils_testdir/swmr_check_compat_vfd
+rc=$?
+if [[ $rc != 0 ]] ; then
+    echo
+    echo "The VFD specified by the HDF5_DRIVER environment variable"
+    echo "does not support SWMR"
+    echo
+    echo "SWMR use case tests skipped"
+    echo
+    exit 0
+fi
+
+# Define symbols
+EXIT_SUCCESS=0
+EXIT_FAILURE=1
+EXIT_VALUE=$EXIT_SUCCESS    # Default all tests succeed
+RESULT_PASSED=" PASSED"
+RESULT_FAILED="*FAILED*"
+RESULT_SKIP="-SKIP-"
+USECASES_PROGRAMS="use_append_chunk use_append_mchunks"
+TESTNAME="Use Case"
+
+# Source in the output filter function definitions.
+. $srcdir/../bin/output_filter.sh
+
+# Define functions
+# Print a line-line message left justified in a field of 72 characters.
+# Results can be " PASSED", "*FAILED*", "-SKIP-", up to 8 characters
+# wide.
+# SPACES should be at least 71 spaces. ($* + ' ' + 71 + 8 >= 80)
+#
+TESTING() {
+   SPACES="                                                                        "
+   echo "$* $SPACES" | cut -c1-72 | tr -d '\012'
+}
+
+# Run a test and print PASS or *FAIL*.  If a test fails then increment
+# the `nerrors' global variable and (if $verbose is set) display the
+# difference between the actual output and the expected output. The
+# expected output is given as the first argument to this function and
+# the actual output file is calculated by replacing the `.ddl' with
+# `.out'.  The actual output is not removed if $HDF5_NOCLEANUP has a
+# non-zero value.
+# ADD_H5_TEST
+TOOLTEST() {
+    program=$1
+    shift
+
+    actual="$program.out"
+    actual_err="$program.err"
+    actual_sav=${actual}-sav
+    actual_err_sav=${actual_err}-sav
+
+    # Run test.
+    TESTING $program $@
+    (
+      $RUNSERIAL $testdir/$program "$@"
+    ) >$actual 2>$actual_err
+    exit_code=$?
+
+    # save actual and actual_err in case they are needed later.
+    cp $actual $actual_sav
+    STDOUT_FILTER $actual
+    cp $actual_err $actual_err_sav
+    STDERR_FILTER $actual_err
+    cat $actual_err >> $actual
+
+    if [ $exit_code -eq 0 ];then
+    echo "$RESULT_PASSED"
+    test yes = "$verbose" && sed 's/^/    /' < $actual
+    else
+    echo "$RESULT_FAILED"
+    nerrors="`expr $nerrors + 1`"
+    test yes = "$verbose" && sed 's/^/    /' < $actual
+    fi
+
+    # Clean up output file
+    if test -z "$HDF5_NOCLEANUP"; then
+    rm -f $actual $actual_err $actual_sav $actual_err_sav $actual_ext
+    fi
+}
+
+# HDF5 has several tests that create and delete signal files to communicate
+# between processes, and it seems that even though the names of the files are
+# different, occasionally the wrong file is deleted, interrupting the flow of
+# the test.  Running each of these tests in its own directory should eliminate
+# the problem.
+mkdir usecases_test
+cp $testdir/twriteorder usecases_test
+for FILE in use_*; do
+    case "$FILE" in
+        *.o) continue ;;    ## don't copy the .o files
+    esac
+    if test -f "$FILE" ; then
+        cp $FILE usecases_test
+    fi
+done
+
+# With the --disable-shared option, swmr program files are built in the test
+# directory, otherwise they are in test/.libs with a corresponding wrapper
+# script in the test directory.  The programs or wrapper scripts in test should
+# always be copied, swmr files in .libs should be copied only if they exists.
+if [ -f .libs/use_append_chunk ]; then
+    mkdir usecases_test/.libs
+    for FILE in .libs/use_*; do
+        case "$FILE" in
+            *.o) continue ;;    ## don't copy the .o files
+        esac
+        if test -f "$FILE" ; then
+            cp $FILE usecases_test/.libs
+        fi
+    done
+    cp .libs/twriteorder usecases_test/.libs
+fi
+
+cd usecases_test
+
+
+# run tests for H5Odisable_mdc_flushes/H5Oenable_mdc_flushes/H5Oare_mdc_flushes_disabled here temporary
+USECORK=use_disable_mdc_flushes
+for p in $USECORK; do
+    TOOLTEST $p
+    TOOLTEST $p -y 3
+    TOOLTEST $p -n 3000
+    TOOLTEST $p -n 5000
+done
+
+# run write order test here temporary
+WRITEORDER=twriteorder
+for p in $WRITEORDER; do
+    TOOLTEST $p
+    TOOLTEST $p -b 1000
+    TOOLTEST $p -p 3000
+    TOOLTEST $p -n 2000
+    TOOLTEST $p -l w
+    TOOLTEST $p -l r
+done
+
+# Report test results
+if test $nerrors -eq 0 ; then
+    echo "$WRITEORDER test passed."
+else
+    echo "$WRITEORDER test failed with $nerrors errors."
+    EXIT_VALUE=$EXIT_FAILURE
+    nerrors=0           # reset nerror for the regular tests below.
+fi
+
+# main body
+for p in $USECASES_PROGRAMS; do
+    TOOLTEST $p
+    TOOLTEST $p -z 256
+    tmpfile=/tmp/datatfile.$$
+    TOOLTEST $p -f $tmpfile; rm -f $tmpfile
+    TOOLTEST $p -l w
+    TOOLTEST $p -l r
+    # use case 1.9, testing with multi-planes chunks
+    TOOLTEST $p -z 256 -y 5    # 5 planes chunks
+    # cleanup temp datafile
+    if test -z "$HDF5_NOCLEANUP"; then
+    rm -f $p.h5
+    fi
+done
+
+cd ..
+# Report test results and exit
+if test $nerrors -eq 0 ; then
+    echo "All $TESTNAME tests passed."
+    if test -z "$HDF5_NOCLEANUP"; then
+        # delete the test directory
+        rm -rf usecases_test
+    fi
+else
+    echo "$TESTNAME tests failed with $nerrors errors."
+    EXIT_VALUE=$EXIT_FAILURE
+fi
+
+exit $EXIT_VALUE