usr.bin/tar/test/test.h

   1 /*
   2  * Copyright (c) 2003-2006 Tim Kientzle
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 /* Every test program should #include "test.h" as the first thing. */
  29
  30 /*
  31  * The goal of this file (and the matching test.c) is to
  32  * simplify the very repetitive test-*.c test programs.
  33  */
  34 #if defined(HAVE_CONFIG_H)
  35 /* Most POSIX platforms use the 'configure' script to build config.h */
  36 #include "config.h"
  37 #elif defined(__FreeBSD__)
  38 /* Building as part of FreeBSD system requires a pre-built config.h. */
  39 #include "config_freebsd.h"
  40 #elif defined(_WIN32) && !defined(__CYGWIN__)
  41 /* Win32 can't run the 'configure' script. */
  42 #include "config_windows.h"
  43 #else
  44 /* Warn if the library hasn't been (automatically or manually) configured. */
  45 #error Oops: No config.h and no pre-built configuration in test.h.
  46 #endif
  47
  48 #if !defined(_WIN32) || defined(__CYGWIN__)
  49 #include <dirent.h>
  50 #else
  51 #define dirent direct
  52 #include "../bsdtar_windows.h"
  53 #include <direct.h>
  54 #endif
  55 #include <errno.h>
  56 #include <fcntl.h>
  57 #include <stdio.h>
  58 #include <stdlib.h>
  59 #include <string.h>
  60 #include <sys/stat.h>
  61 #if !defined(_WIN32) || defined(__CYGWIN__)
  62 #include <unistd.h>
  63 #endif
  64 #include <wchar.h>
  65
  66 #ifdef USE_DMALLOC
  67 #include <dmalloc.h>
  68 #endif
  69
  70 #ifdef __FreeBSD__
  71 #include <sys/cdefs.h>  /* For __FBSDID */
  72 #else
  73 /* Some non-FreeBSD platforms such as newlib-derived ones like
  74  * cygwin, have __FBSDID, so this definition must be guarded.
  75  */
  76 #ifndef __FBSDID
  77 #define __FBSDID(a)     /* null */
  78 #endif
  79 #endif
  80
  81 /*
  82  * Redefine DEFINE_TEST for use in defining the test functions.
  83  */
  84 #undef DEFINE_TEST
  85 #define DEFINE_TEST(name) void name(void); void name(void)
  86
  87 /* An implementation of the standard assert() macro */
  88 #define assert(e)   test_assert(__FILE__, __LINE__, (e), #e, NULL)
  89
  90 /* Assert two integers are the same.  Reports value of each one if not. */
  91 #define assertEqualInt(v1,v2)   \
  92   test_assert_equal_int(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
  93
  94 /* Assert two strings are the same.  Reports value of each one if not. */
  95 #define assertEqualString(v1,v2)   \
  96   test_assert_equal_string(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
  97 /* As above, but v1 and v2 are wchar_t * */
  98 #define assertEqualWString(v1,v2)   \
  99   test_assert_equal_wstring(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
 100 /* As above, but raw blocks of bytes. */
 101 #define assertEqualMem(v1, v2, l)       \
 102   test_assert_equal_mem(__FILE__, __LINE__, (v1), #v1, (v2), #v2, (l), #l, NULL)
 103 /* Assert two files are the same; allow printf-style expansion of second name.
 104  * See below for comments about variable arguments here...
 105  */
 106 #define assertEqualFile         \
 107   test_setup(__FILE__, __LINE__);test_assert_equal_file
 108 /* Assert that a file is empty; supports printf-style arguments. */
 109 #define assertEmptyFile         \
 110   test_setup(__FILE__, __LINE__);test_assert_empty_file
 111 /* Assert that a file is not empty; supports printf-style arguments. */
 112 #define assertNonEmptyFile              \
 113   test_setup(__FILE__, __LINE__);test_assert_non_empty_file
 114 /* Assert that a file exists; supports printf-style arguments. */
 115 #define assertFileExists                \
 116   test_setup(__FILE__, __LINE__);test_assert_file_exists
 117 /* Assert that a file exists; supports printf-style arguments. */
 118 #define assertFileNotExists             \
 119   test_setup(__FILE__, __LINE__);test_assert_file_not_exists
 120 /* Assert that file contents match a string; supports printf-style arguments. */
 121 #define assertFileContents             \
 122   test_setup(__FILE__, __LINE__);test_assert_file_contents
 123
 124 /*
 125  * This would be simple with C99 variadic macros, but I don't want to
 126  * require that.  Instead, I insert a function call before each
 127  * skipping() call to pass the file and line information down.  Crude,
 128  * but effective.
 129  */
 130 #define skipping        \
 131   test_setup(__FILE__, __LINE__);test_skipping
 132
 133 /* Function declarations.  These are defined in test_utility.c. */
 134 void failure(const char *fmt, ...);
 135 void test_setup(const char *, int);
 136 void test_skipping(const char *fmt, ...);
 137 int test_assert(const char *, int, int, const char *, void *);
 138 int test_assert_empty_file(const char *, ...);
 139 int test_assert_non_empty_file(const char *, ...);
 140 int test_assert_equal_file(const char *, const char *, ...);
 141 int test_assert_equal_int(const char *, int, int, const char *, int, const char *, void *);
 142 int test_assert_equal_string(const char *, int, const char *v1, const char *, const char *v2, const char *, void *);
 143 int test_assert_equal_wstring(const char *, int, const wchar_t *v1, const char *, const wchar_t *v2, const char *, void *);
 144 int test_assert_equal_mem(const char *, int, const char *, const char *, const char *, const char *, size_t, const char *, void *);
 145 int test_assert_file_contents(const void *, int, const char *, ...);
 146 int test_assert_file_exists(const char *, ...);
 147 int test_assert_file_not_exists(const char *, ...);
 148
 149 /* Like sprintf, then system() */
 150 int systemf(const char * fmt, ...);
 151
 152 /* Suck file into string allocated via malloc(). Call free() when done. */
 153 /* Supports printf-style args: slurpfile(NULL, "%s/myfile", refdir); */
 154 char *slurpfile(size_t *, const char *fmt, ...);
 155
 156 /* Extracts named reference file to the current directory. */
 157 void extract_reference_file(const char *);
 158
 159 /*
 160  * Special interfaces for program test harness.
 161  */
 162
 163 /* Pathname of exe to be tested. */
 164 const char *testprog;