netcdf-c/nczarr_test/run_chunkcases.sh
Dennis Heimbigner df3636b959 Mitigate S3 test interference + Unlimited Dimensions in NCZarr
This PR started as an attempt to add unlimited dimensions to NCZarr.
It did that, but this exposed significant problems with test interference.
So this PR is mostly about fixing -- well mitigating anyway -- test
interference.

The problem of test interference is now documented in the document docs/internal.md.
The solutions implemented here are also describe in that document.
The solution is somewhat fragile but multiple cleanup mechanisms
are provided. Note that this feature requires that the
AWS command line utility must be installed.

## Unlimited Dimensions.
The existing NCZarr extensions to Zarr are modified to support unlimited dimensions.
NCzarr extends the Zarr meta-data for the ".zgroup" object to include netcdf-4 model extensions. This information is stored in ".zgroup" as dictionary named "_nczarr_group".
Inside "_nczarr_group", there is a key named "dims" that stores information about netcdf-4 named dimensions. The value of "dims" is a dictionary whose keys are the named dimensions. The value associated with each dimension name has one of two forms
Form 1 is a special case of form 2, and is kept for backward compatibility. Whenever a new file is written, it uses format 1 if possible, otherwise format 2.
* Form 1: An integer representing the size of the dimension, which is used for simple named dimensions.
* Form 2: A dictionary with the following keys and values"
   - "size" with an integer value representing the (current) size of the dimension.
   - "unlimited" with a value of either "1" or "0" to indicate if this dimension is an unlimited dimension.

For Unlimited dimensions, the size is initially zero, and as variables extend the length of that dimension, the size value for the dimension increases.
That dimension size is shared by all arrays referencing that dimension, so if one array extends an unlimited dimension, it is implicitly extended for all other arrays that reference that dimension.
This is the standard semantics for unlimited dimensions.

Adding unlimited dimensions required a number of other changes to the NCZarr code-base. These included the following.
* Did a partial refactor of the slice handling code in zwalk.c to clean it up.
* Added a number of tests for unlimited dimensions derived from the same test in nc_test4.
* Added several NCZarr specific unlimited tests; more are needed.
* Add test of endianness.

## Misc. Other Changes
* Modify libdispatch/ncs3sdk_aws.cpp to optionally support use of the
   AWS Transfer Utility mechanism. This is controlled by the
   ```#define TRANSFER```` command in that file. It defaults to being disabled.
* Parameterize both the standard Unidata S3 bucket (S3TESTBUCKET) and the netcdf-c test data prefix (S3TESTSUBTREE).
* Fixed an obscure memory leak in ncdump.
* Removed some obsolete unit testing code and test cases.
* Uncovered a bug in the netcdf-c handling of big-endian floats and doubles. Have not fixed yet. See tst_h5_endians.c.
* Renamed some nczarr_tests testcases to avoid name conflicts with nc_test4.
* Modify the semantics of zmap\#ncsmap_write to only allow total rewrite of objects.
* Modify the semantics of zodom to properly handle stride > 1.
* Add a truncate operation to the libnczarr zmap code.
2023-09-26 16:56:48 -06:00

129 lines
3.5 KiB
Bash
Executable File

#!/bin/sh
# Note that this test builds a special results.<pid> directory in
# which to run the tests, where <pid> is the process id number of
# the bash shell instance. The reason for doing this is so that
# it works correctly under Github actions. By empirical
# observation, it appears that the various workflow matrix
# elements are not running in isolation when using cmake. Rather
# they appear to be running simultaneously while sharing the build
# directory for cmake. By running the tests in a separate
# results.<pid> I can guarantee that isolation is preserved.
if test "x$srcdir" = x ; then srcdir=`pwd`; fi
. ../test_common.sh
. ${srcdir}/test_nczarr.sh
set -e
s3isolate "testdir_chunkcases"
THISDIR=`pwd`
cd $ISOPATH
TC="${execdir}/test_chunkcases -4"
ZM="${execdir}/zmapio -t int"
remfile() {
case "$zext" in
nc4) rm -fr $1 ;;
file) rm -fr $1 ;;
zip) rm -fr $1 ;;
s3) ;;
*) echo "no such extension: $zext" ; exit 1;;
esac
}
remfile() {
case "$zext" in
nc4) rm -fr $1 ;;
file) rm -fr $1 ;;
zip) rm -fr $1 ;;
s3) ;;
*) echo "no such extension: $zext" ; exit 1;;
esac
}
makefile() {
fileargs $1
remfile $file
case "$zext" in
nc4) F=$file;;
file) F=$fileurl;;
zip) F=$fileurl;;
s3) F=$fileurl;;
*) echo "no such extension: $zext" ; exit 1;;
esac
}
testcasesxfail() {
zext=$1
} # testcasesxfail()
testcasespass() {
zext=$1
echo ""; echo "*** Test format $1"
makefile tmp_whole
rm -f tmp_whole_${zext}.txt tmp_whole_${zext}.cdl tmp_err_${zext}.txt
makefile tmp_whole
# This should succeed
$TC -d 8,8 -c 4,4 -s 4,4 -e 4,4 -OWcw $F
$TC -d 8,8 -c 4,4 -s 4,4 -e 4,4 -vn -OWr $F > tmp_whole_${zext}.txt
diff -b ${srcdir}/ref_whole.txt tmp_whole_${zext}.txt
${NCDUMP} $F > tmp_whole_${zext}.cdl
diff -b ${srcdir}/ref_whole.cdl tmp_whole_${zext}.cdl
# Test skipping whole chunks
echo "Test chunk skipping during read"
makefile tmp_skip
rm -f tmp_skip_${zext}.txt tmp_skip_${zext}.cdl
$TC -d 6,6 -c 2,2 -s 0,0 -e 6,6 -Ocw $F
$TC -i 5,5 -p 6,6 -Or $F > tmp_skip_${zext}.txt
${NCDUMP} $F > tmp_skip_${zext}.cdl
diff -b ${srcdir}/ref_skip.txt tmp_skip_${zext}.txt
diff -b ${srcdir}/ref_skip.cdl tmp_skip_${zext}.cdl
echo "Test chunk skipping during write"
makefile tmp_skipw
rm -f tmp_skipw_${zext}.cdl
$TC -d 6,6 -c 2,2 -i 5,5 -p 6,6 -Ocw $F
${NCDUMP} $F > tmp_skipw_${zext}.cdl
diff -b ${srcdir}/ref_skipw.cdl tmp_skipw_${zext}.cdl
echo "Test dimlen % chunklen != 0"
makefile tmp_rem
rm -f tmp_rem_${zext}.txt tmp_rem_${zext}.cdl
$TC -d 8,8 -c 3,3 -s 0,0 -p 8,8 -Ocw $F
${NCDUMP} $F > tmp_rem_${zext}.cdl
diff -b ${srcdir}/ref_rem.cdl tmp_rem_${zext}.cdl
${execdir}/ncdumpchunks -v v $F > tmp_rem_${zext}.txt
diff -b ${srcdir}/ref_rem.dmp tmp_rem_${zext}.txt
echo "Test rank > 2"
makefile tmp_ndims
rm -f tmp_ndims_${zext}.txt tmp_ndims_${zext}.cdl
$TC -d 8,8,8,8 -c 3,3,4,4 -s 0,0,0,0 -p 8,8,8,8 -Ocw $F
${NCDUMP} $F > tmp_ndims_${zext}.cdl
diff -b ${srcdir}/ref_ndims.cdl tmp_ndims_${zext}.cdl
${execdir}/ncdumpchunks -v v $F > tmp_ndims_${zext}.dmp
diff -b ${srcdir}/ref_ndims.dmp tmp_ndims_${zext}.dmp
echo "Test miscellaneous 1"
makefile tmp_misc1
rm -f tmp_misc1_${zext}.txt tmp_misc1_${zext}.cdl
$TC -d 6,12,4 -c 2,3,1 -s 0,0,0 -e 6,1,4 -Ocw $F
${NCDUMP} $F > tmp_misc1_${zext}.cdl
diff -b ${srcdir}/ref_misc1.cdl tmp_misc1_${zext}.cdl
${execdir}/ncdumpchunks -v v $F > tmp_misc1_${zext}.dmp
diff -b ${srcdir}/ref_misc1.dmp tmp_misc1_${zext}.dmp
} # testcasespass()
testcases() {
testcasesxfail $1
testcasespass $1
}
testcases file
if test "x$FEATURE_NCZARR_ZIP" = xyes ; then testcases zip; fi
if test "x$FEATURE_S3TESTS" = xyes ; then testcases s3; fi