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: head/lib/libarchive/test/test_write_compress_bzip2.c 191183 2009-04-17 01:06:31Z kientzle $");
29 
30 /*
31  * A basic exercise of bzip2 reading and writing.
32  *
33  * TODO: Add a reference file and make sure we can decompress that.
34  */
35 
36 DEFINE_TEST(test_write_filter_bzip2)
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, use_prog;
45 
46 	buffsize = 2000000;
47 	assert(NULL != (buff = (char *)malloc(buffsize)));
48 	if (buff == NULL)
49 		return;
50 
51 	datasize = 10000;
52 	assert(NULL != (data = (char *)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 	 */
62 	assert((a = archive_write_new()) != NULL);
63 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
64 	r = archive_write_add_filter_bzip2(a);
65 	use_prog = (r == ARCHIVE_WARN && canBzip2());
66 	if (r != ARCHIVE_OK && !use_prog) {
67 		skipping("bzip2 writing not supported on this platform");
68 		assertEqualInt(ARCHIVE_OK, archive_write_free(a));
69 		free(buff);
70 		free(data);
71 		return;
72 	}
73 
74 	assertEqualIntA(a, ARCHIVE_OK,
75 	    archive_write_set_bytes_per_block(a, 10));
76 	assertEqualInt(ARCHIVE_FILTER_BZIP2, archive_filter_code(a, 0));
77 	assertEqualString("bzip2", archive_filter_name(a, 0));
78 	assertEqualIntA(a, ARCHIVE_OK,
79 	    archive_write_open_memory(a, buff, buffsize, &used1));
80 	assertEqualInt(ARCHIVE_FILTER_BZIP2, archive_filter_code(a, 0));
81 	assertEqualString("bzip2", archive_filter_name(a, 0));
82 	assert((ae = archive_entry_new()) != NULL);
83 	archive_entry_set_filetype(ae, AE_IFREG);
84 	archive_entry_set_size(ae, datasize);
85 	for (i = 0; i < 999; i++) {
86 		sprintf(path, "file%03d", i);
87 		archive_entry_copy_pathname(ae, path);
88 		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
89 		assertA(datasize
90 		    == (size_t)archive_write_data(a, data, datasize));
91 	}
92 	archive_entry_free(ae);
93 	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
94 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
95 
96 	assert((a = archive_read_new()) != NULL);
97 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
98 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_filter_all(a));
99 	assertEqualIntA(a, ARCHIVE_OK,
100 	    archive_read_open_memory(a, buff, used1));
101 	for (i = 0; i < 999; i++) {
102 		sprintf(path, "file%03d", i);
103 		if (!assertEqualInt(0, archive_read_next_header(a, &ae)))
104 			break;
105 		assertEqualString(path, archive_entry_pathname(ae));
106 		assertEqualInt((int)datasize, archive_entry_size(ae));
107 	}
108 	assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
109 	assertEqualInt(ARCHIVE_OK, archive_read_free(a));
110 
111 	/*
112 	 * Repeat the cycle again, this time setting some compression
113 	 * options.
114 	 */
115 	assert((a = archive_write_new()) != NULL);
116 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
117 	assertEqualIntA(a, ARCHIVE_OK,
118 	    archive_write_set_bytes_per_block(a, 10));
119 	if (use_prog)
120 		assertEqualIntA(a, ARCHIVE_WARN,
121 		    archive_write_add_filter_bzip2(a));
122 	else
123 		assertEqualIntA(a, ARCHIVE_OK,
124 		    archive_write_add_filter_bzip2(a));
125 	assertEqualIntA(a, ARCHIVE_FAILED, archive_write_set_filter_option(a,
126 	    NULL, "nonexistent-option", "0"));
127 	assertEqualIntA(a, ARCHIVE_FAILED, archive_write_set_filter_option(a,
128 	    NULL, "compression-level", "abc"));
129 	assertEqualIntA(a, ARCHIVE_FAILED, archive_write_set_filter_option(a,
130 	    NULL, "compression-level", "99"));
131 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_filter_option(a,
132 	    NULL, "compression-level", "9"));
133 	assertEqualIntA(a, ARCHIVE_OK,
134 	    archive_write_open_memory(a, buff, buffsize, &used2));
135 	for (i = 0; i < 999; i++) {
136 		sprintf(path, "file%03d", i);
137 		assert((ae = archive_entry_new()) != NULL);
138 		archive_entry_copy_pathname(ae, path);
139 		archive_entry_set_size(ae, datasize);
140 		archive_entry_set_filetype(ae, AE_IFREG);
141 		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
142 		assertA(datasize == (size_t)archive_write_data(a, data,
143 		    datasize));
144 		archive_entry_free(ae);
145 	}
146 	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
147 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
148 
149 	/* Curiously, this test fails; the test data above compresses
150 	 * better at default compression than at level 9. */
151 	/*
152 	failure("compression-level=9 wrote %d bytes, default wrote %d bytes",
153 	    (int)used2, (int)used1);
154 	assert(used2 < used1);
155 	*/
156 
157 	assert((a = archive_read_new()) != NULL);
158 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
159 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_filter_all(a));
160 	assertEqualIntA(a, ARCHIVE_OK,
161 	    archive_read_open_memory(a, buff, used2));
162 	for (i = 0; i < 999; i++) {
163 		sprintf(path, "file%03d", i);
164 		if (!assertEqualInt(0, 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 	assertEqualInt(ARCHIVE_OK, archive_read_free(a));
171 
172 	/*
173 	 * Repeat again, with much lower compression.
174 	 */
175 	assert((a = archive_write_new()) != NULL);
176 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
177 	assertEqualIntA(a, ARCHIVE_OK,
178 	    archive_write_set_bytes_per_block(a, 10));
179 	if (use_prog)
180 		assertEqualIntA(a, ARCHIVE_WARN,
181 		    archive_write_add_filter_bzip2(a));
182 	else
183 		assertEqualIntA(a, ARCHIVE_OK,
184 		    archive_write_add_filter_bzip2(a));
185 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_filter_option(a,
186 	    NULL, "compression-level", "1"));
187 	assertEqualIntA(a, ARCHIVE_OK,
188 	    archive_write_open_memory(a, buff, buffsize, &used2));
189 	for (i = 0; i < 999; i++) {
190 		sprintf(path, "file%03d", i);
191 		assert((ae = archive_entry_new()) != NULL);
192 		archive_entry_copy_pathname(ae, path);
193 		archive_entry_set_size(ae, datasize);
194 		archive_entry_set_filetype(ae, AE_IFREG);
195 		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
196 		failure("Writing file %s", path);
197 		assertEqualIntA(a, datasize,
198 		    (size_t)archive_write_data(a, data, datasize));
199 		archive_entry_free(ae);
200 	}
201 	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
202 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
203 
204 	/* Level 0 really does result in larger data. */
205 	failure("Compression-level=0 wrote %d bytes; default wrote %d bytes",
206 	    (int)used2, (int)used1);
207 	assert(used2 > used1);
208 
209 	assert((a = archive_read_new()) != NULL);
210 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
211 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_filter_all(a));
212 	assertEqualIntA(a, ARCHIVE_OK,
213 	    archive_read_open_memory(a, buff, used2));
214 	for (i = 0; i < 999; i++) {
215 		sprintf(path, "file%03d", i);
216 		if (!assertEqualInt(0, 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 	assertEqualInt(ARCHIVE_OK, archive_read_free(a));
223 
224 	/*
225 	 * Test various premature shutdown scenarios to make sure we
226 	 * don't crash or leak memory.
227 	 */
228 	assert((a = archive_write_new()) != NULL);
229 	if (use_prog)
230 		assertEqualIntA(a, ARCHIVE_WARN,
231 		    archive_write_add_filter_bzip2(a));
232 	else
233 		assertEqualIntA(a, ARCHIVE_OK,
234 		    archive_write_add_filter_bzip2(a));
235 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
236 
237 	assert((a = archive_write_new()) != NULL);
238 	if (use_prog)
239 		assertEqualIntA(a, ARCHIVE_WARN,
240 		    archive_write_add_filter_bzip2(a));
241 	else
242 		assertEqualIntA(a, ARCHIVE_OK,
243 		    archive_write_add_filter_bzip2(a));
244 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
245 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
246 
247 	assert((a = archive_write_new()) != NULL);
248 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
249 	if (use_prog)
250 		assertEqualIntA(a, ARCHIVE_WARN,
251 		    archive_write_add_filter_bzip2(a));
252 	else
253 		assertEqualIntA(a, ARCHIVE_OK,
254 		    archive_write_add_filter_bzip2(a));
255 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
256 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
257 
258 	assert((a = archive_write_new()) != NULL);
259 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
260 	if (use_prog)
261 		assertEqualIntA(a, ARCHIVE_WARN,
262 		    archive_write_add_filter_bzip2(a));
263 	else
264 		assertEqualIntA(a, ARCHIVE_OK,
265 		    archive_write_add_filter_bzip2(a));
266 	assertEqualIntA(a, ARCHIVE_OK,
267 	    archive_write_open_memory(a, buff, buffsize, &used2));
268 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
269 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
270 
271 	/*
272 	 * Clean up.
273 	 */
274 	free(data);
275 	free(buff);
276 }
277