archivers/libarchive/files/libarchive/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: src/lib/libarchive/test/test.h,v 1.10 2008/06/15 10:35:22 kientzle Exp $
  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)
  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 <dirent.h>
  49 #include <errno.h>
  50 #include <fcntl.h>
  51 #include <stdio.h>
  52 #include <stdlib.h>
  53 #include <string.h>
  54 #include <sys/stat.h>
  55 #ifndef _WIN32
  56 #include <unistd.h>
  57 #endif
  58 #include <wchar.h>
  59
  60 #ifdef USE_DMALLOC
  61 #include <dmalloc.h>
  62 #endif
  63
  64 /* No non-FreeBSD platform will have __FBSDID, so just define it here. */
  65 #ifdef __FreeBSD__
  66 #include <sys/cdefs.h>  /* For __FBSDID */
  67 #else
  68 #define __FBSDID(a)     /* null */
  69 #endif
  70
  71 /*
  72  * Redefine DEFINE_TEST for use in defining the test functions.
  73  */
  74 #undef DEFINE_TEST
  75 #define DEFINE_TEST(name) void name(void); void name(void)
  76
  77 /* An implementation of the standard assert() macro */
  78 #define assert(e)   test_assert(__FILE__, __LINE__, (e), #e, NULL)
  79
  80 /* Assert two integers are the same.  Reports value of each one if not. */
  81 #define assertEqualInt(v1,v2)   \
  82   test_assert_equal_int(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
  83
  84 /* Assert two strings are the same.  Reports value of each one if not. */
  85 #define assertEqualString(v1,v2)   \
  86   test_assert_equal_string(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
  87 /* As above, but v1 and v2 are wchar_t * */
  88 #define assertEqualWString(v1,v2)   \
  89   test_assert_equal_wstring(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
  90 /* As above, but raw blocks of bytes. */
  91 #define assertEqualMem(v1, v2, l)       \
  92   test_assert_equal_mem(__FILE__, __LINE__, (v1), #v1, (v2), #v2, (l), #l, NULL)
  93 /* Assert two files are the same; allow printf-style expansion of second name.
  94  * See below for comments about variable arguments here...
  95  */
  96 #define assertEqualFile         \
  97   test_setup(__FILE__, __LINE__);test_assert_equal_file
  98 /* Assert that a file is empty; supports printf-style arguments. */
  99 #define assertEmptyFile         \
 100   test_setup(__FILE__, __LINE__);test_assert_empty_file
 101 /* Assert that a file exists; supports printf-style arguments. */
 102 #define assertFileExists                \
 103   test_setup(__FILE__, __LINE__);test_assert_file_exists
 104 /* Assert that a file exists; supports printf-style arguments. */
 105 #define assertFileNotExists             \
 106   test_setup(__FILE__, __LINE__);test_assert_file_not_exists
 107 /* Assert that file contents match a string; supports printf-style arguments. */
 108 #define assertFileContents             \
 109   test_setup(__FILE__, __LINE__);test_assert_file_contents
 110
 111 /*
 112  * This would be simple with C99 variadic macros, but I don't want to
 113  * require that.  Instead, I insert a function call before each
 114  * skipping() call to pass the file and line information down.  Crude,
 115  * but effective.
 116  */
 117 #define skipping        \
 118   test_setup(__FILE__, __LINE__);test_skipping
 119
 120 /* Function declarations.  These are defined in test_utility.c. */
 121 void failure(const char *fmt, ...);
 122 void test_setup(const char *, int);
 123 void test_skipping(const char *fmt, ...);
 124 int test_assert(const char *, int, int, const char *, void *);
 125 int test_assert_empty_file(const char *, ...);
 126 int test_assert_equal_file(const char *, const char *, ...);
 127 int test_assert_equal_int(const char *, int, int, const char *, int, const char *, void *);
 128 int test_assert_equal_string(const char *, int, const char *v1, const char *, const char *v2, const char *, void *);
 129 int test_assert_equal_wstring(const char *, int, const wchar_t *v1, const char *, const wchar_t *v2, const char *, void *);
 130 int test_assert_equal_mem(const char *, int, const char *, const char *, const char *, const char *, size_t, const char *, void *);
 131 int test_assert_file_contents(const void *, int, const char *, ...);
 132 int test_assert_file_exists(const char *, ...);
 133 int test_assert_file_not_exists(const char *, ...);
 134
 135 /* Like sprintf, then system() */
 136 int systemf(const char * fmt, ...);
 137
 138 /* Suck file into string allocated via malloc(). Call free() when done. */
 139 /* Supports printf-style args: slurpfile(NULL, "%s/myfile", refdir); */
 140 char *slurpfile(size_t *, const char *fmt, ...);
 141
 142 /* Extracts named reference file to the current directory. */
 143 void extract_reference_file(const char *);
 144
 145 /*
 146  * Special interfaces for libarchive test harness.
 147  */
 148
 149 #include "archive.h"
 150 #include "archive_entry.h"
 151
 152 /* Special customized read-from-memory interface. */
 153 int read_open_memory(struct archive *, void *, size_t, size_t);
 154
 155 /*
 156  * ARCHIVE_VERSION_STAMP first appeared in 1.9 and libarchive 2.2.4.
 157  * We can approximate it for earlier versions, though.
 158  * This is used to disable tests of features not present in the current
 159  * version.
 160  */
 161 #ifndef ARCHIVE_VERSION_STAMP
 162 #define ARCHIVE_VERSION_STAMP   \
 163                 (ARCHIVE_API_VERSION * 1000000 + ARCHIVE_API_FEATURE * 1000)
 164 #endif
 165
 166 /* Versions of above that accept an archive argument for additional info. */
 167 #define assertA(e)   test_assert(__FILE__, __LINE__, (e), #e, (a))
 168 #define assertEqualIntA(a,v1,v2)   \
 169   test_assert_equal_int(__FILE__, __LINE__, (v1), #v1, (v2), #v2, (a))
 170 #define assertEqualStringA(a,v1,v2)   \
 171   test_assert_equal_string(__FILE__, __LINE__, (v1), #v1, (v2), #v2, (a))