contrib/libarchive/libarchive/test/test_write_compress_gzip.c

   1 /*-
   2  * Copyright (c) 2007 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  *    in this position and unchanged.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #include "test.h"
  28 __FBSDID("$FreeBSD$");
  29
  30 /*
  31  * A basic exercise of gzip reading and writing.
  32  *
  33  * TODO: Add a reference file and make sure we can decompress that.
  34  */
  35
  36 DEFINE_TEST(test_write_compress_gzip)
  37 {
  38         struct archive_entry *ae;
  39         struct archive* a;
  40         char *buff, *data;
  41         size_t buffsize, datasize;
  42         char path[16];
  43         size_t used1, used2;
  44         int i, r;
  45
  46         buffsize = 2000000;
  47         assert(NULL != (buff = (char *)malloc(buffsize)));
  48
  49         datasize = 10000;
  50         assert(NULL != (data = (char *)malloc(datasize)));
  51         memset(data, 0, datasize);
  52
  53         /*
  54          * Write a 100 files and read them all back.
  55          */
  56         assert((a = archive_write_new()) != NULL);
  57         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
  58         assertEqualIntA(a, ARCHIVE_OK,
  59             archive_write_set_compression_compress(a));
  60         r = archive_write_set_compression_gzip(a);
  61         if (r == ARCHIVE_FATAL) {
  62                 skipping("gzip writing not supported on this platform");
  63                 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
  64                 return;
  65         }
  66         assertEqualIntA(a, ARCHIVE_OK,
  67             archive_write_set_bytes_per_block(a, 10));
  68         assertEqualInt(ARCHIVE_COMPRESSION_GZIP, archive_compression(a));
  69         assertEqualString("gzip", archive_compression_name(a));
  70         assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used1));
  71         assertEqualInt(ARCHIVE_COMPRESSION_GZIP, archive_compression(a));
  72         assertEqualString("gzip", archive_compression_name(a));
  73         assert((ae = archive_entry_new()) != NULL);
  74         archive_entry_set_filetype(ae, AE_IFREG);
  75         archive_entry_set_size(ae, datasize);
  76         for (i = 0; i < 100; i++) {
  77                 sprintf(path, "file%03d", i);
  78                 archive_entry_copy_pathname(ae, path);
  79                 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
  80                 assertA(datasize
  81                     == (size_t)archive_write_data(a, data, datasize));
  82         }
  83         archive_entry_free(ae);
  84         assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
  85         assertEqualInt(ARCHIVE_OK, archive_write_free(a));
  86
  87         assert((a = archive_read_new()) != NULL);
  88         assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
  89         r = archive_read_support_filter_gzip(a);
  90         if (r == ARCHIVE_WARN) {
  91                 skipping("Can't verify gzip writing by reading back;"
  92                     " gzip reading not fully supported on this platform");
  93         } else {
  94                 assertEqualIntA(a, ARCHIVE_OK,
  95                     archive_read_open_memory(a, buff, used1));
  96                 for (i = 0; i < 100; i++) {
  97                         sprintf(path, "file%03d", i);
  98                         if (!assertEqualInt(ARCHIVE_OK,
  99                                 archive_read_next_header(a, &ae)))
 100                                 break;
 101                         assertEqualString(path, archive_entry_pathname(ae));
 102                         assertEqualInt((int)datasize, archive_entry_size(ae));
 103                 }
 104                 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
 105         }
 106         assertEqualInt(ARCHIVE_OK, archive_read_free(a));
 107
 108         /*
 109          * Repeat the cycle again, this time setting some compression
 110          * options.
 111          */
 112         assert((a = archive_write_new()) != NULL);
 113         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
 114         assertEqualIntA(a, ARCHIVE_OK,
 115             archive_write_set_bytes_per_block(a, 10));
 116         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_compression_gzip(a));
 117         assertEqualIntA(a, ARCHIVE_FAILED,
 118             archive_write_set_options(a, "gzip:nonexistent-option=0"));
 119         assertEqualIntA(a, ARCHIVE_OK,
 120             archive_write_set_options(a, "gzip:compression-level=0"));
 121         assertEqualIntA(a, ARCHIVE_OK,
 122             archive_write_set_filter_option(a, NULL, "compression-level", "9"));
 123         assertEqualIntA(a, ARCHIVE_FAILED,
 124             archive_write_set_filter_option(a, NULL, "compression-level", "abc"));
 125         assertEqualIntA(a, ARCHIVE_FAILED,
 126             archive_write_set_filter_option(a, NULL, "compression-level", "99"));
 127         assertEqualIntA(a, ARCHIVE_OK,
 128             archive_write_set_options(a, "gzip:compression-level=9"));
 129         assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));
 130         for (i = 0; i < 100; i++) {
 131                 sprintf(path, "file%03d", i);
 132                 assert((ae = archive_entry_new()) != NULL);
 133                 archive_entry_copy_pathname(ae, path);
 134                 archive_entry_set_size(ae, datasize);
 135                 archive_entry_set_filetype(ae, AE_IFREG);
 136                 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
 137                 assertA(datasize == (size_t)archive_write_data(a, data, datasize));
 138                 archive_entry_free(ae);
 139         }
 140         assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
 141         assertEqualInt(ARCHIVE_OK, archive_write_free(a));
 142
 143         /* Curiously, this test fails; the test data above compresses
 144          * better at default compression than at level 9. */
 145         /*
 146         failure("compression-level=9 wrote %d bytes, default wrote %d bytes",
 147             (int)used2, (int)used1);
 148         assert(used2 < used1);
 149         */
 150
 151         assert((a = archive_read_new()) != NULL);
 152         assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
 153         r = archive_read_support_filter_gzip(a);
 154         if (r == ARCHIVE_WARN) {
 155                 skipping("gzip reading not fully supported on this platform");
 156         } else {
 157                 assertEqualIntA(a, ARCHIVE_OK,
 158                     archive_read_support_filter_all(a));
 159                 assertEqualIntA(a, ARCHIVE_OK,
 160                     archive_read_open_memory(a, buff, used2));
 161                 for (i = 0; i < 100; i++) {
 162                         sprintf(path, "file%03d", i);
 163                         if (!assertEqualInt(ARCHIVE_OK,
 164                                 archive_read_next_header(a, &ae)))
 165                                 break;
 166                         assertEqualString(path, archive_entry_pathname(ae));
 167                         assertEqualInt((int)datasize, archive_entry_size(ae));
 168                 }
 169                 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
 170         }
 171         assertEqualInt(ARCHIVE_OK, archive_read_free(a));
 172
 173         /*
 174          * Repeat again, with much lower compression.
 175          */
 176         assert((a = archive_write_new()) != NULL);
 177         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
 178         assertEqualIntA(a, ARCHIVE_OK,
 179             archive_write_set_bytes_per_block(a, 10));
 180         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_compression_gzip(a));
 181         assertEqualIntA(a, ARCHIVE_OK,
 182             archive_write_set_filter_option(a, NULL, "compression-level", "0"));
 183         assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));
 184         for (i = 0; i < 100; i++) {
 185                 sprintf(path, "file%03d", i);
 186                 assert((ae = archive_entry_new()) != NULL);
 187                 archive_entry_copy_pathname(ae, path);
 188                 archive_entry_set_size(ae, datasize);
 189                 archive_entry_set_filetype(ae, AE_IFREG);
 190                 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
 191                 failure("Writing file %s", path);
 192                 assertEqualIntA(a, datasize,
 193                     (size_t)archive_write_data(a, data, datasize));
 194                 archive_entry_free(ae);
 195         }
 196         assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
 197         assertEqualInt(ARCHIVE_OK, archive_write_free(a));
 198
 199         /* Level 0 really does result in larger data. */
 200         failure("Compression-level=0 wrote %d bytes; default wrote %d bytes",
 201             (int)used2, (int)used1);
 202         assert(used2 > used1);
 203
 204         assert((a = archive_read_new()) != NULL);
 205         assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
 206         assertEqualIntA(a, ARCHIVE_OK, archive_read_support_filter_all(a));
 207         r = archive_read_support_filter_gzip(a);
 208         if (r == ARCHIVE_WARN) {
 209                 skipping("gzip reading not fully supported on this platform");
 210         } else {
 211                 assertEqualIntA(a, ARCHIVE_OK,
 212                     archive_read_open_memory(a, buff, used2));
 213                 for (i = 0; i < 100; i++) {
 214                         sprintf(path, "file%03d", i);
 215                         if (!assertEqualInt(ARCHIVE_OK,
 216                                 archive_read_next_header(a, &ae)))
 217                                 break;
 218                         assertEqualString(path, archive_entry_pathname(ae));
 219                         assertEqualInt((int)datasize, archive_entry_size(ae));
 220                 }
 221                 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
 222         }
 223         assertEqualInt(ARCHIVE_OK, archive_read_free(a));
 224
 225         /*
 226          * Test various premature shutdown scenarios to make sure we
 227          * don't crash or leak memory.
 228          */
 229         assert((a = archive_write_new()) != NULL);
 230         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_compression_gzip(a));
 231         assertEqualInt(ARCHIVE_OK, archive_write_free(a));
 232
 233         assert((a = archive_write_new()) != NULL);
 234         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_compression_gzip(a));
 235         assertEqualInt(ARCHIVE_OK, archive_write_close(a));
 236         assertEqualInt(ARCHIVE_OK, archive_write_free(a));
 237
 238         assert((a = archive_write_new()) != NULL);
 239         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
 240         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_compression_gzip(a));
 241         assertEqualInt(ARCHIVE_OK, archive_write_close(a));
 242         assertEqualInt(ARCHIVE_OK, archive_write_free(a));
 243
 244         assert((a = archive_write_new()) != NULL);
 245         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
 246         assertEqualIntA(a, ARCHIVE_OK, archive_write_set_compression_gzip(a));
 247         assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));
 248         assertEqualInt(ARCHIVE_OK, archive_write_close(a));
 249         assertEqualInt(ARCHIVE_OK, archive_write_free(a));
 250
 251         /*
 252          * Clean up.
 253          */
 254         free(data);
 255         free(buff);
 256 }