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;
43 
44 	assert((a = archive_write_new()) != NULL);
45 	r = archive_write_add_filter_lzop(a);
46 	if (r != ARCHIVE_OK) {
47 		if (canLzop() && r == ARCHIVE_WARN)
48 			use_prog = 1;
49 		else {
50 			skipping("lzop writing not supported on this platform");
51 			assertEqualInt(ARCHIVE_OK, archive_write_free(a));
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 
62 	/*
63 	 * Write a 100 files and read them all back.
64 	 */
65 	assert((a = archive_write_new()) != NULL);
66 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
67 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
68 	    archive_write_add_filter_lzop(a));
69 	assertEqualIntA(a, ARCHIVE_OK,
70 	    archive_write_set_bytes_per_block(a, 1024));
71 	assertEqualIntA(a, ARCHIVE_OK,
72 	    archive_write_set_bytes_in_last_block(a, 1024));
73 	assertEqualInt(ARCHIVE_FILTER_LZOP, archive_filter_code(a, 0));
74 	assertEqualString("lzop", archive_filter_name(a, 0));
75 	assertEqualIntA(a, ARCHIVE_OK,
76 	    archive_write_open_memory(a, buff, buffsize, &used1));
77 	assert((ae = archive_entry_new()) != NULL);
78 	archive_entry_set_filetype(ae, AE_IFREG);
79 	archive_entry_set_size(ae, datasize);
80 	for (i = 0; i < 100; i++) {
81 		sprintf(path, "file%03d", i);
82 		archive_entry_copy_pathname(ae, path);
83 		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
84 		assertA(datasize
85 		    == (size_t)archive_write_data(a, data, datasize));
86 	}
87 	archive_entry_free(ae);
88 	assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
89 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
90 
91 	assert((a = archive_read_new()) != NULL);
92 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
93 	r = archive_read_support_filter_lzop(a);
94 	if (r == ARCHIVE_WARN) {
95 		skipping("Can't verify lzop writing by reading back;"
96 		    " lzop reading not fully supported on this platform");
97 	} else {
98 		assertEqualIntA(a, ARCHIVE_OK,
99 		    archive_read_open_memory(a, buff, used1));
100 		for (i = 0; i < 100; i++) {
101 			sprintf(path, "file%03d", i);
102 			if (!assertEqualInt(ARCHIVE_OK,
103 				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 	}
110 	assertEqualInt(ARCHIVE_OK, archive_read_free(a));
111 
112 	/*
113 	 * Repeat the cycle again, this time setting some compression
114 	 * options.
115 	 */
116 	assert((a = archive_write_new()) != NULL);
117 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
118 	assertEqualIntA(a, ARCHIVE_OK,
119 	    archive_write_set_bytes_per_block(a, 10));
120 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
121 	    archive_write_add_filter_lzop(a));
122 	assertEqualIntA(a, ARCHIVE_FAILED,
123 	    archive_write_set_options(a, "lzop:nonexistent-option=0"));
124 	assertEqualIntA(a, ARCHIVE_OK,
125 	    archive_write_set_options(a, "lzop:compression-level=1"));
126 	assertEqualIntA(a, ARCHIVE_OK,
127 	    archive_write_set_filter_option(a, NULL, "compression-level", "9"));
128 	assertEqualIntA(a, ARCHIVE_FAILED,
129 	    archive_write_set_filter_option(a, NULL, "compression-level", "abc"));
130 	assertEqualIntA(a, ARCHIVE_FAILED,
131 	    archive_write_set_filter_option(a, NULL, "compression-level", "99"));
132 	assertEqualIntA(a, ARCHIVE_OK,
133 	    archive_write_set_options(a, "lzop:compression-level=9"));
134 	assertEqualIntA(a, ARCHIVE_OK,
135 	    archive_write_open_memory(a, buff, buffsize, &used2));
136 	for (i = 0; i < 100; i++) {
137 		sprintf(path, "file%03d", i);
138 		assert((ae = archive_entry_new()) != NULL);
139 		archive_entry_copy_pathname(ae, path);
140 		archive_entry_set_size(ae, datasize);
141 		archive_entry_set_filetype(ae, AE_IFREG);
142 		assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
143 		assertA(datasize == (size_t)archive_write_data(
144 		    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 	failure("compression-level=9 wrote %d bytes, default wrote %d bytes",
151 	    (int)used2, (int)used1);
152 	assert(used2 < used1);
153 
154 	assert((a = archive_read_new()) != NULL);
155 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
156 	r = archive_read_support_filter_lzop(a);
157 	if (r != ARCHIVE_OK && !use_prog) {
158 		skipping("lzop reading not fully supported on this platform");
159 	} else {
160 		assertEqualIntA(a, ARCHIVE_OK,
161 		    archive_read_support_filter_all(a));
162 		assertEqualIntA(a, ARCHIVE_OK,
163 		    archive_read_open_memory(a, buff, used2));
164 		for (i = 0; i < 100; i++) {
165 			sprintf(path, "file%03d", i);
166 			if (!assertEqualInt(ARCHIVE_OK,
167 				archive_read_next_header(a, &ae)))
168 				break;
169 			assertEqualString(path, archive_entry_pathname(ae));
170 			assertEqualInt((int)datasize, archive_entry_size(ae));
171 		}
172 		assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
173 	}
174 	assertEqualInt(ARCHIVE_OK, archive_read_free(a));
175 
176 	/*
177 	 * Repeat again, with much lower compression.
178 	 */
179 	assert((a = archive_write_new()) != NULL);
180 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
181 	assertEqualIntA(a, ARCHIVE_OK,
182 	    archive_write_set_bytes_per_block(a, 10));
183 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
184 	    archive_write_add_filter_lzop(a));
185 	assertEqualIntA(a, ARCHIVE_OK,
186 	    archive_write_set_filter_option(a, NULL, "compression-level", "1"));
187 	assertEqualIntA(a, ARCHIVE_OK,
188 	    archive_write_open_memory(a, buff, buffsize, &used2));
189 	for (i = 0; i < 100; 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 #if 0
205 	failure("Compression-level=1 wrote %d bytes; default wrote %d bytes",
206 	    (int)used2, (int)used1);
207 	assert(used2 > used1);
208 #endif
209 
210 	assert((a = archive_read_new()) != NULL);
211 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
212 	assertEqualIntA(a, ARCHIVE_OK, archive_read_support_filter_all(a));
213 	r = archive_read_support_filter_lzop(a);
214 	if (r == ARCHIVE_WARN) {
215 		skipping("lzop reading not fully supported on this platform");
216 	} else {
217 		assertEqualIntA(a, ARCHIVE_OK,
218 		    archive_read_open_memory(a, buff, used2));
219 		for (i = 0; i < 100; i++) {
220 			sprintf(path, "file%03d", i);
221 			if (!assertEqualInt(ARCHIVE_OK,
222 				archive_read_next_header(a, &ae)))
223 				break;
224 			assertEqualString(path, archive_entry_pathname(ae));
225 			assertEqualInt((int)datasize, archive_entry_size(ae));
226 		}
227 		assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
228 	}
229 	assertEqualInt(ARCHIVE_OK, archive_read_free(a));
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, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
237 	    archive_write_add_filter_lzop(a));
238 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
239 
240 	assert((a = archive_write_new()) != NULL);
241 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
242 	    archive_write_add_filter_lzop(a));
243 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
244 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
245 
246 	assert((a = archive_write_new()) != NULL);
247 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
248 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
249 	    archive_write_add_filter_lzop(a));
250 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
251 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
252 
253 	assert((a = archive_write_new()) != NULL);
254 	assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
255 	assertEqualIntA(a, (use_prog)?ARCHIVE_WARN:ARCHIVE_OK,
256 	    archive_write_add_filter_lzop(a));
257 	assertEqualIntA(a, ARCHIVE_OK,
258 	    archive_write_open_memory(a, buff, buffsize, &used2));
259 	assertEqualInt(ARCHIVE_OK, archive_write_close(a));
260 	assertEqualInt(ARCHIVE_OK, archive_write_free(a));
261 
262 	/*
263 	 * Clean up.
264 	 */
265 	free(data);
266 	free(buff);
267 }
268