netcdf-c/nczarr_test/run_ncgen4.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

98 lines
2.2 KiB
Bash
Executable File

#!/bin/sh
# Tests for ncgen4 using list of test cdl files from the cdl4
# directory, and comparing output to expected results in the expected4
# directory. Note that these tests are run for classic files in
# test_ncgen4_classic.sh
# Dennis Heimbigner
if test "x$srcdir" = x ; then srcdir=`pwd`; fi
. ../test_common.sh
. "$srcdir/test_nczarr.sh"
# Isolate both test and S3
s3isolate "testdir_ncgen4"
THISDIR=`pwd`
cd $ISOPATH
set -e
# To add a new test,
# 1. put the .cdl file in the 'ncdump/cdl' directory
# 2. put the result of running ncgen then ncdump
# into the directory 'expected' as .dmp
# 3. Add the test to the end of the TESTS variable
# 4. Add the new files into ncdump/cdl/Makefile.am
# and ncdump/expected/Makefile.am
TESTS="\
dimscope \
tst_group_data \
tst_solar_1 \
tst_nul4 \
"
# These tests need to leave _FillValue
FVTESTS="tst_nans"
ALLTESTS="$TESTS $FVTESTS"
# Location constants
cdl="$srcdir/../ncdump/cdl"
expected="$srcdir/../ncdump/expected"
# Functions
# See if this is an FVTEST
testiffv() {
ok=0
for FV in $FVTESTS ; do
if test "x$FV" = "x$1" ; then ok=1; fi
done
}
# Remove fillvalue attribute since zarr generates it when hdf5 does not
fvclean() {
cat $1 \
| sed -e '/:_FillValue/d' \
| cat > $2
}
difftest() {
echo ""; echo "*** Test zext=$zext"
for t in ${ALLTESTS} ; do
echo "*** Testing: ${t}"
# determine if we need the specflag set
# determine properties
checkprops ${t}
ref="ref_${t}"
rm -fr ${t}.$zext
rm -f tmp_${t}.dmp
fileargs $t
${NCGEN} -4 -lb -o ${fileurl} ${cdl}/${ref}.cdl
${NCDUMP} ${headflag} ${specflag} -n ${ref} ${fileurl} > tmp_${t}.dmp
testiffv $t
if test "x$ok" = x0 ; then
fvclean tmp_${t}.dmp tmp_${t}.dmpx
else
cp tmp_${t}.dmp tmp_${t}.dmpx
fi
# compare against expected
diff -b -w ${expected}/${ref}.dmp ./tmp_${t}.dmpx
echo "*** SUCCEED: ${t}"
done
}
runtestset() {
extfor $1
echo "*** Testing nczarr X ncgen with zmap=${zext}"
difftest
echo "*** PASSED: zext=${zext}"
}
runtestset file
if test "x$FEATURE_NCZARR_ZIP" = xyes ; then runtestset zip; fi
if test "x$FEATURE_S3TESTS" = xyes ; then runtestset s3; fi
echo "*** PASSED ***"