[svn-r27218] Add VDS tests to h5ls

9 files changed, 495 insertions, 0 deletions

diff --git a/tools/h5ls/CMakeLists.txt b/tools/h5ls/CMakeLists.txt
index 984b36b..1bf5f4c 100644
--- a/tools/h5ls/CMakeLists.txt
+++ b/tools/h5ls/CMakeLists.txt
@@ -23,6 +23,8 @@ if (BUILD_TESTING)
 
   include (CMakeTests.cmake)
 
+  include (CMakeTestsVDS.cmake)
+
 endif (BUILD_TESTING)
 
 ##############################################################################
diff --git a/tools/h5ls/CMakeTestsVDS.cmake b/tools/h5ls/CMakeTestsVDS.cmake
new file mode 100644
index 0000000..b10674b
--- /dev/null
+++ b/tools/h5ls/CMakeTestsVDS.cmake
@@ -0,0 +1,155 @@
+
+##############################################################################
+##############################################################################
+###           T E S T I N G                                                ###
+##############################################################################
+##############################################################################
+
+  # --------------------------------------------------------------------
+  # Copy all the test files from source directory to test directory
+  # --------------------------------------------------------------------
+  set (LIST_HDF5_TEST_FILES
+      1_a.h5
+      1_b.h5
+      1_c.h5
+      1_d.h5
+      1_e.h5
+      1_f.h5
+      1_vds.h5
+      2_a.h5
+      2_b.h5
+      2_c.h5
+      2_d.h5
+      2_e.h5
+      2_vds.h5
+      3_1_vds.h5
+      3_2_vds.h5
+      4_0.h5
+      4_1.h5
+      4_2.h5
+      4_vds.h5
+      5_a.h5
+      5_b.h5
+      5_c.h5
+      5_vds.h5
+  )
+
+  set (LIST_OTHER_TEST_FILES
+      tvds-1.ls
+      tvds-2.ls
+      tvds-3_1.ls
+      tvds-3_2.ls
+      tvds-4.ls
+      tvds-5.ls
+      tvds_layout-1.ls
+      tvds_layout-2.ls
+      tvds_layout-3_1.ls
+      tvds_layout-3_2.ls
+      tvds_layout-4.ls
+      tvds_layout-5.ls
+  )
+
+  file (MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/testfiles")
+
+  # copy the list of test files
+  foreach (listfiles ${LIST_HDF5_TEST_FILES} ${LIST_OTHER_TEST_FILES})
+    GET_FILENAME_COMPONENT(fname "${listfiles}" NAME)
+    set (dest "${PROJECT_BINARY_DIR}/testfiles/vds/${fname}")
+    #message (STATUS " Copying ${listfiles} to ${dest}")
+    add_custom_command (
+        TARGET     h5ls
+        POST_BUILD
+        COMMAND    ${CMAKE_COMMAND}
+        ARGS       -E copy_if_different ${HDF5_TOOLS_SRC_DIR}/testfiles/vds/${listfiles} ${dest}
+    )
+  endforeach (listfiles ${LIST_HDF5_TEST_FILES} ${LIST_OTHER_TEST_FILES})
+
+
+##############################################################################
+##############################################################################
+###           T H E   T E S T S  M A C R O S                               ###
+##############################################################################
+##############################################################################
+
+  MACRO (ADD_H5_VDS_TEST resultfile resultcode)
+    # If using memchecker add tests without using scripts
+    if (HDF5_ENABLE_USING_MEMCHECKER)
+      add_test (NAME H5LS-${resultfile} COMMAND $<TARGET_FILE:h5ls> ${ARGN})
+      set_tests_properties (H5LS-${resultfile} PROPERTIES WORKING_DIRECTORY "${PROJECT_BINARY_DIR}/testfiles/vds")
+      if (${resultcode} STREQUAL "1")
+        set_tests_properties (H5LS-${resultfile} PROPERTIES WILL_FAIL "true")
+      endif (${resultcode} STREQUAL "1")
+      if (NOT "${last_test}" STREQUAL "")
+        set_tests_properties (H5LS-${resultfile} PROPERTIES DEPENDS ${last_test})
+      endif (NOT "${last_test}" STREQUAL "")
+    else (HDF5_ENABLE_USING_MEMCHECKER)
+      add_test (
+          NAME H5LS-${resultfile}-clear-objects
+          COMMAND    ${CMAKE_COMMAND}
+              -E remove ./testfiles/${resultfile}.out ./testfiles/vds/${resultfile}.out.err
+      )
+      add_test (
+          NAME H5LS-${resultfile}
+          COMMAND "${CMAKE_COMMAND}"
+              -D "TEST_PROGRAM=$<TARGET_FILE:h5ls>"
+              -D "TEST_ARGS=${ARGN}"
+              -D "TEST_FOLDER=${PROJECT_BINARY_DIR}/testfiles/vds"
+              -D "TEST_OUTPUT=${resultfile}.out"
+              -D "TEST_EXPECT=${resultcode}"
+              -D "TEST_REFERENCE=${resultfile}.ls"
+              -P "${HDF_RESOURCES_EXT_DIR}/runTest.cmake"
+      )
+      set_tests_properties (H5LS-${resultfile} PROPERTIES DEPENDS "H5LS_VDS-${resultfile}-clear-objects")
+    endif (HDF5_ENABLE_USING_MEMCHECKER)
+  ENDMACRO (ADD_H5_VDS_TEST file)
+
+##############################################################################
+##############################################################################
+###           T H E   T E S T S                                            ###
+##############################################################################
+##############################################################################
+
+  if (HDF5_ENABLE_USING_MEMCHECKER)
+    # Remove any output file left over from previous test run
+    add_test (
+      NAME H5LS_VDS-clearall-objects
+      COMMAND    ${CMAKE_COMMAND}
+          -E remove
+          tvds-1.out
+          tvds-1.out.err
+          tvds-2.out
+          tvds-2.out.err
+          tvds-3_1.out
+          tvds-3_1.out.err
+          tvds-3_2.out
+          tvds-3_2.out.err
+          tvds-4.out
+          tvds-4.out.err
+          tvds-5.out
+          tvds-5.out.err
+          tvds_layout-1.out
+          tvds_layout-1.out.err
+          tvds_layout-2.out
+          tvds_layout-2.out.err
+          tvds_layout-3_1.out
+          tvds_layout-3_1.out.err
+          tvds_layout-3_2.out
+          tvds_layout-3_2.out.err
+          tvds_layout-4.out
+          tvds_layout-4.out.err
+          tvds_layout-5.out
+          tvds_layout-5.out.err
+    )
+    if (NOT "${last_test}" STREQUAL "")
+      set_tests_properties (H5LS_VDS-clearall-objects PROPERTIES DEPENDS ${last_test})
+    endif (NOT "${last_test}" STREQUAL "")
+    set (last_test "H5LS_VDS-clearall-objects")
+  endif (HDF5_ENABLE_USING_MEMCHECKER)
+
+  ADD_H5_VDS_TEST (tvds-1 0 -w80 -v 1_vds.h5)
+  ADD_H5_VDS_TEST (tvds-2 0 -w80 -v 2_vds.h5)
+  ADD_H5_VDS_TEST (tvds-3_1 0 -w80 -v 3_1_vds.h5)
+  ADD_H5_VDS_TEST (tvds-3_2 0 -w80 -v 3_2_vds.h5)
+  ADD_H5_VDS_TEST (tvds-4 0 -w80 -v 4_vds.h5)
+  ADD_H5_VDS_TEST (tvds-5 0 -w80 -v 5_vds.h5)
+
diff --git a/tools/h5ls/testh5lsvds.sh.in b/tools/h5ls/testh5lsvds.sh.in
new file mode 100644
index 0000000..2fd4bc0
--- /dev/null
+++ b/tools/h5ls/testh5lsvds.sh.in
@@ -0,0 +1,264 @@
+#! /bin/sh
+#
+# Copyright by The HDF Group.
+# Copyright by the Board of Trustees of the University of Illinois.
+# 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 files COPYING and Copyright.html.  COPYING can be found at the root
+# of the source code distribution tree; Copyright.html can be found at the
+# root level of an installed copy of the electronic HDF5 document set and
+# is linked from the top-level documents page.  It can also be found at
+# http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have
+# access to either file, you may request a copy from help@hdfgroup.org.
+#
+# Tests for the h5ls tool
+
+srcdir=@srcdir@
+
+TESTNAME=h5ls
+EXIT_SUCCESS=0
+EXIT_FAILURE=1
+
+H5LS=h5ls               # The tool name
+H5LS_BIN=`pwd`/$H5LS    # The path of the tool binary
+
+RM='rm -rf'
+CMP='cmp -s'
+DIFF='diff -c'
+CP='cp'
+NLINES=20          # Max. lines of output to display if test fails
+DIRNAME='dirname'
+LS='ls'
+AWK='awk'
+
+WORDS_BIGENDIAN="@WORDS_BIGENDIAN@"
+
+nerrors=0
+verbose=yes
+h5haveexitcode=yes      # default is yes
+
+# source dirs
+SRC_TOOLS="$srcdir/.."
+SRC_TOOLS_TESTFILES="$SRC_TOOLS/testfiles"
+
+# testfiles source dirs for tools
+SRC_H5LS_TESTFILES="$SRC_TOOLS_TESTFILES"
+SRC_H5DUMP_TESTFILES="$SRC_TOOLS_TESTFILES"
+SRC_H5DIFF_TESTFILES="$SRC_TOOLS/h5diff/testfiles"
+SRC_H5COPY_TESTFILES="$SRC_TOOLS/h5copy/testfiles"
+SRC_H5REPACK_TESTFILES="$SRC_TOOLS/h5repack/testfiles"
+SRC_H5JAM_TESTFILES="$SRC_TOOLS/h5jam/testfiles"
+SRC_H5STAT_TESTFILES="$SRC_TOOLS/h5stat/testfiles"
+SRC_H5IMPORT_TESTFILES="$SRC_TOOLS/h5import/testfiles"
+
+TEST_P_DIR=./testfiles
+TESTDIR=./testfiles/vds
+test -d $TEST_P_DIR || mkdir -p $TEST_P_DIR
+test -d $TESTDIR || mkdir $TESTDIR
+
+######################################################################
+# test files
+# --------------------------------------------------------------------
+# All the test files copy from source directory to test directory
+# NOTE: Keep this framework to add/remove test files.
+#       Any test files from other tools can be used in this framework.
+#       This list are also used for checking exist.
+#       Comment '#' without space can be used.
+# --------------------------------------------------------------------
+LIST_HDF5_TEST_FILES="
+$SRC_H5LS_TESTFILES/vds/1_a.h5
+$SRC_H5LS_TESTFILES/vds/1_b.h5
+$SRC_H5LS_TESTFILES/vds/1_c.h5
+$SRC_H5LS_TESTFILES/vds/1_d.h5
+$SRC_H5LS_TESTFILES/vds/1_e.h5
+$SRC_H5LS_TESTFILES/vds/1_f.h5
+$SRC_H5LS_TESTFILES/vds/1_vds.h5
+$SRC_H5LS_TESTFILES/vds/2_a.h5
+$SRC_H5LS_TESTFILES/vds/2_b.h5
+$SRC_H5LS_TESTFILES/vds/2_c.h5
+$SRC_H5LS_TESTFILES/vds/2_d.h5
+$SRC_H5LS_TESTFILES/vds/2_e.h5
+$SRC_H5LS_TESTFILES/vds/2_vds.h5
+$SRC_H5LS_TESTFILES/vds/3_1_vds.h5
+$SRC_H5LS_TESTFILES/vds/3_2_vds.h5
+$SRC_H5LS_TESTFILES/vds/4_0.h5
+$SRC_H5LS_TESTFILES/vds/4_1.h5
+$SRC_H5LS_TESTFILES/vds/4_2.h5
+$SRC_H5LS_TESTFILES/vds/4_vds.h5
+$SRC_H5LS_TESTFILES/vds/5_a.h5
+$SRC_H5LS_TESTFILES/vds/5_b.h5
+$SRC_H5LS_TESTFILES/vds/5_c.h5
+$SRC_H5LS_TESTFILES/vds/5_vds.h5
+"
+
+LIST_OTHER_TEST_FILES="
+$SRC_H5LS_TESTFILES/vds/tvds-1.ls
+$SRC_H5LS_TESTFILES/vds/tvds-2.ls
+$SRC_H5LS_TESTFILES/vds/tvds-3_1.ls
+$SRC_H5LS_TESTFILES/vds/tvds-3_2.ls
+$SRC_H5LS_TESTFILES/vds/tvds-4.ls
+$SRC_H5LS_TESTFILES/vds/tvds-5.ls
+$SRC_H5LS_TESTFILES/vds/tvds_layout-1.ls
+$SRC_H5LS_TESTFILES/vds/tvds_layout-2.ls
+$SRC_H5LS_TESTFILES/vds/tvds_layout-3_1.ls
+$SRC_H5LS_TESTFILES/vds/tvds_layout-3_2.ls
+$SRC_H5LS_TESTFILES/vds/tvds_layout-4.ls
+$SRC_H5LS_TESTFILES/vds/tvds_layout-5.ls
+"
+
+
+# RUNSERIAL is used. Check if it can return exit code from executalbe correctly.
+if [ -n "$RUNSERIAL_NOEXITCODE" ]; then
+    echo "***Warning*** Serial Exit Code is not passed back to shell corretly."
+    echo "***Warning*** Exit code checking is skipped."
+    h5haveexitcode=no
+fi
+
+#
+# copy test files and expected output files from source dirs to test dir
+#
+COPY_TESTFILES="$LIST_HDF5_TEST_FILES $LIST_OTHER_TEST_FILES"
+
+COPY_TESTFILES_TO_TESTDIR()
+{
+    # copy test files. Used -f to make sure get a new copy
+    for tstfile in $COPY_TESTFILES
+    do
+        # ignore '#' comment
+        echo $tstfile | tr -d ' ' | grep '^#' > /dev/null
+        RET=$?
+        if [ $RET -eq 1 ]; then
+            # skip cp if srcdir is same as destdir
+            # this occurs when build/test performed in source dir and
+            # make cp fail
+            SDIR=`$DIRNAME $tstfile`
+            INODE_SDIR=`$LS -i -d $SDIR | $AWK -F' ' '{print $1}'`
+            INODE_DDIR=`$LS -i -d $TESTDIR | $AWK -F' ' '{print $1}'`
+            if [ "$INODE_SDIR" != "$INODE_DDIR" ]; then
+              $CP -f $tstfile $TESTDIR
+                if [ $? -ne 0 ]; then
+                    echo "Error: FAILED to copy $tstfile ."
+
+                    # Comment out this to CREATE expected file
+                    exit $EXIT_FAILURE
+                fi
+            fi
+        fi
+    done
+}
+
+CLEAN_TESTFILES_AND_TESTDIR()
+{
+    # skip rm if srcdir is same as destdir
+    # this occurs when build/test performed in source dir and
+    # make cp fail
+    SDIR=`$DIRNAME $tstfile`
+    INODE_SDIR=`$LS -i -d $SDIR | $AWK -F' ' '{print $1}'`
+    INODE_DDIR=`$LS -i -d $TESTDIR | $AWK -F' ' '{print $1}'`
+    if [ "$INODE_SDIR" != "$INODE_DDIR" ]; then
+        $RM $TESTDIR
+    fi
+}
+
+# Print a line-line message left justified in a field of 70 characters
+# beginning with the word "Testing".
+TESTING() {
+    SPACES="                                                               "
+    echo "Testing $* $SPACES" |cut -c1-70 |tr -d '\012'
+}
+
+# Source in the output filter function definitions.
+. $srcdir/../../bin/output_filter.sh
+
+# Run a test and print PASS or *FAIL*. For now, if h5ls can complete
+# with exit status 0, consider it pass. If a test fails then increment
+# the `nerrors' global variable and (if $verbose is set) display up to $NLINS
+# lines of the actual output from the tool test.  The actual output is not
+# removed if $HDF5_NOCLEANUP has a non-zero value.
+# Arguemnts:
+# $1 -- actual output filename to use
+# $2 and on -- argument for the h5ls tool
+TOOLTEST() {
+    expect="$TESTDIR/$1"
+    actual="$TESTDIR/`basename $1 .ls`.out"
+    actual_err="$TESTDIR/`basename $1 .ls`.err"
+    actual_sav=${actual}-sav
+    actual_err_sav=${actual_err}-sav
+    shift
+    retvalexpect=$1
+    shift
+
+    # Run test.
+    # Stderr is included in stdout so that the diff can detect
+    # any unexpected output from that stream too.
+    TESTING $H5LS $@
+    (
+  cd $TESTDIR
+        $RUNSERIAL $H5LS_BIN "$@"
+    ) >$actual 2>$actual_err
+
+    exitcode=$?
+    # 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 [ $h5haveexitcode = 'yes' -a $exitcode -ne $retvalexpect ]; then
+  echo "*FAILED*"
+  nerrors="`expr $nerrors + 1`"
+  if [ yes = "$verbose" ]; then
+      echo "test returned with exit code $exitcode"
+      echo "test output: (up to $NLINES lines)"
+      head -$NLINES $actual
+      echo "***end of test output***"
+      echo ""
+  fi
+    elif [ ! -f $expect ]; then
+  # Create the expect file if it doesn't yet exist.
+        echo " CREATED"
+        cp $actual $expect
+    elif $CMP $expect $actual; then
+        echo " PASSED"
+    else
+        echo "*FAILED*"
+  echo "    Expected result differs from actual result"
+  nerrors="`expr $nerrors + 1`"
+  test yes = "$verbose" && $DIFF $expect $actual |sed 's/^/    /'
+    fi
+
+    # Clean up output file
+    if test -z "$HDF5_NOCLEANUP"; then
+  rm -f $actual $actual_err $actual_sav $actual_err_sav
+    fi
+}
+
+##############################################################################
+##############################################################################
+###			  T H E   T E S T S                                ###
+##############################################################################
+##############################################################################
+# prepare for test
+COPY_TESTFILES_TO_TESTDIR
+
+####### test for dataset vds ######
+
+TOOLTEST tvds-1.ls -w80 -v 1_vds.h5
+TOOLTEST tvds-2.ls -w80 -v 2_vds.h5
+TOOLTEST tvds-3_1.ls -w80 -v 3_1_vds.h5
+TOOLTEST tvds-3_2.ls -w80 -v 3_2_vds.h5
+TOOLTEST tvds-4.ls -w80 -v 4_vds.h5
+TOOLTEST tvds-5.ls -w80 -v 5_vds.h5
+
+# Clean up temporary files/directories
+CLEAN_TESTFILES_AND_TESTDIR
+
+if test $nerrors -eq 0 ; then
+    echo "All $TESTNAME tests passed."
+    exit $EXIT_SUCCESS
+else
+    echo "$TESTNAME tests failed with $nerrors errors."
+    exit $EXIT_FAILURE
+fi
diff --git a/tools/testfiles/vds/tvds-1.ls b/tools/testfiles/vds/tvds-1.ls
new file mode 100644
index 0000000..25a4a3b
--- /dev/null
+++ b/tools/testfiles/vds/tvds-1.ls
@@ -0,0 +1,14 @@
+Opened "1_vds.h5" with sec2 driver.
+vds_dset                 Dataset {5/Inf, 18/18, 8/8}
+    Location:  1:800
+    Links:     1
+    Maps:      {6} Source {
+                      1_a.h5   /source_dset
+                      1_b.h5   /source_dset
+                      1_c.h5   /source_dset
+                      1_d.h5   /source_dset
+                      1_e.h5   /source_dset
+                      1_f.h5   /source_dset
+               }
+    Storage:   2880 logical bytes, 0 allocated bytes
+    Type:      native int
diff --git a/tools/testfiles/vds/tvds-2.ls b/tools/testfiles/vds/tvds-2.ls
new file mode 100644
index 0000000..cbba5ff
--- /dev/null
+++ b/tools/testfiles/vds/tvds-2.ls
@@ -0,0 +1,13 @@
+Opened "2_vds.h5" with sec2 driver.
+vds_dset                 Dataset {6/Inf, 8/8, 14/14}
+    Location:  1:800
+    Links:     1
+    Maps:      {5} Source {
+                      2_a.h5   /source_dset
+                      2_b.h5   /source_dset
+                      2_c.h5   /source_dset
+                      2_d.h5   /source_dset
+                      2_e.h5   /source_dset
+               }
+    Storage:   2688 logical bytes, 0 allocated bytes
+    Type:      native int
diff --git a/tools/testfiles/vds/tvds-3_1.ls b/tools/testfiles/vds/tvds-3_1.ls
new file mode 100644
index 0000000..0667c4e
--- /dev/null
+++ b/tools/testfiles/vds/tvds-3_1.ls
@@ -0,0 +1,14 @@
+Opened "3_1_vds.h5" with sec2 driver.
+vds_dset                 Dataset {5/Inf, 25/25, 8/8}
+    Location:  1:800
+    Links:     1
+    Maps:      {6} Source {
+                      1_a.h5   /source_dset
+                      1_b.h5   /source_dset
+                      1_c.h5   /source_dset
+                      1_d.h5   /source_dset
+                      1_e.h5   /source_dset
+                      1_f.h5   /source_dset
+               }
+    Storage:   4000 logical bytes, 0 allocated bytes
+    Type:      native int
diff --git a/tools/testfiles/vds/tvds-3_2.ls b/tools/testfiles/vds/tvds-3_2.ls
new file mode 100644
index 0000000..7d6824c
--- /dev/null
+++ b/tools/testfiles/vds/tvds-3_2.ls
@@ -0,0 +1,13 @@
+Opened "3_2_vds.h5" with sec2 driver.
+vds_dset                 Dataset {6/Inf, 13/13, 19/19}
+    Location:  1:800
+    Links:     1
+    Maps:      {5} Source {
+                      2_a.h5   /source_dset
+                      2_b.h5   /source_dset
+                      2_c.h5   /source_dset
+                      2_d.h5   /source_dset
+                      2_e.h5   /source_dset
+               }
+    Storage:   5928 logical bytes, 0 allocated bytes
+    Type:      native int
diff --git a/tools/testfiles/vds/tvds-4.ls b/tools/testfiles/vds/tvds-4.ls
new file mode 100644
index 0000000..8abc0dd
--- /dev/null
+++ b/tools/testfiles/vds/tvds-4.ls
@@ -0,0 +1,9 @@
+Opened "4_vds.h5" with sec2 driver.
+vds_dset                 Dataset {9/Inf, 4/4, 4/4}
+    Location:  1:800
+    Links:     1
+    Maps:      {1} Source {
+                      4_%b.h5   /source_dset
+               }
+    Storage:   576 logical bytes, 0 allocated bytes
+    Type:      native int
diff --git a/tools/testfiles/vds/tvds-5.ls b/tools/testfiles/vds/tvds-5.ls
new file mode 100644
index 0000000..3bd811b
--- /dev/null
+++ b/tools/testfiles/vds/tvds-5.ls
@@ -0,0 +1,11 @@
+Opened "5_vds.h5" with sec2 driver.
+vds_dset                 Dataset {9/Inf, 4/4, 4/4}
+    Location:  1:800
+    Links:     1
+    Maps:      {3} Source {
+                      5_a.h5   /source_dset
+                      5_b.h5   /source_dset
+                      5_c.h5   /source_dset
+               }
+    Storage:   576 logical bytes, 0 allocated bytes
+    Type:      native int