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
29 /*
30 * A basic exercise of gzip reading and writing.
31 *
32 * TODO: Add a reference file and make sure we can decompress that.
33 */
34
DEFINE_TEST(test_write_filter_gzip)35 DEFINE_TEST(test_write_filter_gzip)
36 {
37 struct archive_entry *ae;
38 struct archive* a;
39 char *buff, *data;
40 size_t buffsize, datasize;
41 unsigned char *rbuff;
42 char path[16];
43 size_t used1, used2;
44 int i, r, use_prog = 0;
45
46 buffsize = 2000000;
47 assert(NULL != (buff = malloc(buffsize)));
48 if (buff == NULL)
49 return;
50
51 datasize = 10000;
52 assert(NULL != (data = malloc(datasize)));
53 if (data == NULL) {
54 free(buff);
55 return;
56 }
57 memset(data, 0, datasize);
58
59 /*
60 * Write a 100 files and read them all back.
61 * Use default compression level (6).
62 */
63 assert((a = archive_write_new()) != NULL);
64 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
65 r = archive_write_add_filter_gzip(a);
66 if (r != ARCHIVE_OK) {
67 if (canGzip() && r == ARCHIVE_WARN)
68 use_prog = 1;
69 else {
70 skipping("gzip writing not supported on this platform");
71 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
72 free(buff);
73 free(data);
74 return;
75 }
76 }
77 assertEqualIntA(a, ARCHIVE_OK,
78 archive_write_set_bytes_per_block(a, 10));
79 assertEqualInt(ARCHIVE_FILTER_GZIP, archive_filter_code(a, 0));
80 assertEqualString("gzip", archive_filter_name(a, 0));
81 assertEqualIntA(a, ARCHIVE_OK,
82 archive_write_open_memory(a, buff, buffsize, &used1));
83 assert((ae = archive_entry_new()) != NULL);
84 archive_entry_set_filetype(ae, AE_IFREG);
85 archive_entry_set_size(ae, datasize);
86 for (i = 0; i < 100; i++) {
87 snprintf(path, sizeof(path), "file%03d", i);
88 archive_entry_copy_pathname(ae, path);
89 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
90 assertA(datasize
91 == (size_t)archive_write_data(a, data, datasize));
92 }
93 archive_entry_free(ae);
94 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
95 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
96
97 /* Basic gzip header tests */
98 rbuff = (unsigned char *)buff;
99 assertEqualInt(rbuff[0], 0x1f);
100 assertEqualInt(rbuff[1], 0x8b);
101 assertEqualInt(rbuff[2], 0x08);
102 assertEqualInt(rbuff[3], 0x00);
103 assertEqualInt(rbuff[8], 0); /* RFC 1952 flag for compression level 6 */
104
105 assert((a = archive_read_new()) != NULL);
106 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
107 r = archive_read_support_filter_gzip(a);
108 if (r == ARCHIVE_WARN) {
109 skipping("Can't verify gzip writing by reading back;"
110 " gzip reading not fully supported on this platform");
111 } else {
112 assertEqualIntA(a, ARCHIVE_OK,
113 archive_read_open_memory(a, buff, used1));
114 for (i = 0; i < 100; i++) {
115 snprintf(path, sizeof(path), "file%03d", i);
116 if (!assertEqualInt(ARCHIVE_OK,
117 archive_read_next_header(a, &ae)))
118 break;
119 assertEqualString(path, archive_entry_pathname(ae));
120 assertEqualInt((int)datasize, archive_entry_size(ae));
121 }
122 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
123 }
124 assertEqualInt(ARCHIVE_OK, archive_read_free(a));
125
126 /*
127 * Repeat the cycle again, this time setting some compression
128 * options. Compression level is 9.
129 */
130 assert((a = archive_write_new()) != NULL);
131 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
132 assertEqualIntA(a, ARCHIVE_OK,
133 archive_write_set_bytes_per_block(a, 10));
134 assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
135 archive_write_add_filter_gzip(a));
136 assertEqualIntA(a, ARCHIVE_FAILED,
137 archive_write_set_options(a, "gzip:nonexistent-option=0"));
138 assertEqualIntA(a, ARCHIVE_OK,
139 archive_write_set_options(a, "gzip:compression-level=1"));
140 assertEqualIntA(a, ARCHIVE_OK,
141 archive_write_set_filter_option(a, NULL, "compression-level", "9"));
142 assertEqualIntA(a, ARCHIVE_FAILED,
143 archive_write_set_filter_option(a, NULL, "compression-level", "abc"));
144 assertEqualIntA(a, ARCHIVE_FAILED,
145 archive_write_set_filter_option(a, NULL, "compression-level", "99"));
146 assertEqualIntA(a, ARCHIVE_OK,
147 archive_write_set_options(a, "gzip:compression-level=9"));
148 assertEqualIntA(a, ARCHIVE_OK,
149 archive_write_set_options(a, "gzip:original-filename=testorgfilename"));
150 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));
151 for (i = 0; i < 100; i++) {
152 snprintf(path, sizeof(path), "file%03d", i);
153 assert((ae = archive_entry_new()) != NULL);
154 archive_entry_copy_pathname(ae, path);
155 archive_entry_set_size(ae, datasize);
156 archive_entry_set_filetype(ae, AE_IFREG);
157 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
158 assertA(datasize == (size_t)archive_write_data(a, data, datasize));
159 archive_entry_free(ae);
160 }
161 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
162 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
163
164 /* Basic gzip header tests */
165 rbuff = (unsigned char *)buff;
166 assertEqualInt(rbuff[0], 0x1f);
167 assertEqualInt(rbuff[1], 0x8b);
168 assertEqualInt(rbuff[2], 0x08);
169 /* RFC 1952 flag for compression level 9 */
170 assertEqualInt(rbuff[8], 2);
171 /* External gzip program might not save filename */
172 if (!use_prog || rbuff[3] == 0x08) {
173 assertEqualInt(rbuff[3], 0x08);
174 assertEqualString((const char*)rbuff+10, "testorgfilename");
175 } else {
176 assertEqualInt(rbuff[3], 0x00);
177 }
178
179 /* Curiously, this test fails; the test data above compresses
180 * better at default compression than at level 9. */
181 /*
182 failure("compression-level=9 wrote %d bytes, default wrote %d bytes",
183 (int)used2, (int)used1);
184 assert(used2 < used1);
185 */
186
187 assert((a = archive_read_new()) != NULL);
188 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
189 r = archive_read_support_filter_gzip(a);
190 if (r != ARCHIVE_OK && !use_prog) {
191 skipping("gzip reading not fully supported on this platform");
192 } else {
193 assertEqualIntA(a, ARCHIVE_OK,
194 archive_read_support_filter_all(a));
195 assertEqualIntA(a, ARCHIVE_OK,
196 archive_read_open_memory(a, buff, used2));
197 for (i = 0; i < 100; i++) {
198 snprintf(path, sizeof(path), "file%03d", i);
199 if (!assertEqualInt(ARCHIVE_OK,
200 archive_read_next_header(a, &ae)))
201 break;
202 assertEqualString(path, archive_entry_pathname(ae));
203 assertEqualInt((int)datasize, archive_entry_size(ae));
204 }
205 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
206 }
207 assertEqualInt(ARCHIVE_OK, archive_read_free(a));
208
209 /*
210 * Repeat again, with compression level 1
211 */
212 assert((a = archive_write_new()) != NULL);
213 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
214 assertEqualIntA(a, ARCHIVE_OK,
215 archive_write_set_bytes_per_block(a, 10));
216 assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
217 archive_write_add_filter_gzip(a));
218 assertEqualIntA(a, ARCHIVE_OK,
219 archive_write_set_filter_option(a, NULL, "compression-level", "1"));
220 assertEqualIntA(a, ARCHIVE_OK,
221 archive_write_open_memory(a, buff, buffsize, &used2));
222 for (i = 0; i < 100; i++) {
223 snprintf(path, sizeof(path), "file%03d", i);
224 assert((ae = archive_entry_new()) != NULL);
225 archive_entry_copy_pathname(ae, path);
226 archive_entry_set_size(ae, datasize);
227 archive_entry_set_filetype(ae, AE_IFREG);
228 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
229 failure("Writing file %s", path);
230 assertEqualIntA(a, datasize,
231 (size_t)archive_write_data(a, data, datasize));
232 archive_entry_free(ae);
233 }
234 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
235 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
236
237 /* Level 1 really does result in larger data. */
238 failure("Compression-level=1 wrote %d bytes; default wrote %d bytes",
239 (int)used2, (int)used1);
240 assert(used2 > used1);
241
242 /* Basic gzip header tests */
243 rbuff = (unsigned char *)buff;
244 assertEqualInt(rbuff[0], 0x1f);
245 assertEqualInt(rbuff[1], 0x8b);
246 assertEqualInt(rbuff[2], 0x08);
247 assertEqualInt(rbuff[3], 0x00);
248 assertEqualInt(rbuff[8], 4); /* RFC 1952 flag for compression level 1 */
249
250 assert((a = archive_read_new()) != NULL);
251 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
252 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_filter_all(a));
253 r = archive_read_support_filter_gzip(a);
254 if (r == ARCHIVE_WARN) {
255 skipping("gzip reading not fully supported on this platform");
256 } else {
257 assertEqualIntA(a, ARCHIVE_OK,
258 archive_read_open_memory(a, buff, used2));
259 for (i = 0; i < 100; i++) {
260 snprintf(path, sizeof(path), "file%03d", i);
261 if (!assertEqualInt(ARCHIVE_OK,
262 archive_read_next_header(a, &ae)))
263 break;
264 assertEqualString(path, archive_entry_pathname(ae));
265 assertEqualInt((int)datasize, archive_entry_size(ae));
266 }
267 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
268 }
269 assertEqualInt(ARCHIVE_OK, archive_read_free(a));
270
271 /*
272 * Test various premature shutdown scenarios to make sure we
273 * don't crash or leak memory.
274 */
275 assert((a = archive_write_new()) != NULL);
276 assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
277 archive_write_add_filter_gzip(a));
278 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
279
280 assert((a = archive_write_new()) != NULL);
281 assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
282 archive_write_add_filter_gzip(a));
283 assertEqualInt(ARCHIVE_OK, archive_write_close(a));
284 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
285
286 assert((a = archive_write_new()) != NULL);
287 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
288 assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
289 archive_write_add_filter_gzip(a));
290 assertEqualInt(ARCHIVE_OK, archive_write_close(a));
291 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
292
293 assert((a = archive_write_new()) != NULL);
294 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
295 assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
296 archive_write_add_filter_gzip(a));
297 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));
298 assertEqualInt(ARCHIVE_OK, archive_write_close(a));
299 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
300
301 /*
302 * Clean up.
303 */
304 free(data);
305 free(buff);
306 }
307