1 /*-
2  * Copyright (c) 2012 Michihiro NAKAJIMA
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  * A basic exercise of lzop reading and writing.
30  */
31 
32 DEFINE_TEST(test_write_filter_lzop)
33 {
34 	struct archive_entry *ae;
35 	struct archive* a;
36 	char *buff, *data;
37 	size_t buffsize, datasize;
38 	char path[16];
39 	size_t used1, used2;
40 	int i, r, use_prog = 0, filecount;
41 
42 	assert((a = archive_write_new()) != NULL);
43 	r = archive_write_add_filter_lzop(a);
44 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
45 	if (r != ARCHIVE_OK) {
46 		if (canLzop() && r == ARCHIVE_WARN)
47 			use_prog = 1;
48 		else {
49 			skipping("lzop writing not supported on this platform");
50 			return;
51 		}
52 	}
53 
54 	buffsize = 2000000;
55 	assert(NULL != (buff = (char *)malloc(buffsize)));
56 
57 	datasize = 10000;
58 	assert(NULL != (data = (char *)calloc(datasize, 1)));
59 	filecount = 10;
60 
61 	/*
62 	 * Write a filecount files and read them all back.
63 	 */
64 	assert((a = archive_write_new()) != NULL);
65 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
66 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
67 	    archive_write_add_filter_lzop(a));
68 	assertEqualIntA(a, ARCHIVE_OK,
69 	    archive_write_set_bytes_per_block(a, 1024));
70 	assertEqualIntA(a, ARCHIVE_OK,
71 	    archive_write_set_bytes_in_last_block(a, 1024));
72 	assertEqualInt(ARCHIVE_FILTER_LZOP, archive_filter_code(a, 0));
73 	assertEqualString("lzop", archive_filter_name(a, 0));
74 	assertEqualIntA(a, ARCHIVE_OK,
75 	    archive_write_open_memory(a, buff, buffsize, &used1));
76 	assert((ae = archive_entry_new()) != NULL);
77 	archive_entry_set_filetype(ae, AE_IFREG);
78 	archive_entry_set_size(ae, datasize);
79 	for (i = 0; i < filecount; i++) {
80 		snprintf(path, sizeof(path), "file%03d", i);
81 		archive_entry_copy_pathname(ae, path);
82 		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
83 		assertA(datasize
84 		    == (size_t)archive_write_data(a, data, datasize));
85 	}
86 	archive_entry_free(ae);
87 	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
88 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
89 
90 	assert((a = archive_read_new()) != NULL);
91 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
92 	r = archive_read_support_filter_lzop(a);
93 	if (r == ARCHIVE_WARN && !use_prog) {
94 		skipping("Can't verify lzop writing by reading back;"
95 		    " lzop reading not fully supported on this platform");
96 	} else {
97 		assertEqualIntA(a, ARCHIVE_OK,
98 		    archive_read_open_memory(a, buff, used1));
99 		for (i = 0; i < filecount; i++) {
100 			snprintf(path, sizeof(path), "file%03d", i);
101 			if (!assertEqualInt(ARCHIVE_OK,
102 				archive_read_next_header(a, &ae)))
103 				break;
104 			assertEqualString(path, archive_entry_pathname(ae));
105 			assertEqualInt((int)datasize, archive_entry_size(ae));
106 		}
107 		assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
108 	}
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 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
120 	    archive_write_add_filter_lzop(a));
121 	assertEqualIntA(a, ARCHIVE_FAILED,
122 	    archive_write_set_options(a, "lzop:nonexistent-option=0"));
123 	assertEqualIntA(a, ARCHIVE_OK,
124 	    archive_write_set_options(a, "lzop:compression-level=1"));
125 	assertEqualIntA(a, ARCHIVE_OK,
126 	    archive_write_set_filter_option(a, NULL, "compression-level", "9"));
127 	assertEqualIntA(a, ARCHIVE_FAILED,
128 	    archive_write_set_filter_option(a, NULL, "compression-level", "abc"));
129 	assertEqualIntA(a, ARCHIVE_FAILED,
130 	    archive_write_set_filter_option(a, NULL, "compression-level", "99"));
131 	assertEqualIntA(a, ARCHIVE_OK,
132 	    archive_write_set_options(a, "lzop:compression-level=9"));
133 	assertEqualIntA(a, ARCHIVE_OK,
134 	    archive_write_open_memory(a, buff, buffsize, &used2));
135 	for (i = 0; i < filecount; i++) {
136 		snprintf(path, sizeof(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(
143 		    a, data, 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 	failure("compression-level=9 wrote %d bytes, default wrote %d bytes",
150 	    (int)used2, (int)used1);
151 	assert(used2 < used1);
152 
153 	assert((a = archive_read_new()) != NULL);
154 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
155 	r = archive_read_support_filter_lzop(a);
156 	if (r != ARCHIVE_OK && !use_prog) {
157 		skipping("lzop reading not fully supported on this platform");
158 	} else {
159 		assertEqualIntA(a, ARCHIVE_OK,
160 		    archive_read_support_filter_all(a));
161 		assertEqualIntA(a, ARCHIVE_OK,
162 		    archive_read_open_memory(a, buff, used2));
163 		for (i = 0; i < filecount; i++) {
164 			snprintf(path, sizeof(path), "file%03d", i);
165 			if (!assertEqualInt(ARCHIVE_OK,
166 				archive_read_next_header(a, &ae)))
167 				break;
168 			assertEqualString(path, archive_entry_pathname(ae));
169 			assertEqualInt((int)datasize, archive_entry_size(ae));
170 		}
171 		assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
172 	}
173 	assertEqualInt(ARCHIVE_OK, archive_read_free(a));
174 
175 	/*
176 	 * Repeat again, with much lower compression.
177 	 */
178 	assert((a = archive_write_new()) != NULL);
179 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
180 	assertEqualIntA(a, ARCHIVE_OK,
181 	    archive_write_set_bytes_per_block(a, 10));
182 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
183 	    archive_write_add_filter_lzop(a));
184 	assertEqualIntA(a, ARCHIVE_OK,
185 	    archive_write_set_filter_option(a, NULL, "compression-level", "1"));
186 	assertEqualIntA(a, ARCHIVE_OK,
187 	    archive_write_open_memory(a, buff, buffsize, &used2));
188 	for (i = 0; i < filecount; i++) {
189 		snprintf(path, sizeof(path), "file%03d", i);
190 		assert((ae = archive_entry_new()) != NULL);
191 		archive_entry_copy_pathname(ae, path);
192 		archive_entry_set_size(ae, datasize);
193 		archive_entry_set_filetype(ae, AE_IFREG);
194 		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
195 		failure("Writing file %s", path);
196 		assertEqualIntA(a, datasize,
197 		    (size_t)archive_write_data(a, data, datasize));
198 		archive_entry_free(ae);
199 	}
200 	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
201 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
202 
203 #if 0
204 	failure("Compression-level=1 wrote %d bytes; default wrote %d bytes",
205 	    (int)used2, (int)used1);
206 	assert(used2 > used1);
207 #endif
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 	r = archive_read_support_filter_lzop(a);
213 	if (r == ARCHIVE_WARN && !use_prog) {
214 		skipping("lzop reading not fully supported on this platform");
215 	} else {
216 		assertEqualIntA(a, ARCHIVE_OK,
217 		    archive_read_open_memory(a, buff, used2));
218 		for (i = 0; i < filecount; i++) {
219 			snprintf(path, sizeof(path), "file%03d", i);
220 			if (!assertEqualInt(ARCHIVE_OK,
221 				archive_read_next_header(a, &ae)))
222 				break;
223 			assertEqualString(path, archive_entry_pathname(ae));
224 			assertEqualInt((int)datasize, archive_entry_size(ae));
225 		}
226 		assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
227 	}
228 	assertEqualInt(ARCHIVE_OK, archive_read_free(a));
229 
230 	/*
231 	 * Test various premature shutdown scenarios to make sure we
232 	 * don't crash or leak memory.
233 	 */
234 	assert((a = archive_write_new()) != NULL);
235 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
236 	    archive_write_add_filter_lzop(a));
237 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
238 
239 	assert((a = archive_write_new()) != NULL);
240 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
241 	    archive_write_add_filter_lzop(a));
242 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
243 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
244 
245 	assert((a = archive_write_new()) != NULL);
246 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
247 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
248 	    archive_write_add_filter_lzop(a));
249 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
250 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
251 
252 	assert((a = archive_write_new()) != NULL);
253 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
254 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
255 	    archive_write_add_filter_lzop(a));
256 	assertEqualIntA(a, ARCHIVE_OK,
257 	    archive_write_open_memory(a, buff, buffsize, &used2));
258 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
259 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
260 
261 	/*
262 	 * Clean up.
263 	 */
264 	free(data);
265 	free(buff);
266 }
267