blob: 7249b13d4c2b51e2cd3e175826790b4309d246d1 [file] [log] [blame]
Ezio Melotti74c96ec2009-07-08 22:24:06 +00001import io
2import os
Georg Brandl5ba11de2011-01-01 10:09:32 +00003import sys
Brett Cannonb57a0852013-06-15 17:32:30 -04004import importlib.util
Ezio Melotti35386712009-12-31 13:22:41 +00005import time
Ezio Melotti74c96ec2009-07-08 22:24:06 +00006import shutil
7import struct
8import zipfile
9import unittest
10
Tim Petersa45cacf2004-08-20 03:47:14 +000011
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000012from tempfile import TemporaryFile
Serhiy Storchakafa6bc292013-07-22 21:00:11 +030013from random import randint, random, getrandbits
Tim Petersa19a1682001-03-29 04:36:09 +000014
Serhiy Storchakafa6bc292013-07-22 21:00:11 +030015from test.support import (TESTFN, findfile, unlink,
Serhiy Storchakac5b75db2013-01-29 20:14:08 +020016 requires_zlib, requires_bz2, requires_lzma,
17 captured_stdout)
Guido van Rossum368f04a2000-04-10 13:23:04 +000018
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000019TESTFN2 = TESTFN + "2"
Martin v. Löwis59e47792009-01-24 14:10:07 +000020TESTFNDIR = TESTFN + "d"
Guido van Rossumb5a755e2007-07-18 18:15:48 +000021FIXEDTEST_SIZE = 1000
Georg Brandl5ba11de2011-01-01 10:09:32 +000022DATAFILES_DIR = 'zipfile_datafiles'
Guido van Rossum368f04a2000-04-10 13:23:04 +000023
Christian Heimes790c8232008-01-07 21:14:23 +000024SMALL_TEST_DATA = [('_ziptest1', '1q2w3e4r5t'),
25 ('ziptest2dir/_ziptest2', 'qawsedrftg'),
Gregory P. Smithb47acbf2013-02-01 11:22:43 -080026 ('ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
Christian Heimes790c8232008-01-07 21:14:23 +000027 ('ziptest2dir/ziptest3dir/ziptest4dir/_ziptest3', '6y7u8i9o0p')]
28
Serhiy Storchakafa6bc292013-07-22 21:00:11 +030029def get_files(test):
30 yield TESTFN2
31 with TemporaryFile() as f:
32 yield f
33 test.assertFalse(f.closed)
34 with io.BytesIO() as f:
35 yield f
36 test.assertFalse(f.closed)
Ezio Melotti76430242009-07-11 18:28:48 +000037
Serhiy Storchakafa6bc292013-07-22 21:00:11 +030038class AbstractTestsWithSourceFile:
39 @classmethod
40 def setUpClass(cls):
41 cls.line_gen = [bytes("Zipfile test line %d. random float: %f\n" %
42 (i, random()), "ascii")
43 for i in range(FIXEDTEST_SIZE)]
44 cls.data = b''.join(cls.line_gen)
45
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000046 def setUp(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000047 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +000048 with open(TESTFN, "wb") as fp:
49 fp.write(self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000050
Ezio Melottiafd0d112009-07-15 17:17:17 +000051 def make_test_archive(self, f, compression):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000052 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000053 with zipfile.ZipFile(f, "w", compression) as zipfp:
54 zipfp.write(TESTFN, "another.name")
55 zipfp.write(TESTFN, TESTFN)
56 zipfp.writestr("strfile", self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000057
Ezio Melottiafd0d112009-07-15 17:17:17 +000058 def zip_test(self, f, compression):
59 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +000060
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000061 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000062 with zipfile.ZipFile(f, "r", compression) as zipfp:
63 self.assertEqual(zipfp.read(TESTFN), self.data)
64 self.assertEqual(zipfp.read("another.name"), self.data)
65 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000066
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000067 # Print the ZIP directory
68 fp = io.StringIO()
69 zipfp.printdir(file=fp)
70 directory = fp.getvalue()
71 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +000072 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +000073
Benjamin Peterson577473f2010-01-19 00:09:57 +000074 self.assertIn('File Name', lines[0])
75 self.assertIn('Modified', lines[0])
76 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +000077
Ezio Melotti35386712009-12-31 13:22:41 +000078 fn, date, time_, size = lines[1].split()
79 self.assertEqual(fn, 'another.name')
80 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
81 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
82 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000083
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000084 # Check the namelist
85 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +000086 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000087 self.assertIn(TESTFN, names)
88 self.assertIn("another.name", names)
89 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000090
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000091 # Check infolist
92 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +000093 names = [i.filename for i in infos]
94 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000095 self.assertIn(TESTFN, names)
96 self.assertIn("another.name", names)
97 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000098 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +000099 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000100
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000101 # check getinfo
102 for nm in (TESTFN, "another.name", "strfile"):
103 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000104 self.assertEqual(info.filename, nm)
105 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000106
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000107 # Check that testzip doesn't raise an exception
108 zipfp.testzip()
Tim Peters7d3bad62001-04-04 18:56:49 +0000109
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300110 def test_basic(self):
111 for f in get_files(self):
112 self.zip_test(f, self.compression)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000113
Ezio Melottiafd0d112009-07-15 17:17:17 +0000114 def zip_open_test(self, f, compression):
115 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000116
117 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000118 with zipfile.ZipFile(f, "r", compression) as zipfp:
119 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000120 with zipfp.open(TESTFN) as zipopen1:
121 while True:
122 read_data = zipopen1.read(256)
123 if not read_data:
124 break
125 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000126
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000127 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000128 with zipfp.open("another.name") as zipopen2:
129 while True:
130 read_data = zipopen2.read(256)
131 if not read_data:
132 break
133 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000134
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000135 self.assertEqual(b''.join(zipdata1), self.data)
136 self.assertEqual(b''.join(zipdata2), self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000137
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300138 def test_open(self):
139 for f in get_files(self):
140 self.zip_open_test(f, self.compression)
Georg Brandlb533e262008-05-25 18:19:30 +0000141
Ezio Melottiafd0d112009-07-15 17:17:17 +0000142 def zip_random_open_test(self, f, compression):
143 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000144
145 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000146 with zipfile.ZipFile(f, "r", compression) as zipfp:
147 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000148 with zipfp.open(TESTFN) as zipopen1:
149 while True:
150 read_data = zipopen1.read(randint(1, 1024))
151 if not read_data:
152 break
153 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000154
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000155 self.assertEqual(b''.join(zipdata1), self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000156
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300157 def test_random_open(self):
158 for f in get_files(self):
159 self.zip_random_open_test(f, self.compression)
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000160
Serhiy Storchakad2c07a52013-09-27 22:11:57 +0300161 def zip_read1_test(self, f, compression):
162 self.make_test_archive(f, compression)
163
164 # Read the ZIP archive
165 with zipfile.ZipFile(f, "r") as zipfp, \
166 zipfp.open(TESTFN) as zipopen:
167 zipdata = []
168 while True:
169 read_data = zipopen.read1(-1)
170 if not read_data:
171 break
172 zipdata.append(read_data)
173
174 self.assertEqual(b''.join(zipdata), self.data)
175
176 def test_read1(self):
177 for f in get_files(self):
178 self.zip_read1_test(f, self.compression)
179
180 def zip_read1_10_test(self, f, compression):
181 self.make_test_archive(f, compression)
182
183 # Read the ZIP archive
184 with zipfile.ZipFile(f, "r") as zipfp, \
185 zipfp.open(TESTFN) as zipopen:
186 zipdata = []
187 while True:
188 read_data = zipopen.read1(10)
189 self.assertLessEqual(len(read_data), 10)
190 if not read_data:
191 break
192 zipdata.append(read_data)
193
194 self.assertEqual(b''.join(zipdata), self.data)
195
196 def test_read1_10(self):
197 for f in get_files(self):
198 self.zip_read1_10_test(f, self.compression)
199
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000200 def zip_readline_read_test(self, f, compression):
201 self.make_test_archive(f, compression)
202
203 # Read the ZIP archive
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300204 with zipfile.ZipFile(f, "r") as zipfp, \
205 zipfp.open(TESTFN) as zipopen:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000206 data = b''
207 while True:
208 read = zipopen.readline()
209 if not read:
210 break
211 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000212
Brian Curtin8fb9b862010-11-18 02:15:28 +0000213 read = zipopen.read(100)
214 if not read:
215 break
216 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000217
218 self.assertEqual(data, self.data)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300219
220 def test_readline_read(self):
221 # Issue #7610: calls to readline() interleaved with calls to read().
222 for f in get_files(self):
223 self.zip_readline_read_test(f, self.compression)
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000224
Ezio Melottiafd0d112009-07-15 17:17:17 +0000225 def zip_readline_test(self, f, compression):
226 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000227
228 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000229 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000230 with zipfp.open(TESTFN) as zipopen:
231 for line in self.line_gen:
232 linedata = zipopen.readline()
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300233 self.assertEqual(linedata, line)
234
235 def test_readline(self):
236 for f in get_files(self):
237 self.zip_readline_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000238
Ezio Melottiafd0d112009-07-15 17:17:17 +0000239 def zip_readlines_test(self, f, compression):
240 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000241
242 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000243 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000244 with zipfp.open(TESTFN) as zipopen:
245 ziplines = zipopen.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000246 for line, zipline in zip(self.line_gen, ziplines):
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300247 self.assertEqual(zipline, line)
248
249 def test_readlines(self):
250 for f in get_files(self):
251 self.zip_readlines_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000252
Ezio Melottiafd0d112009-07-15 17:17:17 +0000253 def zip_iterlines_test(self, f, compression):
254 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000255
256 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000257 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000258 with zipfp.open(TESTFN) as zipopen:
259 for line, zipline in zip(self.line_gen, zipopen):
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300260 self.assertEqual(zipline, line)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000261
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300262 def test_iterlines(self):
263 for f in get_files(self):
264 self.zip_iterlines_test(f, self.compression)
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000265
Ezio Melottiafd0d112009-07-15 17:17:17 +0000266 def test_low_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000267 """Check for cases where compressed data is larger than original."""
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000268 # Create the ZIP archive
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300269 with zipfile.ZipFile(TESTFN2, "w", self.compression) as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000270 zipfp.writestr("strfile", '12')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000271
272 # Get an open object for strfile
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300273 with zipfile.ZipFile(TESTFN2, "r", self.compression) as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000274 with zipfp.open("strfile") as openobj:
275 self.assertEqual(openobj.read(1), b'1')
276 self.assertEqual(openobj.read(1), b'2')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000277
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300278 def test_writestr_compression(self):
279 zipfp = zipfile.ZipFile(TESTFN2, "w")
280 zipfp.writestr("b.txt", "hello world", compress_type=self.compression)
281 info = zipfp.getinfo('b.txt')
282 self.assertEqual(info.compress_type, self.compression)
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200283
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300284 def test_read_return_size(self):
285 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
286 # than requested.
287 for test_size in (1, 4095, 4096, 4097, 16384):
288 file_size = test_size + 1
289 junk = getrandbits(8 * file_size).to_bytes(file_size, 'little')
290 with zipfile.ZipFile(io.BytesIO(), "w", self.compression) as zipf:
291 zipf.writestr('foo', junk)
292 with zipf.open('foo', 'r') as fp:
293 buf = fp.read(test_size)
294 self.assertEqual(len(buf), test_size)
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200295
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300296 def tearDown(self):
297 unlink(TESTFN)
298 unlink(TESTFN2)
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200299
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200300
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300301class StoredTestsWithSourceFile(AbstractTestsWithSourceFile,
302 unittest.TestCase):
303 compression = zipfile.ZIP_STORED
304 test_low_compression = None
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200305
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300306 def zip_test_writestr_permissions(self, f, compression):
307 # Make sure that writestr creates files with mode 0600,
308 # when it is passed a name rather than a ZipInfo instance.
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200309
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300310 self.make_test_archive(f, compression)
311 with zipfile.ZipFile(f, "r") as zipfp:
312 zinfo = zipfp.getinfo('strfile')
313 self.assertEqual(zinfo.external_attr, 0o600 << 16)
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200314
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300315 def test_writestr_permissions(self):
316 for f in get_files(self):
317 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +0200318
Ezio Melottiafd0d112009-07-15 17:17:17 +0000319 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000320 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
321 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000322
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000323 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
324 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000325
Ezio Melottiafd0d112009-07-15 17:17:17 +0000326 def test_append_to_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000327 """Test appending to an existing zipfile."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000328 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
329 zipfp.write(TESTFN, TESTFN)
330
331 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
332 zipfp.writestr("strfile", self.data)
333 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000334
Ezio Melottiafd0d112009-07-15 17:17:17 +0000335 def test_append_to_non_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000336 """Test appending to an existing file that is not a zipfile."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000337 # NOTE: this test fails if len(d) < 22 because of the first
338 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti35386712009-12-31 13:22:41 +0000339 data = b'I am not a ZipFile!'*10
340 with open(TESTFN2, 'wb') as f:
341 f.write(data)
342
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000343 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
344 zipfp.write(TESTFN, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000345
Ezio Melotti35386712009-12-31 13:22:41 +0000346 with open(TESTFN2, 'rb') as f:
347 f.seek(len(data))
348 with zipfile.ZipFile(f, "r") as zipfp:
349 self.assertEqual(zipfp.namelist(), [TESTFN])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000350
R David Murray4fbb9db2011-06-09 15:50:51 -0400351 def test_ignores_newline_at_end(self):
352 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
353 zipfp.write(TESTFN, TESTFN)
354 with open(TESTFN2, 'a') as f:
355 f.write("\r\n\00\00\00")
356 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
357 self.assertIsInstance(zipfp, zipfile.ZipFile)
358
359 def test_ignores_stuff_appended_past_comments(self):
360 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
361 zipfp.comment = b"this is a comment"
362 zipfp.write(TESTFN, TESTFN)
363 with open(TESTFN2, 'a') as f:
364 f.write("abcdef\r\n")
365 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
366 self.assertIsInstance(zipfp, zipfile.ZipFile)
367 self.assertEqual(zipfp.comment, b"this is a comment")
368
Ezio Melottiafd0d112009-07-15 17:17:17 +0000369 def test_write_default_name(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000370 """Check that calling ZipFile.write without arcname specified
371 produces the expected result."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000372 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
373 zipfp.write(TESTFN)
Brian Curtin8fb9b862010-11-18 02:15:28 +0000374 with open(TESTFN, "rb") as f:
375 self.assertEqual(zipfp.read(TESTFN), f.read())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000376
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300377 def test_write_to_readonly(self):
378 """Check that trying to call write() on a readonly ZipFile object
379 raises a RuntimeError."""
380 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
381 zipfp.writestr("somefile.txt", "bogus")
382
383 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
384 self.assertRaises(RuntimeError, zipfp.write, TESTFN)
385
386 def test_add_file_before_1980(self):
387 # Set atime and mtime to 1970-01-01
388 os.utime(TESTFN, (0, 0))
389 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
390 self.assertRaises(ValueError, zipfp.write, TESTFN)
391
392@requires_zlib
393class DeflateTestsWithSourceFile(AbstractTestsWithSourceFile,
394 unittest.TestCase):
395 compression = zipfile.ZIP_DEFLATED
396
Ezio Melottiafd0d112009-07-15 17:17:17 +0000397 def test_per_file_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000398 """Check that files within a Zip archive can have different
399 compression options."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000400 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
401 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
402 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
403 sinfo = zipfp.getinfo('storeme')
404 dinfo = zipfp.getinfo('deflateme')
405 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
406 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000407
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300408@requires_bz2
409class Bzip2TestsWithSourceFile(AbstractTestsWithSourceFile,
410 unittest.TestCase):
411 compression = zipfile.ZIP_BZIP2
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000412
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300413@requires_lzma
414class LzmaTestsWithSourceFile(AbstractTestsWithSourceFile,
415 unittest.TestCase):
416 compression = zipfile.ZIP_LZMA
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000417
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300418
419class AbstractTestZip64InSmallFiles:
420 # These tests test the ZIP64 functionality without using large files,
421 # see test_zipfile64 for proper tests.
422
423 @classmethod
424 def setUpClass(cls):
425 line_gen = (bytes("Test of zipfile line %d." % i, "ascii")
426 for i in range(0, FIXEDTEST_SIZE))
427 cls.data = b'\n'.join(line_gen)
428
429 def setUp(self):
430 self._limit = zipfile.ZIP64_LIMIT
431 zipfile.ZIP64_LIMIT = 5
432
433 # Make a source file with some lines
434 with open(TESTFN, "wb") as fp:
435 fp.write(self.data)
436
437 def zip_test(self, f, compression):
438 # Create the ZIP archive
439 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
440 zipfp.write(TESTFN, "another.name")
441 zipfp.write(TESTFN, TESTFN)
442 zipfp.writestr("strfile", self.data)
443
444 # Read the ZIP archive
445 with zipfile.ZipFile(f, "r", compression) as zipfp:
446 self.assertEqual(zipfp.read(TESTFN), self.data)
447 self.assertEqual(zipfp.read("another.name"), self.data)
448 self.assertEqual(zipfp.read("strfile"), self.data)
449
450 # Print the ZIP directory
451 fp = io.StringIO()
452 zipfp.printdir(fp)
453
454 directory = fp.getvalue()
455 lines = directory.splitlines()
456 self.assertEqual(len(lines), 4) # Number of files + header
457
458 self.assertIn('File Name', lines[0])
459 self.assertIn('Modified', lines[0])
460 self.assertIn('Size', lines[0])
461
462 fn, date, time_, size = lines[1].split()
463 self.assertEqual(fn, 'another.name')
464 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
465 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
466 self.assertEqual(size, str(len(self.data)))
467
468 # Check the namelist
469 names = zipfp.namelist()
470 self.assertEqual(len(names), 3)
471 self.assertIn(TESTFN, names)
472 self.assertIn("another.name", names)
473 self.assertIn("strfile", names)
474
475 # Check infolist
476 infos = zipfp.infolist()
477 names = [i.filename for i in infos]
478 self.assertEqual(len(names), 3)
479 self.assertIn(TESTFN, names)
480 self.assertIn("another.name", names)
481 self.assertIn("strfile", names)
482 for i in infos:
483 self.assertEqual(i.file_size, len(self.data))
484
485 # check getinfo
486 for nm in (TESTFN, "another.name", "strfile"):
487 info = zipfp.getinfo(nm)
488 self.assertEqual(info.filename, nm)
489 self.assertEqual(info.file_size, len(self.data))
490
491 # Check that testzip doesn't raise an exception
492 zipfp.testzip()
493
494 def test_basic(self):
495 for f in get_files(self):
496 self.zip_test(f, self.compression)
497
498 def tearDown(self):
499 zipfile.ZIP64_LIMIT = self._limit
500 unlink(TESTFN)
501 unlink(TESTFN2)
502
503
504class StoredTestZip64InSmallFiles(AbstractTestZip64InSmallFiles,
505 unittest.TestCase):
506 compression = zipfile.ZIP_STORED
507
508 def large_file_exception_test(self, f, compression):
509 with zipfile.ZipFile(f, "w", compression) as zipfp:
510 self.assertRaises(zipfile.LargeZipFile,
511 zipfp.write, TESTFN, "another.name")
512
513 def large_file_exception_test2(self, f, compression):
514 with zipfile.ZipFile(f, "w", compression) as zipfp:
515 self.assertRaises(zipfile.LargeZipFile,
516 zipfp.writestr, "another.name", self.data)
517
518 def test_large_file_exception(self):
519 for f in get_files(self):
520 self.large_file_exception_test(f, zipfile.ZIP_STORED)
521 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
522
523 def test_absolute_arcnames(self):
524 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
525 allowZip64=True) as zipfp:
526 zipfp.write(TESTFN, "/absolute")
527
528 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
529 self.assertEqual(zipfp.namelist(), ["absolute"])
530
531@requires_zlib
532class DeflateTestZip64InSmallFiles(AbstractTestZip64InSmallFiles,
533 unittest.TestCase):
534 compression = zipfile.ZIP_DEFLATED
535
536@requires_bz2
537class Bzip2TestZip64InSmallFiles(AbstractTestZip64InSmallFiles,
538 unittest.TestCase):
539 compression = zipfile.ZIP_BZIP2
540
541@requires_lzma
542class LzmaTestZip64InSmallFiles(AbstractTestZip64InSmallFiles,
543 unittest.TestCase):
544 compression = zipfile.ZIP_LZMA
545
546
547class PyZipFileTests(unittest.TestCase):
548 def assertCompiledIn(self, name, namelist):
549 if name + 'o' not in namelist:
550 self.assertIn(name + 'c', namelist)
551
552 def test_write_pyfile(self):
553 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
554 fn = __file__
555 if fn.endswith('.pyc') or fn.endswith('.pyo'):
556 path_split = fn.split(os.sep)
557 if os.altsep is not None:
558 path_split.extend(fn.split(os.altsep))
559 if '__pycache__' in path_split:
Serhiy Storchaka9068e4d2013-07-22 21:02:14 +0300560 fn = importlib.util.source_from_cache(fn)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300561 else:
562 fn = fn[:-1]
563
564 zipfp.writepy(fn)
565
566 bn = os.path.basename(fn)
567 self.assertNotIn(bn, zipfp.namelist())
568 self.assertCompiledIn(bn, zipfp.namelist())
569
570 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
571 fn = __file__
572 if fn.endswith(('.pyc', '.pyo')):
573 fn = fn[:-1]
574
575 zipfp.writepy(fn, "testpackage")
576
577 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
578 self.assertNotIn(bn, zipfp.namelist())
579 self.assertCompiledIn(bn, zipfp.namelist())
580
581 def test_write_python_package(self):
582 import email
583 packagedir = os.path.dirname(email.__file__)
584
585 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
586 zipfp.writepy(packagedir)
587
588 # Check for a couple of modules at different levels of the
589 # hierarchy
590 names = zipfp.namelist()
591 self.assertCompiledIn('email/__init__.py', names)
592 self.assertCompiledIn('email/mime/text.py', names)
593
Christian Tismer59202e52013-10-21 03:59:23 +0200594 def test_write_filtered_python_package(self):
595 import test
596 packagedir = os.path.dirname(test.__file__)
597
598 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
599
Christian Tismer59202e52013-10-21 03:59:23 +0200600 # first make sure that the test folder gives error messages
Georg Brandla6065422013-10-21 08:29:29 +0200601 # (on the badsyntax_... files)
602 with captured_stdout() as reportSIO:
603 zipfp.writepy(packagedir)
Christian Tismer59202e52013-10-21 03:59:23 +0200604 reportStr = reportSIO.getvalue()
605 self.assertTrue('SyntaxError' in reportStr)
606
Christian Tismer410d9312013-10-22 04:09:28 +0200607 # then check that the filter works on the whole package
Georg Brandla6065422013-10-21 08:29:29 +0200608 with captured_stdout() as reportSIO:
609 zipfp.writepy(packagedir, filterfunc=lambda whatever: False)
Christian Tismer59202e52013-10-21 03:59:23 +0200610 reportStr = reportSIO.getvalue()
611 self.assertTrue('SyntaxError' not in reportStr)
612
Christian Tismer410d9312013-10-22 04:09:28 +0200613 # then check that the filter works on individual files
614 with captured_stdout() as reportSIO:
615 zipfp.writepy(packagedir, filterfunc=lambda fn:
616 'bad' not in fn)
617 reportStr = reportSIO.getvalue()
618 if reportStr:
619 print(reportStr)
620 self.assertTrue('SyntaxError' not in reportStr)
621
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300622 def test_write_with_optimization(self):
623 import email
624 packagedir = os.path.dirname(email.__file__)
625 # use .pyc if running test in optimization mode,
626 # use .pyo if running test in debug mode
627 optlevel = 1 if __debug__ else 0
628 ext = '.pyo' if optlevel == 1 else '.pyc'
629
630 with TemporaryFile() as t, \
Christian Tismer59202e52013-10-21 03:59:23 +0200631 zipfile.PyZipFile(t, "w", optimize=optlevel) as zipfp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300632 zipfp.writepy(packagedir)
633
634 names = zipfp.namelist()
635 self.assertIn('email/__init__' + ext, names)
636 self.assertIn('email/mime/text' + ext, names)
637
638 def test_write_python_directory(self):
639 os.mkdir(TESTFN2)
640 try:
641 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
642 fp.write("print(42)\n")
643
644 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
645 fp.write("print(42 * 42)\n")
646
647 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
648 fp.write("bla bla bla\n")
649
650 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
651 zipfp.writepy(TESTFN2)
652
653 names = zipfp.namelist()
654 self.assertCompiledIn('mod1.py', names)
655 self.assertCompiledIn('mod2.py', names)
656 self.assertNotIn('mod2.txt', names)
657
658 finally:
659 shutil.rmtree(TESTFN2)
660
Christian Tismer410d9312013-10-22 04:09:28 +0200661 def test_write_python_directory_filtered(self):
662 os.mkdir(TESTFN2)
663 try:
664 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
665 fp.write("print(42)\n")
666
667 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
668 fp.write("print(42 * 42)\n")
669
670 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
671 zipfp.writepy(TESTFN2, filterfunc=lambda fn:
672 not fn.endswith('mod2.py'))
673
674 names = zipfp.namelist()
675 self.assertCompiledIn('mod1.py', names)
676 self.assertNotIn('mod2.py', names)
677
678 finally:
679 shutil.rmtree(TESTFN2)
680
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300681 def test_write_non_pyfile(self):
682 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
683 with open(TESTFN, 'w') as f:
684 f.write('most definitely not a python file')
685 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
686 os.remove(TESTFN)
687
688 def test_write_pyfile_bad_syntax(self):
689 os.mkdir(TESTFN2)
690 try:
691 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
692 fp.write("Bad syntax in python file\n")
693
694 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
695 # syntax errors are printed to stdout
696 with captured_stdout() as s:
697 zipfp.writepy(os.path.join(TESTFN2, "mod1.py"))
698
699 self.assertIn("SyntaxError", s.getvalue())
700
701 # as it will not have compiled the python file, it will
702 # include the .py file not .pyc or .pyo
703 names = zipfp.namelist()
704 self.assertIn('mod1.py', names)
705 self.assertNotIn('mod1.pyc', names)
706 self.assertNotIn('mod1.pyo', names)
707
708 finally:
709 shutil.rmtree(TESTFN2)
710
711
712class ExtractTests(unittest.TestCase):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000713 def test_extract(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000714 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
715 for fpath, fdata in SMALL_TEST_DATA:
716 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000717
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000718 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
719 for fpath, fdata in SMALL_TEST_DATA:
720 writtenfile = zipfp.extract(fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000721
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000722 # make sure it was written to the right place
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800723 correctfile = os.path.join(os.getcwd(), fpath)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000724 correctfile = os.path.normpath(correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000725
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000726 self.assertEqual(writtenfile, correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000727
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000728 # make sure correct data is in correct file
Brian Curtin8fb9b862010-11-18 02:15:28 +0000729 with open(writtenfile, "rb") as f:
730 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000731
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000732 os.remove(writtenfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000733
734 # remove the test file subdirectories
735 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
736
Ezio Melottiafd0d112009-07-15 17:17:17 +0000737 def test_extract_all(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000738 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
739 for fpath, fdata in SMALL_TEST_DATA:
740 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000741
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000742 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
743 zipfp.extractall()
744 for fpath, fdata in SMALL_TEST_DATA:
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800745 outfile = os.path.join(os.getcwd(), fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000746
Brian Curtin8fb9b862010-11-18 02:15:28 +0000747 with open(outfile, "rb") as f:
748 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000749
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000750 os.remove(outfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000751
752 # remove the test file subdirectories
753 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
754
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800755 def check_file(self, filename, content):
756 self.assertTrue(os.path.isfile(filename))
757 with open(filename, 'rb') as f:
758 self.assertEqual(f.read(), content)
759
Gregory P. Smith09aa7522013-02-03 00:36:32 -0800760 def test_sanitize_windows_name(self):
761 san = zipfile.ZipFile._sanitize_windows_name
762 # Passing pathsep in allows this test to work regardless of platform.
763 self.assertEqual(san(r',,?,C:,foo,bar/z', ','), r'_,C_,foo,bar/z')
764 self.assertEqual(san(r'a\b,c<d>e|f"g?h*i', ','), r'a\b,c_d_e_f_g_h_i')
765 self.assertEqual(san('../../foo../../ba..r', '/'), r'foo/ba..r')
766
767 def test_extract_hackers_arcnames_common_cases(self):
768 common_hacknames = [
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800769 ('../foo/bar', 'foo/bar'),
770 ('foo/../bar', 'foo/bar'),
771 ('foo/../../bar', 'foo/bar'),
772 ('foo/bar/..', 'foo/bar'),
773 ('./../foo/bar', 'foo/bar'),
774 ('/foo/bar', 'foo/bar'),
775 ('/foo/../bar', 'foo/bar'),
776 ('/foo/../../bar', 'foo/bar'),
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800777 ]
Gregory P. Smith09aa7522013-02-03 00:36:32 -0800778 self._test_extract_hackers_arcnames(common_hacknames)
779
780 @unittest.skipIf(os.path.sep != '\\', 'Requires \\ as path separator.')
781 def test_extract_hackers_arcnames_windows_only(self):
782 """Test combination of path fixing and windows name sanitization."""
783 windows_hacknames = [
Christian Tismer59202e52013-10-21 03:59:23 +0200784 (r'..\foo\bar', 'foo/bar'),
785 (r'..\/foo\/bar', 'foo/bar'),
786 (r'foo/\..\/bar', 'foo/bar'),
787 (r'foo\/../\bar', 'foo/bar'),
788 (r'C:foo/bar', 'foo/bar'),
789 (r'C:/foo/bar', 'foo/bar'),
790 (r'C://foo/bar', 'foo/bar'),
791 (r'C:\foo\bar', 'foo/bar'),
792 (r'//conky/mountpoint/foo/bar', 'foo/bar'),
793 (r'\\conky\mountpoint\foo\bar', 'foo/bar'),
794 (r'///conky/mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
795 (r'\\\conky\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
796 (r'//conky//mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
797 (r'\\conky\\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
798 (r'//?/C:/foo/bar', 'foo/bar'),
799 (r'\\?\C:\foo\bar', 'foo/bar'),
800 (r'C:/../C:/foo/bar', 'C_/foo/bar'),
801 (r'a:b\c<d>e|f"g?h*i', 'b/c_d_e_f_g_h_i'),
802 ('../../foo../../ba..r', 'foo/ba..r'),
Gregory P. Smith09aa7522013-02-03 00:36:32 -0800803 ]
804 self._test_extract_hackers_arcnames(windows_hacknames)
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800805
Gregory P. Smith09aa7522013-02-03 00:36:32 -0800806 @unittest.skipIf(os.path.sep != '/', r'Requires / as path separator.')
807 def test_extract_hackers_arcnames_posix_only(self):
808 posix_hacknames = [
809 ('//foo/bar', 'foo/bar'),
810 ('../../foo../../ba..r', 'foo../ba..r'),
811 (r'foo/..\bar', r'foo/..\bar'),
812 ]
813 self._test_extract_hackers_arcnames(posix_hacknames)
814
815 def _test_extract_hackers_arcnames(self, hacknames):
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800816 for arcname, fixedname in hacknames:
817 content = b'foobar' + arcname.encode()
818 with zipfile.ZipFile(TESTFN2, 'w', zipfile.ZIP_STORED) as zipfp:
Serhiy Storchakae5e64442013-02-02 19:50:59 +0200819 zinfo = zipfile.ZipInfo()
820 # preserve backslashes
821 zinfo.filename = arcname
822 zinfo.external_attr = 0o600 << 16
823 zipfp.writestr(zinfo, content)
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800824
Serhiy Storchakae5e64442013-02-02 19:50:59 +0200825 arcname = arcname.replace(os.sep, "/")
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800826 targetpath = os.path.join('target', 'subdir', 'subsub')
827 correctfile = os.path.join(targetpath, *fixedname.split('/'))
828
829 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
830 writtenfile = zipfp.extract(arcname, targetpath)
Serhiy Storchakae5e64442013-02-02 19:50:59 +0200831 self.assertEqual(writtenfile, correctfile,
Gregory P. Smith09aa7522013-02-03 00:36:32 -0800832 msg='extract %r: %r != %r' %
833 (arcname, writtenfile, correctfile))
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800834 self.check_file(correctfile, content)
835 shutil.rmtree('target')
836
837 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
838 zipfp.extractall(targetpath)
839 self.check_file(correctfile, content)
840 shutil.rmtree('target')
841
842 correctfile = os.path.join(os.getcwd(), *fixedname.split('/'))
843
844 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
845 writtenfile = zipfp.extract(arcname)
Serhiy Storchakae5e64442013-02-02 19:50:59 +0200846 self.assertEqual(writtenfile, correctfile,
847 msg="extract %r" % arcname)
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800848 self.check_file(correctfile, content)
849 shutil.rmtree(fixedname.split('/')[0])
850
851 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
852 zipfp.extractall()
853 self.check_file(correctfile, content)
854 shutil.rmtree(fixedname.split('/')[0])
855
856 os.remove(TESTFN2)
857
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000858
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300859class OtherTests(unittest.TestCase):
860 def test_open_via_zip_info(self):
861 # Create the ZIP archive
862 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
863 zipfp.writestr("name", "foo")
864 zipfp.writestr("name", "bar")
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000865
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300866 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
867 infos = zipfp.infolist()
868 data = b""
869 for info in infos:
870 with zipfp.open(info) as zipopen:
871 data += zipopen.read()
872 self.assertIn(data, {b"foobar", b"barfoo"})
873 data = b""
874 for info in infos:
875 data += zipfp.read(info)
876 self.assertIn(data, {b"foobar", b"barfoo"})
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200877
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300878 def test_universal_readaheads(self):
879 f = io.BytesIO()
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +0200880
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300881 data = b'a\r\n' * 16 * 1024
882 with zipfile.ZipFile(f, 'w', zipfile.ZIP_STORED) as zipfp:
883 zipfp.writestr(TESTFN, data)
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000884
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300885 data2 = b''
886 with zipfile.ZipFile(f, 'r') as zipfp, \
887 zipfp.open(TESTFN, 'rU') as zipopen:
888 for line in zipopen:
889 data2 += line
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000890
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300891 self.assertEqual(data, data2.replace(b'\n', b'\r\n'))
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000892
Gregory P. Smithb0d9ca922009-07-07 05:06:04 +0000893 def test_writestr_extended_local_header_issue1202(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000894 with zipfile.ZipFile(TESTFN2, 'w') as orig_zip:
895 for data in 'abcdefghijklmnop':
896 zinfo = zipfile.ZipInfo(data)
897 zinfo.flag_bits |= 0x08 # Include an extended local header.
898 orig_zip.writestr(zinfo, data)
899
900 def test_close(self):
901 """Check that the zipfile is closed after the 'with' block."""
902 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
903 for fpath, fdata in SMALL_TEST_DATA:
904 zipfp.writestr(fpath, fdata)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300905 self.assertIsNotNone(zipfp.fp, 'zipfp is not open')
906 self.assertIsNone(zipfp.fp, 'zipfp is not closed')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000907
908 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300909 self.assertIsNotNone(zipfp.fp, 'zipfp is not open')
910 self.assertIsNone(zipfp.fp, 'zipfp is not closed')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000911
912 def test_close_on_exception(self):
913 """Check that the zipfile is closed if an exception is raised in the
914 'with' block."""
915 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
916 for fpath, fdata in SMALL_TEST_DATA:
917 zipfp.writestr(fpath, fdata)
918
919 try:
920 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
Georg Brandl4d540882010-10-28 06:42:33 +0000921 raise zipfile.BadZipFile()
922 except zipfile.BadZipFile:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300923 self.assertIsNone(zipfp2.fp, 'zipfp is not closed')
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000924
Martin v. Löwisd099b562012-05-01 14:08:22 +0200925 def test_unsupported_version(self):
926 # File has an extract_version of 120
927 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 +0200928 b'\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00xPK\x01\x02x\x03x\x00\x00\x00\x00'
929 b'\x00!p\xa1@\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00'
930 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00\x00xPK\x05\x06'
931 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 +0300932
Martin v. Löwisd099b562012-05-01 14:08:22 +0200933 self.assertRaises(NotImplementedError, zipfile.ZipFile,
934 io.BytesIO(data), 'r')
935
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300936 @requires_zlib
937 def test_read_unicode_filenames(self):
938 # bug #10801
939 fname = findfile('zip_cp437_header.zip')
940 with zipfile.ZipFile(fname) as zipfp:
941 for name in zipfp.namelist():
942 zipfp.open(name).close()
943
944 def test_write_unicode_filenames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000945 with zipfile.ZipFile(TESTFN, "w") as zf:
946 zf.writestr("foo.txt", "Test for unicode filename")
947 zf.writestr("\xf6.txt", "Test for unicode filename")
Ezio Melottie9615932010-01-24 19:26:24 +0000948 self.assertIsInstance(zf.infolist()[0].filename, str)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000949
950 with zipfile.ZipFile(TESTFN, "r") as zf:
951 self.assertEqual(zf.filelist[0].filename, "foo.txt")
952 self.assertEqual(zf.filelist[1].filename, "\xf6.txt")
Martin v. Löwis8570f6a2008-05-05 17:44:38 +0000953
Ezio Melottiafd0d112009-07-15 17:17:17 +0000954 def test_create_non_existent_file_for_append(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +0000955 if os.path.exists(TESTFN):
956 os.unlink(TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000957
Thomas Wouterscf297e42007-02-23 15:07:44 +0000958 filename = 'testfile.txt'
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000959 content = b'hello, world. this is some content.'
Guido van Rossumd8faa362007-04-27 19:54:29 +0000960
Thomas Wouterscf297e42007-02-23 15:07:44 +0000961 try:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000962 with zipfile.ZipFile(TESTFN, 'a') as zf:
963 zf.writestr(filename, content)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200964 except OSError:
Thomas Wouterscf297e42007-02-23 15:07:44 +0000965 self.fail('Could not append data to a non-existent zip file.')
966
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000967 self.assertTrue(os.path.exists(TESTFN))
Thomas Wouterscf297e42007-02-23 15:07:44 +0000968
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000969 with zipfile.ZipFile(TESTFN, 'r') as zf:
970 self.assertEqual(zf.read(filename), content)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000971
Ezio Melottiafd0d112009-07-15 17:17:17 +0000972 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000973 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti35386712009-12-31 13:22:41 +0000974 # it opens if there's an error in the file. If it doesn't, the
975 # traceback holds a reference to the ZipFile object and, indirectly,
976 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000977 # On Windows, this causes the os.unlink() call to fail because the
978 # underlying file is still open. This is SF bug #412214.
979 #
Ezio Melotti35386712009-12-31 13:22:41 +0000980 with open(TESTFN, "w") as fp:
981 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000982 try:
983 zf = zipfile.ZipFile(TESTFN)
Georg Brandl4d540882010-10-28 06:42:33 +0000984 except zipfile.BadZipFile:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000985 pass
986
Ezio Melottiafd0d112009-07-15 17:17:17 +0000987 def test_is_zip_erroneous_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000988 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000989 # - passing a filename
990 with open(TESTFN, "w") as fp:
991 fp.write("this is not a legal zip file\n")
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300992 self.assertFalse(zipfile.is_zipfile(TESTFN))
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000993 # - passing a file object
994 with open(TESTFN, "rb") as fp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300995 self.assertFalse(zipfile.is_zipfile(fp))
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000996 # - passing a file-like object
997 fp = io.BytesIO()
998 fp.write(b"this is not a legal zip file\n")
Serhiy Storchakafa6bc292013-07-22 21:00:11 +0300999 self.assertFalse(zipfile.is_zipfile(fp))
Ezio Melotti35386712009-12-31 13:22:41 +00001000 fp.seek(0, 0)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001001 self.assertFalse(zipfile.is_zipfile(fp))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001002
Serhiy Storchakad2b15272013-01-31 15:27:07 +02001003 def test_damaged_zipfile(self):
1004 """Check that zipfiles with missing bytes at the end raise BadZipFile."""
1005 # - Create a valid zip file
1006 fp = io.BytesIO()
1007 with zipfile.ZipFile(fp, mode="w") as zipf:
1008 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
1009 zipfiledata = fp.getvalue()
1010
1011 # - Now create copies of it missing the last N bytes and make sure
1012 # a BadZipFile exception is raised when we try to open it
1013 for N in range(len(zipfiledata)):
1014 fp = io.BytesIO(zipfiledata[:N])
1015 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, fp)
1016
Ezio Melottiafd0d112009-07-15 17:17:17 +00001017 def test_is_zip_valid_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001018 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001019 # - passing a filename
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001020 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1021 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
1022
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001023 self.assertTrue(zipfile.is_zipfile(TESTFN))
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001024 # - passing a file object
1025 with open(TESTFN, "rb") as fp:
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001026 self.assertTrue(zipfile.is_zipfile(fp))
Ezio Melotti35386712009-12-31 13:22:41 +00001027 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +00001028 zip_contents = fp.read()
1029 # - passing a file-like object
1030 fp = io.BytesIO()
1031 fp.write(zip_contents)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001032 self.assertTrue(zipfile.is_zipfile(fp))
Ezio Melotti35386712009-12-31 13:22:41 +00001033 fp.seek(0, 0)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001034 self.assertTrue(zipfile.is_zipfile(fp))
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001035
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001036 def test_non_existent_file_raises_OSError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001037 # make sure we don't raise an AttributeError when a partially-constructed
1038 # ZipFile instance is finalized; this tests for regression on SF tracker
1039 # bug #403871.
1040
1041 # The bug we're testing for caused an AttributeError to be raised
1042 # when a ZipFile instance was created for a file that did not
1043 # exist; the .fp member was not initialized but was needed by the
1044 # __del__() method. Since the AttributeError is in the __del__(),
1045 # it is ignored, but the user should be sufficiently annoyed by
1046 # the message on the output that regression will be noticed
1047 # quickly.
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001048 self.assertRaises(OSError, zipfile.ZipFile, TESTFN)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001049
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +00001050 def test_empty_file_raises_BadZipFile(self):
1051 f = open(TESTFN, 'w')
1052 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001053 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +00001054
Ezio Melotti35386712009-12-31 13:22:41 +00001055 with open(TESTFN, 'w') as fp:
1056 fp.write("short file")
Georg Brandl4d540882010-10-28 06:42:33 +00001057 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +00001058
Ezio Melottiafd0d112009-07-15 17:17:17 +00001059 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001060 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001061 data = io.BytesIO()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001062 with zipfile.ZipFile(data, mode="w") as zipf:
1063 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001064
Andrew Svetlov737fb892012-12-18 21:14:22 +02001065 # This is correct; calling .read on a closed ZipFile should raise
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001066 # a RuntimeError, and so should calling .testzip. An earlier
1067 # version of .testzip would swallow this exception (and any other)
1068 # and report that the first file in the archive was corrupt.
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001069 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
1070 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001071 self.assertRaises(RuntimeError, zipf.testzip)
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001072 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Brian Curtin8fb9b862010-11-18 02:15:28 +00001073 with open(TESTFN, 'w') as f:
1074 f.write('zipfile test data')
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001075 self.assertRaises(RuntimeError, zipf.write, TESTFN)
1076
Ezio Melottiafd0d112009-07-15 17:17:17 +00001077 def test_bad_constructor_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001078 """Check that bad modes passed to ZipFile constructor are caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001079 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
1080
Ezio Melottiafd0d112009-07-15 17:17:17 +00001081 def test_bad_open_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001082 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001083 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1084 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1085
1086 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001087 # read the data to make sure the file is there
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001088 zipf.read("foo.txt")
1089 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001090
Ezio Melottiafd0d112009-07-15 17:17:17 +00001091 def test_read0(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001092 """Check that calling read(0) on a ZipExtFile object returns an empty
1093 string and doesn't advance file pointer."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001094 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1095 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1096 # read the data to make sure the file is there
Brian Curtin8fb9b862010-11-18 02:15:28 +00001097 with zipf.open("foo.txt") as f:
1098 for i in range(FIXEDTEST_SIZE):
1099 self.assertEqual(f.read(0), b'')
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001100
Brian Curtin8fb9b862010-11-18 02:15:28 +00001101 self.assertEqual(f.read(), b"O, for a Muse of Fire!")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001102
Ezio Melottiafd0d112009-07-15 17:17:17 +00001103 def test_open_non_existent_item(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001104 """Check that attempting to call open() for an item that doesn't
1105 exist in the archive raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001106 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1107 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001108
Ezio Melottiafd0d112009-07-15 17:17:17 +00001109 def test_bad_compression_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001110 """Check that bad compression methods passed to ZipFile.open are
1111 caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001112 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
1113
Martin v. Löwisb3260f02012-05-01 08:38:01 +02001114 def test_unsupported_compression(self):
1115 # data is declared as shrunk, but actually deflated
1116 data = (b'PK\x03\x04.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00'
Christian Tismer59202e52013-10-21 03:59:23 +02001117 b'\x00\x02\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00x\x03\x00PK\x01'
1118 b'\x02.\x03.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00\x00\x02\x00\x00'
1119 b'\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
1120 b'\x80\x01\x00\x00\x00\x00xPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00'
1121 b'/\x00\x00\x00!\x00\x00\x00\x00\x00')
Martin v. Löwisb3260f02012-05-01 08:38:01 +02001122 with zipfile.ZipFile(io.BytesIO(data), 'r') as zipf:
1123 self.assertRaises(NotImplementedError, zipf.open, 'x')
1124
Ezio Melottiafd0d112009-07-15 17:17:17 +00001125 def test_null_byte_in_filename(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001126 """Check that a filename containing a null byte is properly
1127 terminated."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001128 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1129 zipf.writestr("foo.txt\x00qqq", b"O, for a Muse of Fire!")
1130 self.assertEqual(zipf.namelist(), ['foo.txt'])
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001131
Ezio Melottiafd0d112009-07-15 17:17:17 +00001132 def test_struct_sizes(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001133 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001134 self.assertEqual(zipfile.sizeEndCentDir, 22)
1135 self.assertEqual(zipfile.sizeCentralDir, 46)
1136 self.assertEqual(zipfile.sizeEndCentDir64, 56)
1137 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
1138
Ezio Melottiafd0d112009-07-15 17:17:17 +00001139 def test_comments(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001140 """Check that comments on the archive are handled properly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001141
1142 # check default comment is empty
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001143 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1144 self.assertEqual(zipf.comment, b'')
1145 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1146
1147 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1148 self.assertEqual(zipfr.comment, b'')
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001149
1150 # check a simple short comment
1151 comment = b'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001152 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1153 zipf.comment = comment
1154 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1155 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1156 self.assertEqual(zipf.comment, comment)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001157
1158 # check a comment of max length
1159 comment2 = ''.join(['%d' % (i**3 % 10) for i in range((1 << 16)-1)])
1160 comment2 = comment2.encode("ascii")
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001161 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1162 zipf.comment = comment2
1163 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1164
1165 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1166 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001167
1168 # check a comment that is too long is truncated
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001169 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1170 zipf.comment = comment2 + b'oops'
1171 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1172 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1173 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001174
Antoine Pitrouc3991852012-06-30 17:31:37 +02001175 # check that comments are correctly modified in append mode
1176 with zipfile.ZipFile(TESTFN,mode="w") as zipf:
1177 zipf.comment = b"original comment"
1178 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1179 with zipfile.ZipFile(TESTFN,mode="a") as zipf:
1180 zipf.comment = b"an updated comment"
1181 with zipfile.ZipFile(TESTFN,mode="r") as zipf:
1182 self.assertEqual(zipf.comment, b"an updated comment")
1183
1184 # check that comments are correctly shortened in append mode
1185 with zipfile.ZipFile(TESTFN,mode="w") as zipf:
1186 zipf.comment = b"original comment that's longer"
1187 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1188 with zipfile.ZipFile(TESTFN,mode="a") as zipf:
1189 zipf.comment = b"shorter comment"
1190 with zipfile.ZipFile(TESTFN,mode="r") as zipf:
1191 self.assertEqual(zipf.comment, b"shorter comment")
1192
R David Murrayf50b38a2012-04-12 18:44:58 -04001193 def test_unicode_comment(self):
1194 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1195 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1196 with self.assertRaises(TypeError):
1197 zipf.comment = "this is an error"
1198
1199 def test_change_comment_in_empty_archive(self):
1200 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1201 self.assertFalse(zipf.filelist)
1202 zipf.comment = b"this is a comment"
1203 with zipfile.ZipFile(TESTFN, "r") as zipf:
1204 self.assertEqual(zipf.comment, b"this is a comment")
1205
1206 def test_change_comment_in_nonempty_archive(self):
1207 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1208 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1209 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1210 self.assertTrue(zipf.filelist)
1211 zipf.comment = b"this is a comment"
1212 with zipfile.ZipFile(TESTFN, "r") as zipf:
1213 self.assertEqual(zipf.comment, b"this is a comment")
1214
Georg Brandl268e4d42010-10-14 06:59:45 +00001215 def test_empty_zipfile(self):
1216 # Check that creating a file in 'w' or 'a' mode and closing without
1217 # adding any files to the archives creates a valid empty ZIP file
1218 zipf = zipfile.ZipFile(TESTFN, mode="w")
1219 zipf.close()
1220 try:
1221 zipf = zipfile.ZipFile(TESTFN, mode="r")
1222 except zipfile.BadZipFile:
1223 self.fail("Unable to create empty ZIP file in 'w' mode")
1224
1225 zipf = zipfile.ZipFile(TESTFN, mode="a")
1226 zipf.close()
1227 try:
1228 zipf = zipfile.ZipFile(TESTFN, mode="r")
1229 except:
1230 self.fail("Unable to create empty ZIP file in 'a' mode")
1231
1232 def test_open_empty_file(self):
1233 # Issue 1710703: Check that opening a file with less than 22 bytes
Georg Brandl4d540882010-10-28 06:42:33 +00001234 # raises a BadZipFile exception (rather than the previously unhelpful
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001235 # OSError)
Georg Brandl268e4d42010-10-14 06:59:45 +00001236 f = open(TESTFN, 'w')
1237 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001238 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN, 'r')
Georg Brandl268e4d42010-10-14 06:59:45 +00001239
Senthil Kumaran29fa9d42011-10-20 01:46:00 +08001240 def test_create_zipinfo_before_1980(self):
1241 self.assertRaises(ValueError,
1242 zipfile.ZipInfo, 'seventies', (1979, 1, 1, 0, 0, 0))
1243
Guido van Rossumd8faa362007-04-27 19:54:29 +00001244 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001245 unlink(TESTFN)
1246 unlink(TESTFN2)
1247
Thomas Wouterscf297e42007-02-23 15:07:44 +00001248
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001249class AbstractBadCrcTests:
1250 def test_testzip_with_bad_crc(self):
1251 """Tests that files with bad CRCs return their name from testzip."""
1252 zipdata = self.zip_with_bad_crc
1253
1254 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1255 # testzip returns the name of the first corrupt file, or None
1256 self.assertEqual('afile', zipf.testzip())
1257
1258 def test_read_with_bad_crc(self):
1259 """Tests that files with bad CRCs raise a BadZipFile exception when read."""
1260 zipdata = self.zip_with_bad_crc
1261
1262 # Using ZipFile.read()
1263 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1264 self.assertRaises(zipfile.BadZipFile, zipf.read, 'afile')
1265
1266 # Using ZipExtFile.read()
1267 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1268 with zipf.open('afile', 'r') as corrupt_file:
1269 self.assertRaises(zipfile.BadZipFile, corrupt_file.read)
1270
1271 # Same with small reads (in order to exercise the buffering logic)
1272 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1273 with zipf.open('afile', 'r') as corrupt_file:
1274 corrupt_file.MIN_READ_SIZE = 2
1275 with self.assertRaises(zipfile.BadZipFile):
1276 while corrupt_file.read(2):
1277 pass
1278
1279
1280class StoredBadCrcTests(AbstractBadCrcTests, unittest.TestCase):
1281 compression = zipfile.ZIP_STORED
1282 zip_with_bad_crc = (
Christian Tismer59202e52013-10-21 03:59:23 +02001283 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
1284 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
1285 b'ilehello,AworldP'
1286 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
1287 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
1288 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
1289 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
1290 b'\0\0/\0\0\0\0\0')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001291
1292@requires_zlib
1293class DeflateBadCrcTests(AbstractBadCrcTests, unittest.TestCase):
1294 compression = zipfile.ZIP_DEFLATED
1295 zip_with_bad_crc = (
Christian Tismer59202e52013-10-21 03:59:23 +02001296 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
1297 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
1298 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
1299 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
1300 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
1301 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
1302 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
1303 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001304
1305@requires_bz2
1306class Bzip2BadCrcTests(AbstractBadCrcTests, unittest.TestCase):
1307 compression = zipfile.ZIP_BZIP2
1308 zip_with_bad_crc = (
Christian Tismer59202e52013-10-21 03:59:23 +02001309 b'PK\x03\x04\x14\x03\x00\x00\x0c\x00nu\x0c=FA'
1310 b'KE8\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
1311 b'ileBZh91AY&SY\xd4\xa8\xca'
1312 b'\x7f\x00\x00\x0f\x11\x80@\x00\x06D\x90\x80 \x00 \xa5'
1313 b'P\xd9!\x03\x03\x13\x13\x13\x89\xa9\xa9\xc2u5:\x9f'
1314 b'\x8b\xb9"\x9c(HjTe?\x80PK\x01\x02\x14'
1315 b'\x03\x14\x03\x00\x00\x0c\x00nu\x0c=FAKE8'
1316 b'\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00\x00\x00\x00\x00\x00'
1317 b'\x00 \x80\x80\x81\x00\x00\x00\x00afilePK'
1318 b'\x05\x06\x00\x00\x00\x00\x01\x00\x01\x003\x00\x00\x00[\x00'
1319 b'\x00\x00\x00\x00')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001320
1321@requires_lzma
1322class LzmaBadCrcTests(AbstractBadCrcTests, unittest.TestCase):
1323 compression = zipfile.ZIP_LZMA
1324 zip_with_bad_crc = (
Christian Tismer59202e52013-10-21 03:59:23 +02001325 b'PK\x03\x04\x14\x03\x00\x00\x0e\x00nu\x0c=FA'
1326 b'KE\x1b\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
1327 b'ile\t\x04\x05\x00]\x00\x00\x00\x04\x004\x19I'
1328 b'\xee\x8d\xe9\x17\x89:3`\tq!.8\x00PK'
1329 b'\x01\x02\x14\x03\x14\x03\x00\x00\x0e\x00nu\x0c=FA'
1330 b'KE\x1b\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00\x00\x00'
1331 b'\x00\x00\x00\x00 \x80\x80\x81\x00\x00\x00\x00afil'
1332 b'ePK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x003\x00\x00'
1333 b'\x00>\x00\x00\x00\x00\x00')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001334
1335
Thomas Wouterscf297e42007-02-23 15:07:44 +00001336class DecryptionTests(unittest.TestCase):
Ezio Melotti35386712009-12-31 13:22:41 +00001337 """Check that ZIP decryption works. Since the library does not
1338 support encryption at the moment, we use a pre-generated encrypted
1339 ZIP file."""
Thomas Wouterscf297e42007-02-23 15:07:44 +00001340
1341 data = (
Christian Tismer59202e52013-10-21 03:59:23 +02001342 b'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1343 b'\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1344 b'\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1345 b'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1346 b'\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1347 b'\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1348 b'\x00\x00L\x00\x00\x00\x00\x00' )
Christian Heimesfdab48e2008-01-20 09:06:41 +00001349 data2 = (
Christian Tismer59202e52013-10-21 03:59:23 +02001350 b'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1351 b'\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1352 b'\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1353 b'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1354 b'\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1355 b'\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1356 b'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1357 b'\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Thomas Wouterscf297e42007-02-23 15:07:44 +00001358
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001359 plain = b'zipfile.py encryption test'
Christian Heimesfdab48e2008-01-20 09:06:41 +00001360 plain2 = b'\x00'*512
Thomas Wouterscf297e42007-02-23 15:07:44 +00001361
1362 def setUp(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001363 with open(TESTFN, "wb") as fp:
1364 fp.write(self.data)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001365 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti35386712009-12-31 13:22:41 +00001366 with open(TESTFN2, "wb") as fp:
1367 fp.write(self.data2)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001368 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001369
1370 def tearDown(self):
1371 self.zip.close()
1372 os.unlink(TESTFN)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001373 self.zip2.close()
1374 os.unlink(TESTFN2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001375
Ezio Melottiafd0d112009-07-15 17:17:17 +00001376 def test_no_password(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001377 # Reading the encrypted file without password
1378 # must generate a RunTime exception
1379 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001380 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001381
Ezio Melottiafd0d112009-07-15 17:17:17 +00001382 def test_bad_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001383 self.zip.setpassword(b"perl")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001384 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001385 self.zip2.setpassword(b"perl")
1386 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001387
Ezio Melotti975077a2011-05-19 22:03:22 +03001388 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001389 def test_good_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001390 self.zip.setpassword(b"python")
Ezio Melotti35386712009-12-31 13:22:41 +00001391 self.assertEqual(self.zip.read("test.txt"), self.plain)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001392 self.zip2.setpassword(b"12345")
Ezio Melotti35386712009-12-31 13:22:41 +00001393 self.assertEqual(self.zip2.read("zero"), self.plain2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001394
R. David Murray8d855d82010-12-21 21:53:37 +00001395 def test_unicode_password(self):
1396 self.assertRaises(TypeError, self.zip.setpassword, "unicode")
1397 self.assertRaises(TypeError, self.zip.read, "test.txt", "python")
1398 self.assertRaises(TypeError, self.zip.open, "test.txt", pwd="python")
1399 self.assertRaises(TypeError, self.zip.extract, "test.txt", pwd="python")
1400
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001401class AbstractTestsWithRandomBinaryFiles:
1402 @classmethod
1403 def setUpClass(cls):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001404 datacount = randint(16, 64)*1024 + randint(1, 1024)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001405 cls.data = b''.join(struct.pack('<f', random()*randint(-1000, 1000))
1406 for i in range(datacount))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001407
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001408 def setUp(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001409 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +00001410 with open(TESTFN, "wb") as fp:
1411 fp.write(self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001412
1413 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001414 unlink(TESTFN)
1415 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001416
Ezio Melottiafd0d112009-07-15 17:17:17 +00001417 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001418 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001419 with zipfile.ZipFile(f, "w", compression) as zipfp:
1420 zipfp.write(TESTFN, "another.name")
1421 zipfp.write(TESTFN, TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001422
Ezio Melottiafd0d112009-07-15 17:17:17 +00001423 def zip_test(self, f, compression):
1424 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001425
1426 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001427 with zipfile.ZipFile(f, "r", compression) as zipfp:
1428 testdata = zipfp.read(TESTFN)
1429 self.assertEqual(len(testdata), len(self.data))
1430 self.assertEqual(testdata, self.data)
1431 self.assertEqual(zipfp.read("another.name"), self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001432
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001433 def test_read(self):
1434 for f in get_files(self):
1435 self.zip_test(f, self.compression)
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +02001436
Ezio Melottiafd0d112009-07-15 17:17:17 +00001437 def zip_open_test(self, f, compression):
1438 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001439
1440 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001441 with zipfile.ZipFile(f, "r", compression) as zipfp:
1442 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001443 with zipfp.open(TESTFN) as zipopen1:
1444 while True:
1445 read_data = zipopen1.read(256)
1446 if not read_data:
1447 break
1448 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001449
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001450 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001451 with zipfp.open("another.name") as zipopen2:
1452 while True:
1453 read_data = zipopen2.read(256)
1454 if not read_data:
1455 break
1456 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001457
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001458 testdata1 = b''.join(zipdata1)
1459 self.assertEqual(len(testdata1), len(self.data))
1460 self.assertEqual(testdata1, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001461
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001462 testdata2 = b''.join(zipdata2)
Ezio Melotti35386712009-12-31 13:22:41 +00001463 self.assertEqual(len(testdata2), len(self.data))
1464 self.assertEqual(testdata2, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001465
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001466 def test_open(self):
1467 for f in get_files(self):
1468 self.zip_open_test(f, self.compression)
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +02001469
Ezio Melottiafd0d112009-07-15 17:17:17 +00001470 def zip_random_open_test(self, f, compression):
1471 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001472
1473 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001474 with zipfile.ZipFile(f, "r", compression) as zipfp:
1475 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001476 with zipfp.open(TESTFN) as zipopen1:
1477 while True:
1478 read_data = zipopen1.read(randint(1, 1024))
1479 if not read_data:
1480 break
1481 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001482
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001483 testdata = b''.join(zipdata1)
1484 self.assertEqual(len(testdata), len(self.data))
1485 self.assertEqual(testdata, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001486
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001487 def test_random_open(self):
1488 for f in get_files(self):
1489 self.zip_random_open_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001490
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001491
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001492class StoredTestsWithRandomBinaryFiles(AbstractTestsWithRandomBinaryFiles,
1493 unittest.TestCase):
1494 compression = zipfile.ZIP_STORED
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001495
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001496@requires_zlib
1497class DeflateTestsWithRandomBinaryFiles(AbstractTestsWithRandomBinaryFiles,
1498 unittest.TestCase):
1499 compression = zipfile.ZIP_DEFLATED
1500
1501@requires_bz2
1502class Bzip2TestsWithRandomBinaryFiles(AbstractTestsWithRandomBinaryFiles,
1503 unittest.TestCase):
1504 compression = zipfile.ZIP_BZIP2
1505
1506@requires_lzma
1507class LzmaTestsWithRandomBinaryFiles(AbstractTestsWithRandomBinaryFiles,
1508 unittest.TestCase):
1509 compression = zipfile.ZIP_LZMA
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +02001510
Ezio Melotti76430242009-07-11 18:28:48 +00001511
Ezio Melotti975077a2011-05-19 22:03:22 +03001512@requires_zlib
Guido van Rossumd8faa362007-04-27 19:54:29 +00001513class TestsWithMultipleOpens(unittest.TestCase):
1514 def setUp(self):
1515 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001516 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1517 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1518 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001519
Ezio Melottiafd0d112009-07-15 17:17:17 +00001520 def test_same_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001521 # Verify that (when the ZipFile is in control of creating file objects)
1522 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001523 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001524 with zipf.open('ones') as zopen1, zipf.open('ones') as zopen2:
1525 data1 = zopen1.read(500)
1526 data2 = zopen2.read(500)
1527 data1 += zopen1.read(500)
1528 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001529 self.assertEqual(data1, data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001530
Ezio Melottiafd0d112009-07-15 17:17:17 +00001531 def test_different_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001532 # Verify that (when the ZipFile is in control of creating file objects)
1533 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001534 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001535 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1536 data1 = zopen1.read(500)
1537 data2 = zopen2.read(500)
1538 data1 += zopen1.read(500)
1539 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001540 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1541 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001542
Ezio Melottiafd0d112009-07-15 17:17:17 +00001543 def test_interleaved(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001544 # Verify that (when the ZipFile is in control of creating file objects)
1545 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001546 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001547 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1548 data1 = zopen1.read(500)
1549 data2 = zopen2.read(500)
1550 data1 += zopen1.read(500)
1551 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001552 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1553 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001554
1555 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001556 unlink(TESTFN2)
1557
Guido van Rossumd8faa362007-04-27 19:54:29 +00001558
Martin v. Löwis59e47792009-01-24 14:10:07 +00001559class TestWithDirectory(unittest.TestCase):
1560 def setUp(self):
1561 os.mkdir(TESTFN2)
1562
Ezio Melottiafd0d112009-07-15 17:17:17 +00001563 def test_extract_dir(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001564 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1565 zipf.extractall(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001566 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1567 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1568 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1569
Ezio Melottiafd0d112009-07-15 17:17:17 +00001570 def test_bug_6050(self):
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001571 # Extraction should succeed if directories already exist
1572 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottiafd0d112009-07-15 17:17:17 +00001573 self.test_extract_dir()
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001574
Ezio Melottiafd0d112009-07-15 17:17:17 +00001575 def test_store_dir(self):
Martin v. Löwis59e47792009-01-24 14:10:07 +00001576 os.mkdir(os.path.join(TESTFN2, "x"))
1577 zipf = zipfile.ZipFile(TESTFN, "w")
1578 zipf.write(os.path.join(TESTFN2, "x"), "x")
1579 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1580
1581 def tearDown(self):
1582 shutil.rmtree(TESTFN2)
1583 if os.path.exists(TESTFN):
Ezio Melotti76430242009-07-11 18:28:48 +00001584 unlink(TESTFN)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001585
Guido van Rossumd8faa362007-04-27 19:54:29 +00001586
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001587class AbstractUniversalNewlineTests:
1588 @classmethod
1589 def setUpClass(cls):
1590 cls.line_gen = [bytes("Test of zipfile line %d." % i, "ascii")
1591 for i in range(FIXEDTEST_SIZE)]
1592 cls.seps = (b'\r', b'\r\n', b'\n')
1593 cls.arcdata = {}
1594 for n, s in enumerate(cls.seps):
1595 cls.arcdata[s] = s.join(cls.line_gen) + s
1596
Guido van Rossumd8faa362007-04-27 19:54:29 +00001597 def setUp(self):
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001598 self.arcfiles = {}
Guido van Rossumd8faa362007-04-27 19:54:29 +00001599 for n, s in enumerate(self.seps):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001600 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001601 with open(self.arcfiles[s], "wb") as f:
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001602 f.write(self.arcdata[s])
Guido van Rossumd8faa362007-04-27 19:54:29 +00001603
Ezio Melottiafd0d112009-07-15 17:17:17 +00001604 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001605 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001606 with zipfile.ZipFile(f, "w", compression) as zipfp:
1607 for fn in self.arcfiles.values():
1608 zipfp.write(fn, fn)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001609
Ezio Melottiafd0d112009-07-15 17:17:17 +00001610 def read_test(self, f, compression):
1611 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001612
1613 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001614 with zipfile.ZipFile(f, "r") as zipfp:
1615 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001616 with zipfp.open(fn, "rU") as fp:
1617 zipdata = fp.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001618 self.assertEqual(self.arcdata[sep], zipdata)
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001619
1620 def test_read(self):
1621 for f in get_files(self):
1622 self.read_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001623
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001624 def readline_read_test(self, f, compression):
1625 self.make_test_archive(f, compression)
1626
1627 # Read the ZIP archive
Brian Curtin8fb9b862010-11-18 02:15:28 +00001628 with zipfile.ZipFile(f, "r") as zipfp:
1629 for sep, fn in self.arcfiles.items():
1630 with zipfp.open(fn, "rU") as zipopen:
1631 data = b''
1632 while True:
1633 read = zipopen.readline()
1634 if not read:
1635 break
1636 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001637
Brian Curtin8fb9b862010-11-18 02:15:28 +00001638 read = zipopen.read(5)
1639 if not read:
1640 break
1641 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001642
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001643 self.assertEqual(data, self.arcdata[b'\n'])
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001644
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001645 def test_readline_read(self):
1646 for f in get_files(self):
1647 self.readline_read_test(f, self.compression)
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001648
Ezio Melottiafd0d112009-07-15 17:17:17 +00001649 def readline_test(self, f, compression):
1650 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001651
1652 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001653 with zipfile.ZipFile(f, "r") as zipfp:
1654 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001655 with zipfp.open(fn, "rU") as zipopen:
1656 for line in self.line_gen:
1657 linedata = zipopen.readline()
1658 self.assertEqual(linedata, line + b'\n')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001659
1660 def test_readline(self):
1661 for f in get_files(self):
1662 self.readline_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001663
Ezio Melottiafd0d112009-07-15 17:17:17 +00001664 def readlines_test(self, f, compression):
1665 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001666
1667 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001668 with zipfile.ZipFile(f, "r") as zipfp:
1669 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001670 with zipfp.open(fn, "rU") as fp:
1671 ziplines = fp.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001672 for line, zipline in zip(self.line_gen, ziplines):
1673 self.assertEqual(zipline, line + b'\n')
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001674
1675 def test_readlines(self):
1676 for f in get_files(self):
1677 self.readlines_test(f, self.compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001678
Ezio Melottiafd0d112009-07-15 17:17:17 +00001679 def iterlines_test(self, f, compression):
1680 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001681
1682 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001683 with zipfile.ZipFile(f, "r") as zipfp:
1684 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001685 with zipfp.open(fn, "rU") as fp:
1686 for line, zipline in zip(self.line_gen, fp):
1687 self.assertEqual(zipline, line + b'\n')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001688
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001689 def test_iterlines(self):
1690 for f in get_files(self):
1691 self.iterlines_test(f, self.compression)
Martin v. Löwis7fb79fc2012-05-13 10:06:36 +02001692
Guido van Rossumd8faa362007-04-27 19:54:29 +00001693 def tearDown(self):
1694 for sep, fn in self.arcfiles.items():
1695 os.remove(fn)
Ezio Melotti76430242009-07-11 18:28:48 +00001696 unlink(TESTFN)
1697 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001698
1699
Serhiy Storchakafa6bc292013-07-22 21:00:11 +03001700class StoredUniversalNewlineTests(AbstractUniversalNewlineTests,
1701 unittest.TestCase):
1702 compression = zipfile.ZIP_STORED
1703
1704@requires_zlib
1705class DeflateUniversalNewlineTests(AbstractUniversalNewlineTests,
1706 unittest.TestCase):
1707 compression = zipfile.ZIP_DEFLATED
1708
1709@requires_bz2
1710class Bzip2UniversalNewlineTests(AbstractUniversalNewlineTests,
1711 unittest.TestCase):
1712 compression = zipfile.ZIP_BZIP2
1713
1714@requires_lzma
1715class LzmaUniversalNewlineTests(AbstractUniversalNewlineTests,
1716 unittest.TestCase):
1717 compression = zipfile.ZIP_LZMA
1718
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001719if __name__ == "__main__":
Brett Cannond5b4e1d2013-06-12 19:57:19 -04001720 unittest.main()