mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
92825d6d65
Includes the following upstream changes: Add a more complete usage message to runtests and add support for a -h command-line flag to display the usage message. is_double() now takes a third argument, an epsilon. Two numbers are considered equal if their absolute difference is less than epsilon. is_double() also now treats wanted and seen values of NaN (not a number) as equal. Thanks to PICCA Frédéric-Emmanuel for the proposed changes. The ok_program function in the shell libtap.sh library no longer strips text after a colon and a space from the program output if the expected status is non-zero. Instead, if program output may contain system-specific error messages after a colon and a space, put the new function strip_colon_error before the program to do this stripping. Thanks to Carsten Hey for the idea. strip_colon_error is now smarter about preserving an initial word ending in a colon (which is generally the program name) while still stripping error messages later in the line. The test_file_path function in the shell libtap.sh library now always returns the empty string, rather than possible absolute paths starting at /, if $BUILD and $SOURCE are not set. Flush standard error in the C TAP library before printing results for more deterministic output. Thanks to Carsten Hey for the idea. All of C TAP Harness now compiles with gcc -ansi -pedantic and should be fully C89-compatible. Note that either C99 or SUSv3 is required to build C TAP Harness. (This should not be a problem on any modern platform.) Based on work by Carsten Hey. Simplify and improve output formatting in the summary of failing tests in some edge cases. Add explicit license statements to the files meant to be copied into other packages rather than referring to LICENSE. Add a test_file_path() function to the basic C and shell TAP libraries, which searches the build and source directories for a particular file and returns the full path. This is a utility function that can be used to find test data files. Change-Id: I3ef84218f0e3a8b75f550c8b629b058330659b31 Reviewed-on: http://gerrit.openafs.org/4589 Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: BuildBot <buildbot@rampaginggeek.com>
142 lines
5.3 KiB
C
142 lines
5.3 KiB
C
/*
|
|
* Basic utility routines for the TAP protocol.
|
|
*
|
|
* This file is part of C TAP Harness. The current version plus supporting
|
|
* documentation is at <http://www.eyrie.org/~eagle/software/c-tap-harness/>.
|
|
*
|
|
* Copyright 2009, 2010 Russ Allbery <rra@stanford.edu>
|
|
* Copyright 2001, 2002, 2004, 2005, 2006, 2007, 2008
|
|
* The Board of Trustees of the Leland Stanford Junior University
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the "Software"),
|
|
* to deal in the Software without restriction, including without limitation
|
|
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
* and/or sell copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
* DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef TAP_BASIC_H
|
|
#define TAP_BASIC_H 1
|
|
|
|
#include <stdarg.h> /* va_list */
|
|
#include <sys/types.h> /* pid_t */
|
|
|
|
/*
|
|
* __attribute__ is available in gcc 2.5 and later, but only with gcc 2.7
|
|
* could you use the __format__ form of the attributes, which is what we use
|
|
* (to avoid confusion with other macros).
|
|
*/
|
|
#ifndef __attribute__
|
|
# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
|
|
# define __attribute__(spec) /* empty */
|
|
# endif
|
|
#endif
|
|
|
|
/*
|
|
* BEGIN_DECLS is used at the beginning of declarations so that C++
|
|
* compilers don't mangle their names. END_DECLS is used at the end.
|
|
*/
|
|
#undef BEGIN_DECLS
|
|
#undef END_DECLS
|
|
#ifdef __cplusplus
|
|
# define BEGIN_DECLS extern "C" {
|
|
# define END_DECLS }
|
|
#else
|
|
# define BEGIN_DECLS /* empty */
|
|
# define END_DECLS /* empty */
|
|
#endif
|
|
|
|
/*
|
|
* Used for iterating through arrays. ARRAY_SIZE returns the number of
|
|
* elements in the array (useful for a < upper bound in a for loop) and
|
|
* ARRAY_END returns a pointer to the element past the end (ISO C99 makes it
|
|
* legal to refer to such a pointer as long as it's never dereferenced).
|
|
*/
|
|
#define ARRAY_SIZE(array) (sizeof(array) / sizeof((array)[0]))
|
|
#define ARRAY_END(array) (&(array)[ARRAY_SIZE(array)])
|
|
|
|
BEGIN_DECLS
|
|
|
|
/*
|
|
* The test count. Always contains the number that will be used for the next
|
|
* test status.
|
|
*/
|
|
extern unsigned long testnum;
|
|
|
|
/* Print out the number of tests and set standard output to line buffered. */
|
|
void plan(unsigned long count);
|
|
|
|
/*
|
|
* Prepare for lazy planning, in which the plan will be printed automatically
|
|
* at the end of the test program.
|
|
*/
|
|
void plan_lazy(void);
|
|
|
|
/* Skip the entire test suite. Call instead of plan. */
|
|
void skip_all(const char *format, ...)
|
|
__attribute__((__noreturn__, __format__(printf, 1, 2)));
|
|
|
|
/*
|
|
* Basic reporting functions. The okv() function is the same as ok() but
|
|
* takes the test description as a va_list to make it easier to reuse the
|
|
* reporting infrastructure when writing new tests.
|
|
*/
|
|
void ok(int success, const char *format, ...)
|
|
__attribute__((__format__(printf, 2, 3)));
|
|
void okv(int success, const char *format, va_list args);
|
|
void skip(const char *reason, ...)
|
|
__attribute__((__format__(printf, 1, 2)));
|
|
|
|
/* Report the same status on, or skip, the next count tests. */
|
|
void ok_block(unsigned long count, int success, const char *format, ...)
|
|
__attribute__((__format__(printf, 3, 4)));
|
|
void skip_block(unsigned long count, const char *reason, ...)
|
|
__attribute__((__format__(printf, 2, 3)));
|
|
|
|
/* Check an expected value against a seen value. */
|
|
void is_int(long wanted, long seen, const char *format, ...)
|
|
__attribute__((__format__(printf, 3, 4)));
|
|
void is_double(double wanted, double seen, double epsilon,
|
|
const char *format, ...)
|
|
__attribute__((__format__(printf, 4, 5)));
|
|
void is_string(const char *wanted, const char *seen, const char *format, ...)
|
|
__attribute__((__format__(printf, 3, 4)));
|
|
void is_hex(unsigned long wanted, unsigned long seen, const char *format, ...)
|
|
__attribute__((__format__(printf, 3, 4)));
|
|
|
|
/* Bail out with an error. sysbail appends strerror(errno). */
|
|
void bail(const char *format, ...)
|
|
__attribute__((__noreturn__, __nonnull__, __format__(printf, 1, 2)));
|
|
void sysbail(const char *format, ...)
|
|
__attribute__((__noreturn__, __nonnull__, __format__(printf, 1, 2)));
|
|
|
|
/* Report a diagnostic to stderr prefixed with #. */
|
|
void diag(const char *format, ...)
|
|
__attribute__((__nonnull__, __format__(printf, 1, 2)));
|
|
void sysdiag(const char *format, ...)
|
|
__attribute__((__nonnull__, __format__(printf, 1, 2)));
|
|
|
|
/*
|
|
* Find a test file under BUILD or SOURCE, returning the full path. The
|
|
* returned path should be freed with test_file_path_free().
|
|
*/
|
|
char *test_file_path(const char *file)
|
|
__attribute__((__malloc__, __nonnull__));
|
|
void test_file_path_free(char *path);
|
|
|
|
END_DECLS
|
|
|
|
#endif /* TAP_BASIC_H */
|