lib/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$
  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
  35 #define _FILE_OFFSET_BITS 64
  36
  37 #include <archive.h>
  38 #include <archive_entry.h>
  39 #include <fcntl.h>
  40 #include <stdio.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include <sys/stat.h>
  44 #include <wchar.h>
  45
  46 #ifdef USE_DMALLOC
  47 #include <dmalloc.h>
  48 #endif
  49
  50 #if defined(HAVE_CONFIG_H)
  51 /* Most POSIX platforms use the 'configure' script to build config.h */
  52 #include "../../config.h"
  53 #elif defined(__FreeBSD__)
  54 /* Building as part of FreeBSD system requires a pre-built config.h. */
  55 #include "../config_freebsd.h"
  56 #elif defined(_WIN32)
  57 /* Win32 can't run the 'configure' script. */
  58 #include "../config_windows.h"
  59 #else
  60 /* Warn if the library hasn't been (automatically or manually) configured. */
  61 #error Oops: No config.h and no pre-built configuration in test.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  * ARCHIVE_VERSION_STAMP first appeared in 1.9 and libarchive 2.2.4.
  73  * We can approximate it for earlier versions, though.
  74  * This is used to disable tests of features not present in the current
  75  * version.
  76  */
  77 #ifndef ARCHIVE_VERSION_STAMP
  78 #define ARCHIVE_VERSION_STAMP   \
  79                 (ARCHIVE_API_VERSION * 1000000 + ARCHIVE_API_FEATURE * 1000)
  80 #endif
  81
  82
  83 /*
  84  * "list.h" is simply created by "grep DEFINE_TEST"; it has
  85  * a line like
  86  *      DEFINE_TEST(test_function)
  87  * for each test.
  88  * Include it here with a suitable DEFINE_TEST to declare all of the
  89  * test functions.
  90  */
  91 #define DEFINE_TEST(name) void name(void);
  92 #include "list.h"
  93 /*
  94  * Redefine DEFINE_TEST for use in defining the test functions.
  95  */
  96 #undef DEFINE_TEST
  97 #define DEFINE_TEST(name) void name(void)
  98
  99 /* An implementation of the standard assert() macro */
 100 #define assert(e)   test_assert(__FILE__, __LINE__, (e), #e, NULL)
 101 /* As above, but reports any archive_error found in variable 'a' */
 102 #define assertA(e)   test_assert(__FILE__, __LINE__, (e), #e, (a))
 103
 104 /* Asserts that two integers are the same.  Reports value of each one if not. */
 105 #define assertEqualIntA(a,v1,v2)   \
 106   test_assert_equal_int(__FILE__, __LINE__, (v1), #v1, (v2), #v2, (a))
 107 #define assertEqualInt(v1,v2)   \
 108   test_assert_equal_int(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
 109
 110 /* Asserts that two strings are the same.  Reports value of each one if not. */
 111 #define assertEqualStringA(a,v1,v2)   \
 112   test_assert_equal_string(__FILE__, __LINE__, (v1), #v1, (v2), #v2, (a))
 113 #define assertEqualString(v1,v2)   \
 114   test_assert_equal_string(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
 115 /* As above, but v1 and v2 are wchar_t * */
 116 #define assertEqualWString(v1,v2)   \
 117   test_assert_equal_wstring(__FILE__, __LINE__, (v1), #v1, (v2), #v2, NULL)
 118
 119 /*
 120  * This would be simple with C99 variadic macros, but I don't want to
 121  * require that.  Instead, I insert a function call before each
 122  * skipping() call to pass the file and line information down.  Crude,
 123  * but effective.
 124  */
 125 #define skipping        \
 126   skipping_setup(__FILE__, __LINE__);test_skipping
 127
 128 /* Function declarations.  These are defined in test_utility.c. */
 129 void failure(const char *fmt, ...);
 130 void skipping_setup(const char *, int);
 131 void test_skipping(const char *fmt, ...);
 132 void test_assert(const char *, int, int, const char *, struct archive *);
 133 void test_assert_equal_int(const char *, int, int, const char *, int, const char *, struct archive *);
 134 void test_assert_equal_string(const char *, int, const char *v1, const char *, const char *v2, const char *, struct archive *);
 135 void test_assert_equal_wstring(const char *, int, const wchar_t *v1, const char *, const wchar_t *v2, const char *, struct archive *);
 136
 137 /* Special customized read-from-memory interface. */
 138 int read_open_memory(struct archive *, void *, size_t, size_t);
 139 int     read_open_memory(struct archive *, void *, size_t, size_t);