1 /*- 2 * Copyright (c) 2017 Sean Purcell 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 DEFINE_TEST(test_write_filter_zstd) 31 { 32 struct archive_entry *ae; 33 struct archive *a; 34 char *buff, *data; 35 size_t buffsize, datasize; 36 char path[16]; 37 size_t used1, used2, used3; 38 int i, r; 39 40 buffsize = 2000000; 41 assert(NULL != (buff = (char *)malloc(buffsize))); 42 if (buff == NULL) 43 return; 44 45 datasize = 10000; 46 assert(NULL != (data = (char *)malloc(datasize))); 47 if (data == NULL) { 48 free(buff); 49 return; 50 } 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 r = archive_write_add_filter_zstd(a); 59 if (r != ARCHIVE_OK) { 60 skipping("zstd writing not supported on this platform"); 61 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 62 free(buff); 63 free(data); 64 return; 65 } 66 assertEqualIntA(a, ARCHIVE_OK, 67 archive_write_set_bytes_per_block(a, 10)); 68 assertEqualInt(ARCHIVE_FILTER_ZSTD, archive_filter_code(a, 0)); 69 assertEqualString("zstd", archive_filter_name(a, 0)); 70 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used1)); 71 assertEqualInt(ARCHIVE_FILTER_ZSTD, archive_filter_code(a, 0)); 72 assertEqualString("zstd", archive_filter_name(a, 0)); 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 snprintf(path, sizeof(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_zstd(a); 90 if (r == ARCHIVE_WARN) { 91 skipping("Can't verify zstd writing by reading back;" 92 " zstd reading not fully supported on this platform"); 93 } else { 94 assertEqualIntA(a, ARCHIVE_OK, 95 archive_read_support_filter_all(a)); 96 assertEqualIntA(a, ARCHIVE_OK, 97 archive_read_open_memory(a, buff, used1)); 98 for (i = 0; i < 100; i++) { 99 snprintf(path, sizeof(path), "file%03d", i); 100 if (!assertEqualInt(ARCHIVE_OK, 101 archive_read_next_header(a, &ae))) 102 break; 103 assertEqualString(path, archive_entry_pathname(ae)); 104 assertEqualInt((int)datasize, archive_entry_size(ae)); 105 } 106 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a)); 107 } 108 assertEqualInt(ARCHIVE_OK, archive_read_free(a)); 109 110 /* 111 * Repeat the cycle again, this time setting some compression 112 * options. 113 */ 114 assert((a = archive_write_new()) != NULL); 115 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a)); 116 assertEqualIntA(a, ARCHIVE_OK, 117 archive_write_set_bytes_per_block(a, 10)); 118 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 119 assertEqualIntA(a, ARCHIVE_FAILED, 120 archive_write_set_filter_option(a, NULL, "nonexistent-option", "0")); 121 assertEqualIntA(a, ARCHIVE_FAILED, 122 archive_write_set_filter_option(a, NULL, "compression-level", "abc")); 123 assertEqualIntA(a, ARCHIVE_FAILED, 124 archive_write_set_filter_option(a, NULL, "compression-level", "25")); /* too big */ 125 assertEqualIntA(a, ARCHIVE_OK, 126 archive_write_set_filter_option(a, NULL, "compression-level", "9")); 127 /* Following is disabled as it will fail on library versions < 1.3.4 */ 128 /* assertEqualIntA(a, ARCHIVE_OK, 129 archive_write_set_filter_option(a, NULL, "compression-level", "-1")); */ 130 assertEqualIntA(a, ARCHIVE_OK, 131 archive_write_set_filter_option(a, NULL, "compression-level", "7")); 132 assertEqualIntA(a, ARCHIVE_FAILED, 133 archive_write_set_filter_option(a, NULL, "threads", "-1")); /* negative */ 134 assertEqualIntA(a, ARCHIVE_OK, 135 archive_write_set_filter_option(a, NULL, "threads", "4")); 136 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2)); 137 for (i = 0; i < 100; i++) { 138 snprintf(path, sizeof(path), "file%03d", i); 139 assert((ae = archive_entry_new()) != NULL); 140 archive_entry_copy_pathname(ae, path); 141 archive_entry_set_size(ae, datasize); 142 archive_entry_set_filetype(ae, AE_IFREG); 143 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae)); 144 assertA(datasize == (size_t)archive_write_data(a, data, datasize)); 145 archive_entry_free(ae); 146 } 147 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a)); 148 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 149 150 assert((a = archive_read_new()) != NULL); 151 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a)); 152 r = archive_read_support_filter_zstd(a); 153 if (r == ARCHIVE_WARN) { 154 skipping("zstd reading not fully supported on this platform"); 155 } else { 156 assertEqualIntA(a, ARCHIVE_OK, 157 archive_read_support_filter_all(a)); 158 assertEqualIntA(a, ARCHIVE_OK, 159 archive_read_open_memory(a, buff, used2)); 160 for (i = 0; i < 100; i++) { 161 snprintf(path, sizeof(path), "file%03d", i); 162 failure("Trying to read %s", path); 163 if (!assertEqualIntA(a, 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 * One more time at level 1 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_add_filter_zstd(a)); 181 assertEqualIntA(a, ARCHIVE_OK, 182 archive_write_set_filter_option(a, NULL, "compression-level", "1")); 183 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used3)); 184 assert((ae = archive_entry_new()) != NULL); 185 archive_entry_set_filetype(ae, AE_IFREG); 186 archive_entry_set_size(ae, datasize); 187 for (i = 0; i < 100; i++) { 188 snprintf(path, sizeof(path), "file%03d", i); 189 archive_entry_copy_pathname(ae, path); 190 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae)); 191 assertA(datasize == (size_t)archive_write_data(a, data, datasize)); 192 } 193 archive_entry_free(ae); 194 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a)); 195 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 196 197 assert((a = archive_read_new()) != NULL); 198 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a)); 199 r = archive_read_support_filter_zstd(a); 200 if (r == ARCHIVE_WARN) { 201 skipping("zstd reading not fully supported on this platform"); 202 } else { 203 assertEqualIntA(a, ARCHIVE_OK, 204 archive_read_support_filter_all(a)); 205 assertEqualIntA(a, ARCHIVE_OK, 206 archive_read_open_memory(a, buff, used3)); 207 for (i = 0; i < 100; i++) { 208 snprintf(path, sizeof(path), "file%03d", i); 209 failure("Trying to read %s", path); 210 if (!assertEqualIntA(a, ARCHIVE_OK, 211 archive_read_next_header(a, &ae))) 212 break; 213 assertEqualString(path, archive_entry_pathname(ae)); 214 assertEqualInt((int)datasize, archive_entry_size(ae)); 215 } 216 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a)); 217 } 218 assertEqualInt(ARCHIVE_OK, archive_read_free(a)); 219 220 /* 221 * Check output sizes for various compression levels, expectation 222 * is that archive size for level=7 < default < level=1 223 */ 224 failure("compression-level=7 wrote %d bytes, default wrote %d bytes", 225 (int)used2, (int)used1); 226 assert(used2 < used1); 227 failure("compression-level=1 wrote %d bytes, default wrote %d bytes", 228 (int)used3, (int)used1); 229 assert(used1 < used3); 230 231 /* 232 * Test various premature shutdown scenarios to make sure we 233 * don't crash or leak memory. 234 */ 235 assert((a = archive_write_new()) != NULL); 236 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 237 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 238 239 assert((a = archive_write_new()) != NULL); 240 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(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_add_filter_zstd(a)); 247 assertEqualInt(ARCHIVE_OK, archive_write_close(a)); 248 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 249 250 assert((a = archive_write_new()) != NULL); 251 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a)); 252 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 253 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2)); 254 assertEqualInt(ARCHIVE_OK, archive_write_close(a)); 255 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 256 257 /* 258 * Clean up. 259 */ 260 free(data); 261 free(buff); 262 } 263