contrib/libarchive/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 #include <sys/types.h>  /* Windows requires this before sys/stat.h */
  49 #include <sys/stat.h>
  50
  51 #if HAVE_DIRENT_H
  52 #include <dirent.h>
  53 #endif
  54 #ifdef HAVE_DIRECT_H
  55 #include <direct.h>
  56 #define dirent direct
  57 #endif
  58 #include <errno.h>
  59 #include <fcntl.h>
  60 #ifdef HAVE_IO_H
  61 #include <io.h>
  62 #endif
  63 #ifdef HAVE_STDINT_H
  64 #include <stdint.h>
  65 #endif
  66 #include <stdio.h>
  67 #include <stdlib.h>
  68 #include <string.h>
  69 #include <time.h>
  70 #ifdef HAVE_UNISTD_H
  71 #include <unistd.h>
  72 #endif
  73 #include <wchar.h>
  74 #ifdef HAVE_WINDOWS_H
  75 #include <windows.h>
  76 #endif
  77
  78 /*
  79  * System-specific tweaks.  We really want to minimize these
  80  * as much as possible, since they make it harder to understand
  81  * the mainline code.
  82  */
  83
  84 /* Windows (including Visual Studio and MinGW but not Cygwin) */
  85 #if defined(_WIN32) && !defined(__CYGWIN__)
  86 #if !defined(__BORLANDC__)
  87 #undef chdir
  88 #define chdir _chdir
  89 #define strdup _strdup
  90 #endif
  91 #endif
  92
  93 /* Visual Studio */
  94 #ifdef _MSC_VER
  95 #define snprintf        sprintf_s
  96 #endif
  97
  98 #if defined(__BORLANDC__)
  99 #pragma warn -8068      /* Constant out of range in comparison. */
 100 #endif
 101
 102 /* Haiku OS and QNX */
 103 #if defined(__HAIKU__) || defined(__QNXNTO__)
 104 /* Haiku and QNX have typedefs in stdint.h (needed for int64_t) */
 105 #include <stdint.h>
 106 #endif
 107
 108 /* Get a real definition for __FBSDID if we can */
 109 #if HAVE_SYS_CDEFS_H
 110 #include <sys/cdefs.h>
 111 #endif
 112
 113 /* If not, define it so as to avoid dangling semicolons. */
 114 #ifndef __FBSDID
 115 #define __FBSDID(a)     struct _undefined_hack
 116 #endif
 117
 118 #ifndef O_BINARY
 119 #define O_BINARY 0
 120 #endif
 121
 122 /*
 123  * Redefine DEFINE_TEST for use in defining the test functions.
 124  */
 125 #undef DEFINE_TEST
 126 #define DEFINE_TEST(name) void name(void); void name(void)
 127
 128 /* An implementation of the standard assert() macro */
 129 #define assert(e)   assertion_assert(__FILE__, __LINE__, (e), #e, NULL)
 130 /* chdir() and error if it fails */
 131 #define assertChdir(path)  \
 132   assertion_chdir(__FILE__, __LINE__, path)
 133 /* Assert two integers are the same.  Reports value of each one if not. */
 134 #define assertEqualInt(v1,v2) \
 135   assertion_equal_int(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
 136 /* Assert two strings are the same.  Reports value of each one if not. */
 137 #define assertEqualString(v1,v2)   \
 138   assertion_equal_string(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL, 0)
 139 #define assertEqualUTF8String(v1,v2)   \
 140   assertion_equal_string(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL, 1)
 141 /* As above, but v1 and v2 are wchar_t * */
 142 #define assertEqualWString(v1,v2)   \
 143   assertion_equal_wstring(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
 144 /* As above, but raw blocks of bytes. */
 145 #define assertEqualMem(v1, v2, l)       \
 146   assertion_equal_mem(__FILE__, __LINE__, (v1), #v1, (v2), #v2, (l), #l, NULL)
 147 /* Assert two files are the same. */
 148 #define assertEqualFile(f1, f2) \
 149   assertion_equal_file(__FILE__, __LINE__, (f1), (f2))
 150 /* Assert that a file is empty. */
 151 #define assertEmptyFile(pathname)       \
 152   assertion_empty_file(__FILE__, __LINE__, (pathname))
 153 /* Assert that a file is not empty. */
 154 #define assertNonEmptyFile(pathname)            \
 155   assertion_non_empty_file(__FILE__, __LINE__, (pathname))
 156 #define assertFileAtime(pathname, sec, nsec)    \
 157   assertion_file_atime(__FILE__, __LINE__, pathname, sec, nsec)
 158 #define assertFileAtimeRecent(pathname) \
 159   assertion_file_atime_recent(__FILE__, __LINE__, pathname)
 160 #define assertFileBirthtime(pathname, sec, nsec)        \
 161   assertion_file_birthtime(__FILE__, __LINE__, pathname, sec, nsec)
 162 #define assertFileBirthtimeRecent(pathname) \
 163   assertion_file_birthtime_recent(__FILE__, __LINE__, pathname)
 164 /* Assert that a file exists; supports printf-style arguments. */
 165 #define assertFileExists(pathname) \
 166   assertion_file_exists(__FILE__, __LINE__, pathname)
 167 /* Assert that a file exists. */
 168 #define assertFileNotExists(pathname) \
 169   assertion_file_not_exists(__FILE__, __LINE__, pathname)
 170 /* Assert that file contents match a string. */
 171 #define assertFileContents(data, data_size, pathname) \
 172   assertion_file_contents(__FILE__, __LINE__, data, data_size, pathname)
 173 #define assertFileMtime(pathname, sec, nsec)    \
 174   assertion_file_mtime(__FILE__, __LINE__, pathname, sec, nsec)
 175 #define assertFileMtimeRecent(pathname) \
 176   assertion_file_mtime_recent(__FILE__, __LINE__, pathname)
 177 #define assertFileNLinks(pathname, nlinks)  \
 178   assertion_file_nlinks(__FILE__, __LINE__, pathname, nlinks)
 179 #define assertFileSize(pathname, size)  \
 180   assertion_file_size(__FILE__, __LINE__, pathname, size)
 181 #define assertTextFileContents(text, pathname) \
 182   assertion_text_file_contents(__FILE__, __LINE__, text, pathname)
 183 #define assertFileContainsLinesAnyOrder(pathname, lines)        \
 184   assertion_file_contains_lines_any_order(__FILE__, __LINE__, pathname, lines)
 185 #define assertIsDir(pathname, mode)             \
 186   assertion_is_dir(__FILE__, __LINE__, pathname, mode)
 187 #define assertIsHardlink(path1, path2)  \
 188   assertion_is_hardlink(__FILE__, __LINE__, path1, path2)
 189 #define assertIsNotHardlink(path1, path2)       \
 190   assertion_is_not_hardlink(__FILE__, __LINE__, path1, path2)
 191 #define assertIsReg(pathname, mode)             \
 192   assertion_is_reg(__FILE__, __LINE__, pathname, mode)
 193 #define assertIsSymlink(pathname, contents)     \
 194   assertion_is_symlink(__FILE__, __LINE__, pathname, contents)
 195 /* Create a directory, report error if it fails. */
 196 #define assertMakeDir(dirname, mode)    \
 197   assertion_make_dir(__FILE__, __LINE__, dirname, mode)
 198 #define assertMakeFile(path, mode, contents) \
 199   assertion_make_file(__FILE__, __LINE__, path, mode, -1, contents)
 200 #define assertMakeBinFile(path, mode, csize, contents) \
 201   assertion_make_file(__FILE__, __LINE__, path, mode, csize, contents)
 202 #define assertMakeHardlink(newfile, oldfile)    \
 203   assertion_make_hardlink(__FILE__, __LINE__, newfile, oldfile)
 204 #define assertMakeSymlink(newfile, linkto)      \
 205   assertion_make_symlink(__FILE__, __LINE__, newfile, linkto)
 206 #define assertNodump(path)      \
 207   assertion_nodump(__FILE__, __LINE__, path)
 208 #define assertUmask(mask)       \
 209   assertion_umask(__FILE__, __LINE__, mask)
 210 #define assertUtimes(pathname, atime, atime_nsec, mtime, mtime_nsec)    \
 211   assertion_utimes(__FILE__, __LINE__, pathname, atime, atime_nsec, mtime, mtime_nsec)
 212
 213 /*
 214  * This would be simple with C99 variadic macros, but I don't want to
 215  * require that.  Instead, I insert a function call before each
 216  * skipping() call to pass the file and line information down.  Crude,
 217  * but effective.
 218  */
 219 #define skipping        \
 220   skipping_setup(__FILE__, __LINE__);test_skipping
 221
 222 /* Function declarations.  These are defined in test_utility.c. */
 223 void failure(const char *fmt, ...);
 224 int assertion_assert(const char *, int, int, const char *, void *);
 225 int assertion_chdir(const char *, int, const char *);
 226 int assertion_empty_file(const char *, int, const char *);
 227 int assertion_equal_file(const char *, int, const char *, const char *);
 228 int assertion_equal_int(const char *, int, long long, const char *, long long, const char *, void *);
 229 int assertion_equal_mem(const char *, int, const void *, const char *, const void *, const char *, size_t, const char *, void *);
 230 int assertion_equal_string(const char *, int, const char *v1, const char *, const char *v2, const char *, void *, int);
 231 int assertion_equal_wstring(const char *, int, const wchar_t *v1, const char *, const wchar_t *v2, const char *, void *);
 232 int assertion_file_atime(const char *, int, const char *, long, long);
 233 int assertion_file_atime_recent(const char *, int, const char *);
 234 int assertion_file_birthtime(const char *, int, const char *, long, long);
 235 int assertion_file_birthtime_recent(const char *, int, const char *);
 236 int assertion_file_contains_lines_any_order(const char *, int, const char *, const char **);
 237 int assertion_file_contents(const char *, int, const void *, int, const char *);
 238 int assertion_file_exists(const char *, int, const char *);
 239 int assertion_file_mtime(const char *, int, const char *, long, long);
 240 int assertion_file_mtime_recent(const char *, int, const char *);
 241 int assertion_file_nlinks(const char *, int, const char *, int);
 242 int assertion_file_not_exists(const char *, int, const char *);
 243 int assertion_file_size(const char *, int, const char *, long);
 244 int assertion_is_dir(const char *, int, const char *, int);
 245 int assertion_is_hardlink(const char *, int, const char *, const char *);
 246 int assertion_is_not_hardlink(const char *, int, const char *, const char *);
 247 int assertion_is_reg(const char *, int, const char *, int);
 248 int assertion_is_symlink(const char *, int, const char *, const char *);
 249 int assertion_make_dir(const char *, int, const char *, int);
 250 int assertion_make_file(const char *, int, const char *, int, int, const void *);
 251 int assertion_make_hardlink(const char *, int, const char *newpath, const char *);
 252 int assertion_make_symlink(const char *, int, const char *newpath, const char *);
 253 int assertion_nodump(const char *, int, const char *);
 254 int assertion_non_empty_file(const char *, int, const char *);
 255 int assertion_text_file_contents(const char *, int, const char *buff, const char *f);
 256 int assertion_umask(const char *, int, int);
 257 int assertion_utimes(const char *, int, const char *, long, long, long, long );
 258
 259 void skipping_setup(const char *, int);
 260 void test_skipping(const char *fmt, ...);
 261
 262 /* Like sprintf, then system() */
 263 int systemf(const char * fmt, ...);
 264
 265 /* Delay until time() returns a value after this. */
 266 void sleepUntilAfter(time_t);
 267
 268 /* Return true if this platform can create symlinks. */
 269 int canSymlink(void);
 270
 271 /* Return true if this platform can run the "bzip2" program. */
 272 int canBzip2(void);
 273
 274 /* Return true if this platform can run the "grzip" program. */
 275 int canGrzip(void);
 276
 277 /* Return true if this platform can run the "gzip" program. */
 278 int canGzip(void);
 279
 280 /* Return true if this platform can run the "lrzip" program. */
 281 int canLrzip(void);
 282
 283 /* Return true if this platform can run the "lzip" program. */
 284 int canLzip(void);
 285
 286 /* Return true if this platform can run the "lzma" program. */
 287 int canLzma(void);
 288
 289 /* Return true if this platform can run the "lzop" program. */
 290 int canLzop(void);
 291
 292 /* Return true if this platform can run the "xz" program. */
 293 int canXz(void);
 294
 295 /* Return true if this filesystem can handle nodump flags. */
 296 int canNodump(void);
 297
 298 /* Return true if the file has large i-node number(>0xffffffff). */
 299 int is_LargeInode(const char *);
 300
 301 /* Suck file into string allocated via malloc(). Call free() when done. */
 302 /* Supports printf-style args: slurpfile(NULL, "%s/myfile", refdir); */
 303 char *slurpfile(size_t *, const char *fmt, ...);
 304
 305 /* Extracts named reference file to the current directory. */
 306 void extract_reference_file(const char *);
 307
 308 /* Path to working directory for current test */
 309 const char *testworkdir;
 310
 311 /*
 312  * Special interfaces for program test harness.
 313  */
 314
 315 /* Pathname of exe to be tested. */
 316 const char *testprogfile;
 317 /* Name of exe to use in printf-formatted command strings. */
 318 /* On Windows, this includes leading/trailing quotes. */
 319 const char *testprog;
 320
 321 #ifdef USE_DMALLOC
 322 #include <dmalloc.h>
 323 #endif