mirror of
https://github.com/HDFGroup/hdf5.git
synced 2024-11-27 02:10:55 +08:00
34d6ef545a
Added new testframe.h header to document testing framework functions and split them away from h5test.h and from test programs that don't integrate with the testframe.c testing framework Added new test setup callback to testframe.c testing framework Added parameters to AddTest() to specify size of test parameters so they can be copied for later use Enabled HDF5 error stacks in testframe.c framework by default and added some error stack suppressions to some testhdf5 tests Added new maxthreads option to testframe.c framework to allow specifying the maximum number of threads a multi-threaded test can use Moved TestExpress functionality out of testframe.c and into more general h5test.c for wider use by tests through getter and setter Updated some tests to not mix and match functionality between h5test.c/h and testframe.c/h Moved some functionality from testphdf5.h into testpar.h for parallel tests that aren't part of testphdf5 Added new parallel test library that contains common shared functionality for parallel tests (similar to h5test library)
295 lines
18 KiB
C
295 lines
18 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* 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 COPYING file, which can be found at the root of the source code *
|
|
* distribution tree, or in https://www.hdfgroup.org/licenses. *
|
|
* If you do not have access to either file, you may request a copy from *
|
|
* help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*
|
|
* Purpose: Test support stuff.
|
|
*/
|
|
#ifndef H5TEST_H
|
|
#define H5TEST_H
|
|
|
|
/*
|
|
* Include required headers. This file tests internal library functions,
|
|
* so we include the private headers here.
|
|
*/
|
|
#include "hdf5.h"
|
|
#include "H5private.h"
|
|
#include "H5Eprivate.h"
|
|
|
|
/*
|
|
* This contains the filename prefix specified as command line option for
|
|
* the parallel test files.
|
|
*/
|
|
H5TEST_DLLVAR char *paraprefix;
|
|
#ifdef H5_HAVE_PARALLEL
|
|
H5TEST_DLLVAR MPI_Info h5_io_info_g; /* MPI INFO object for IO */
|
|
#endif
|
|
|
|
/*
|
|
* Print the current location on the standard output stream.
|
|
*/
|
|
#define AT() \
|
|
do { \
|
|
printf(" at %s:%d in %s()...\n", __FILE__, __LINE__, __func__); \
|
|
} while (0)
|
|
|
|
/*
|
|
* The name of the test is printed by saying TESTING("something") which will
|
|
* result in the string `Testing something' being flushed to standard output.
|
|
* If a test passes, fails, or is skipped then the PASSED(), H5_FAILED(), or
|
|
* SKIPPED() macro should be called. After H5_FAILED() or SKIPPED() the caller
|
|
* should print additional information to stdout indented by at least four
|
|
* spaces. If the h5_errors() is used for automatic error handling then
|
|
* the H5_FAILED() macro is invoked automatically when an API function fails.
|
|
*/
|
|
#define TESTING(WHAT) \
|
|
do { \
|
|
printf("Testing %-62s", WHAT); \
|
|
fflush(stdout); \
|
|
n_tests_run_g++; \
|
|
} while (0)
|
|
#define TESTING_2(WHAT) \
|
|
do { \
|
|
printf(" Testing %-60s", WHAT); \
|
|
fflush(stdout); \
|
|
n_tests_run_g++; \
|
|
} while (0)
|
|
#define PASSED() \
|
|
do { \
|
|
puts(" PASSED"); \
|
|
fflush(stdout); \
|
|
n_tests_passed_g++; \
|
|
} while (0)
|
|
#define H5_FAILED() \
|
|
do { \
|
|
puts("*FAILED*"); \
|
|
fflush(stdout); \
|
|
n_tests_failed_g++; \
|
|
} while (0)
|
|
#define H5_WARNING() \
|
|
do { \
|
|
puts("*WARNING*"); \
|
|
fflush(stdout); \
|
|
} while (0)
|
|
#define SKIPPED() \
|
|
do { \
|
|
puts(" -SKIP-"); \
|
|
fflush(stdout); \
|
|
n_tests_skipped_g++; \
|
|
} while (0)
|
|
#define PUTS_ERROR(s) \
|
|
do { \
|
|
puts(s); \
|
|
AT(); \
|
|
goto error; \
|
|
} while (0)
|
|
#define TEST_ERROR \
|
|
do { \
|
|
H5_FAILED(); \
|
|
AT(); \
|
|
goto error; \
|
|
} while (0)
|
|
#define STACK_ERROR \
|
|
do { \
|
|
H5Eprint2(H5E_DEFAULT, stdout); \
|
|
goto error; \
|
|
} while (0)
|
|
#define FAIL_STACK_ERROR \
|
|
do { \
|
|
H5_FAILED(); \
|
|
AT(); \
|
|
H5Eprint2(H5E_DEFAULT, stdout); \
|
|
goto error; \
|
|
} while (0)
|
|
#define FAIL_PUTS_ERROR(s) \
|
|
do { \
|
|
H5_FAILED(); \
|
|
AT(); \
|
|
puts(s); \
|
|
goto error; \
|
|
} while (0)
|
|
|
|
/*
|
|
* Testing macros used for multi-part tests.
|
|
*/
|
|
#define TESTING_MULTIPART(WHAT) \
|
|
do { \
|
|
printf("Testing %-62s", WHAT); \
|
|
puts(""); \
|
|
fflush(stdout); \
|
|
} while (0)
|
|
|
|
/*
|
|
* Begin and end an entire section of multi-part tests. By placing all the
|
|
* parts of a test between these macros, skipping to the 'error' cleanup
|
|
* section of a test is deferred until all parts have finished.
|
|
*/
|
|
#define BEGIN_MULTIPART \
|
|
{ \
|
|
int part_nerrors = 0;
|
|
|
|
#define END_MULTIPART \
|
|
if (part_nerrors > 0) \
|
|
goto error; \
|
|
}
|
|
|
|
/*
|
|
* Begin, end and handle errors within a single part of a multi-part test.
|
|
* The PART_END macro creates a goto label based on the given "part name".
|
|
* When a failure occurs in the current part, the PART_ERROR macro uses
|
|
* this label to skip to the next part of the multi-part test. The PART_ERROR
|
|
* macro also increments the error count so that the END_MULTIPART macro
|
|
* knows to skip to the test's 'error' label once all test parts have finished.
|
|
*/
|
|
#define PART_BEGIN(part_name) {
|
|
#define PART_END(part_name) \
|
|
} \
|
|
part_##part_name##_end:
|
|
#define PART_ERROR(part_name) \
|
|
do { \
|
|
n_tests_failed_g++; \
|
|
part_nerrors++; \
|
|
goto part_##part_name##_end; \
|
|
} while (0)
|
|
#define PART_TEST_ERROR(part_name) \
|
|
do { \
|
|
H5_FAILED(); \
|
|
AT(); \
|
|
part_nerrors++; \
|
|
goto part_##part_name##_end; \
|
|
} while (0)
|
|
|
|
/*
|
|
* Simply skips to the goto label for this test part and moves on to the
|
|
* next test part. Useful for when a test part needs to be skipped for
|
|
* some reason or is currently unimplemented and empty.
|
|
*/
|
|
#define PART_EMPTY(part_name) \
|
|
do { \
|
|
goto part_##part_name##_end; \
|
|
} while (0)
|
|
|
|
/* Flags for h5_fileaccess_flags() */
|
|
#define H5_FILEACCESS_VFD 0x01
|
|
#define H5_FILEACCESS_LIBVER 0x02
|
|
|
|
/* Flags for h5_driver_uses_multiple_files() */
|
|
#define H5_EXCLUDE_MULTIPART_DRIVERS 0x01
|
|
#define H5_EXCLUDE_NON_MULTIPART_DRIVERS 0x02
|
|
|
|
/* Fill an array on the heap with an increasing count value. BUF
|
|
* is expected to point to a `struct { TYPE arr[...][...]; }`.
|
|
*/
|
|
#define H5TEST_FILL_2D_HEAP_ARRAY(BUF, TYPE) \
|
|
do { \
|
|
/* Prefix with h5tfa to avoid shadow warnings */ \
|
|
size_t h5tfa_i = 0; \
|
|
size_t h5tfa_j = 0; \
|
|
TYPE h5tfa_count = 0; \
|
|
\
|
|
for (h5tfa_i = 0; h5tfa_i < NELMTS((BUF)->arr); h5tfa_i++) \
|
|
for (h5tfa_j = 0; h5tfa_j < NELMTS((BUF)->arr[0]); h5tfa_j++) { \
|
|
(BUF)->arr[h5tfa_i][h5tfa_j] = h5tfa_count; \
|
|
h5tfa_count++; \
|
|
} \
|
|
} while (0)
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* Ugly hack to cast away const for freeing const-qualified pointers.
|
|
* Should only be used sparingly, where the alternative (like keeping
|
|
* an equivalent non-const pointer around) is far messier.
|
|
*/
|
|
#ifndef h5_free_const
|
|
#define h5_free_const(mem) free((void *)(uintptr_t)mem)
|
|
#endif
|
|
|
|
/* Generally useful testing routines */
|
|
H5TEST_DLL int h5_cleanup(const char *base_name[], hid_t fapl);
|
|
H5TEST_DLL char *h5_fixname(const char *base_name, hid_t fapl, char *fullname, size_t size);
|
|
H5TEST_DLL char *h5_fixname_superblock(const char *base_name, hid_t fapl, char *fullname, size_t size);
|
|
H5TEST_DLL char *h5_fixname_no_suffix(const char *base_name, hid_t fapl, char *fullname, size_t size);
|
|
H5TEST_DLL char *h5_fixname_printf(const char *base_name, hid_t fapl, char *fullname, size_t size);
|
|
H5TEST_DLL hid_t h5_fileaccess(void);
|
|
H5TEST_DLL hid_t h5_fileaccess_flags(unsigned flags);
|
|
H5TEST_DLL void h5_no_hwconv(void);
|
|
H5TEST_DLL const char *h5_rmprefix(const char *filename);
|
|
H5TEST_DLL void h5_restore_err(void);
|
|
H5TEST_DLL void h5_show_hostname(void);
|
|
H5TEST_DLL h5_stat_size_t h5_get_file_size(const char *filename, hid_t fapl);
|
|
H5TEST_DLL int h5_make_local_copy(const char *origfilename, const char *local_copy_name);
|
|
H5TEST_DLL herr_t h5_verify_cached_stabs(const char *base_name[], hid_t fapl);
|
|
H5TEST_DLL H5FD_class_t *h5_get_dummy_vfd_class(void);
|
|
H5TEST_DLL H5VL_class_t *h5_get_dummy_vol_class(void);
|
|
H5TEST_DLL const char *h5_get_version_string(H5F_libver_t libver);
|
|
H5TEST_DLL int h5_compare_file_bytes(char *fname1, char *fname2);
|
|
H5TEST_DLL int h5_duplicate_file_by_bytes(const char *orig, const char *dest);
|
|
H5TEST_DLL herr_t h5_check_if_file_locking_enabled(bool *are_enabled);
|
|
H5TEST_DLL void h5_check_file_locking_env_var(htri_t *use_locks, htri_t *ignore_disabled_locks);
|
|
H5TEST_DLL herr_t h5_using_native_vol(hid_t fapl_id, hid_t obj_id, bool *is_native_vol);
|
|
H5TEST_DLL const char *h5_get_test_driver_name(void);
|
|
H5TEST_DLL bool h5_using_default_driver(const char *drv_name);
|
|
H5TEST_DLL herr_t h5_using_parallel_driver(hid_t fapl_id, bool *driver_is_parallel);
|
|
H5TEST_DLL herr_t h5_driver_is_default_vfd_compatible(hid_t fapl_id, bool *default_vfd_compatible);
|
|
H5TEST_DLL bool h5_driver_uses_multiple_files(const char *drv_name, unsigned flags);
|
|
|
|
/* Random number functions that don't modify the underlying rand/random state.
|
|
* These use rand_r with a state pointer under the hood. The state is always
|
|
* initialized to the same value so that each process in the parallel tests
|
|
* always gets the same sequence.
|
|
*/
|
|
H5TEST_DLL int h5_local_rand(void);
|
|
H5TEST_DLL void h5_local_srand(unsigned int seed);
|
|
|
|
/* Functions that will replace components of a FAPL */
|
|
H5TEST_DLL herr_t h5_get_vfd_fapl(hid_t fapl_id);
|
|
H5TEST_DLL herr_t h5_get_libver_fapl(hid_t fapl_id);
|
|
|
|
/* fapl must be closed by caller */
|
|
H5TEST_DLL void h5_delete_test_file(const char *base_name, hid_t fapl);
|
|
H5TEST_DLL void h5_delete_all_test_files(const char *base_name[], hid_t fapl);
|
|
|
|
/* Performs any special actions before the test begins,
|
|
* including resetting the library by closing it */
|
|
H5TEST_DLL void h5_test_init(void);
|
|
|
|
/* Functions that deal with expediting testing */
|
|
H5TEST_DLL int h5_get_testexpress(void);
|
|
H5TEST_DLL void h5_set_testexpress(int new_val);
|
|
|
|
#ifdef H5_HAVE_FILTER_SZIP
|
|
H5TEST_DLL int h5_szip_can_encode(void);
|
|
#endif /* H5_HAVE_FILTER_SZIP */
|
|
|
|
#ifdef H5_HAVE_PARALLEL
|
|
H5TEST_DLL int h5_set_info_object(void);
|
|
H5TEST_DLL void h5_dump_info_object(MPI_Info info);
|
|
H5TEST_DLL char *getenv_all(MPI_Comm comm, int root, const char *name);
|
|
#endif
|
|
|
|
/* Extern global variables */
|
|
H5TEST_DLLVAR size_t n_tests_run_g;
|
|
H5TEST_DLLVAR size_t n_tests_passed_g;
|
|
H5TEST_DLLVAR size_t n_tests_failed_g;
|
|
H5TEST_DLLVAR size_t n_tests_skipped_g;
|
|
H5TEST_DLLVAR uint64_t vol_cap_flags_g;
|
|
|
|
H5TEST_DLL void h5_send_message(const char *file, const char *arg1, const char *arg2);
|
|
H5TEST_DLL herr_t h5_wait_message(const char *file);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|