summaryrefslogtreecommitdiffstats
path: root/tools/test/misc/testh5clear.sh.in
blob: a31b8241b9297382d92b8603381420ec68741d73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
#! /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 h5clear tool
#
srcdir=@srcdir@
TESTNAME=h5clear
EXIT_SUCCESS=0
EXIT_FAILURE=1

H5CLEAR=../../src/misc/h5clear      # The tool name
H5CLEAR_BIN=`pwd`/$H5CLEAR          # The path of the tool binary

OPENCHK=clear_open_chk              # Program to check whether the file can be opened
OPENCHK_BIN=`pwd`/$OPENCHK          # The path to the binary

RM='rm -rf'
CMP='cmp -s'
DIFF='diff -c'
CP='cp'
DIRNAME='dirname'
LS='ls'
AWK='awk'

SUCCEED=0
FAIL=1

nerrors=0
verbose=yes

# source dirs
SRC_TOOLS="$srcdir/../.."

SRC_TOOLS_TESTFILES="$SRC_TOOLS/testfiles"
# testfiles source dirs for tools
SRC_H5CLEAR_TESTFILES="$SRC_TOOLS/test/misc/testfiles"

TESTDIR=./testh5clear
test -d $TESTDIR || mkdir -p $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.
# --------------------------------------------------------------------

#
# copy test files and expected output files from source dirs to test dir
#
COPY_TESTFILES="
$SRC_H5CLEAR_TESTFILES/h5clear_usage.ddl
$SRC_H5CLEAR_TESTFILES/h5clear_open_fail.ddl
$SRC_H5CLEAR_TESTFILES/h5clear_missing_file.ddl
$SRC_H5CLEAR_TESTFILES/h5clear_no_mdc_image.ddl
$SRC_H5CLEAR_TESTFILES/h5clear_sec2_v0.h5
$SRC_H5CLEAR_TESTFILES/h5clear_sec2_v2.h5
$SRC_H5CLEAR_TESTFILES/h5clear_sec2_v3.h5
$SRC_H5CLEAR_TESTFILES/h5clear_log_v3.h5
$SRC_H5CLEAR_TESTFILES/latest_h5clear_log_v3.h5
$SRC_H5CLEAR_TESTFILES/latest_h5clear_sec2_v3.h5
$SRC_H5CLEAR_TESTFILES/h5clear_mdc_image.h5
"

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=$SRC_H5CLEAR_TESTFILES
    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-74 | tr -d '\012'
}

# $1 is the expected output
# $2 is the output from testing
COMPARE_OUT() {
    if $CMP $1 $2; then
        echo "PASSED"
    else
        echo "*FAILED*"
        echo "    Expected result (*.ddl) differs from actual result (*.out)"
        nerrors="`expr $nerrors + 1`"
        test yes = "$verbose" && $DIFF $expect $actual |sed 's/^/    /'
    fi
}

#
#
#
# Run h5clear and verify the expected output
# $1: the test file name
# $2: option 1 passed to the tool
# $3: option 2 passed to the tool
# $4: the expected output
TOOLTEST_OUT() {
    fname=$1
    option1=$2
    option2=$3
    expected=$4
    # Prepare expected and actual output
    expect="$TESTDIR/$expected"
    actual="$TESTDIR/`basename $expected .ddl`.out"
    actual_err="$TESTDIR/`basename $expected .ddl`.err"
    actual_sav=${actual}-sav
    actual_err_sav=${actual_err}-sav

    # Run test.
    TESTING $H5CLEAR $option1 $option2 $fname
    (
        $RUNSERIAL $H5CLEAR_BIN $option1 $option2 $fname
    ) >$actual 2>$actual_err
    cp $actual $actual_sav
    cp $actual_err $actual_err_sav
    cat $actual_err >> $actual

    # Compare output
    COMPARE_OUT $expect $actual

    # Clean up output file
    if test -z "$HDF5_NOCLEANUP"; then
        $RM $actual $actual_err $actual_sav $actual_err_sav
    fi
}

# $1 is the filename to open
# $2 is the expected return from the open/check program
OPEN_CHK() {
    fname=$1
    expected=$2
    $OPENCHK_BIN $fname 2>/dev/null
    actual=$?
    if test $actual -ne $expected; then
        echo "Unexpected return from $OPENCHK"
        nerrors=`expr $nerrors + 1`
    fi
}

# Run h5clear and verify the expected exit code
# $1 is the filename to open
# $2 is option 1
# $3 is option 2
# $4 is the expected exit code from the tool
TOOLTEST() {
    fname=$1
    option1=$2
    option2=$3
    ret_expected=$4
    #
    TESTING $H5CLEAR $option1 $option2 $fname
    fname=$1
    # h5clear $option1 $option2 $fname
    $RUNSERIAL $H5CLEAR_BIN $option1 $option2 $fname 2>/dev/null 1>/dev/null
    if test $? -ne $ret_expected; then
        echo "*FAILED*"
        nerrors=`expr $nerrors + 1`
    else
        echo "PASSED"
    fi
}

##############################################################################
##############################################################################
###              T H E   T E S T S                                         ###
##############################################################################
##############################################################################
# prepare for testing
COPY_TESTFILES_TO_TESTDIR
#
#
#
# The following are tests to verify the expected output from h5clear
# "h5clear -h"
# "h5clear"                             (no options, no file)
# "h5clear junk.h5"                     (no options, nonexisting file)
# "h5clear h5clear_sec2_v3.h5"          (no options, existing file)
# "h5clear -m"                          (valid 1 option, no file)
# "h5clear -s junk.h5"                  (valid 1 option, nonexisting file)
# "h5clear -m -s"                       (valid 2 options, no file)
# "h5clear -m -s junk.h5"               (valid 2 options, nonexisting file)
# "h5clear -m h5clear_sec2_v2.h5"       (valid 1 option, existing file, no cache image)
# "h5clear -s -m h5clear_sec2_v0.h5"    (valid 2 options, existing file, no cache image)
TOOLTEST_OUT "" -h "" h5clear_usage.ddl
TOOLTEST_OUT "" "" "" h5clear_usage.ddl
TOOLTEST_OUT junk.h5 "" "" h5clear_usage.ddl
TOOLTEST_OUT $TESTDIR/h5clear_sec2_v3.h5 "" "" h5clear_usage.ddl
TOOLTEST_OUT "" -m "" h5clear_missing_file.ddl
TOOLTEST_OUT junk.h5 -s "" h5clear_open_fail.ddl
TOOLTEST_OUT "" -m -s h5clear_missing_file.ddl
TOOLTEST_OUT junk.h5 -m -s h5clear_open_fail.ddl
TOOLTEST_OUT $TESTDIR/h5clear_sec2_v2.h5 -m "" h5clear_no_mdc_image.ddl
TOOLTEST_OUT $TESTDIR/h5clear_sec2_v0.h5 -s -m h5clear_no_mdc_image.ddl
#
#
#
# The following are tests to verify the expected exit code from h5clear:
# "h5clear -k"                          (invalid 1 option, no file, fail exit code)
# "h5clear -k junk.h5"                  (invalid 1 option, nonexisting file, fail exit code)
# "h5clear -l h5clear_sec2_v2.h5"       (invalid 1 option, existing file, fail exit code)
# "h5clear -m -k"                       (valid/invalid 2 options, nofile, fail exit code)
# "h5clear -l -m"                       (invalid/valid 2 options, nofile, fail exit code)
# "h5clear -m -k junk.h5"               (valid/invalid 2 options, nonexisting file, fail exit code)
# "h5clear -l -m junk.h5"               (invalid/valid 2 options, nonexisting file, fail exit code)
# "h5clear -m -k h5clear_sec2_v0.h5"    (valid/invalid 2 options, existing file, fail exit code)
# "h5clear -l -m h5clear_sec2_v0.h5"    (invalid/valid 2 options, existing file, fail exit code)
TOOLTEST "" -k "" $FAIL
TOOLTEST junk.h5 -k "" $FAIL
TOOLTEST h5clear_sec2_v2.h5 -l "" $FAIL
TOOLTEST "" -m -k $FAIL
TOOLTEST "" -l -m $FAIL
TOOLTEST junk.h5 -m -k $FAIL
TOOLTEST junk.h5 -l -m $FAIL
TOOLTEST $TESTDIR/h5clear_sec2_v0.h5 -m -k $FAIL
TOOLTEST $TESTDIR/h5clear_sec2_v0.h5 -l -m $FAIL
#
# "h5clear --vers"                      (valid option, version #, succeed exit code)
# "h5clear -m h5clear_mdc_image.h5"     (valid option, existing file, succeed exit code)
TOOLTEST "" --vers "" $SUCCEED
TOOLTEST $TESTDIR/h5clear_mdc_image.h5 -m "" $SUCCEED
#
#
#
# h5clear_mdc_image.h5 already has cache image removed earlier, verify the expected warning from h5clear:
TOOLTEST_OUT $TESTDIR/h5clear_mdc_image.h5 -m "" h5clear_no_mdc_image.ddl
TOOLTEST_OUT $TESTDIR/h5clear_mdc_image.h5 -s -m h5clear_no_mdc_image.ddl
#
#
#
# The following are tests to verify the status_flags field is cleared properly:
OPEN_CHK $TESTDIR/h5clear_sec2_v3.h5 $FAIL
TOOLTEST $TESTDIR/h5clear_sec2_v3.h5 -s "" $SUCCEED
OPEN_CHK $TESTDIR/h5clear_sec2_v3.h5 $SUCCEED
#
OPEN_CHK $TESTDIR/h5clear_log_v3.h5 $FAIL
TOOLTEST $TESTDIR/h5clear_log_v3.h5 -s "" $SUCCEED
OPEN_CHK $TESTDIR/h5clear_log_v3.h5 $SUCCEED
#
OPEN_CHK $TESTDIR/latest_h5clear_sec2_v3.h5 $FAIL
TOOLTEST $TESTDIR/latest_h5clear_sec2_v3.h5 -s "" $SUCCEED
OPEN_CHK $TESTDIR/latest_h5clear_sec2_v3.h5 $SUCCEED
#
OPEN_CHK $TESTDIR/latest_h5clear_log_v3.h5 $FAIL
TOOLTEST $TESTDIR/latest_h5clear_log_v3.h5 -s "" $SUCCEED
OPEN_CHK $TESTDIR/latest_h5clear_log_v3.h5 $SUCCEED
#
# File open succeeds for the following 2 test files because the
# library does not check status_flags for files with < v3 superblock:
OPEN_CHK $TESTDIR/h5clear_sec2_v0.h5 $SUCCEED
TOOLTEST $TESTDIR/h5clear_sec2_v0.h5 -s "" $SUCCEED
OPEN_CHK $TESTDIR/h5clear_sec2_v0.h5 $SUCCEED
#
OPEN_CHK $TESTDIR/h5clear_sec2_v2.h5 $SUCCEED
TOOLTEST $TESTDIR/h5clear_sec2_v2.h5 -s "" $SUCCEED
OPEN_CHK $TESTDIR/h5clear_sec2_v2.h5 $SUCCEED
#
#
#
# Clean up test files
if test -z "$HDF5_NOCLEANUP"; then
   rm -f h5clear_*.h5 latest_h5clear*.h5
fi
#
#
#
# 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 error(s)."
    exit $EXIT_FAILURE
fi