netcdf-c/nc_test4/tst_unknown.sh
Dennis Heimbigner 49737888ca Improve S3 Documentation and Support
## Improvements to S3 Documentation
* Create a new document *quickstart_paths.md* that give a summary of the legal path formats used by netcdf-c. This includes both file paths and URL paths.
* Modify *nczarr.md* to remove most of the S3 related text.
* Move the S3 text from *nczarr.md* to a new document *cloud.md*.
* Add some S3-related text to the *byterange.md* document.

Hopefully, this will make it easier for users to find the information they want.

## Rebuild NCZarr Testing
In order to avoid problems with running make check in parallel, two changes were made:
1. The *nczarr_test* test system was rebuilt. Now, for each test.
any generated files are kept in a test-specific directory, isolated
from all other test executions.
2. Similarly, since the S3 test bucket is shared, any generated S3 objects
are isolated using a test-specific key path.

## Other S3 Related Changes
* Add code to ensure that files created on S3 are reclaimed at end of testing.
* Used the bash "trap" command to ensure S3 cleanup even if the test fails.
* Cleanup the S3 related configure.ac flag set since S3 is used in several places. So now one should use the option *--enable-s3* instead of *--enable-nczarr-s3*, although the latter is still kept as a deprecated alias for the former.
* Get some of the github actions yml to work with S3; required fixing various test scripts adding a secret to access the Unidata S3 bucket.
* Cleanup S3 portion of libnetcdf.settings.in and netcdf_meta.h.in and test_common.in.
* Merge partial S3 support into dhttp.c.
* Create an experimental s3 access library especially for use with Windows. It is enabled by using the options *--enable-s3-internal* (automake) or *-DENABLE_S3_INTERNAL=ON* (CMake). Also add a unit-test for it.
* Move some definitions from ncrc.h to ncs3sdk.h

## Other Changes
* Provide a default implementation of strlcpy and move this and similar defaults into *dmissing.c*.
2023-04-25 17:15:06 -06:00

115 lines
2.9 KiB
Bash
Executable File

#!/bin/bash
if test "x$srcdir" = x ; then srcdir=`pwd`; fi
. ../test_common.sh
isolate "testdir_unknown"
THISDIR=`pwd`
cd $ISOPATH
if test "x$TESTNCZARR" = x1 ; then
. "$srcdir/test_nczarr.sh"
s3isolate
fi
set -e
# Load the findplugins function
. ${builddir}/findplugin.sh
echo "findplugin.sh loaded"
# Set up HDF5_PLUGIN_PATH
export HDF5_PLUGIN_PATH=${HDF5_PLUGIN_DIR}
# Test operation with an unknown filter
# Function to remove selected -s attributes from file;
# These attributes might be platform dependent
sclean() {
cat $1 \
| sed -e '/:_IsNetcdf4/d' \
| sed -e '/:_Endianness/d' \
| sed -e '/_NCProperties/d' \
| sed -e '/_SuperblockVersion/d' \
| cat > $2
}
# Function to extract _Filter attribute from a file
# These attributes might be platform dependent
getfilterattr() {
sed -e '/var.*:_Filter/p' -ed <$1 >$2
}
# Function to extract _Codecs attribute from a file
# These attributes might be platform dependent
getcodecsattr() {
sed -e '/var.*:_Codecs/p' -ed <$1 >$2
}
trimleft() {
sed -e 's/[ ]*\([^ ].*\)/\1/' <$1 >$2
}
# Locate the plugin path and the library names; argument order is critical
# Find noop and capture
findplugin h5unknown
UNKNOWNDIR="${HDF5_PLUGIN_DIR}"
UNKNOWNLIB="${HDF5_PLUGIN_LIB}"
UNKNOWNFILTER="${HDF5_PLUGIN_DIR}/${UNKNOWNLIB}"
# Getting the name is especially tricky for dylib, which puts the version before the .dylib
# Verify
if ! test -f ${UNKNOWNFILTER} ; then echo "Unable to locate ${UNKNOWNFILTER}"; exit 1; fi
testunk() {
zext=$1
echo "*** Testing access to filter info when filter implementation is not available for map $zext"
if test "x$TESTNCZARR" = x1 ; then
fileargs tmp_known
deletemap $zext $file
else
file="tmp_known_${zfilt}.nc"
rm -f $file
fileurl="$file"
fi
# build .nc file using unknown
${NCGEN} -lb -4 -o $fileurl ${srcdir}/../nc_test4/unknown.cdl
# dump and clean file when filter is avail
${NCDUMP} -hs $fileurl > ./tmp_known_$zext.txt
# Remove irrelevant -s output
sclean ./tmp_known_$zext.txt tmp_known_$zext.dump
# Hide the filter
rm -fr ${UNKNOWNDIR}/save
mkdir -p ${UNKNOWNDIR}/save
# Figure out all matching libs; make sure to remove .so, so.0, etc
LSRC=`${execdir}/../ncdump/ncpathcvt -F "${UNKNOWNDIR}"`
LDST=`${execdir}/../ncdump/ncpathcvt -F ${UNKNOWNDIR}/save`
mv ${LSRC}/*unknown* ${LDST}
# Verify that the filter is no longer defined
# Try to read the data; should xfail
if ${NCDUMP} -s $fileurl > ./tmp_unk_$zext.dmp ; then
echo "*** FAIL: filter found"
found=1
else
echo "*** XFAIL: filter not found"
found=0
fi
# Restore the filter
mv ${LDST}/*unknown* ${LSRC}
rm -fr ${UNKNOWNDIR}/save
if test "x$found" = x1 ; then exit 1; fi
}
if test "x$TESTNCZARR" = x1 ; then
testunk file
if test "x$FEATURE_NCZARR_ZIP" = xyes ; then testunk zip ; fi
if test "x$FEATURE_S3TESTS" = xyes ; then testunk s3 ; fi
if test "x$FEATURE_S3TESTS" = xyes ; then s3sdkdelete "/${S3ISOPATH}" ; fi # Cleanup
else
testunk nc
fi
exit 0