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