blob: 4c6f57c07590885c371b46e6e764d0cc2df4c6e6 [file] [log] [blame]
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02001import contextlib
Ezio Melotti74c96ec2009-07-08 22:24:06 +00002import io
3import os
Brett Cannonb57a0852013-06-15 17:32:30 -04004import importlib.util
Serhiy Storchaka8606e952017-03-08 14:37:51 +02005import pathlib
Serhiy Storchaka503f9082016-02-08 00:02:25 +02006import posixpath
Ezio Melotti35386712009-12-31 13:22:41 +00007import time
Ezio Melotti74c96ec2009-07-08 22:24:06 +00008import struct
9import zipfile
10import unittest
11
Tim Petersa45cacf2004-08-20 03:47:14 +000012
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000013from tempfile import TemporaryFile
Serhiy Storchakafa6bc292013-07-22 21:00:11 +030014from random import randint, random, getrandbits
Tim Petersa19a1682001-03-29 04:36:09 +000015
Serhiy Storchaka61c4c442016-10-23 13:07:59 +030016from test.support import script_helper
Serhiy Storchaka8606e952017-03-08 14:37:51 +020017from test.support import (TESTFN, findfile, unlink, rmtree, temp_dir, temp_cwd,
Serhiy Storchakac5b75db2013-01-29 20:14:08 +020018 requires_zlib, requires_bz2, requires_lzma,
Victor Stinnerd6debb22017-03-27 16:05:26 +020019 captured_stdout)
Guido van Rossum368f04a2000-04-10 13:23:04 +000020
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000021TESTFN2 = TESTFN + "2"
Martin v. Löwis59e47792009-01-24 14:10:07 +000022TESTFNDIR = TESTFN + "d"
Guido van Rossumb5a755e2007-07-18 18:15:48 +000023FIXEDTEST_SIZE = 1000
Georg Brandl5ba11de2011-01-01 10:09:32 +000024DATAFILES_DIR = 'zipfile_datafiles'
Guido van Rossum368f04a2000-04-10 13:23:04 +000025
Christian Heimes790c8232008-01-07 21:14:23 +000026SMALL_TEST_DATA = [('_ziptest1', '1q2w3e4r5t'),
27 ('ziptest2dir/_ziptest2', 'qawsedrftg'),
Gregory P. Smithb47acbf2013-02-01 11:22:43 -080028 ('ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
Christian Heimes790c8232008-01-07 21:14:23 +000029 ('ziptest2dir/ziptest3dir/ziptest4dir/_ziptest3', '6y7u8i9o0p')]
30
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +020031def getrandbytes(size):
32 return getrandbits(8 * size).to_bytes(size, 'little')
33
Serhiy Storchakafa6bc292013-07-22 21:00:11 +030034def get_files(test):
35 yield TESTFN2
36 with TemporaryFile() as f:
37 yield f
38 test.assertFalse(f.closed)
39 with io.BytesIO() as f:
40 yield f
41 test.assertFalse(f.closed)
Ezio Melotti76430242009-07-11 18:28:48 +000042
Serhiy Storchakafa6bc292013-07-22 21:00:11 +030043class AbstractTestsWithSourceFile:
44 @classmethod
45 def setUpClass(cls):
46 cls.line_gen = [bytes("Zipfile test line %d. random float: %f\n" %
47 (i, random()), "ascii")
48 for i in range(FIXEDTEST_SIZE)]
49 cls.data = b''.join(cls.line_gen)
50
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000051 def setUp(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000052 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +000053 with open(TESTFN, "wb") as fp:
54 fp.write(self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000055
Bo Baylesce237c72018-01-29 23:54:07 -060056 def make_test_archive(self, f, compression, compresslevel=None):
57 kwargs = {'compression': compression, 'compresslevel': compresslevel}
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000058 # Create the ZIP archive
Bo Baylesce237c72018-01-29 23:54:07 -060059 with zipfile.ZipFile(f, "w", **kwargs) as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000060 zipfp.write(TESTFN, "another.name")
61 zipfp.write(TESTFN, TESTFN)
62 zipfp.writestr("strfile", self.data)
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +030063 with zipfp.open('written-open-w', mode='w') as f:
64 for line in self.line_gen:
65 f.write(line)
Tim Peters7d3bad62001-04-04 18:56:49 +000066
Bo Baylesce237c72018-01-29 23:54:07 -060067 def zip_test(self, f, compression, compresslevel=None):
68 self.make_test_archive(f, compression, compresslevel)
Guido van Rossumd8faa362007-04-27 19:54:29 +000069
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000070 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000071 with zipfile.ZipFile(f, "r", compression) as zipfp:
72 self.assertEqual(zipfp.read(TESTFN), self.data)
73 self.assertEqual(zipfp.read("another.name"), self.data)
74 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000075
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000076 # Print the ZIP directory
77 fp = io.StringIO()
78 zipfp.printdir(file=fp)
79 directory = fp.getvalue()
80 lines = directory.splitlines()
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +030081 self.assertEqual(len(lines), 5) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +000082
Benjamin Peterson577473f2010-01-19 00:09:57 +000083 self.assertIn('File Name', lines[0])
84 self.assertIn('Modified', lines[0])
85 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +000086
Ezio Melotti35386712009-12-31 13:22:41 +000087 fn, date, time_, size = lines[1].split()
88 self.assertEqual(fn, 'another.name')
89 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
90 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
91 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000092
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000093 # Check the namelist
94 names = zipfp.namelist()
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +030095 self.assertEqual(len(names), 4)
Benjamin Peterson577473f2010-01-19 00:09:57 +000096 self.assertIn(TESTFN, names)
97 self.assertIn("another.name", names)
98 self.assertIn("strfile", names)
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +030099 self.assertIn("written-open-w", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000100
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000101 # Check infolist
102 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +0000103 names = [i.filename for i in infos]
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +0300104 self.assertEqual(len(names), 4)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000105 self.assertIn(TESTFN, names)
106 self.assertIn("another.name", names)
107 self.assertIn("strfile", names)
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +0300108 self.assertIn("written-open-w", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000109 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +0000110 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000111
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000112 # check getinfo
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +0300113 for nm in (TESTFN, "another.name", "strfile", "written-open-w"):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000114 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000115 self.assertEqual(info.filename, nm)
116 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000117
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000118 # Check that testzip doesn't raise an exception
119 zipfp.testzip()
Tim Peters7d3bad62001-04-04 18:56:49 +0000120
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300121 def test_basic(self):
122 for f in get_files(self):
123 self.zip_test(f, self.compression)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000124
Ezio Melottiafd0d112009-07-15 17:17:17 +0000125 def zip_open_test(self, f, compression):
126 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000127
128 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000129 with zipfile.ZipFile(f, "r", compression) as zipfp:
130 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000131 with zipfp.open(TESTFN) as zipopen1:
132 while True:
133 read_data = zipopen1.read(256)
134 if not read_data:
135 break
136 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000137
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000138 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000139 with zipfp.open("another.name") as zipopen2:
140 while True:
141 read_data = zipopen2.read(256)
142 if not read_data:
143 break
144 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000145
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000146 self.assertEqual(b''.join(zipdata1), self.data)
147 self.assertEqual(b''.join(zipdata2), self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000148
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300149 def test_open(self):
150 for f in get_files(self):
151 self.zip_open_test(f, self.compression)
Georg Brandlb533e262008-05-25 18:19:30 +0000152
Serhiy Storchaka8606e952017-03-08 14:37:51 +0200153 def test_open_with_pathlike(self):
154 path = pathlib.Path(TESTFN2)
155 self.zip_open_test(path, self.compression)
156 with zipfile.ZipFile(path, "r", self.compression) as zipfp:
157 self.assertIsInstance(zipfp.filename, str)
158
Ezio Melottiafd0d112009-07-15 17:17:17 +0000159 def zip_random_open_test(self, f, compression):
160 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000161
162 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000163 with zipfile.ZipFile(f, "r", compression) as zipfp:
164 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000165 with zipfp.open(TESTFN) as zipopen1:
166 while True:
167 read_data = zipopen1.read(randint(1, 1024))
168 if not read_data:
169 break
170 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000171
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000172 self.assertEqual(b''.join(zipdata1), self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000173
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300174 def test_random_open(self):
175 for f in get_files(self):
176 self.zip_random_open_test(f, self.compression)
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000177
Serhiy Storchakad2c07a52013-09-27 22:11:57 +0300178 def zip_read1_test(self, f, compression):
179 self.make_test_archive(f, compression)
180
181 # Read the ZIP archive
182 with zipfile.ZipFile(f, "r") as zipfp, \
183 zipfp.open(TESTFN) as zipopen:
184 zipdata = []
185 while True:
186 read_data = zipopen.read1(-1)
187 if not read_data:
188 break
189 zipdata.append(read_data)
190
191 self.assertEqual(b''.join(zipdata), self.data)
192
193 def test_read1(self):
194 for f in get_files(self):
195 self.zip_read1_test(f, self.compression)
196
197 def zip_read1_10_test(self, f, compression):
198 self.make_test_archive(f, compression)
199
200 # Read the ZIP archive
201 with zipfile.ZipFile(f, "r") as zipfp, \
202 zipfp.open(TESTFN) as zipopen:
203 zipdata = []
204 while True:
205 read_data = zipopen.read1(10)
206 self.assertLessEqual(len(read_data), 10)
207 if not read_data:
208 break
209 zipdata.append(read_data)
210
211 self.assertEqual(b''.join(zipdata), self.data)
212
213 def test_read1_10(self):
214 for f in get_files(self):
215 self.zip_read1_10_test(f, self.compression)
216
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000217 def zip_readline_read_test(self, f, compression):
218 self.make_test_archive(f, compression)
219
220 # Read the ZIP archive
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300221 with zipfile.ZipFile(f, "r") as zipfp, \
222 zipfp.open(TESTFN) as zipopen:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000223 data = b''
224 while True:
225 read = zipopen.readline()
226 if not read:
227 break
228 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000229
Brian Curtin8fb9b862010-11-18 02:15:28 +0000230 read = zipopen.read(100)
231 if not read:
232 break
233 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000234
235 self.assertEqual(data, self.data)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300236
237 def test_readline_read(self):
238 # Issue #7610: calls to readline() interleaved with calls to read().
239 for f in get_files(self):
240 self.zip_readline_read_test(f, self.compression)
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000241
Ezio Melottiafd0d112009-07-15 17:17:17 +0000242 def zip_readline_test(self, f, compression):
243 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000244
245 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000246 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000247 with zipfp.open(TESTFN) as zipopen:
248 for line in self.line_gen:
249 linedata = zipopen.readline()
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300250 self.assertEqual(linedata, line)
251
252 def test_readline(self):
253 for f in get_files(self):
254 self.zip_readline_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000255
Ezio Melottiafd0d112009-07-15 17:17:17 +0000256 def zip_readlines_test(self, f, compression):
257 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000258
259 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000260 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000261 with zipfp.open(TESTFN) as zipopen:
262 ziplines = zipopen.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000263 for line, zipline in zip(self.line_gen, ziplines):
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300264 self.assertEqual(zipline, line)
265
266 def test_readlines(self):
267 for f in get_files(self):
268 self.zip_readlines_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000269
Ezio Melottiafd0d112009-07-15 17:17:17 +0000270 def zip_iterlines_test(self, f, compression):
271 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000272
273 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000274 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000275 with zipfp.open(TESTFN) as zipopen:
276 for line, zipline in zip(self.line_gen, zipopen):
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300277 self.assertEqual(zipline, line)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000278
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300279 def test_iterlines(self):
280 for f in get_files(self):
281 self.zip_iterlines_test(f, self.compression)
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000282
Ezio Melottiafd0d112009-07-15 17:17:17 +0000283 def test_low_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000284 """Check for cases where compressed data is larger than original."""
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000285 # Create the ZIP archive
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300286 with zipfile.ZipFile(TESTFN2, "w", self.compression) as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000287 zipfp.writestr("strfile", '12')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000288
289 # Get an open object for strfile
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300290 with zipfile.ZipFile(TESTFN2, "r", self.compression) as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000291 with zipfp.open("strfile") as openobj:
292 self.assertEqual(openobj.read(1), b'1')
293 self.assertEqual(openobj.read(1), b'2')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000294
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300295 def test_writestr_compression(self):
296 zipfp = zipfile.ZipFile(TESTFN2, "w")
297 zipfp.writestr("b.txt", "hello world", compress_type=self.compression)
298 info = zipfp.getinfo('b.txt')
299 self.assertEqual(info.compress_type, self.compression)
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200300
Bo Baylesce237c72018-01-29 23:54:07 -0600301 def test_writestr_compresslevel(self):
302 zipfp = zipfile.ZipFile(TESTFN2, "w", compresslevel=1)
303 zipfp.writestr("a.txt", "hello world", compress_type=self.compression)
304 zipfp.writestr("b.txt", "hello world", compress_type=self.compression,
305 compresslevel=2)
306
307 # Compression level follows the constructor.
308 a_info = zipfp.getinfo('a.txt')
309 self.assertEqual(a_info.compress_type, self.compression)
310 self.assertEqual(a_info._compresslevel, 1)
311
312 # Compression level is overridden.
313 b_info = zipfp.getinfo('b.txt')
314 self.assertEqual(b_info.compress_type, self.compression)
315 self.assertEqual(b_info._compresslevel, 2)
316
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300317 def test_read_return_size(self):
318 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
319 # than requested.
320 for test_size in (1, 4095, 4096, 4097, 16384):
321 file_size = test_size + 1
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +0200322 junk = getrandbytes(file_size)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300323 with zipfile.ZipFile(io.BytesIO(), "w", self.compression) as zipf:
324 zipf.writestr('foo', junk)
325 with zipf.open('foo', 'r') as fp:
326 buf = fp.read(test_size)
327 self.assertEqual(len(buf), test_size)
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200328
Serhiy Storchaka5ce3f102014-01-09 14:50:20 +0200329 def test_truncated_zipfile(self):
330 fp = io.BytesIO()
331 with zipfile.ZipFile(fp, mode='w') as zipf:
332 zipf.writestr('strfile', self.data, compress_type=self.compression)
333 end_offset = fp.tell()
334 zipfiledata = fp.getvalue()
335
336 fp = io.BytesIO(zipfiledata)
337 with zipfile.ZipFile(fp) as zipf:
338 with zipf.open('strfile') as zipopen:
339 fp.truncate(end_offset - 20)
340 with self.assertRaises(EOFError):
341 zipopen.read()
342
343 fp = io.BytesIO(zipfiledata)
344 with zipfile.ZipFile(fp) as zipf:
345 with zipf.open('strfile') as zipopen:
346 fp.truncate(end_offset - 20)
347 with self.assertRaises(EOFError):
348 while zipopen.read(100):
349 pass
350
351 fp = io.BytesIO(zipfiledata)
352 with zipfile.ZipFile(fp) as zipf:
353 with zipf.open('strfile') as zipopen:
354 fp.truncate(end_offset - 20)
355 with self.assertRaises(EOFError):
356 while zipopen.read1(100):
357 pass
358
Serhiy Storchaka51a43702014-10-29 22:42:06 +0200359 def test_repr(self):
360 fname = 'file.name'
361 for f in get_files(self):
362 with zipfile.ZipFile(f, 'w', self.compression) as zipfp:
363 zipfp.write(TESTFN, fname)
364 r = repr(zipfp)
365 self.assertIn("mode='w'", r)
366
367 with zipfile.ZipFile(f, 'r') as zipfp:
368 r = repr(zipfp)
369 if isinstance(f, str):
370 self.assertIn('filename=%r' % f, r)
371 else:
372 self.assertIn('file=%r' % f, r)
373 self.assertIn("mode='r'", r)
374 r = repr(zipfp.getinfo(fname))
375 self.assertIn('filename=%r' % fname, r)
376 self.assertIn('filemode=', r)
377 self.assertIn('file_size=', r)
378 if self.compression != zipfile.ZIP_STORED:
379 self.assertIn('compress_type=', r)
380 self.assertIn('compress_size=', r)
381 with zipfp.open(fname) as zipopen:
382 r = repr(zipopen)
383 self.assertIn('name=%r' % fname, r)
384 self.assertIn("mode='r'", r)
385 if self.compression != zipfile.ZIP_STORED:
386 self.assertIn('compress_type=', r)
387 self.assertIn('[closed]', repr(zipopen))
388 self.assertIn('[closed]', repr(zipfp))
389
Bo Baylesce237c72018-01-29 23:54:07 -0600390 def test_compresslevel_basic(self):
391 for f in get_files(self):
392 self.zip_test(f, self.compression, compresslevel=9)
393
394 def test_per_file_compresslevel(self):
395 """Check that files within a Zip archive can have different
396 compression levels."""
397 with zipfile.ZipFile(TESTFN2, "w", compresslevel=1) as zipfp:
398 zipfp.write(TESTFN, 'compress_1')
399 zipfp.write(TESTFN, 'compress_9', compresslevel=9)
400 one_info = zipfp.getinfo('compress_1')
401 nine_info = zipfp.getinfo('compress_9')
402 self.assertEqual(one_info._compresslevel, 1)
403 self.assertEqual(nine_info._compresslevel, 9)
404
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300405 def tearDown(self):
406 unlink(TESTFN)
407 unlink(TESTFN2)
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200408
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200409
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300410class StoredTestsWithSourceFile(AbstractTestsWithSourceFile,
411 unittest.TestCase):
412 compression = zipfile.ZIP_STORED
413 test_low_compression = None
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200414
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300415 def zip_test_writestr_permissions(self, f, compression):
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +0300416 # Make sure that writestr and open(... mode='w') create files with
417 # mode 0600, when they are passed a name rather than a ZipInfo
418 # instance.
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200419
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300420 self.make_test_archive(f, compression)
421 with zipfile.ZipFile(f, "r") as zipfp:
422 zinfo = zipfp.getinfo('strfile')
423 self.assertEqual(zinfo.external_attr, 0o600 << 16)
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200424
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +0300425 zinfo2 = zipfp.getinfo('written-open-w')
426 self.assertEqual(zinfo2.external_attr, 0o600 << 16)
427
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300428 def test_writestr_permissions(self):
429 for f in get_files(self):
430 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +0200431
Ezio Melottiafd0d112009-07-15 17:17:17 +0000432 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000433 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
434 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000435
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000436 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
437 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000438
Ezio Melottiafd0d112009-07-15 17:17:17 +0000439 def test_append_to_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000440 """Test appending to an existing zipfile."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000441 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
442 zipfp.write(TESTFN, TESTFN)
443
444 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
445 zipfp.writestr("strfile", self.data)
446 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000447
Ezio Melottiafd0d112009-07-15 17:17:17 +0000448 def test_append_to_non_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000449 """Test appending to an existing file that is not a zipfile."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000450 # NOTE: this test fails if len(d) < 22 because of the first
451 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti35386712009-12-31 13:22:41 +0000452 data = b'I am not a ZipFile!'*10
453 with open(TESTFN2, 'wb') as f:
454 f.write(data)
455
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000456 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
457 zipfp.write(TESTFN, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000458
Ezio Melotti35386712009-12-31 13:22:41 +0000459 with open(TESTFN2, 'rb') as f:
460 f.seek(len(data))
461 with zipfile.ZipFile(f, "r") as zipfp:
462 self.assertEqual(zipfp.namelist(), [TESTFN])
Serhiy Storchaka8793b212016-10-07 22:20:50 +0300463 self.assertEqual(zipfp.read(TESTFN), self.data)
464 with open(TESTFN2, 'rb') as f:
465 self.assertEqual(f.read(len(data)), data)
466 zipfiledata = f.read()
467 with io.BytesIO(zipfiledata) as bio, zipfile.ZipFile(bio) as zipfp:
468 self.assertEqual(zipfp.namelist(), [TESTFN])
469 self.assertEqual(zipfp.read(TESTFN), self.data)
470
471 def test_read_concatenated_zip_file(self):
472 with io.BytesIO() as bio:
473 with zipfile.ZipFile(bio, 'w', zipfile.ZIP_STORED) as zipfp:
474 zipfp.write(TESTFN, TESTFN)
475 zipfiledata = bio.getvalue()
476 data = b'I am not a ZipFile!'*10
477 with open(TESTFN2, 'wb') as f:
478 f.write(data)
479 f.write(zipfiledata)
480
481 with zipfile.ZipFile(TESTFN2) as zipfp:
482 self.assertEqual(zipfp.namelist(), [TESTFN])
483 self.assertEqual(zipfp.read(TESTFN), self.data)
484
485 def test_append_to_concatenated_zip_file(self):
486 with io.BytesIO() as bio:
487 with zipfile.ZipFile(bio, 'w', zipfile.ZIP_STORED) as zipfp:
488 zipfp.write(TESTFN, TESTFN)
489 zipfiledata = bio.getvalue()
490 data = b'I am not a ZipFile!'*1000000
491 with open(TESTFN2, 'wb') as f:
492 f.write(data)
493 f.write(zipfiledata)
494
495 with zipfile.ZipFile(TESTFN2, 'a') as zipfp:
496 self.assertEqual(zipfp.namelist(), [TESTFN])
497 zipfp.writestr('strfile', self.data)
498
499 with open(TESTFN2, 'rb') as f:
500 self.assertEqual(f.read(len(data)), data)
501 zipfiledata = f.read()
502 with io.BytesIO(zipfiledata) as bio, zipfile.ZipFile(bio) as zipfp:
503 self.assertEqual(zipfp.namelist(), [TESTFN, 'strfile'])
504 self.assertEqual(zipfp.read(TESTFN), self.data)
505 self.assertEqual(zipfp.read('strfile'), self.data)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000506
R David Murray4fbb9db2011-06-09 15:50:51 -0400507 def test_ignores_newline_at_end(self):
508 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
509 zipfp.write(TESTFN, TESTFN)
510 with open(TESTFN2, 'a') as f:
511 f.write("\r\n\00\00\00")
512 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
513 self.assertIsInstance(zipfp, zipfile.ZipFile)
514
515 def test_ignores_stuff_appended_past_comments(self):
516 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
517 zipfp.comment = b"this is a comment"
518 zipfp.write(TESTFN, TESTFN)
519 with open(TESTFN2, 'a') as f:
520 f.write("abcdef\r\n")
521 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
522 self.assertIsInstance(zipfp, zipfile.ZipFile)
523 self.assertEqual(zipfp.comment, b"this is a comment")
524
Ezio Melottiafd0d112009-07-15 17:17:17 +0000525 def test_write_default_name(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000526 """Check that calling ZipFile.write without arcname specified
527 produces the expected result."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000528 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
529 zipfp.write(TESTFN)
Brian Curtin8fb9b862010-11-18 02:15:28 +0000530 with open(TESTFN, "rb") as f:
531 self.assertEqual(zipfp.read(TESTFN), f.read())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000532
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300533 def test_write_to_readonly(self):
534 """Check that trying to call write() on a readonly ZipFile object
Serhiy Storchakab0d497c2016-09-10 21:28:07 +0300535 raises a ValueError."""
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300536 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
537 zipfp.writestr("somefile.txt", "bogus")
538
539 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
Serhiy Storchakab0d497c2016-09-10 21:28:07 +0300540 self.assertRaises(ValueError, zipfp.write, TESTFN)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300541
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +0300542 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
Serhiy Storchakab0d497c2016-09-10 21:28:07 +0300543 with self.assertRaises(ValueError):
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +0300544 zipfp.open(TESTFN, mode='w')
545
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300546 def test_add_file_before_1980(self):
547 # Set atime and mtime to 1970-01-01
548 os.utime(TESTFN, (0, 0))
549 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
550 self.assertRaises(ValueError, zipfp.write, TESTFN)
551
Marcel Plch77b112c2018-08-31 16:43:31 +0200552 with zipfile.ZipFile(TESTFN2, "w", strict_timestamps=False) as zipfp:
553 zipfp.write(TESTFN)
Marcel Plcha2fe1e52018-08-02 15:04:52 +0200554 zinfo = zipfp.getinfo(TESTFN)
555 self.assertEqual(zinfo.date_time, (1980, 1, 1, 0, 0, 0))
556
557 def test_add_file_after_2107(self):
558 # Set atime and mtime to 2108-12-30
Marcel Plch7b41dba2018-08-03 17:59:19 +0200559 try:
560 os.utime(TESTFN, (4386268800, 4386268800))
561 except OverflowError:
562 self.skipTest('Host fs cannot set timestamp to required value.')
563
Marcel Plcha2fe1e52018-08-02 15:04:52 +0200564 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
565 self.assertRaises(struct.error, zipfp.write, TESTFN)
566
Marcel Plch77b112c2018-08-31 16:43:31 +0200567 with zipfile.ZipFile(TESTFN2, "w", strict_timestamps=False) as zipfp:
568 zipfp.write(TESTFN)
Marcel Plcha2fe1e52018-08-02 15:04:52 +0200569 zinfo = zipfp.getinfo(TESTFN)
570 self.assertEqual(zinfo.date_time, (2107, 12, 31, 23, 59, 59))
571
Serhiy Storchaka5ce3f102014-01-09 14:50:20 +0200572
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300573@requires_zlib
574class DeflateTestsWithSourceFile(AbstractTestsWithSourceFile,
575 unittest.TestCase):
576 compression = zipfile.ZIP_DEFLATED
577
Ezio Melottiafd0d112009-07-15 17:17:17 +0000578 def test_per_file_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000579 """Check that files within a Zip archive can have different
580 compression options."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000581 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
582 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
583 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
584 sinfo = zipfp.getinfo('storeme')
585 dinfo = zipfp.getinfo('deflateme')
586 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
587 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000588
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300589@requires_bz2
590class Bzip2TestsWithSourceFile(AbstractTestsWithSourceFile,
591 unittest.TestCase):
592 compression = zipfile.ZIP_BZIP2
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000593
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300594@requires_lzma
595class LzmaTestsWithSourceFile(AbstractTestsWithSourceFile,
596 unittest.TestCase):
597 compression = zipfile.ZIP_LZMA
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000598
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300599
600class AbstractTestZip64InSmallFiles:
601 # These tests test the ZIP64 functionality without using large files,
602 # see test_zipfile64 for proper tests.
603
604 @classmethod
605 def setUpClass(cls):
606 line_gen = (bytes("Test of zipfile line %d." % i, "ascii")
607 for i in range(0, FIXEDTEST_SIZE))
608 cls.data = b'\n'.join(line_gen)
609
610 def setUp(self):
611 self._limit = zipfile.ZIP64_LIMIT
Serhiy Storchaka026a3992014-09-23 22:27:34 +0300612 self._filecount_limit = zipfile.ZIP_FILECOUNT_LIMIT
613 zipfile.ZIP64_LIMIT = 1000
614 zipfile.ZIP_FILECOUNT_LIMIT = 9
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300615
616 # Make a source file with some lines
617 with open(TESTFN, "wb") as fp:
618 fp.write(self.data)
619
620 def zip_test(self, f, compression):
621 # Create the ZIP archive
622 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
623 zipfp.write(TESTFN, "another.name")
624 zipfp.write(TESTFN, TESTFN)
625 zipfp.writestr("strfile", self.data)
626
627 # Read the ZIP archive
628 with zipfile.ZipFile(f, "r", compression) as zipfp:
629 self.assertEqual(zipfp.read(TESTFN), self.data)
630 self.assertEqual(zipfp.read("another.name"), self.data)
631 self.assertEqual(zipfp.read("strfile"), self.data)
632
633 # Print the ZIP directory
634 fp = io.StringIO()
635 zipfp.printdir(fp)
636
637 directory = fp.getvalue()
638 lines = directory.splitlines()
639 self.assertEqual(len(lines), 4) # Number of files + header
640
641 self.assertIn('File Name', lines[0])
642 self.assertIn('Modified', lines[0])
643 self.assertIn('Size', lines[0])
644
645 fn, date, time_, size = lines[1].split()
646 self.assertEqual(fn, 'another.name')
647 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
648 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
649 self.assertEqual(size, str(len(self.data)))
650
651 # Check the namelist
652 names = zipfp.namelist()
653 self.assertEqual(len(names), 3)
654 self.assertIn(TESTFN, names)
655 self.assertIn("another.name", names)
656 self.assertIn("strfile", names)
657
658 # Check infolist
659 infos = zipfp.infolist()
660 names = [i.filename for i in infos]
661 self.assertEqual(len(names), 3)
662 self.assertIn(TESTFN, names)
663 self.assertIn("another.name", names)
664 self.assertIn("strfile", names)
665 for i in infos:
666 self.assertEqual(i.file_size, len(self.data))
667
668 # check getinfo
669 for nm in (TESTFN, "another.name", "strfile"):
670 info = zipfp.getinfo(nm)
671 self.assertEqual(info.filename, nm)
672 self.assertEqual(info.file_size, len(self.data))
673
674 # Check that testzip doesn't raise an exception
675 zipfp.testzip()
676
677 def test_basic(self):
678 for f in get_files(self):
679 self.zip_test(f, self.compression)
680
Serhiy Storchaka026a3992014-09-23 22:27:34 +0300681 def test_too_many_files(self):
682 # This test checks that more than 64k files can be added to an archive,
683 # and that the resulting archive can be read properly by ZipFile
684 zipf = zipfile.ZipFile(TESTFN, "w", self.compression,
685 allowZip64=True)
686 zipf.debug = 100
687 numfiles = 15
688 for i in range(numfiles):
689 zipf.writestr("foo%08d" % i, "%d" % (i**3 % 57))
690 self.assertEqual(len(zipf.namelist()), numfiles)
691 zipf.close()
692
693 zipf2 = zipfile.ZipFile(TESTFN, "r", self.compression)
694 self.assertEqual(len(zipf2.namelist()), numfiles)
695 for i in range(numfiles):
696 content = zipf2.read("foo%08d" % i).decode('ascii')
697 self.assertEqual(content, "%d" % (i**3 % 57))
698 zipf2.close()
699
700 def test_too_many_files_append(self):
701 zipf = zipfile.ZipFile(TESTFN, "w", self.compression,
702 allowZip64=False)
703 zipf.debug = 100
704 numfiles = 9
705 for i in range(numfiles):
706 zipf.writestr("foo%08d" % i, "%d" % (i**3 % 57))
707 self.assertEqual(len(zipf.namelist()), numfiles)
708 with self.assertRaises(zipfile.LargeZipFile):
709 zipf.writestr("foo%08d" % numfiles, b'')
710 self.assertEqual(len(zipf.namelist()), numfiles)
711 zipf.close()
712
713 zipf = zipfile.ZipFile(TESTFN, "a", self.compression,
714 allowZip64=False)
715 zipf.debug = 100
716 self.assertEqual(len(zipf.namelist()), numfiles)
717 with self.assertRaises(zipfile.LargeZipFile):
718 zipf.writestr("foo%08d" % numfiles, b'')
719 self.assertEqual(len(zipf.namelist()), numfiles)
720 zipf.close()
721
722 zipf = zipfile.ZipFile(TESTFN, "a", self.compression,
723 allowZip64=True)
724 zipf.debug = 100
725 self.assertEqual(len(zipf.namelist()), numfiles)
726 numfiles2 = 15
727 for i in range(numfiles, numfiles2):
728 zipf.writestr("foo%08d" % i, "%d" % (i**3 % 57))
729 self.assertEqual(len(zipf.namelist()), numfiles2)
730 zipf.close()
731
732 zipf2 = zipfile.ZipFile(TESTFN, "r", self.compression)
733 self.assertEqual(len(zipf2.namelist()), numfiles2)
734 for i in range(numfiles2):
735 content = zipf2.read("foo%08d" % i).decode('ascii')
736 self.assertEqual(content, "%d" % (i**3 % 57))
737 zipf2.close()
738
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300739 def tearDown(self):
740 zipfile.ZIP64_LIMIT = self._limit
Serhiy Storchaka026a3992014-09-23 22:27:34 +0300741 zipfile.ZIP_FILECOUNT_LIMIT = self._filecount_limit
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300742 unlink(TESTFN)
743 unlink(TESTFN2)
744
745
746class StoredTestZip64InSmallFiles(AbstractTestZip64InSmallFiles,
747 unittest.TestCase):
748 compression = zipfile.ZIP_STORED
749
750 def large_file_exception_test(self, f, compression):
Serhiy Storchaka235c5e02013-11-23 15:55:38 +0200751 with zipfile.ZipFile(f, "w", compression, allowZip64=False) as zipfp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300752 self.assertRaises(zipfile.LargeZipFile,
753 zipfp.write, TESTFN, "another.name")
754
755 def large_file_exception_test2(self, f, compression):
Serhiy Storchaka235c5e02013-11-23 15:55:38 +0200756 with zipfile.ZipFile(f, "w", compression, allowZip64=False) as zipfp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300757 self.assertRaises(zipfile.LargeZipFile,
758 zipfp.writestr, "another.name", self.data)
759
760 def test_large_file_exception(self):
761 for f in get_files(self):
762 self.large_file_exception_test(f, zipfile.ZIP_STORED)
763 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
764
765 def test_absolute_arcnames(self):
766 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
767 allowZip64=True) as zipfp:
768 zipfp.write(TESTFN, "/absolute")
769
770 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
771 self.assertEqual(zipfp.namelist(), ["absolute"])
772
773@requires_zlib
774class DeflateTestZip64InSmallFiles(AbstractTestZip64InSmallFiles,
775 unittest.TestCase):
776 compression = zipfile.ZIP_DEFLATED
777
778@requires_bz2
779class Bzip2TestZip64InSmallFiles(AbstractTestZip64InSmallFiles,
780 unittest.TestCase):
781 compression = zipfile.ZIP_BZIP2
782
783@requires_lzma
784class LzmaTestZip64InSmallFiles(AbstractTestZip64InSmallFiles,
785 unittest.TestCase):
786 compression = zipfile.ZIP_LZMA
787
788
Serhiy Storchaka4c0d9ea2017-04-12 16:03:23 +0300789class AbstractWriterTests:
790
791 def tearDown(self):
792 unlink(TESTFN2)
793
794 def test_close_after_close(self):
795 data = b'content'
796 with zipfile.ZipFile(TESTFN2, "w", self.compression) as zipf:
797 w = zipf.open('test', 'w')
798 w.write(data)
799 w.close()
800 self.assertTrue(w.closed)
801 w.close()
802 self.assertTrue(w.closed)
803 self.assertEqual(zipf.read('test'), data)
804
805 def test_write_after_close(self):
806 data = b'content'
807 with zipfile.ZipFile(TESTFN2, "w", self.compression) as zipf:
808 w = zipf.open('test', 'w')
809 w.write(data)
810 w.close()
811 self.assertTrue(w.closed)
812 self.assertRaises(ValueError, w.write, b'')
813 self.assertEqual(zipf.read('test'), data)
814
815class StoredWriterTests(AbstractWriterTests, unittest.TestCase):
816 compression = zipfile.ZIP_STORED
817
818@requires_zlib
819class DeflateWriterTests(AbstractWriterTests, unittest.TestCase):
820 compression = zipfile.ZIP_DEFLATED
821
822@requires_bz2
823class Bzip2WriterTests(AbstractWriterTests, unittest.TestCase):
824 compression = zipfile.ZIP_BZIP2
825
826@requires_lzma
827class LzmaWriterTests(AbstractWriterTests, unittest.TestCase):
828 compression = zipfile.ZIP_LZMA
829
830
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300831class PyZipFileTests(unittest.TestCase):
832 def assertCompiledIn(self, name, namelist):
833 if name + 'o' not in namelist:
834 self.assertIn(name + 'c', namelist)
835
Serhiy Storchakadb724fe2015-02-14 23:04:35 +0200836 def requiresWriteAccess(self, path):
Berker Peksage1efc072015-02-16 04:36:18 +0200837 # effective_ids unavailable on windows
838 if not os.access(path, os.W_OK,
839 effective_ids=os.access in os.supports_effective_ids):
Serhiy Storchakadb724fe2015-02-14 23:04:35 +0200840 self.skipTest('requires write access to the installed location')
Serhiy Storchakad86a6ef2015-09-19 10:55:20 +0300841 filename = os.path.join(path, 'test_zipfile.try')
842 try:
843 fd = os.open(filename, os.O_WRONLY | os.O_CREAT)
844 os.close(fd)
845 except Exception:
846 self.skipTest('requires write access to the installed location')
847 unlink(filename)
Serhiy Storchakadb724fe2015-02-14 23:04:35 +0200848
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300849 def test_write_pyfile(self):
Serhiy Storchakadb724fe2015-02-14 23:04:35 +0200850 self.requiresWriteAccess(os.path.dirname(__file__))
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300851 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
852 fn = __file__
Brett Cannonf299abd2015-04-13 14:21:02 -0400853 if fn.endswith('.pyc'):
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300854 path_split = fn.split(os.sep)
855 if os.altsep is not None:
856 path_split.extend(fn.split(os.altsep))
857 if '__pycache__' in path_split:
Serhiy Storchaka9068e4d2013-07-22 21:02:14 +0300858 fn = importlib.util.source_from_cache(fn)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300859 else:
860 fn = fn[:-1]
861
862 zipfp.writepy(fn)
863
864 bn = os.path.basename(fn)
865 self.assertNotIn(bn, zipfp.namelist())
866 self.assertCompiledIn(bn, zipfp.namelist())
867
868 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
869 fn = __file__
Brett Cannonf299abd2015-04-13 14:21:02 -0400870 if fn.endswith('.pyc'):
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300871 fn = fn[:-1]
872
873 zipfp.writepy(fn, "testpackage")
874
875 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
876 self.assertNotIn(bn, zipfp.namelist())
877 self.assertCompiledIn(bn, zipfp.namelist())
878
879 def test_write_python_package(self):
880 import email
881 packagedir = os.path.dirname(email.__file__)
Serhiy Storchakadb724fe2015-02-14 23:04:35 +0200882 self.requiresWriteAccess(packagedir)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300883
884 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
885 zipfp.writepy(packagedir)
886
887 # Check for a couple of modules at different levels of the
888 # hierarchy
889 names = zipfp.namelist()
890 self.assertCompiledIn('email/__init__.py', names)
891 self.assertCompiledIn('email/mime/text.py', names)
892
Christian Tismer59202e52013-10-21 03:59:23 +0200893 def test_write_filtered_python_package(self):
894 import test
895 packagedir = os.path.dirname(test.__file__)
Serhiy Storchakadb724fe2015-02-14 23:04:35 +0200896 self.requiresWriteAccess(packagedir)
Christian Tismer59202e52013-10-21 03:59:23 +0200897
898 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
899
Christian Tismer59202e52013-10-21 03:59:23 +0200900 # first make sure that the test folder gives error messages
Georg Brandla6065422013-10-21 08:29:29 +0200901 # (on the badsyntax_... files)
902 with captured_stdout() as reportSIO:
903 zipfp.writepy(packagedir)
Christian Tismer59202e52013-10-21 03:59:23 +0200904 reportStr = reportSIO.getvalue()
905 self.assertTrue('SyntaxError' in reportStr)
906
Christian Tismer410d9312013-10-22 04:09:28 +0200907 # then check that the filter works on the whole package
Georg Brandla6065422013-10-21 08:29:29 +0200908 with captured_stdout() as reportSIO:
909 zipfp.writepy(packagedir, filterfunc=lambda whatever: False)
Christian Tismer59202e52013-10-21 03:59:23 +0200910 reportStr = reportSIO.getvalue()
911 self.assertTrue('SyntaxError' not in reportStr)
912
Christian Tismer410d9312013-10-22 04:09:28 +0200913 # then check that the filter works on individual files
Larry Hastings7e63b362015-05-08 06:54:58 -0700914 def filter(path):
915 return not os.path.basename(path).startswith("bad")
Serhiy Storchakac46d1fa2014-01-20 21:59:33 +0200916 with captured_stdout() as reportSIO, self.assertWarns(UserWarning):
Larry Hastings7e63b362015-05-08 06:54:58 -0700917 zipfp.writepy(packagedir, filterfunc=filter)
Christian Tismer410d9312013-10-22 04:09:28 +0200918 reportStr = reportSIO.getvalue()
919 if reportStr:
920 print(reportStr)
921 self.assertTrue('SyntaxError' not in reportStr)
922
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300923 def test_write_with_optimization(self):
924 import email
925 packagedir = os.path.dirname(email.__file__)
Serhiy Storchakadb724fe2015-02-14 23:04:35 +0200926 self.requiresWriteAccess(packagedir)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300927 optlevel = 1 if __debug__ else 0
Brett Cannonf299abd2015-04-13 14:21:02 -0400928 ext = '.pyc'
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300929
930 with TemporaryFile() as t, \
Christian Tismer59202e52013-10-21 03:59:23 +0200931 zipfile.PyZipFile(t, "w", optimize=optlevel) as zipfp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300932 zipfp.writepy(packagedir)
933
934 names = zipfp.namelist()
935 self.assertIn('email/__init__' + ext, names)
936 self.assertIn('email/mime/text' + ext, names)
937
938 def test_write_python_directory(self):
939 os.mkdir(TESTFN2)
940 try:
941 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
942 fp.write("print(42)\n")
943
944 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
945 fp.write("print(42 * 42)\n")
946
947 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
948 fp.write("bla bla bla\n")
949
950 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
951 zipfp.writepy(TESTFN2)
952
953 names = zipfp.namelist()
954 self.assertCompiledIn('mod1.py', names)
955 self.assertCompiledIn('mod2.py', names)
956 self.assertNotIn('mod2.txt', names)
957
958 finally:
Victor Stinner57004c62014-09-04 00:49:01 +0200959 rmtree(TESTFN2)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300960
Christian Tismer410d9312013-10-22 04:09:28 +0200961 def test_write_python_directory_filtered(self):
962 os.mkdir(TESTFN2)
963 try:
964 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
965 fp.write("print(42)\n")
966
967 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
968 fp.write("print(42 * 42)\n")
969
970 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
971 zipfp.writepy(TESTFN2, filterfunc=lambda fn:
972 not fn.endswith('mod2.py'))
973
974 names = zipfp.namelist()
975 self.assertCompiledIn('mod1.py', names)
976 self.assertNotIn('mod2.py', names)
977
978 finally:
Victor Stinner57004c62014-09-04 00:49:01 +0200979 rmtree(TESTFN2)
Christian Tismer410d9312013-10-22 04:09:28 +0200980
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300981 def test_write_non_pyfile(self):
982 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
983 with open(TESTFN, 'w') as f:
984 f.write('most definitely not a python file')
985 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
Victor Stinner88b215e2014-09-04 00:51:09 +0200986 unlink(TESTFN)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300987
988 def test_write_pyfile_bad_syntax(self):
989 os.mkdir(TESTFN2)
990 try:
991 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
992 fp.write("Bad syntax in python file\n")
993
994 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
995 # syntax errors are printed to stdout
996 with captured_stdout() as s:
997 zipfp.writepy(os.path.join(TESTFN2, "mod1.py"))
998
999 self.assertIn("SyntaxError", s.getvalue())
1000
1001 # as it will not have compiled the python file, it will
Brett Cannonf299abd2015-04-13 14:21:02 -04001002 # include the .py file not .pyc
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001003 names = zipfp.namelist()
1004 self.assertIn('mod1.py', names)
1005 self.assertNotIn('mod1.pyc', names)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001006
1007 finally:
Victor Stinner57004c62014-09-04 00:49:01 +02001008 rmtree(TESTFN2)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001009
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001010 def test_write_pathlike(self):
1011 os.mkdir(TESTFN2)
1012 try:
1013 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
1014 fp.write("print(42)\n")
1015
1016 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
1017 zipfp.writepy(pathlib.Path(TESTFN2) / "mod1.py")
1018 names = zipfp.namelist()
1019 self.assertCompiledIn('mod1.py', names)
1020 finally:
1021 rmtree(TESTFN2)
1022
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001023
1024class ExtractTests(unittest.TestCase):
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001025
1026 def make_test_file(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001027 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
1028 for fpath, fdata in SMALL_TEST_DATA:
1029 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +00001030
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001031 def test_extract(self):
1032 with temp_cwd():
1033 self.make_test_file()
1034 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
1035 for fpath, fdata in SMALL_TEST_DATA:
1036 writtenfile = zipfp.extract(fpath)
1037
1038 # make sure it was written to the right place
1039 correctfile = os.path.join(os.getcwd(), fpath)
1040 correctfile = os.path.normpath(correctfile)
1041
1042 self.assertEqual(writtenfile, correctfile)
1043
1044 # make sure correct data is in correct file
1045 with open(writtenfile, "rb") as f:
1046 self.assertEqual(fdata.encode(), f.read())
1047
1048 unlink(writtenfile)
1049
1050 def _test_extract_with_target(self, target):
1051 self.make_test_file()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001052 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
1053 for fpath, fdata in SMALL_TEST_DATA:
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001054 writtenfile = zipfp.extract(fpath, target)
Christian Heimes790c8232008-01-07 21:14:23 +00001055
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001056 # make sure it was written to the right place
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001057 correctfile = os.path.join(target, fpath)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001058 correctfile = os.path.normpath(correctfile)
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001059 self.assertTrue(os.path.samefile(writtenfile, correctfile), (writtenfile, target))
Christian Heimes790c8232008-01-07 21:14:23 +00001060
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001061 # make sure correct data is in correct file
Brian Curtin8fb9b862010-11-18 02:15:28 +00001062 with open(writtenfile, "rb") as f:
1063 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +00001064
Victor Stinner88b215e2014-09-04 00:51:09 +02001065 unlink(writtenfile)
Christian Heimes790c8232008-01-07 21:14:23 +00001066
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001067 unlink(TESTFN2)
1068
1069 def test_extract_with_target(self):
1070 with temp_dir() as extdir:
1071 self._test_extract_with_target(extdir)
1072
1073 def test_extract_with_target_pathlike(self):
1074 with temp_dir() as extdir:
1075 self._test_extract_with_target(pathlib.Path(extdir))
Christian Heimes790c8232008-01-07 21:14:23 +00001076
Ezio Melottiafd0d112009-07-15 17:17:17 +00001077 def test_extract_all(self):
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001078 with temp_cwd():
1079 self.make_test_file()
1080 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
1081 zipfp.extractall()
1082 for fpath, fdata in SMALL_TEST_DATA:
1083 outfile = os.path.join(os.getcwd(), fpath)
Christian Heimes790c8232008-01-07 21:14:23 +00001084
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001085 with open(outfile, "rb") as f:
1086 self.assertEqual(fdata.encode(), f.read())
1087
1088 unlink(outfile)
1089
1090 def _test_extract_all_with_target(self, target):
1091 self.make_test_file()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001092 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001093 zipfp.extractall(target)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001094 for fpath, fdata in SMALL_TEST_DATA:
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001095 outfile = os.path.join(target, fpath)
Christian Heimes790c8232008-01-07 21:14:23 +00001096
Brian Curtin8fb9b862010-11-18 02:15:28 +00001097 with open(outfile, "rb") as f:
1098 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +00001099
Victor Stinner88b215e2014-09-04 00:51:09 +02001100 unlink(outfile)
Christian Heimes790c8232008-01-07 21:14:23 +00001101
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001102 unlink(TESTFN2)
1103
1104 def test_extract_all_with_target(self):
1105 with temp_dir() as extdir:
1106 self._test_extract_all_with_target(extdir)
1107
1108 def test_extract_all_with_target_pathlike(self):
1109 with temp_dir() as extdir:
1110 self._test_extract_all_with_target(pathlib.Path(extdir))
Christian Heimes790c8232008-01-07 21:14:23 +00001111
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001112 def check_file(self, filename, content):
1113 self.assertTrue(os.path.isfile(filename))
1114 with open(filename, 'rb') as f:
1115 self.assertEqual(f.read(), content)
1116
Gregory P. Smith09aa7522013-02-03 00:36:32 -08001117 def test_sanitize_windows_name(self):
1118 san = zipfile.ZipFile._sanitize_windows_name
1119 # Passing pathsep in allows this test to work regardless of platform.
1120 self.assertEqual(san(r',,?,C:,foo,bar/z', ','), r'_,C_,foo,bar/z')
1121 self.assertEqual(san(r'a\b,c<d>e|f"g?h*i', ','), r'a\b,c_d_e_f_g_h_i')
1122 self.assertEqual(san('../../foo../../ba..r', '/'), r'foo/ba..r')
1123
1124 def test_extract_hackers_arcnames_common_cases(self):
1125 common_hacknames = [
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001126 ('../foo/bar', 'foo/bar'),
1127 ('foo/../bar', 'foo/bar'),
1128 ('foo/../../bar', 'foo/bar'),
1129 ('foo/bar/..', 'foo/bar'),
1130 ('./../foo/bar', 'foo/bar'),
1131 ('/foo/bar', 'foo/bar'),
1132 ('/foo/../bar', 'foo/bar'),
1133 ('/foo/../../bar', 'foo/bar'),
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001134 ]
Gregory P. Smith09aa7522013-02-03 00:36:32 -08001135 self._test_extract_hackers_arcnames(common_hacknames)
1136
1137 @unittest.skipIf(os.path.sep != '\\', 'Requires \\ as path separator.')
1138 def test_extract_hackers_arcnames_windows_only(self):
1139 """Test combination of path fixing and windows name sanitization."""
1140 windows_hacknames = [
Christian Tismer59202e52013-10-21 03:59:23 +02001141 (r'..\foo\bar', 'foo/bar'),
1142 (r'..\/foo\/bar', 'foo/bar'),
1143 (r'foo/\..\/bar', 'foo/bar'),
1144 (r'foo\/../\bar', 'foo/bar'),
1145 (r'C:foo/bar', 'foo/bar'),
1146 (r'C:/foo/bar', 'foo/bar'),
1147 (r'C://foo/bar', 'foo/bar'),
1148 (r'C:\foo\bar', 'foo/bar'),
1149 (r'//conky/mountpoint/foo/bar', 'foo/bar'),
1150 (r'\\conky\mountpoint\foo\bar', 'foo/bar'),
1151 (r'///conky/mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
1152 (r'\\\conky\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
1153 (r'//conky//mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
1154 (r'\\conky\\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
1155 (r'//?/C:/foo/bar', 'foo/bar'),
1156 (r'\\?\C:\foo\bar', 'foo/bar'),
1157 (r'C:/../C:/foo/bar', 'C_/foo/bar'),
1158 (r'a:b\c<d>e|f"g?h*i', 'b/c_d_e_f_g_h_i'),
1159 ('../../foo../../ba..r', 'foo/ba..r'),
Gregory P. Smith09aa7522013-02-03 00:36:32 -08001160 ]
1161 self._test_extract_hackers_arcnames(windows_hacknames)
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001162
Gregory P. Smith09aa7522013-02-03 00:36:32 -08001163 @unittest.skipIf(os.path.sep != '/', r'Requires / as path separator.')
1164 def test_extract_hackers_arcnames_posix_only(self):
1165 posix_hacknames = [
1166 ('//foo/bar', 'foo/bar'),
1167 ('../../foo../../ba..r', 'foo../ba..r'),
1168 (r'foo/..\bar', r'foo/..\bar'),
1169 ]
1170 self._test_extract_hackers_arcnames(posix_hacknames)
1171
1172 def _test_extract_hackers_arcnames(self, hacknames):
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001173 for arcname, fixedname in hacknames:
1174 content = b'foobar' + arcname.encode()
1175 with zipfile.ZipFile(TESTFN2, 'w', zipfile.ZIP_STORED) as zipfp:
Serhiy Storchakae5e64442013-02-02 19:50:59 +02001176 zinfo = zipfile.ZipInfo()
1177 # preserve backslashes
1178 zinfo.filename = arcname
1179 zinfo.external_attr = 0o600 << 16
1180 zipfp.writestr(zinfo, content)
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001181
Serhiy Storchakae5e64442013-02-02 19:50:59 +02001182 arcname = arcname.replace(os.sep, "/")
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001183 targetpath = os.path.join('target', 'subdir', 'subsub')
1184 correctfile = os.path.join(targetpath, *fixedname.split('/'))
1185
1186 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
1187 writtenfile = zipfp.extract(arcname, targetpath)
Serhiy Storchakae5e64442013-02-02 19:50:59 +02001188 self.assertEqual(writtenfile, correctfile,
Gregory P. Smith09aa7522013-02-03 00:36:32 -08001189 msg='extract %r: %r != %r' %
1190 (arcname, writtenfile, correctfile))
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001191 self.check_file(correctfile, content)
Victor Stinner57004c62014-09-04 00:49:01 +02001192 rmtree('target')
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001193
1194 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
1195 zipfp.extractall(targetpath)
1196 self.check_file(correctfile, content)
Victor Stinner57004c62014-09-04 00:49:01 +02001197 rmtree('target')
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001198
1199 correctfile = os.path.join(os.getcwd(), *fixedname.split('/'))
1200
1201 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
1202 writtenfile = zipfp.extract(arcname)
Serhiy Storchakae5e64442013-02-02 19:50:59 +02001203 self.assertEqual(writtenfile, correctfile,
1204 msg="extract %r" % arcname)
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001205 self.check_file(correctfile, content)
Victor Stinner57004c62014-09-04 00:49:01 +02001206 rmtree(fixedname.split('/')[0])
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001207
1208 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
1209 zipfp.extractall()
1210 self.check_file(correctfile, content)
Victor Stinner57004c62014-09-04 00:49:01 +02001211 rmtree(fixedname.split('/')[0])
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001212
Victor Stinner88b215e2014-09-04 00:51:09 +02001213 unlink(TESTFN2)
Gregory P. Smithb47acbf2013-02-01 11:22:43 -08001214
Ronald Oussorenee5c8852010-02-07 20:24:02 +00001215
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001216class OtherTests(unittest.TestCase):
1217 def test_open_via_zip_info(self):
1218 # Create the ZIP archive
1219 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
1220 zipfp.writestr("name", "foo")
Serhiy Storchaka9b7a1a12014-01-20 21:57:40 +02001221 with self.assertWarns(UserWarning):
1222 zipfp.writestr("name", "bar")
1223 self.assertEqual(zipfp.namelist(), ["name"] * 2)
Ronald Oussorenee5c8852010-02-07 20:24:02 +00001224
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001225 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
1226 infos = zipfp.infolist()
1227 data = b""
1228 for info in infos:
1229 with zipfp.open(info) as zipopen:
1230 data += zipopen.read()
1231 self.assertIn(data, {b"foobar", b"barfoo"})
1232 data = b""
1233 for info in infos:
1234 data += zipfp.read(info)
1235 self.assertIn(data, {b"foobar", b"barfoo"})
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001236
Gregory P. Smithb0d9ca922009-07-07 05:06:04 +00001237 def test_writestr_extended_local_header_issue1202(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001238 with zipfile.ZipFile(TESTFN2, 'w') as orig_zip:
1239 for data in 'abcdefghijklmnop':
1240 zinfo = zipfile.ZipInfo(data)
1241 zinfo.flag_bits |= 0x08 # Include an extended local header.
1242 orig_zip.writestr(zinfo, data)
1243
1244 def test_close(self):
1245 """Check that the zipfile is closed after the 'with' block."""
1246 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
1247 for fpath, fdata in SMALL_TEST_DATA:
1248 zipfp.writestr(fpath, fdata)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001249 self.assertIsNotNone(zipfp.fp, 'zipfp is not open')
1250 self.assertIsNone(zipfp.fp, 'zipfp is not closed')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001251
1252 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001253 self.assertIsNotNone(zipfp.fp, 'zipfp is not open')
1254 self.assertIsNone(zipfp.fp, 'zipfp is not closed')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001255
1256 def test_close_on_exception(self):
1257 """Check that the zipfile is closed if an exception is raised in the
1258 'with' block."""
1259 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
1260 for fpath, fdata in SMALL_TEST_DATA:
1261 zipfp.writestr(fpath, fdata)
1262
1263 try:
1264 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
Georg Brandl4d540882010-10-28 06:42:33 +00001265 raise zipfile.BadZipFile()
1266 except zipfile.BadZipFile:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001267 self.assertIsNone(zipfp2.fp, 'zipfp is not closed')
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001268
Martin v. Löwisd099b562012-05-01 14:08:22 +02001269 def test_unsupported_version(self):
1270 # File has an extract_version of 120
1271 data = (b'PK\x03\x04x\x00\x00\x00\x00\x00!p\xa1@\x00\x00\x00\x00\x00\x00'
Christian Tismer59202e52013-10-21 03:59:23 +02001272 b'\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00xPK\x01\x02x\x03x\x00\x00\x00\x00'
1273 b'\x00!p\xa1@\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00'
1274 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00\x00xPK\x05\x06'
1275 b'\x00\x00\x00\x00\x01\x00\x01\x00/\x00\x00\x00\x1f\x00\x00\x00\x00\x00')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001276
Martin v. Löwisd099b562012-05-01 14:08:22 +02001277 self.assertRaises(NotImplementedError, zipfile.ZipFile,
1278 io.BytesIO(data), 'r')
1279
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001280 @requires_zlib
1281 def test_read_unicode_filenames(self):
1282 # bug #10801
1283 fname = findfile('zip_cp437_header.zip')
1284 with zipfile.ZipFile(fname) as zipfp:
1285 for name in zipfp.namelist():
1286 zipfp.open(name).close()
1287
1288 def test_write_unicode_filenames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001289 with zipfile.ZipFile(TESTFN, "w") as zf:
1290 zf.writestr("foo.txt", "Test for unicode filename")
1291 zf.writestr("\xf6.txt", "Test for unicode filename")
Ezio Melottie9615932010-01-24 19:26:24 +00001292 self.assertIsInstance(zf.infolist()[0].filename, str)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001293
1294 with zipfile.ZipFile(TESTFN, "r") as zf:
1295 self.assertEqual(zf.filelist[0].filename, "foo.txt")
1296 self.assertEqual(zf.filelist[1].filename, "\xf6.txt")
Martin v. Löwis8570f6a2008-05-05 17:44:38 +00001297
Serhiy Storchaka764fc9b2015-03-25 10:09:41 +02001298 def test_exclusive_create_zip_file(self):
1299 """Test exclusive creating a new zipfile."""
1300 unlink(TESTFN2)
1301 filename = 'testfile.txt'
1302 content = b'hello, world. this is some content.'
1303 with zipfile.ZipFile(TESTFN2, "x", zipfile.ZIP_STORED) as zipfp:
1304 zipfp.writestr(filename, content)
1305 with self.assertRaises(FileExistsError):
1306 zipfile.ZipFile(TESTFN2, "x", zipfile.ZIP_STORED)
1307 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
1308 self.assertEqual(zipfp.namelist(), [filename])
1309 self.assertEqual(zipfp.read(filename), content)
1310
Ezio Melottiafd0d112009-07-15 17:17:17 +00001311 def test_create_non_existent_file_for_append(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001312 if os.path.exists(TESTFN):
1313 os.unlink(TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001314
Thomas Wouterscf297e42007-02-23 15:07:44 +00001315 filename = 'testfile.txt'
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001316 content = b'hello, world. this is some content.'
Guido van Rossumd8faa362007-04-27 19:54:29 +00001317
Thomas Wouterscf297e42007-02-23 15:07:44 +00001318 try:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001319 with zipfile.ZipFile(TESTFN, 'a') as zf:
1320 zf.writestr(filename, content)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001321 except OSError:
Thomas Wouterscf297e42007-02-23 15:07:44 +00001322 self.fail('Could not append data to a non-existent zip file.')
1323
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001324 self.assertTrue(os.path.exists(TESTFN))
Thomas Wouterscf297e42007-02-23 15:07:44 +00001325
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001326 with zipfile.ZipFile(TESTFN, 'r') as zf:
1327 self.assertEqual(zf.read(filename), content)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001328
Ezio Melottiafd0d112009-07-15 17:17:17 +00001329 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001330 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti35386712009-12-31 13:22:41 +00001331 # it opens if there's an error in the file. If it doesn't, the
1332 # traceback holds a reference to the ZipFile object and, indirectly,
1333 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001334 # On Windows, this causes the os.unlink() call to fail because the
1335 # underlying file is still open. This is SF bug #412214.
1336 #
Ezio Melotti35386712009-12-31 13:22:41 +00001337 with open(TESTFN, "w") as fp:
1338 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001339 try:
1340 zf = zipfile.ZipFile(TESTFN)
Georg Brandl4d540882010-10-28 06:42:33 +00001341 except zipfile.BadZipFile:
Guido van Rossumd8faa362007-04-27 19:54:29 +00001342 pass
1343
Ezio Melottiafd0d112009-07-15 17:17:17 +00001344 def test_is_zip_erroneous_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001345 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001346 # - passing a filename
1347 with open(TESTFN, "w") as fp:
1348 fp.write("this is not a legal zip file\n")
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001349 self.assertFalse(zipfile.is_zipfile(TESTFN))
Serhiy Storchaka8606e952017-03-08 14:37:51 +02001350 # - passing a path-like object
1351 self.assertFalse(zipfile.is_zipfile(pathlib.Path(TESTFN)))
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001352 # - passing a file object
1353 with open(TESTFN, "rb") as fp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001354 self.assertFalse(zipfile.is_zipfile(fp))
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001355 # - passing a file-like object
1356 fp = io.BytesIO()
1357 fp.write(b"this is not a legal zip file\n")
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001358 self.assertFalse(zipfile.is_zipfile(fp))
Ezio Melotti35386712009-12-31 13:22:41 +00001359 fp.seek(0, 0)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001360 self.assertFalse(zipfile.is_zipfile(fp))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001361
Serhiy Storchakad2b15272013-01-31 15:27:07 +02001362 def test_damaged_zipfile(self):
1363 """Check that zipfiles with missing bytes at the end raise BadZipFile."""
1364 # - Create a valid zip file
1365 fp = io.BytesIO()
1366 with zipfile.ZipFile(fp, mode="w") as zipf:
1367 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
1368 zipfiledata = fp.getvalue()
1369
1370 # - Now create copies of it missing the last N bytes and make sure
1371 # a BadZipFile exception is raised when we try to open it
1372 for N in range(len(zipfiledata)):
1373 fp = io.BytesIO(zipfiledata[:N])
1374 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, fp)
1375
Ezio Melottiafd0d112009-07-15 17:17:17 +00001376 def test_is_zip_valid_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001377 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001378 # - passing a filename
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001379 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1380 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
1381
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001382 self.assertTrue(zipfile.is_zipfile(TESTFN))
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001383 # - passing a file object
1384 with open(TESTFN, "rb") as fp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001385 self.assertTrue(zipfile.is_zipfile(fp))
Ezio Melotti35386712009-12-31 13:22:41 +00001386 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001387 zip_contents = fp.read()
1388 # - passing a file-like object
1389 fp = io.BytesIO()
1390 fp.write(zip_contents)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001391 self.assertTrue(zipfile.is_zipfile(fp))
Ezio Melotti35386712009-12-31 13:22:41 +00001392 fp.seek(0, 0)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001393 self.assertTrue(zipfile.is_zipfile(fp))
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001394
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001395 def test_non_existent_file_raises_OSError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001396 # make sure we don't raise an AttributeError when a partially-constructed
1397 # ZipFile instance is finalized; this tests for regression on SF tracker
1398 # bug #403871.
1399
1400 # The bug we're testing for caused an AttributeError to be raised
1401 # when a ZipFile instance was created for a file that did not
1402 # exist; the .fp member was not initialized but was needed by the
1403 # __del__() method. Since the AttributeError is in the __del__(),
1404 # it is ignored, but the user should be sufficiently annoyed by
1405 # the message on the output that regression will be noticed
1406 # quickly.
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001407 self.assertRaises(OSError, zipfile.ZipFile, TESTFN)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001408
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +00001409 def test_empty_file_raises_BadZipFile(self):
1410 f = open(TESTFN, 'w')
1411 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001412 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +00001413
Ezio Melotti35386712009-12-31 13:22:41 +00001414 with open(TESTFN, 'w') as fp:
1415 fp.write("short file")
Georg Brandl4d540882010-10-28 06:42:33 +00001416 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +00001417
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001418 def test_closed_zip_raises_ValueError(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001419 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001420 data = io.BytesIO()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001421 with zipfile.ZipFile(data, mode="w") as zipf:
1422 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001423
Andrew Svetlov737fb892012-12-18 21:14:22 +02001424 # This is correct; calling .read on a closed ZipFile should raise
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001425 # a ValueError, and so should calling .testzip. An earlier
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001426 # version of .testzip would swallow this exception (and any other)
1427 # and report that the first file in the archive was corrupt.
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001428 self.assertRaises(ValueError, zipf.read, "foo.txt")
1429 self.assertRaises(ValueError, zipf.open, "foo.txt")
1430 self.assertRaises(ValueError, zipf.testzip)
1431 self.assertRaises(ValueError, zipf.writestr, "bogus.txt", "bogus")
Brian Curtin8fb9b862010-11-18 02:15:28 +00001432 with open(TESTFN, 'w') as f:
1433 f.write('zipfile test data')
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001434 self.assertRaises(ValueError, zipf.write, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001435
Ezio Melottiafd0d112009-07-15 17:17:17 +00001436 def test_bad_constructor_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001437 """Check that bad modes passed to ZipFile constructor are caught."""
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001438 self.assertRaises(ValueError, zipfile.ZipFile, TESTFN, "q")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001439
Ezio Melottiafd0d112009-07-15 17:17:17 +00001440 def test_bad_open_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001441 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001442 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1443 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1444
1445 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Serhiy Storchakae670be22016-06-11 19:32:44 +03001446 # read the data to make sure the file is there
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001447 zipf.read("foo.txt")
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001448 self.assertRaises(ValueError, zipf.open, "foo.txt", "q")
Serhiy Storchakae670be22016-06-11 19:32:44 +03001449 # universal newlines support is removed
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001450 self.assertRaises(ValueError, zipf.open, "foo.txt", "U")
1451 self.assertRaises(ValueError, zipf.open, "foo.txt", "rU")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001452
Ezio Melottiafd0d112009-07-15 17:17:17 +00001453 def test_read0(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001454 """Check that calling read(0) on a ZipExtFile object returns an empty
1455 string and doesn't advance file pointer."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001456 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1457 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1458 # read the data to make sure the file is there
Brian Curtin8fb9b862010-11-18 02:15:28 +00001459 with zipf.open("foo.txt") as f:
1460 for i in range(FIXEDTEST_SIZE):
1461 self.assertEqual(f.read(0), b'')
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001462
Brian Curtin8fb9b862010-11-18 02:15:28 +00001463 self.assertEqual(f.read(), b"O, for a Muse of Fire!")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001464
Ezio Melottiafd0d112009-07-15 17:17:17 +00001465 def test_open_non_existent_item(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001466 """Check that attempting to call open() for an item that doesn't
1467 exist in the archive raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001468 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1469 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001470
Ezio Melottiafd0d112009-07-15 17:17:17 +00001471 def test_bad_compression_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001472 """Check that bad compression methods passed to ZipFile.open are
1473 caught."""
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001474 self.assertRaises(NotImplementedError, zipfile.ZipFile, TESTFN, "w", -1)
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001475
Martin v. Löwisb3260f02012-05-01 08:38:01 +02001476 def test_unsupported_compression(self):
1477 # data is declared as shrunk, but actually deflated
1478 data = (b'PK\x03\x04.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00'
Christian Tismer59202e52013-10-21 03:59:23 +02001479 b'\x00\x02\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00x\x03\x00PK\x01'
1480 b'\x02.\x03.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00\x00\x02\x00\x00'
1481 b'\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
1482 b'\x80\x01\x00\x00\x00\x00xPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00'
1483 b'/\x00\x00\x00!\x00\x00\x00\x00\x00')
Martin v. Löwisb3260f02012-05-01 08:38:01 +02001484 with zipfile.ZipFile(io.BytesIO(data), 'r') as zipf:
1485 self.assertRaises(NotImplementedError, zipf.open, 'x')
1486
Ezio Melottiafd0d112009-07-15 17:17:17 +00001487 def test_null_byte_in_filename(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001488 """Check that a filename containing a null byte is properly
1489 terminated."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001490 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1491 zipf.writestr("foo.txt\x00qqq", b"O, for a Muse of Fire!")
1492 self.assertEqual(zipf.namelist(), ['foo.txt'])
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001493
Ezio Melottiafd0d112009-07-15 17:17:17 +00001494 def test_struct_sizes(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001495 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001496 self.assertEqual(zipfile.sizeEndCentDir, 22)
1497 self.assertEqual(zipfile.sizeCentralDir, 46)
1498 self.assertEqual(zipfile.sizeEndCentDir64, 56)
1499 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
1500
Ezio Melottiafd0d112009-07-15 17:17:17 +00001501 def test_comments(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001502 """Check that comments on the archive are handled properly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001503
1504 # check default comment is empty
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001505 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1506 self.assertEqual(zipf.comment, b'')
1507 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1508
1509 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1510 self.assertEqual(zipfr.comment, b'')
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001511
1512 # check a simple short comment
1513 comment = b'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001514 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1515 zipf.comment = comment
1516 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1517 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1518 self.assertEqual(zipf.comment, comment)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001519
1520 # check a comment of max length
1521 comment2 = ''.join(['%d' % (i**3 % 10) for i in range((1 << 16)-1)])
1522 comment2 = comment2.encode("ascii")
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001523 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1524 zipf.comment = comment2
1525 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1526
1527 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1528 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001529
1530 # check a comment that is too long is truncated
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001531 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
Serhiy Storchaka9b7a1a12014-01-20 21:57:40 +02001532 with self.assertWarns(UserWarning):
1533 zipf.comment = comment2 + b'oops'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001534 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1535 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1536 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001537
Antoine Pitrouc3991852012-06-30 17:31:37 +02001538 # check that comments are correctly modified in append mode
1539 with zipfile.ZipFile(TESTFN,mode="w") as zipf:
1540 zipf.comment = b"original comment"
1541 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1542 with zipfile.ZipFile(TESTFN,mode="a") as zipf:
1543 zipf.comment = b"an updated comment"
1544 with zipfile.ZipFile(TESTFN,mode="r") as zipf:
1545 self.assertEqual(zipf.comment, b"an updated comment")
1546
1547 # check that comments are correctly shortened in append mode
1548 with zipfile.ZipFile(TESTFN,mode="w") as zipf:
1549 zipf.comment = b"original comment that's longer"
1550 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1551 with zipfile.ZipFile(TESTFN,mode="a") as zipf:
1552 zipf.comment = b"shorter comment"
1553 with zipfile.ZipFile(TESTFN,mode="r") as zipf:
1554 self.assertEqual(zipf.comment, b"shorter comment")
1555
R David Murrayf50b38a2012-04-12 18:44:58 -04001556 def test_unicode_comment(self):
1557 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1558 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1559 with self.assertRaises(TypeError):
1560 zipf.comment = "this is an error"
1561
1562 def test_change_comment_in_empty_archive(self):
1563 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1564 self.assertFalse(zipf.filelist)
1565 zipf.comment = b"this is a comment"
1566 with zipfile.ZipFile(TESTFN, "r") as zipf:
1567 self.assertEqual(zipf.comment, b"this is a comment")
1568
1569 def test_change_comment_in_nonempty_archive(self):
1570 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1571 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1572 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1573 self.assertTrue(zipf.filelist)
1574 zipf.comment = b"this is a comment"
1575 with zipfile.ZipFile(TESTFN, "r") as zipf:
1576 self.assertEqual(zipf.comment, b"this is a comment")
1577
Georg Brandl268e4d42010-10-14 06:59:45 +00001578 def test_empty_zipfile(self):
1579 # Check that creating a file in 'w' or 'a' mode and closing without
1580 # adding any files to the archives creates a valid empty ZIP file
1581 zipf = zipfile.ZipFile(TESTFN, mode="w")
1582 zipf.close()
1583 try:
1584 zipf = zipfile.ZipFile(TESTFN, mode="r")
1585 except zipfile.BadZipFile:
1586 self.fail("Unable to create empty ZIP file in 'w' mode")
1587
1588 zipf = zipfile.ZipFile(TESTFN, mode="a")
1589 zipf.close()
1590 try:
1591 zipf = zipfile.ZipFile(TESTFN, mode="r")
1592 except:
1593 self.fail("Unable to create empty ZIP file in 'a' mode")
1594
1595 def test_open_empty_file(self):
1596 # Issue 1710703: Check that opening a file with less than 22 bytes
Georg Brandl4d540882010-10-28 06:42:33 +00001597 # raises a BadZipFile exception (rather than the previously unhelpful
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001598 # OSError)
Georg Brandl268e4d42010-10-14 06:59:45 +00001599 f = open(TESTFN, 'w')
1600 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001601 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN, 'r')
Georg Brandl268e4d42010-10-14 06:59:45 +00001602
Senthil Kumaran29fa9d42011-10-20 01:46:00 +08001603 def test_create_zipinfo_before_1980(self):
1604 self.assertRaises(ValueError,
1605 zipfile.ZipInfo, 'seventies', (1979, 1, 1, 0, 0, 0))
1606
Gregory P. Smith0af8a862014-05-29 23:42:14 -07001607 def test_zipfile_with_short_extra_field(self):
1608 """If an extra field in the header is less than 4 bytes, skip it."""
1609 zipdata = (
1610 b'PK\x03\x04\x14\x00\x00\x00\x00\x00\x93\x9b\xad@\x8b\x9e'
1611 b'\xd9\xd3\x01\x00\x00\x00\x01\x00\x00\x00\x03\x00\x03\x00ab'
1612 b'c\x00\x00\x00APK\x01\x02\x14\x03\x14\x00\x00\x00\x00'
1613 b'\x00\x93\x9b\xad@\x8b\x9e\xd9\xd3\x01\x00\x00\x00\x01\x00\x00'
1614 b'\x00\x03\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00'
1615 b'\x00\x00\x00abc\x00\x00PK\x05\x06\x00\x00\x00\x00'
1616 b'\x01\x00\x01\x003\x00\x00\x00%\x00\x00\x00\x00\x00'
1617 )
1618 with zipfile.ZipFile(io.BytesIO(zipdata), 'r') as zipf:
1619 # testzip returns the name of the first corrupt file, or None
1620 self.assertIsNone(zipf.testzip())
1621
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +03001622 def test_open_conflicting_handles(self):
1623 # It's only possible to open one writable file handle at a time
1624 msg1 = b"It's fun to charter an accountant!"
1625 msg2 = b"And sail the wide accountant sea"
1626 msg3 = b"To find, explore the funds offshore"
1627 with zipfile.ZipFile(TESTFN2, 'w', zipfile.ZIP_STORED) as zipf:
1628 with zipf.open('foo', mode='w') as w2:
1629 w2.write(msg1)
1630 with zipf.open('bar', mode='w') as w1:
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001631 with self.assertRaises(ValueError):
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +03001632 zipf.open('handle', mode='w')
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001633 with self.assertRaises(ValueError):
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +03001634 zipf.open('foo', mode='r')
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001635 with self.assertRaises(ValueError):
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +03001636 zipf.writestr('str', 'abcde')
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001637 with self.assertRaises(ValueError):
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +03001638 zipf.write(__file__, 'file')
Serhiy Storchakab0d497c2016-09-10 21:28:07 +03001639 with self.assertRaises(ValueError):
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +03001640 zipf.close()
1641 w1.write(msg2)
1642 with zipf.open('baz', mode='w') as w2:
1643 w2.write(msg3)
1644
1645 with zipfile.ZipFile(TESTFN2, 'r') as zipf:
1646 self.assertEqual(zipf.read('foo'), msg1)
1647 self.assertEqual(zipf.read('bar'), msg2)
1648 self.assertEqual(zipf.read('baz'), msg3)
1649 self.assertEqual(zipf.namelist(), ['foo', 'bar', 'baz'])
1650
John Jolly066df4f2018-01-30 01:51:35 -07001651 def test_seek_tell(self):
1652 # Test seek functionality
1653 txt = b"Where's Bruce?"
1654 bloc = txt.find(b"Bruce")
1655 # Check seek on a file
1656 with zipfile.ZipFile(TESTFN, "w") as zipf:
1657 zipf.writestr("foo.txt", txt)
1658 with zipfile.ZipFile(TESTFN, "r") as zipf:
1659 with zipf.open("foo.txt", "r") as fp:
1660 fp.seek(bloc, os.SEEK_SET)
1661 self.assertEqual(fp.tell(), bloc)
1662 fp.seek(-bloc, os.SEEK_CUR)
1663 self.assertEqual(fp.tell(), 0)
1664 fp.seek(bloc, os.SEEK_CUR)
1665 self.assertEqual(fp.tell(), bloc)
1666 self.assertEqual(fp.read(5), txt[bloc:bloc+5])
1667 fp.seek(0, os.SEEK_END)
1668 self.assertEqual(fp.tell(), len(txt))
Mickaël Schoentgen3f8c6912018-07-29 20:26:52 +02001669 fp.seek(0, os.SEEK_SET)
1670 self.assertEqual(fp.tell(), 0)
John Jolly066df4f2018-01-30 01:51:35 -07001671 # Check seek on memory file
1672 data = io.BytesIO()
1673 with zipfile.ZipFile(data, mode="w") as zipf:
1674 zipf.writestr("foo.txt", txt)
1675 with zipfile.ZipFile(data, mode="r") as zipf:
1676 with zipf.open("foo.txt", "r") as fp:
1677 fp.seek(bloc, os.SEEK_SET)
1678 self.assertEqual(fp.tell(), bloc)
1679 fp.seek(-bloc, os.SEEK_CUR)
1680 self.assertEqual(fp.tell(), 0)
1681 fp.seek(bloc, os.SEEK_CUR)
1682 self.assertEqual(fp.tell(), bloc)
1683 self.assertEqual(fp.read(5), txt[bloc:bloc+5])
1684 fp.seek(0, os.SEEK_END)
1685 self.assertEqual(fp.tell(), len(txt))
Mickaël Schoentgen3f8c6912018-07-29 20:26:52 +02001686 fp.seek(0, os.SEEK_SET)
1687 self.assertEqual(fp.tell(), 0)
John Jolly066df4f2018-01-30 01:51:35 -07001688
Guido van Rossumd8faa362007-04-27 19:54:29 +00001689 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001690 unlink(TESTFN)
1691 unlink(TESTFN2)
1692
Thomas Wouterscf297e42007-02-23 15:07:44 +00001693
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001694class AbstractBadCrcTests:
1695 def test_testzip_with_bad_crc(self):
1696 """Tests that files with bad CRCs return their name from testzip."""
1697 zipdata = self.zip_with_bad_crc
1698
1699 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1700 # testzip returns the name of the first corrupt file, or None
1701 self.assertEqual('afile', zipf.testzip())
1702
1703 def test_read_with_bad_crc(self):
1704 """Tests that files with bad CRCs raise a BadZipFile exception when read."""
1705 zipdata = self.zip_with_bad_crc
1706
1707 # Using ZipFile.read()
1708 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1709 self.assertRaises(zipfile.BadZipFile, zipf.read, 'afile')
1710
1711 # Using ZipExtFile.read()
1712 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1713 with zipf.open('afile', 'r') as corrupt_file:
1714 self.assertRaises(zipfile.BadZipFile, corrupt_file.read)
1715
1716 # Same with small reads (in order to exercise the buffering logic)
1717 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1718 with zipf.open('afile', 'r') as corrupt_file:
1719 corrupt_file.MIN_READ_SIZE = 2
1720 with self.assertRaises(zipfile.BadZipFile):
1721 while corrupt_file.read(2):
1722 pass
1723
1724
1725class StoredBadCrcTests(AbstractBadCrcTests, unittest.TestCase):
1726 compression = zipfile.ZIP_STORED
1727 zip_with_bad_crc = (
Christian Tismer59202e52013-10-21 03:59:23 +02001728 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
1729 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
1730 b'ilehello,AworldP'
1731 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
1732 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
1733 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
1734 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
1735 b'\0\0/\0\0\0\0\0')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001736
1737@requires_zlib
1738class DeflateBadCrcTests(AbstractBadCrcTests, unittest.TestCase):
1739 compression = zipfile.ZIP_DEFLATED
1740 zip_with_bad_crc = (
Christian Tismer59202e52013-10-21 03:59:23 +02001741 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
1742 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
1743 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
1744 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
1745 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
1746 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
1747 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
1748 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001749
1750@requires_bz2
1751class Bzip2BadCrcTests(AbstractBadCrcTests, unittest.TestCase):
1752 compression = zipfile.ZIP_BZIP2
1753 zip_with_bad_crc = (
Christian Tismer59202e52013-10-21 03:59:23 +02001754 b'PK\x03\x04\x14\x03\x00\x00\x0c\x00nu\x0c=FA'
1755 b'KE8\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
1756 b'ileBZh91AY&SY\xd4\xa8\xca'
1757 b'\x7f\x00\x00\x0f\x11\x80@\x00\x06D\x90\x80 \x00 \xa5'
1758 b'P\xd9!\x03\x03\x13\x13\x13\x89\xa9\xa9\xc2u5:\x9f'
1759 b'\x8b\xb9"\x9c(HjTe?\x80PK\x01\x02\x14'
1760 b'\x03\x14\x03\x00\x00\x0c\x00nu\x0c=FAKE8'
1761 b'\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00\x00\x00\x00\x00\x00'
1762 b'\x00 \x80\x80\x81\x00\x00\x00\x00afilePK'
1763 b'\x05\x06\x00\x00\x00\x00\x01\x00\x01\x003\x00\x00\x00[\x00'
1764 b'\x00\x00\x00\x00')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001765
1766@requires_lzma
1767class LzmaBadCrcTests(AbstractBadCrcTests, unittest.TestCase):
1768 compression = zipfile.ZIP_LZMA
1769 zip_with_bad_crc = (
Christian Tismer59202e52013-10-21 03:59:23 +02001770 b'PK\x03\x04\x14\x03\x00\x00\x0e\x00nu\x0c=FA'
1771 b'KE\x1b\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
1772 b'ile\t\x04\x05\x00]\x00\x00\x00\x04\x004\x19I'
1773 b'\xee\x8d\xe9\x17\x89:3`\tq!.8\x00PK'
1774 b'\x01\x02\x14\x03\x14\x03\x00\x00\x0e\x00nu\x0c=FA'
1775 b'KE\x1b\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00\x00\x00'
1776 b'\x00\x00\x00\x00 \x80\x80\x81\x00\x00\x00\x00afil'
1777 b'ePK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x003\x00\x00'
1778 b'\x00>\x00\x00\x00\x00\x00')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001779
1780
Thomas Wouterscf297e42007-02-23 15:07:44 +00001781class DecryptionTests(unittest.TestCase):
Ezio Melotti35386712009-12-31 13:22:41 +00001782 """Check that ZIP decryption works. Since the library does not
1783 support encryption at the moment, we use a pre-generated encrypted
1784 ZIP file."""
Thomas Wouterscf297e42007-02-23 15:07:44 +00001785
1786 data = (
Christian Tismer59202e52013-10-21 03:59:23 +02001787 b'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1788 b'\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1789 b'\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1790 b'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1791 b'\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1792 b'\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1793 b'\x00\x00L\x00\x00\x00\x00\x00' )
Christian Heimesfdab48e2008-01-20 09:06:41 +00001794 data2 = (
Christian Tismer59202e52013-10-21 03:59:23 +02001795 b'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1796 b'\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1797 b'\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1798 b'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1799 b'\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1800 b'\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1801 b'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1802 b'\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Thomas Wouterscf297e42007-02-23 15:07:44 +00001803
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001804 plain = b'zipfile.py encryption test'
Christian Heimesfdab48e2008-01-20 09:06:41 +00001805 plain2 = b'\x00'*512
Thomas Wouterscf297e42007-02-23 15:07:44 +00001806
1807 def setUp(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001808 with open(TESTFN, "wb") as fp:
1809 fp.write(self.data)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001810 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti35386712009-12-31 13:22:41 +00001811 with open(TESTFN2, "wb") as fp:
1812 fp.write(self.data2)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001813 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001814
1815 def tearDown(self):
1816 self.zip.close()
1817 os.unlink(TESTFN)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001818 self.zip2.close()
1819 os.unlink(TESTFN2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001820
Ezio Melottiafd0d112009-07-15 17:17:17 +00001821 def test_no_password(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001822 # Reading the encrypted file without password
1823 # must generate a RunTime exception
1824 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001825 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001826
Ezio Melottiafd0d112009-07-15 17:17:17 +00001827 def test_bad_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001828 self.zip.setpassword(b"perl")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001829 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001830 self.zip2.setpassword(b"perl")
1831 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001832
Ezio Melotti975077a2011-05-19 22:03:22 +03001833 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001834 def test_good_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001835 self.zip.setpassword(b"python")
Ezio Melotti35386712009-12-31 13:22:41 +00001836 self.assertEqual(self.zip.read("test.txt"), self.plain)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001837 self.zip2.setpassword(b"12345")
Ezio Melotti35386712009-12-31 13:22:41 +00001838 self.assertEqual(self.zip2.read("zero"), self.plain2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001839
R. David Murray8d855d82010-12-21 21:53:37 +00001840 def test_unicode_password(self):
1841 self.assertRaises(TypeError, self.zip.setpassword, "unicode")
1842 self.assertRaises(TypeError, self.zip.read, "test.txt", "python")
1843 self.assertRaises(TypeError, self.zip.open, "test.txt", pwd="python")
1844 self.assertRaises(TypeError, self.zip.extract, "test.txt", pwd="python")
1845
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001846class AbstractTestsWithRandomBinaryFiles:
1847 @classmethod
1848 def setUpClass(cls):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001849 datacount = randint(16, 64)*1024 + randint(1, 1024)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001850 cls.data = b''.join(struct.pack('<f', random()*randint(-1000, 1000))
1851 for i in range(datacount))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001852
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001853 def setUp(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001854 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +00001855 with open(TESTFN, "wb") as fp:
1856 fp.write(self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001857
1858 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001859 unlink(TESTFN)
1860 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001861
Ezio Melottiafd0d112009-07-15 17:17:17 +00001862 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001863 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001864 with zipfile.ZipFile(f, "w", compression) as zipfp:
1865 zipfp.write(TESTFN, "another.name")
1866 zipfp.write(TESTFN, TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001867
Ezio Melottiafd0d112009-07-15 17:17:17 +00001868 def zip_test(self, f, compression):
1869 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001870
1871 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001872 with zipfile.ZipFile(f, "r", compression) as zipfp:
1873 testdata = zipfp.read(TESTFN)
1874 self.assertEqual(len(testdata), len(self.data))
1875 self.assertEqual(testdata, self.data)
1876 self.assertEqual(zipfp.read("another.name"), self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001877
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001878 def test_read(self):
1879 for f in get_files(self):
1880 self.zip_test(f, self.compression)
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +02001881
Ezio Melottiafd0d112009-07-15 17:17:17 +00001882 def zip_open_test(self, f, compression):
1883 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001884
1885 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001886 with zipfile.ZipFile(f, "r", compression) as zipfp:
1887 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001888 with zipfp.open(TESTFN) as zipopen1:
1889 while True:
1890 read_data = zipopen1.read(256)
1891 if not read_data:
1892 break
1893 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001894
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001895 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001896 with zipfp.open("another.name") as zipopen2:
1897 while True:
1898 read_data = zipopen2.read(256)
1899 if not read_data:
1900 break
1901 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001902
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001903 testdata1 = b''.join(zipdata1)
1904 self.assertEqual(len(testdata1), len(self.data))
1905 self.assertEqual(testdata1, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001906
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001907 testdata2 = b''.join(zipdata2)
Ezio Melotti35386712009-12-31 13:22:41 +00001908 self.assertEqual(len(testdata2), len(self.data))
1909 self.assertEqual(testdata2, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001910
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001911 def test_open(self):
1912 for f in get_files(self):
1913 self.zip_open_test(f, self.compression)
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +02001914
Ezio Melottiafd0d112009-07-15 17:17:17 +00001915 def zip_random_open_test(self, f, compression):
1916 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001917
1918 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001919 with zipfile.ZipFile(f, "r", compression) as zipfp:
1920 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001921 with zipfp.open(TESTFN) as zipopen1:
1922 while True:
1923 read_data = zipopen1.read(randint(1, 1024))
1924 if not read_data:
1925 break
1926 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001927
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001928 testdata = b''.join(zipdata1)
1929 self.assertEqual(len(testdata), len(self.data))
1930 self.assertEqual(testdata, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001931
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001932 def test_random_open(self):
1933 for f in get_files(self):
1934 self.zip_random_open_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001935
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001936
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001937class StoredTestsWithRandomBinaryFiles(AbstractTestsWithRandomBinaryFiles,
1938 unittest.TestCase):
1939 compression = zipfile.ZIP_STORED
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001940
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001941@requires_zlib
1942class DeflateTestsWithRandomBinaryFiles(AbstractTestsWithRandomBinaryFiles,
1943 unittest.TestCase):
1944 compression = zipfile.ZIP_DEFLATED
1945
1946@requires_bz2
1947class Bzip2TestsWithRandomBinaryFiles(AbstractTestsWithRandomBinaryFiles,
1948 unittest.TestCase):
1949 compression = zipfile.ZIP_BZIP2
1950
1951@requires_lzma
1952class LzmaTestsWithRandomBinaryFiles(AbstractTestsWithRandomBinaryFiles,
1953 unittest.TestCase):
1954 compression = zipfile.ZIP_LZMA
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +02001955
Ezio Melotti76430242009-07-11 18:28:48 +00001956
luzpaza5293b42017-11-05 07:37:50 -06001957# Provide the tell() method but not seek()
Serhiy Storchakaa14f7d22015-01-26 14:01:27 +02001958class Tellable:
1959 def __init__(self, fp):
1960 self.fp = fp
1961 self.offset = 0
1962
1963 def write(self, data):
Serhiy Storchaka77d89972015-03-23 01:09:35 +02001964 n = self.fp.write(data)
1965 self.offset += n
1966 return n
Serhiy Storchakaa14f7d22015-01-26 14:01:27 +02001967
1968 def tell(self):
1969 return self.offset
1970
1971 def flush(self):
Serhiy Storchaka77d89972015-03-23 01:09:35 +02001972 self.fp.flush()
1973
1974class Unseekable:
1975 def __init__(self, fp):
1976 self.fp = fp
1977
1978 def write(self, data):
1979 return self.fp.write(data)
1980
1981 def flush(self):
1982 self.fp.flush()
Serhiy Storchakaa14f7d22015-01-26 14:01:27 +02001983
1984class UnseekableTests(unittest.TestCase):
Serhiy Storchaka77d89972015-03-23 01:09:35 +02001985 def test_writestr(self):
1986 for wrapper in (lambda f: f), Tellable, Unseekable:
1987 with self.subTest(wrapper=wrapper):
1988 f = io.BytesIO()
1989 f.write(b'abc')
1990 bf = io.BufferedWriter(f)
1991 with zipfile.ZipFile(wrapper(bf), 'w', zipfile.ZIP_STORED) as zipfp:
1992 zipfp.writestr('ones', b'111')
1993 zipfp.writestr('twos', b'222')
1994 self.assertEqual(f.getvalue()[:5], b'abcPK')
1995 with zipfile.ZipFile(f, mode='r') as zipf:
1996 with zipf.open('ones') as zopen:
1997 self.assertEqual(zopen.read(), b'111')
1998 with zipf.open('twos') as zopen:
1999 self.assertEqual(zopen.read(), b'222')
2000
2001 def test_write(self):
2002 for wrapper in (lambda f: f), Tellable, Unseekable:
2003 with self.subTest(wrapper=wrapper):
2004 f = io.BytesIO()
2005 f.write(b'abc')
2006 bf = io.BufferedWriter(f)
2007 with zipfile.ZipFile(wrapper(bf), 'w', zipfile.ZIP_STORED) as zipfp:
2008 self.addCleanup(unlink, TESTFN)
2009 with open(TESTFN, 'wb') as f2:
2010 f2.write(b'111')
2011 zipfp.write(TESTFN, 'ones')
2012 with open(TESTFN, 'wb') as f2:
2013 f2.write(b'222')
2014 zipfp.write(TESTFN, 'twos')
2015 self.assertEqual(f.getvalue()[:5], b'abcPK')
2016 with zipfile.ZipFile(f, mode='r') as zipf:
2017 with zipf.open('ones') as zopen:
2018 self.assertEqual(zopen.read(), b'111')
2019 with zipf.open('twos') as zopen:
2020 self.assertEqual(zopen.read(), b'222')
Serhiy Storchakaa14f7d22015-01-26 14:01:27 +02002021
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +03002022 def test_open_write(self):
2023 for wrapper in (lambda f: f), Tellable, Unseekable:
2024 with self.subTest(wrapper=wrapper):
2025 f = io.BytesIO()
2026 f.write(b'abc')
2027 bf = io.BufferedWriter(f)
2028 with zipfile.ZipFile(wrapper(bf), 'w', zipfile.ZIP_STORED) as zipf:
2029 with zipf.open('ones', 'w') as zopen:
2030 zopen.write(b'111')
2031 with zipf.open('twos', 'w') as zopen:
2032 zopen.write(b'222')
2033 self.assertEqual(f.getvalue()[:5], b'abcPK')
2034 with zipfile.ZipFile(f) as zipf:
2035 self.assertEqual(zipf.read('ones'), b'111')
2036 self.assertEqual(zipf.read('twos'), b'222')
2037
Serhiy Storchakaa14f7d22015-01-26 14:01:27 +02002038
Ezio Melotti975077a2011-05-19 22:03:22 +03002039@requires_zlib
Guido van Rossumd8faa362007-04-27 19:54:29 +00002040class TestsWithMultipleOpens(unittest.TestCase):
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02002041 @classmethod
2042 def setUpClass(cls):
2043 cls.data1 = b'111' + getrandbytes(10000)
2044 cls.data2 = b'222' + getrandbytes(10000)
2045
2046 def make_test_archive(self, f):
Guido van Rossumd8faa362007-04-27 19:54:29 +00002047 # Create the ZIP archive
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02002048 with zipfile.ZipFile(f, "w", zipfile.ZIP_DEFLATED) as zipfp:
2049 zipfp.writestr('ones', self.data1)
2050 zipfp.writestr('twos', self.data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00002051
Ezio Melottiafd0d112009-07-15 17:17:17 +00002052 def test_same_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00002053 # Verify that (when the ZipFile is in control of creating file objects)
2054 # multiple open() calls can be made without interfering with each other.
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02002055 for f in get_files(self):
2056 self.make_test_archive(f)
2057 with zipfile.ZipFile(f, mode="r") as zipf:
2058 with zipf.open('ones') as zopen1, zipf.open('ones') as zopen2:
2059 data1 = zopen1.read(500)
2060 data2 = zopen2.read(500)
2061 data1 += zopen1.read()
2062 data2 += zopen2.read()
2063 self.assertEqual(data1, data2)
2064 self.assertEqual(data1, self.data1)
Guido van Rossumd8faa362007-04-27 19:54:29 +00002065
Ezio Melottiafd0d112009-07-15 17:17:17 +00002066 def test_different_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00002067 # Verify that (when the ZipFile is in control of creating file objects)
2068 # multiple open() calls can be made without interfering with each other.
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02002069 for f in get_files(self):
2070 self.make_test_archive(f)
2071 with zipfile.ZipFile(f, mode="r") as zipf:
2072 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
2073 data1 = zopen1.read(500)
2074 data2 = zopen2.read(500)
2075 data1 += zopen1.read()
2076 data2 += zopen2.read()
2077 self.assertEqual(data1, self.data1)
2078 self.assertEqual(data2, self.data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00002079
Ezio Melottiafd0d112009-07-15 17:17:17 +00002080 def test_interleaved(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00002081 # Verify that (when the ZipFile is in control of creating file objects)
2082 # multiple open() calls can be made without interfering with each other.
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02002083 for f in get_files(self):
2084 self.make_test_archive(f)
2085 with zipfile.ZipFile(f, mode="r") as zipf:
Serhiy Storchakad76c7c22016-05-13 21:18:58 +03002086 with zipf.open('ones') as zopen1:
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02002087 data1 = zopen1.read(500)
Serhiy Storchakad76c7c22016-05-13 21:18:58 +03002088 with zipf.open('twos') as zopen2:
2089 data2 = zopen2.read(500)
2090 data1 += zopen1.read()
2091 data2 += zopen2.read()
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02002092 self.assertEqual(data1, self.data1)
2093 self.assertEqual(data2, self.data2)
2094
2095 def test_read_after_close(self):
2096 for f in get_files(self):
2097 self.make_test_archive(f)
2098 with contextlib.ExitStack() as stack:
2099 with zipfile.ZipFile(f, 'r') as zipf:
2100 zopen1 = stack.enter_context(zipf.open('ones'))
2101 zopen2 = stack.enter_context(zipf.open('twos'))
Brian Curtin8fb9b862010-11-18 02:15:28 +00002102 data1 = zopen1.read(500)
2103 data2 = zopen2.read(500)
Serhiy Storchaka1ad088f2014-12-03 09:11:57 +02002104 data1 += zopen1.read()
2105 data2 += zopen2.read()
2106 self.assertEqual(data1, self.data1)
2107 self.assertEqual(data2, self.data2)
2108
2109 def test_read_after_write(self):
2110 for f in get_files(self):
2111 with zipfile.ZipFile(f, 'w', zipfile.ZIP_DEFLATED) as zipf:
2112 zipf.writestr('ones', self.data1)
2113 zipf.writestr('twos', self.data2)
2114 with zipf.open('ones') as zopen1:
2115 data1 = zopen1.read(500)
2116 self.assertEqual(data1, self.data1[:500])
2117 with zipfile.ZipFile(f, 'r') as zipf:
2118 data1 = zipf.read('ones')
2119 data2 = zipf.read('twos')
2120 self.assertEqual(data1, self.data1)
2121 self.assertEqual(data2, self.data2)
2122
2123 def test_write_after_read(self):
2124 for f in get_files(self):
2125 with zipfile.ZipFile(f, "w", zipfile.ZIP_DEFLATED) as zipf:
2126 zipf.writestr('ones', self.data1)
2127 with zipf.open('ones') as zopen1:
2128 zopen1.read(500)
2129 zipf.writestr('twos', self.data2)
2130 with zipfile.ZipFile(f, 'r') as zipf:
2131 data1 = zipf.read('ones')
2132 data2 = zipf.read('twos')
2133 self.assertEqual(data1, self.data1)
2134 self.assertEqual(data2, self.data2)
2135
2136 def test_many_opens(self):
2137 # Verify that read() and open() promptly close the file descriptor,
2138 # and don't rely on the garbage collector to free resources.
2139 self.make_test_archive(TESTFN2)
2140 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
2141 for x in range(100):
2142 zipf.read('ones')
2143 with zipf.open('ones') as zopen1:
2144 pass
2145 with open(os.devnull) as f:
2146 self.assertLess(f.fileno(), 100)
Guido van Rossumd8faa362007-04-27 19:54:29 +00002147
Serhiy Storchaka18ee29d2016-05-13 13:52:49 +03002148 def test_write_while_reading(self):
2149 with zipfile.ZipFile(TESTFN2, 'w', zipfile.ZIP_DEFLATED) as zipf:
2150 zipf.writestr('ones', self.data1)
2151 with zipfile.ZipFile(TESTFN2, 'a', zipfile.ZIP_DEFLATED) as zipf:
2152 with zipf.open('ones', 'r') as r1:
2153 data1 = r1.read(500)
2154 with zipf.open('twos', 'w') as w1:
2155 w1.write(self.data2)
2156 data1 += r1.read()
2157 self.assertEqual(data1, self.data1)
2158 with zipfile.ZipFile(TESTFN2) as zipf:
2159 self.assertEqual(zipf.read('twos'), self.data2)
2160
Guido van Rossumd8faa362007-04-27 19:54:29 +00002161 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00002162 unlink(TESTFN2)
2163
Guido van Rossumd8faa362007-04-27 19:54:29 +00002164
Martin v. Löwis59e47792009-01-24 14:10:07 +00002165class TestWithDirectory(unittest.TestCase):
2166 def setUp(self):
2167 os.mkdir(TESTFN2)
2168
Ezio Melottiafd0d112009-07-15 17:17:17 +00002169 def test_extract_dir(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00002170 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
2171 zipf.extractall(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00002172 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
2173 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
2174 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
2175
Ezio Melottiafd0d112009-07-15 17:17:17 +00002176 def test_bug_6050(self):
Martin v. Löwis70ccd162009-05-24 19:47:22 +00002177 # Extraction should succeed if directories already exist
2178 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottiafd0d112009-07-15 17:17:17 +00002179 self.test_extract_dir()
Martin v. Löwis70ccd162009-05-24 19:47:22 +00002180
Serhiy Storchaka46a34922014-09-23 22:40:23 +03002181 def test_write_dir(self):
2182 dirpath = os.path.join(TESTFN2, "x")
2183 os.mkdir(dirpath)
2184 mode = os.stat(dirpath).st_mode & 0xFFFF
2185 with zipfile.ZipFile(TESTFN, "w") as zipf:
2186 zipf.write(dirpath)
2187 zinfo = zipf.filelist[0]
2188 self.assertTrue(zinfo.filename.endswith("/x/"))
2189 self.assertEqual(zinfo.external_attr, (mode << 16) | 0x10)
2190 zipf.write(dirpath, "y")
2191 zinfo = zipf.filelist[1]
2192 self.assertTrue(zinfo.filename, "y/")
2193 self.assertEqual(zinfo.external_attr, (mode << 16) | 0x10)
2194 with zipfile.ZipFile(TESTFN, "r") as zipf:
2195 zinfo = zipf.filelist[0]
2196 self.assertTrue(zinfo.filename.endswith("/x/"))
2197 self.assertEqual(zinfo.external_attr, (mode << 16) | 0x10)
2198 zinfo = zipf.filelist[1]
2199 self.assertTrue(zinfo.filename, "y/")
2200 self.assertEqual(zinfo.external_attr, (mode << 16) | 0x10)
2201 target = os.path.join(TESTFN2, "target")
2202 os.mkdir(target)
2203 zipf.extractall(target)
2204 self.assertTrue(os.path.isdir(os.path.join(target, "y")))
2205 self.assertEqual(len(os.listdir(target)), 2)
2206
2207 def test_writestr_dir(self):
Martin v. Löwis59e47792009-01-24 14:10:07 +00002208 os.mkdir(os.path.join(TESTFN2, "x"))
Serhiy Storchaka46a34922014-09-23 22:40:23 +03002209 with zipfile.ZipFile(TESTFN, "w") as zipf:
2210 zipf.writestr("x/", b'')
2211 zinfo = zipf.filelist[0]
2212 self.assertEqual(zinfo.filename, "x/")
2213 self.assertEqual(zinfo.external_attr, (0o40775 << 16) | 0x10)
2214 with zipfile.ZipFile(TESTFN, "r") as zipf:
2215 zinfo = zipf.filelist[0]
2216 self.assertTrue(zinfo.filename.endswith("x/"))
2217 self.assertEqual(zinfo.external_attr, (0o40775 << 16) | 0x10)
2218 target = os.path.join(TESTFN2, "target")
2219 os.mkdir(target)
2220 zipf.extractall(target)
2221 self.assertTrue(os.path.isdir(os.path.join(target, "x")))
2222 self.assertEqual(os.listdir(target), ["x"])
Martin v. Löwis59e47792009-01-24 14:10:07 +00002223
2224 def tearDown(self):
Victor Stinner57004c62014-09-04 00:49:01 +02002225 rmtree(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00002226 if os.path.exists(TESTFN):
Ezio Melotti76430242009-07-11 18:28:48 +00002227 unlink(TESTFN)
Martin v. Löwis59e47792009-01-24 14:10:07 +00002228
Guido van Rossumd8faa362007-04-27 19:54:29 +00002229
Serhiy Storchaka503f9082016-02-08 00:02:25 +02002230class ZipInfoTests(unittest.TestCase):
2231 def test_from_file(self):
2232 zi = zipfile.ZipInfo.from_file(__file__)
2233 self.assertEqual(posixpath.basename(zi.filename), 'test_zipfile.py')
2234 self.assertFalse(zi.is_dir())
Serhiy Storchaka8606e952017-03-08 14:37:51 +02002235 self.assertEqual(zi.file_size, os.path.getsize(__file__))
2236
2237 def test_from_file_pathlike(self):
2238 zi = zipfile.ZipInfo.from_file(pathlib.Path(__file__))
2239 self.assertEqual(posixpath.basename(zi.filename), 'test_zipfile.py')
2240 self.assertFalse(zi.is_dir())
2241 self.assertEqual(zi.file_size, os.path.getsize(__file__))
2242
2243 def test_from_file_bytes(self):
2244 zi = zipfile.ZipInfo.from_file(os.fsencode(__file__), 'test')
2245 self.assertEqual(posixpath.basename(zi.filename), 'test')
2246 self.assertFalse(zi.is_dir())
2247 self.assertEqual(zi.file_size, os.path.getsize(__file__))
2248
2249 def test_from_file_fileno(self):
2250 with open(__file__, 'rb') as f:
2251 zi = zipfile.ZipInfo.from_file(f.fileno(), 'test')
2252 self.assertEqual(posixpath.basename(zi.filename), 'test')
2253 self.assertFalse(zi.is_dir())
2254 self.assertEqual(zi.file_size, os.path.getsize(__file__))
Serhiy Storchaka503f9082016-02-08 00:02:25 +02002255
2256 def test_from_dir(self):
2257 dirpath = os.path.dirname(os.path.abspath(__file__))
2258 zi = zipfile.ZipInfo.from_file(dirpath, 'stdlib_tests')
2259 self.assertEqual(zi.filename, 'stdlib_tests/')
2260 self.assertTrue(zi.is_dir())
2261 self.assertEqual(zi.compress_type, zipfile.ZIP_STORED)
2262 self.assertEqual(zi.file_size, 0)
2263
Serhiy Storchaka61c4c442016-10-23 13:07:59 +03002264
2265class CommandLineTest(unittest.TestCase):
2266
2267 def zipfilecmd(self, *args, **kwargs):
2268 rc, out, err = script_helper.assert_python_ok('-m', 'zipfile', *args,
2269 **kwargs)
2270 return out.replace(os.linesep.encode(), b'\n')
2271
2272 def zipfilecmd_failure(self, *args):
2273 return script_helper.assert_python_failure('-m', 'zipfile', *args)
2274
Serhiy Storchaka150cd192017-04-07 18:56:12 +03002275 def test_bad_use(self):
2276 rc, out, err = self.zipfilecmd_failure()
2277 self.assertEqual(out, b'')
2278 self.assertIn(b'usage', err.lower())
2279 self.assertIn(b'error', err.lower())
2280 self.assertIn(b'required', err.lower())
2281 rc, out, err = self.zipfilecmd_failure('-l', '')
2282 self.assertEqual(out, b'')
2283 self.assertNotEqual(err.strip(), b'')
2284
Serhiy Storchaka61c4c442016-10-23 13:07:59 +03002285 def test_test_command(self):
2286 zip_name = findfile('zipdir.zip')
Serhiy Storchaka8c933102016-10-23 13:32:12 +03002287 for opt in '-t', '--test':
2288 out = self.zipfilecmd(opt, zip_name)
2289 self.assertEqual(out.rstrip(), b'Done testing')
Serhiy Storchaka61c4c442016-10-23 13:07:59 +03002290 zip_name = findfile('testtar.tar')
2291 rc, out, err = self.zipfilecmd_failure('-t', zip_name)
2292 self.assertEqual(out, b'')
2293
2294 def test_list_command(self):
2295 zip_name = findfile('zipdir.zip')
2296 t = io.StringIO()
2297 with zipfile.ZipFile(zip_name, 'r') as tf:
2298 tf.printdir(t)
2299 expected = t.getvalue().encode('ascii', 'backslashreplace')
Serhiy Storchaka8c933102016-10-23 13:32:12 +03002300 for opt in '-l', '--list':
2301 out = self.zipfilecmd(opt, zip_name,
2302 PYTHONIOENCODING='ascii:backslashreplace')
2303 self.assertEqual(out, expected)
Serhiy Storchaka61c4c442016-10-23 13:07:59 +03002304
Serhiy Storchakab4293ef2016-10-23 22:32:30 +03002305 @requires_zlib
Serhiy Storchaka61c4c442016-10-23 13:07:59 +03002306 def test_create_command(self):
2307 self.addCleanup(unlink, TESTFN)
2308 with open(TESTFN, 'w') as f:
2309 f.write('test 1')
2310 os.mkdir(TESTFNDIR)
2311 self.addCleanup(rmtree, TESTFNDIR)
2312 with open(os.path.join(TESTFNDIR, 'file.txt'), 'w') as f:
2313 f.write('test 2')
2314 files = [TESTFN, TESTFNDIR]
2315 namelist = [TESTFN, TESTFNDIR + '/', TESTFNDIR + '/file.txt']
Serhiy Storchaka8c933102016-10-23 13:32:12 +03002316 for opt in '-c', '--create':
2317 try:
2318 out = self.zipfilecmd(opt, TESTFN2, *files)
2319 self.assertEqual(out, b'')
2320 with zipfile.ZipFile(TESTFN2) as zf:
2321 self.assertEqual(zf.namelist(), namelist)
2322 self.assertEqual(zf.read(namelist[0]), b'test 1')
2323 self.assertEqual(zf.read(namelist[2]), b'test 2')
2324 finally:
2325 unlink(TESTFN2)
Serhiy Storchaka61c4c442016-10-23 13:07:59 +03002326
2327 def test_extract_command(self):
2328 zip_name = findfile('zipdir.zip')
Serhiy Storchaka8c933102016-10-23 13:32:12 +03002329 for opt in '-e', '--extract':
2330 with temp_dir() as extdir:
2331 out = self.zipfilecmd(opt, zip_name, extdir)
2332 self.assertEqual(out, b'')
2333 with zipfile.ZipFile(zip_name) as zf:
2334 for zi in zf.infolist():
2335 path = os.path.join(extdir,
2336 zi.filename.replace('/', os.sep))
2337 if zi.is_dir():
2338 self.assertTrue(os.path.isdir(path))
2339 else:
2340 self.assertTrue(os.path.isfile(path))
2341 with open(path, 'rb') as f:
2342 self.assertEqual(f.read(), zf.read(zi))
Serhiy Storchaka61c4c442016-10-23 13:07:59 +03002343
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00002344if __name__ == "__main__":
Brett Cannond5b4e1d2013-06-12 19:57:19 -04002345 unittest.main()