2 * Copyright (c) 2017 Sean Purcell
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
28 __FBSDID("$FreeBSD$");
30 DEFINE_TEST(test_write_filter_zstd)
32 struct archive_entry *ae;
35 size_t buffsize, datasize;
37 size_t used1, used2, used3;
41 assert(NULL != (buff = (char *)malloc(buffsize)));
46 assert(NULL != (data = (char *)malloc(datasize)));
51 memset(data, 0, datasize);
54 * Write a 100 files and read them all back.
56 assert((a = archive_write_new()) != NULL);
57 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
58 r = archive_write_add_filter_zstd(a);
59 if (r != ARCHIVE_OK) {
60 skipping("zstd writing not supported on this platform");
61 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
66 assertEqualIntA(a, ARCHIVE_OK,
67 archive_write_set_bytes_per_block(a, 10));
68 assertEqualInt(ARCHIVE_FILTER_ZSTD, archive_filter_code(a, 0));
69 assertEqualString("zstd", archive_filter_name(a, 0));
70 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used1));
71 assertEqualInt(ARCHIVE_FILTER_ZSTD, archive_filter_code(a, 0));
72 assertEqualString("zstd", archive_filter_name(a, 0));
73 assert((ae = archive_entry_new()) != NULL);
74 archive_entry_set_filetype(ae, AE_IFREG);
75 archive_entry_set_size(ae, datasize);
76 for (i = 0; i < 100; i++) {
77 sprintf(path, "file%03d", i);
78 archive_entry_copy_pathname(ae, path);
79 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
81 == (size_t)archive_write_data(a, data, datasize));
83 archive_entry_free(ae);
84 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
85 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
87 assert((a = archive_read_new()) != NULL);
88 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
89 r = archive_read_support_filter_zstd(a);
90 if (r == ARCHIVE_WARN) {
91 skipping("Can't verify zstd writing by reading back;"
92 " zstd reading not fully supported on this platform");
94 assertEqualIntA(a, ARCHIVE_OK,
95 archive_read_support_filter_all(a));
96 assertEqualIntA(a, ARCHIVE_OK,
97 archive_read_open_memory(a, buff, used1));
98 for (i = 0; i < 100; i++) {
99 sprintf(path, "file%03d", i);
100 if (!assertEqualInt(ARCHIVE_OK,
101 archive_read_next_header(a, &ae)))
103 assertEqualString(path, archive_entry_pathname(ae));
104 assertEqualInt((int)datasize, archive_entry_size(ae));
106 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
108 assertEqualInt(ARCHIVE_OK, archive_read_free(a));
111 * Repeat the cycle again, this time setting some compression
114 assert((a = archive_write_new()) != NULL);
115 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
116 assertEqualIntA(a, ARCHIVE_OK,
117 archive_write_set_bytes_per_block(a, 10));
118 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a));
119 assertEqualIntA(a, ARCHIVE_FAILED,
120 archive_write_set_filter_option(a, NULL, "nonexistent-option", "0"));
121 assertEqualIntA(a, ARCHIVE_FAILED,
122 archive_write_set_filter_option(a, NULL, "compression-level", "abc"));
123 assertEqualIntA(a, ARCHIVE_FAILED,
124 archive_write_set_filter_option(a, NULL, "compression-level", "25")); /* too big */
125 assertEqualIntA(a, ARCHIVE_OK,
126 archive_write_set_filter_option(a, NULL, "compression-level", "9"));
127 /* Following is disabled as it will fail on library versions < 1.3.4 */
128 /* assertEqualIntA(a, ARCHIVE_OK,
129 archive_write_set_filter_option(a, NULL, "compression-level", "-1")); */
130 assertEqualIntA(a, ARCHIVE_OK,
131 archive_write_set_filter_option(a, NULL, "compression-level", "7"));
132 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));
133 for (i = 0; i < 100; i++) {
134 sprintf(path, "file%03d", i);
135 assert((ae = archive_entry_new()) != NULL);
136 archive_entry_copy_pathname(ae, path);
137 archive_entry_set_size(ae, datasize);
138 archive_entry_set_filetype(ae, AE_IFREG);
139 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
140 assertA(datasize == (size_t)archive_write_data(a, data, datasize));
141 archive_entry_free(ae);
143 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
144 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
146 assert((a = archive_read_new()) != NULL);
147 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
148 r = archive_read_support_filter_zstd(a);
149 if (r == ARCHIVE_WARN) {
150 skipping("zstd reading not fully supported on this platform");
152 assertEqualIntA(a, ARCHIVE_OK,
153 archive_read_support_filter_all(a));
154 assertEqualIntA(a, ARCHIVE_OK,
155 archive_read_open_memory(a, buff, used2));
156 for (i = 0; i < 100; i++) {
157 sprintf(path, "file%03d", i);
158 failure("Trying to read %s", path);
159 if (!assertEqualIntA(a, ARCHIVE_OK,
160 archive_read_next_header(a, &ae)))
162 assertEqualString(path, archive_entry_pathname(ae));
163 assertEqualInt((int)datasize, archive_entry_size(ae));
165 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
167 assertEqualInt(ARCHIVE_OK, archive_read_free(a));
170 * One more time at level 1
172 assert((a = archive_write_new()) != NULL);
173 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
174 assertEqualIntA(a, ARCHIVE_OK,
175 archive_write_set_bytes_per_block(a, 10));
176 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a));
177 assertEqualIntA(a, ARCHIVE_OK,
178 archive_write_set_filter_option(a, NULL, "compression-level", "1"));
179 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used3));
180 assert((ae = archive_entry_new()) != NULL);
181 archive_entry_set_filetype(ae, AE_IFREG);
182 archive_entry_set_size(ae, datasize);
183 for (i = 0; i < 100; i++) {
184 sprintf(path, "file%03d", i);
185 archive_entry_copy_pathname(ae, path);
186 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae));
187 assertA(datasize == (size_t)archive_write_data(a, data, datasize));
189 archive_entry_free(ae);
190 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
191 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
193 assert((a = archive_read_new()) != NULL);
194 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a));
195 r = archive_read_support_filter_zstd(a);
196 if (r == ARCHIVE_WARN) {
197 skipping("zstd reading not fully supported on this platform");
199 assertEqualIntA(a, ARCHIVE_OK,
200 archive_read_support_filter_all(a));
201 assertEqualIntA(a, ARCHIVE_OK,
202 archive_read_open_memory(a, buff, used3));
203 for (i = 0; i < 100; i++) {
204 sprintf(path, "file%03d", i);
205 failure("Trying to read %s", path);
206 if (!assertEqualIntA(a, ARCHIVE_OK,
207 archive_read_next_header(a, &ae)))
209 assertEqualString(path, archive_entry_pathname(ae));
210 assertEqualInt((int)datasize, archive_entry_size(ae));
212 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a));
214 assertEqualInt(ARCHIVE_OK, archive_read_free(a));
217 * Check output sizes for various compression levels, expectation
218 * is that archive size for level=7 < default < level=1
220 failure("compression-level=7 wrote %d bytes, default wrote %d bytes",
221 (int)used2, (int)used1);
222 assert(used2 < used1);
223 failure("compression-level=1 wrote %d bytes, default wrote %d bytes",
224 (int)used3, (int)used1);
225 assert(used1 < used3);
228 * Test various premature shutdown scenarios to make sure we
229 * don't crash or leak memory.
231 assert((a = archive_write_new()) != NULL);
232 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a));
233 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
235 assert((a = archive_write_new()) != NULL);
236 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a));
237 assertEqualInt(ARCHIVE_OK, archive_write_close(a));
238 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
240 assert((a = archive_write_new()) != NULL);
241 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
242 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a));
243 assertEqualInt(ARCHIVE_OK, archive_write_close(a));
244 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
246 assert((a = archive_write_new()) != NULL);
247 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a));
248 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a));
249 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2));
250 assertEqualInt(ARCHIVE_OK, archive_write_close(a));
251 assertEqualInt(ARCHIVE_OK, archive_write_free(a));