netcdf-c/nczarr_test/run_ncgen4.sh
Dennis Heimbigner 11fe00ea05 Add filter support to NCZarr
Filter support has three goals:

1. Use the existing HDF5 filter implementations,
2. Allow filter metadata to be stored in the NumCodecs metadata format used by Zarr,
3. Allow filters to be used even when HDF5 is disabled

Detailed usage directions are define in docs/filters.md.

For now, the existing filter API is left in place. So filters
are defined using ''nc_def_var_filter'' using the HDF5 style
where the id and parameters are unsigned integers.

This is a big change since filters affect many parts of the code.

In the following, the terms "compressor" and "filter" and "codec" are generally
used synonomously.

### Filter-Related Changes:
* In order to support dynamic loading of shared filter libraries, a new library was added in the libncpoco directory; it helps to isolate dynamic loading across multiple platforms.
* Provide a json parsing library for use by plugins; this is created by merging libdispatch/ncjson.c with include/ncjson.h.
* Add a new _Codecs attribute to allow clients to see what codecs are being used; let ncdump -s print it out.
* Provide special headers to help support compilation of HDF5 filters when HDF5 is not enabled: netcdf_filter_hdf5_build.h and netcdf_filter_build.h.
* Add a number of new test to test the new nczarr filters.
* Let ncgen parse _Codecs attribute, although it is ignored.

### Plugin directory changes:
* Add support for the Blosc compressor; this is essential because it is the most common compressor used in Zarr datasets. This also necessitated adding a CMake FindBlosc.cmake file
* Add NCZarr support for the big-four filters provided by HDF5: shuffle, fletcher32, deflate (zlib), and szip
* Add a Codec defaulter (see docs/filters.md) for the big four filters.
* Make plugins work with windows by properly adding __declspec declaration.

### Misc. Non-Filter Changes
* Replace most uses of USE_NETCDF4 (deprecated) with USE_HDF5.
* Improve support for caching
* More fixes for path conversion code
* Fix misc. memory leaks
* Add new utility -- ncdump/ncpathcvt -- that does more or less the same thing as cygpath.
* Add a number of new test to test the non-filter fixes.
* Update the parsers
* Convert most instances of '#ifdef _MSC_VER' to '#ifdef _WIN32'
2021-09-02 17:04:26 -06:00

100 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
# tst_ncgen4_classic.sh
# Dennis Heimbigner
if test "x$srcdir" = x ; then srcdir=`pwd`; fi
. ../test_common.sh
. "$srcdir/test_nczarr.sh"
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"
RESULTSDIR="./results"
# 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}"
rm -fr ${RESULTSDIR}.$zext
mkdir ${RESULTSDIR}.${zext}
WD=`pwd `
cd ${RESULTSDIR}.${zext}
difftest
cd $WD
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 ***"