blob: d90e771ccbc641e5693dea08bcc0b5b6ca81306e [file] [log] [blame]
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001# We can test part of the module without zlib.
Guido van Rossum368f04a2000-04-10 13:23:04 +00002try:
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00003 import zlib
4except ImportError:
5 zlib = None
Ezio Melotti74c96ec2009-07-08 22:24:06 +00006
7import io
8import os
Barry Warsaw28a691b2010-04-17 00:19:56 +00009import imp
Ezio Melotti35386712009-12-31 13:22:41 +000010import time
Ezio Melotti74c96ec2009-07-08 22:24:06 +000011import shutil
12import struct
13import zipfile
14import unittest
15
Tim Petersa45cacf2004-08-20 03:47:14 +000016
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000017from tempfile import TemporaryFile
Guido van Rossumd8faa362007-04-27 19:54:29 +000018from random import randint, random
Ezio Melotti74c96ec2009-07-08 22:24:06 +000019from unittest import skipUnless
Tim Petersa19a1682001-03-29 04:36:09 +000020
Ezio Melotti76430242009-07-11 18:28:48 +000021from test.support import TESTFN, run_unittest, findfile, unlink
Guido van Rossum368f04a2000-04-10 13:23:04 +000022
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000023TESTFN2 = TESTFN + "2"
Martin v. Löwis59e47792009-01-24 14:10:07 +000024TESTFNDIR = TESTFN + "d"
Guido van Rossumb5a755e2007-07-18 18:15:48 +000025FIXEDTEST_SIZE = 1000
Guido van Rossum368f04a2000-04-10 13:23:04 +000026
Christian Heimes790c8232008-01-07 21:14:23 +000027SMALL_TEST_DATA = [('_ziptest1', '1q2w3e4r5t'),
28 ('ziptest2dir/_ziptest2', 'qawsedrftg'),
29 ('/ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
30 ('ziptest2dir/ziptest3dir/ziptest4dir/_ziptest3', '6y7u8i9o0p')]
31
Ezio Melotti76430242009-07-11 18:28:48 +000032
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000033class TestsWithSourceFile(unittest.TestCase):
34 def setUp(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +000035 self.line_gen = (bytes("Zipfile test line %d. random float: %f" %
Guido van Rossum9c627722007-08-27 18:31:48 +000036 (i, random()), "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +000037 for i in range(FIXEDTEST_SIZE))
38 self.data = b'\n'.join(self.line_gen) + b'\n'
Fred Drake6e7e4852001-02-28 05:34:16 +000039
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000040 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +000041 with open(TESTFN, "wb") as fp:
42 fp.write(self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000043
Ezio Melottiafd0d112009-07-15 17:17:17 +000044 def make_test_archive(self, f, compression):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000045 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000046 with zipfile.ZipFile(f, "w", compression) as zipfp:
47 zipfp.write(TESTFN, "another.name")
48 zipfp.write(TESTFN, TESTFN)
49 zipfp.writestr("strfile", self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000050
Ezio Melottiafd0d112009-07-15 17:17:17 +000051 def zip_test(self, f, compression):
52 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +000053
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000054 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000055 with zipfile.ZipFile(f, "r", compression) as zipfp:
56 self.assertEqual(zipfp.read(TESTFN), self.data)
57 self.assertEqual(zipfp.read("another.name"), self.data)
58 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000059
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000060 # Print the ZIP directory
61 fp = io.StringIO()
62 zipfp.printdir(file=fp)
63 directory = fp.getvalue()
64 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +000065 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +000066
Benjamin Peterson577473f2010-01-19 00:09:57 +000067 self.assertIn('File Name', lines[0])
68 self.assertIn('Modified', lines[0])
69 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +000070
Ezio Melotti35386712009-12-31 13:22:41 +000071 fn, date, time_, size = lines[1].split()
72 self.assertEqual(fn, 'another.name')
73 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
74 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
75 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000076
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000077 # Check the namelist
78 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +000079 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000080 self.assertIn(TESTFN, names)
81 self.assertIn("another.name", names)
82 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000083
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000084 # Check infolist
85 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +000086 names = [i.filename for i in infos]
87 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000088 self.assertIn(TESTFN, names)
89 self.assertIn("another.name", names)
90 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000091 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +000092 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000093
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000094 # check getinfo
95 for nm in (TESTFN, "another.name", "strfile"):
96 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +000097 self.assertEqual(info.filename, nm)
98 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000099
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000100 # Check that testzip doesn't raise an exception
101 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000102 if not isinstance(f, str):
103 f.close()
Tim Peters7d3bad62001-04-04 18:56:49 +0000104
Ezio Melottiafd0d112009-07-15 17:17:17 +0000105 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000106 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000107 self.zip_test(f, zipfile.ZIP_STORED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000108
Ezio Melottiafd0d112009-07-15 17:17:17 +0000109 def zip_open_test(self, f, compression):
110 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000111
112 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000113 with zipfile.ZipFile(f, "r", compression) as zipfp:
114 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000115 with zipfp.open(TESTFN) as zipopen1:
116 while True:
117 read_data = zipopen1.read(256)
118 if not read_data:
119 break
120 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000121
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000122 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000123 with zipfp.open("another.name") as zipopen2:
124 while True:
125 read_data = zipopen2.read(256)
126 if not read_data:
127 break
128 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000129
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000130 self.assertEqual(b''.join(zipdata1), self.data)
131 self.assertEqual(b''.join(zipdata2), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000132 if not isinstance(f, str):
133 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000134
Ezio Melottiafd0d112009-07-15 17:17:17 +0000135 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000136 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000137 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000138
Ezio Melottiafd0d112009-07-15 17:17:17 +0000139 def test_open_via_zip_info(self):
Georg Brandlb533e262008-05-25 18:19:30 +0000140 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000141 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
142 zipfp.writestr("name", "foo")
143 zipfp.writestr("name", "bar")
Georg Brandlb533e262008-05-25 18:19:30 +0000144
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000145 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
146 infos = zipfp.infolist()
147 data = b""
148 for info in infos:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000149 with zipfp.open(info) as zipopen:
150 data += zipopen.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000151 self.assertTrue(data == b"foobar" or data == b"barfoo")
152 data = b""
153 for info in infos:
154 data += zipfp.read(info)
155 self.assertTrue(data == b"foobar" or data == b"barfoo")
Georg Brandlb533e262008-05-25 18:19:30 +0000156
Ezio Melottiafd0d112009-07-15 17:17:17 +0000157 def zip_random_open_test(self, f, compression):
158 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000159
160 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000161 with zipfile.ZipFile(f, "r", compression) as zipfp:
162 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000163 with zipfp.open(TESTFN) as zipopen1:
164 while True:
165 read_data = zipopen1.read(randint(1, 1024))
166 if not read_data:
167 break
168 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000169
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000170 self.assertEqual(b''.join(zipdata1), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000171 if not isinstance(f, str):
172 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000173
Ezio Melottiafd0d112009-07-15 17:17:17 +0000174 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000175 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000176 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000177
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000178 def test_univeral_readaheads(self):
179 f = io.BytesIO()
180
181 data = b'a\r\n' * 16 * 1024
182 zipfp = zipfile.ZipFile(f, 'w', zipfile.ZIP_STORED)
183 zipfp.writestr(TESTFN, data)
184 zipfp.close()
185
186 data2 = b''
187 zipfp = zipfile.ZipFile(f, 'r')
Brian Curtin8fb9b862010-11-18 02:15:28 +0000188 with zipfp.open(TESTFN, 'rU') as zipopen:
189 for line in zipopen:
190 data2 += line
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000191 zipfp.close()
192
193 self.assertEqual(data, data2.replace(b'\n', b'\r\n'))
194
195 def zip_readline_read_test(self, f, compression):
196 self.make_test_archive(f, compression)
197
198 # Read the ZIP archive
199 zipfp = zipfile.ZipFile(f, "r")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000200 with zipfp.open(TESTFN) as zipopen:
201 data = b''
202 while True:
203 read = zipopen.readline()
204 if not read:
205 break
206 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000207
Brian Curtin8fb9b862010-11-18 02:15:28 +0000208 read = zipopen.read(100)
209 if not read:
210 break
211 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000212
213 self.assertEqual(data, self.data)
214 zipfp.close()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000215 if not isinstance(f, str):
216 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000217
Ezio Melottiafd0d112009-07-15 17:17:17 +0000218 def zip_readline_test(self, f, compression):
219 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000220
221 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000222 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000223 with zipfp.open(TESTFN) as zipopen:
224 for line in self.line_gen:
225 linedata = zipopen.readline()
226 self.assertEqual(linedata, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000227 if not isinstance(f, str):
228 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000229
Ezio Melottiafd0d112009-07-15 17:17:17 +0000230 def zip_readlines_test(self, f, compression):
231 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000232
233 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000234 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000235 with zipfp.open(TESTFN) as zipopen:
236 ziplines = zipopen.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000237 for line, zipline in zip(self.line_gen, ziplines):
238 self.assertEqual(zipline, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000239 if not isinstance(f, str):
240 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000241
Ezio Melottiafd0d112009-07-15 17:17:17 +0000242 def zip_iterlines_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, zipline in zip(self.line_gen, zipopen):
249 self.assertEqual(zipline, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000250 if not isinstance(f, str):
251 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000252
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000253 def test_readline_read_stored(self):
254 # Issue #7610: calls to readline() interleaved with calls to read().
255 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
256 self.zip_readline_read_test(f, zipfile.ZIP_STORED)
257
Ezio Melottiafd0d112009-07-15 17:17:17 +0000258 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000259 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000260 self.zip_readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000261
Ezio Melottiafd0d112009-07-15 17:17:17 +0000262 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000263 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000264 self.zip_readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000265
Ezio Melottiafd0d112009-07-15 17:17:17 +0000266 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000267 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000268 self.zip_iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000269
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000270 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000271 def test_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000272 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000273 self.zip_test(f, zipfile.ZIP_DEFLATED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000274
Guido van Rossumd8faa362007-04-27 19:54:29 +0000275
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000276 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000277 def test_open_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000278 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000279 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000280
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000281 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000282 def test_random_open_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000283 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000284 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000285
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000286 @skipUnless(zlib, "requires zlib")
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000287 def test_readline_read_deflated(self):
288 # Issue #7610: calls to readline() interleaved with calls to read().
289 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
290 self.zip_readline_read_test(f, zipfile.ZIP_DEFLATED)
291
292 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000293 def test_readline_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000294 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000295 self.zip_readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000296
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000297 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000298 def test_readlines_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000299 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000300 self.zip_readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000301
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000302 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000303 def test_iterlines_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000304 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000305 self.zip_iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000306
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000307 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000308 def test_low_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000309 """Check for cases where compressed data is larger than original."""
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000310 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000311 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
312 zipfp.writestr("strfile", '12')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000313
314 # Get an open object for strfile
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000315 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_DEFLATED) as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000316 with zipfp.open("strfile") as openobj:
317 self.assertEqual(openobj.read(1), b'1')
318 self.assertEqual(openobj.read(1), b'2')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000319
Ezio Melottiafd0d112009-07-15 17:17:17 +0000320 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000321 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
322 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000323
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000324 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
325 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000326
Ezio Melottiafd0d112009-07-15 17:17:17 +0000327 def test_append_to_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000328 """Test appending to an existing zipfile."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000329 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
330 zipfp.write(TESTFN, TESTFN)
331
332 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
333 zipfp.writestr("strfile", self.data)
334 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000335
Ezio Melottiafd0d112009-07-15 17:17:17 +0000336 def test_append_to_non_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000337 """Test appending to an existing file that is not a zipfile."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000338 # NOTE: this test fails if len(d) < 22 because of the first
339 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti35386712009-12-31 13:22:41 +0000340 data = b'I am not a ZipFile!'*10
341 with open(TESTFN2, 'wb') as f:
342 f.write(data)
343
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000344 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
345 zipfp.write(TESTFN, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000346
Ezio Melotti35386712009-12-31 13:22:41 +0000347 with open(TESTFN2, 'rb') as f:
348 f.seek(len(data))
349 with zipfile.ZipFile(f, "r") as zipfp:
350 self.assertEqual(zipfp.namelist(), [TESTFN])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000351
Ezio Melottiafd0d112009-07-15 17:17:17 +0000352 def test_write_default_name(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000353 """Check that calling ZipFile.write without arcname specified
354 produces the expected result."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000355 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
356 zipfp.write(TESTFN)
Brian Curtin8fb9b862010-11-18 02:15:28 +0000357 with open(TESTFN, "rb") as f:
358 self.assertEqual(zipfp.read(TESTFN), f.read())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000359
Ezio Melotti78ea2022009-09-12 18:41:20 +0000360 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000361 def test_per_file_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000362 """Check that files within a Zip archive can have different
363 compression options."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000364 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
365 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
366 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
367 sinfo = zipfp.getinfo('storeme')
368 dinfo = zipfp.getinfo('deflateme')
369 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
370 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000371
Ezio Melottiafd0d112009-07-15 17:17:17 +0000372 def test_write_to_readonly(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000373 """Check that trying to call write() on a readonly ZipFile object
374 raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000375 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
376 zipfp.writestr("somefile.txt", "bogus")
377
378 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
379 self.assertRaises(RuntimeError, zipfp.write, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000380
Ezio Melottiafd0d112009-07-15 17:17:17 +0000381 def test_extract(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000382 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
383 for fpath, fdata in SMALL_TEST_DATA:
384 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000385
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000386 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
387 for fpath, fdata in SMALL_TEST_DATA:
388 writtenfile = zipfp.extract(fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000389
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000390 # make sure it was written to the right place
391 if os.path.isabs(fpath):
392 correctfile = os.path.join(os.getcwd(), fpath[1:])
393 else:
394 correctfile = os.path.join(os.getcwd(), fpath)
395 correctfile = os.path.normpath(correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000396
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000397 self.assertEqual(writtenfile, correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000398
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000399 # make sure correct data is in correct file
Brian Curtin8fb9b862010-11-18 02:15:28 +0000400 with open(writtenfile, "rb") as f:
401 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000402
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000403 os.remove(writtenfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000404
405 # remove the test file subdirectories
406 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
407
Ezio Melottiafd0d112009-07-15 17:17:17 +0000408 def test_extract_all(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000409 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
410 for fpath, fdata in SMALL_TEST_DATA:
411 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000412
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000413 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
414 zipfp.extractall()
415 for fpath, fdata in SMALL_TEST_DATA:
416 if os.path.isabs(fpath):
417 outfile = os.path.join(os.getcwd(), fpath[1:])
418 else:
419 outfile = os.path.join(os.getcwd(), fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000420
Brian Curtin8fb9b862010-11-18 02:15:28 +0000421 with open(outfile, "rb") as f:
422 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000423
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000424 os.remove(outfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000425
426 # remove the test file subdirectories
427 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
428
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000429 def test_writestr_compression(self):
430 zipfp = zipfile.ZipFile(TESTFN2, "w")
431 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
432 if zlib:
433 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
434
435 info = zipfp.getinfo('a.txt')
436 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
437
438 if zlib:
439 info = zipfp.getinfo('b.txt')
440 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
441
442
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000443 def zip_test_writestr_permissions(self, f, compression):
444 # Make sure that writestr creates files with mode 0600,
445 # when it is passed a name rather than a ZipInfo instance.
446
Ezio Melottiafd0d112009-07-15 17:17:17 +0000447 self.make_test_archive(f, compression)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000448 with zipfile.ZipFile(f, "r") as zipfp:
449 zinfo = zipfp.getinfo('strfile')
450 self.assertEqual(zinfo.external_attr, 0o600 << 16)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000451 if not isinstance(f, str):
452 f.close()
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000453
Ezio Melottiafd0d112009-07-15 17:17:17 +0000454 def test_writestr_permissions(self):
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000455 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
456 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
457
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000458 def test_writestr_extended_local_header_issue1202(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000459 with zipfile.ZipFile(TESTFN2, 'w') as orig_zip:
460 for data in 'abcdefghijklmnop':
461 zinfo = zipfile.ZipInfo(data)
462 zinfo.flag_bits |= 0x08 # Include an extended local header.
463 orig_zip.writestr(zinfo, data)
464
465 def test_close(self):
466 """Check that the zipfile is closed after the 'with' block."""
467 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
468 for fpath, fdata in SMALL_TEST_DATA:
469 zipfp.writestr(fpath, fdata)
470 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
471 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
472
473 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
474 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
475 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
476
477 def test_close_on_exception(self):
478 """Check that the zipfile is closed if an exception is raised in the
479 'with' block."""
480 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
481 for fpath, fdata in SMALL_TEST_DATA:
482 zipfp.writestr(fpath, fdata)
483
484 try:
485 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
Georg Brandl4d540882010-10-28 06:42:33 +0000486 raise zipfile.BadZipFile()
487 except zipfile.BadZipFile:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000488 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000489
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000490 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000491 unlink(TESTFN)
492 unlink(TESTFN2)
493
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000494
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000495class TestZip64InSmallFiles(unittest.TestCase):
496 # These tests test the ZIP64 functionality without using large files,
497 # see test_zipfile64 for proper tests.
498
499 def setUp(self):
500 self._limit = zipfile.ZIP64_LIMIT
501 zipfile.ZIP64_LIMIT = 5
502
Guido van Rossum9c627722007-08-27 18:31:48 +0000503 line_gen = (bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000504 for i in range(0, FIXEDTEST_SIZE))
505 self.data = b'\n'.join(line_gen)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000506
507 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +0000508 with open(TESTFN, "wb") as fp:
509 fp.write(self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000510
Ezio Melottiafd0d112009-07-15 17:17:17 +0000511 def large_file_exception_test(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000512 with zipfile.ZipFile(f, "w", compression) as zipfp:
513 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000514 zipfp.write, TESTFN, "another.name")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000515
Ezio Melottiafd0d112009-07-15 17:17:17 +0000516 def large_file_exception_test2(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000517 with zipfile.ZipFile(f, "w", compression) as zipfp:
518 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000519 zipfp.writestr, "another.name", self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000520 if not isinstance(f, str):
521 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000522
Ezio Melottiafd0d112009-07-15 17:17:17 +0000523 def test_large_file_exception(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000524 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000525 self.large_file_exception_test(f, zipfile.ZIP_STORED)
526 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000527
Ezio Melottiafd0d112009-07-15 17:17:17 +0000528 def zip_test(self, f, compression):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000529 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000530 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
531 zipfp.write(TESTFN, "another.name")
532 zipfp.write(TESTFN, TESTFN)
533 zipfp.writestr("strfile", self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000534
535 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000536 with zipfile.ZipFile(f, "r", compression) as zipfp:
537 self.assertEqual(zipfp.read(TESTFN), self.data)
538 self.assertEqual(zipfp.read("another.name"), self.data)
539 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000540
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000541 # Print the ZIP directory
542 fp = io.StringIO()
543 zipfp.printdir(fp)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000544
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000545 directory = fp.getvalue()
546 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +0000547 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000548
Benjamin Peterson577473f2010-01-19 00:09:57 +0000549 self.assertIn('File Name', lines[0])
550 self.assertIn('Modified', lines[0])
551 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000552
Ezio Melotti35386712009-12-31 13:22:41 +0000553 fn, date, time_, size = lines[1].split()
554 self.assertEqual(fn, 'another.name')
555 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
556 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
557 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000558
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000559 # Check the namelist
560 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +0000561 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000562 self.assertIn(TESTFN, names)
563 self.assertIn("another.name", names)
564 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000565
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000566 # Check infolist
567 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +0000568 names = [i.filename for i in infos]
569 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000570 self.assertIn(TESTFN, names)
571 self.assertIn("another.name", names)
572 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000573 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +0000574 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000575
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000576 # check getinfo
577 for nm in (TESTFN, "another.name", "strfile"):
578 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000579 self.assertEqual(info.filename, nm)
580 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000581
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000582 # Check that testzip doesn't raise an exception
583 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000584 if not isinstance(f, str):
585 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000586
Ezio Melottiafd0d112009-07-15 17:17:17 +0000587 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000588 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000589 self.zip_test(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000590
Ezio Melotti76430242009-07-11 18:28:48 +0000591 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000592 def test_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000593 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000594 self.zip_test(f, zipfile.ZIP_DEFLATED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000595
Ezio Melottiafd0d112009-07-15 17:17:17 +0000596 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000597 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
598 allowZip64=True) as zipfp:
599 zipfp.write(TESTFN, "/absolute")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000600
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000601 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
602 self.assertEqual(zipfp.namelist(), ["absolute"])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000603
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000604 def tearDown(self):
605 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti76430242009-07-11 18:28:48 +0000606 unlink(TESTFN)
607 unlink(TESTFN2)
608
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000609
610class PyZipFileTests(unittest.TestCase):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000611 def test_write_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000612 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000613 fn = __file__
614 if fn.endswith('.pyc') or fn.endswith('.pyo'):
Barry Warsaw28a691b2010-04-17 00:19:56 +0000615 path_split = fn.split(os.sep)
616 if os.altsep is not None:
617 path_split.extend(fn.split(os.altsep))
618 if '__pycache__' in path_split:
619 fn = imp.source_from_cache(fn)
620 else:
621 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000622
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000623 zipfp.writepy(fn)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000624
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000625 bn = os.path.basename(fn)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000626 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000627 self.assertTrue(bn + 'o' in zipfp.namelist() or
628 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000629
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000630 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000631 fn = __file__
Ezio Melotti35386712009-12-31 13:22:41 +0000632 if fn.endswith(('.pyc', '.pyo')):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000633 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000634
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000635 zipfp.writepy(fn, "testpackage")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000636
Ezio Melotti35386712009-12-31 13:22:41 +0000637 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Benjamin Peterson577473f2010-01-19 00:09:57 +0000638 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000639 self.assertTrue(bn + 'o' in zipfp.namelist() or
640 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000641
Ezio Melottiafd0d112009-07-15 17:17:17 +0000642 def test_write_python_package(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000643 import email
644 packagedir = os.path.dirname(email.__file__)
645
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000646 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000647 zipfp.writepy(packagedir)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000648
Ezio Melotti35386712009-12-31 13:22:41 +0000649 # Check for a couple of modules at different levels of the
650 # hierarchy
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000651 names = zipfp.namelist()
652 self.assertTrue('email/__init__.pyo' in names or
653 'email/__init__.pyc' in names)
654 self.assertTrue('email/mime/text.pyo' in names or
655 'email/mime/text.pyc' in names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000656
Georg Brandl8334fd92010-12-04 10:26:46 +0000657 def test_write_with_optimization(self):
658 import email
659 packagedir = os.path.dirname(email.__file__)
660 # use .pyc if running test in optimization mode,
661 # use .pyo if running test in debug mode
662 optlevel = 1 if __debug__ else 0
663 ext = '.pyo' if optlevel == 1 else '.pyc'
664
665 with TemporaryFile() as t, \
666 zipfile.PyZipFile(t, "w", optimize=optlevel) as zipfp:
667 zipfp.writepy(packagedir)
668
669 names = zipfp.namelist()
670 self.assertIn('email/__init__' + ext, names)
671 self.assertIn('email/mime/text' + ext, names)
672
Ezio Melottiafd0d112009-07-15 17:17:17 +0000673 def test_write_python_directory(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000674 os.mkdir(TESTFN2)
675 try:
Ezio Melotti35386712009-12-31 13:22:41 +0000676 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
677 fp.write("print(42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000678
Ezio Melotti35386712009-12-31 13:22:41 +0000679 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
680 fp.write("print(42 * 42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000681
Ezio Melotti35386712009-12-31 13:22:41 +0000682 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
683 fp.write("bla bla bla\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000684
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000685 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
686 zipfp.writepy(TESTFN2)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000687
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000688 names = zipfp.namelist()
689 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
690 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
691 self.assertNotIn('mod2.txt', names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000692
693 finally:
694 shutil.rmtree(TESTFN2)
695
Ezio Melottiafd0d112009-07-15 17:17:17 +0000696 def test_write_non_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000697 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000698 with open(TESTFN, 'w') as f:
699 f.write('most definitely not a python file')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000700 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
701 os.remove(TESTFN)
702
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000703
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000704class OtherTests(unittest.TestCase):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000705 zips_with_bad_crc = {
706 zipfile.ZIP_STORED: (
707 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
708 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
709 b'ilehello,AworldP'
710 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
711 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
712 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
713 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
714 b'\0\0/\0\0\0\0\0'),
715 zipfile.ZIP_DEFLATED: (
716 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
717 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
718 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
719 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
720 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
721 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
722 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
723 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
724 }
725
Ezio Melottiafd0d112009-07-15 17:17:17 +0000726 def test_unicode_filenames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000727 with zipfile.ZipFile(TESTFN, "w") as zf:
728 zf.writestr("foo.txt", "Test for unicode filename")
729 zf.writestr("\xf6.txt", "Test for unicode filename")
Ezio Melottie9615932010-01-24 19:26:24 +0000730 self.assertIsInstance(zf.infolist()[0].filename, str)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000731
732 with zipfile.ZipFile(TESTFN, "r") as zf:
733 self.assertEqual(zf.filelist[0].filename, "foo.txt")
734 self.assertEqual(zf.filelist[1].filename, "\xf6.txt")
Martin v. Löwis8570f6a2008-05-05 17:44:38 +0000735
Ezio Melottiafd0d112009-07-15 17:17:17 +0000736 def test_create_non_existent_file_for_append(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +0000737 if os.path.exists(TESTFN):
738 os.unlink(TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000739
Thomas Wouterscf297e42007-02-23 15:07:44 +0000740 filename = 'testfile.txt'
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000741 content = b'hello, world. this is some content.'
Guido van Rossumd8faa362007-04-27 19:54:29 +0000742
Thomas Wouterscf297e42007-02-23 15:07:44 +0000743 try:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000744 with zipfile.ZipFile(TESTFN, 'a') as zf:
745 zf.writestr(filename, content)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000746 except IOError:
747 self.fail('Could not append data to a non-existent zip file.')
748
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000749 self.assertTrue(os.path.exists(TESTFN))
Thomas Wouterscf297e42007-02-23 15:07:44 +0000750
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000751 with zipfile.ZipFile(TESTFN, 'r') as zf:
752 self.assertEqual(zf.read(filename), content)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000753
Ezio Melottiafd0d112009-07-15 17:17:17 +0000754 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000755 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti35386712009-12-31 13:22:41 +0000756 # it opens if there's an error in the file. If it doesn't, the
757 # traceback holds a reference to the ZipFile object and, indirectly,
758 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000759 # On Windows, this causes the os.unlink() call to fail because the
760 # underlying file is still open. This is SF bug #412214.
761 #
Ezio Melotti35386712009-12-31 13:22:41 +0000762 with open(TESTFN, "w") as fp:
763 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000764 try:
765 zf = zipfile.ZipFile(TESTFN)
Georg Brandl4d540882010-10-28 06:42:33 +0000766 except zipfile.BadZipFile:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000767 pass
768
Ezio Melottiafd0d112009-07-15 17:17:17 +0000769 def test_is_zip_erroneous_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000770 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000771 # - passing a filename
772 with open(TESTFN, "w") as fp:
773 fp.write("this is not a legal zip file\n")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000774 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti35386712009-12-31 13:22:41 +0000775 self.assertFalse(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000776 # - passing a file object
777 with open(TESTFN, "rb") as fp:
778 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000779 self.assertTrue(not chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000780 # - passing a file-like object
781 fp = io.BytesIO()
782 fp.write(b"this is not a legal zip file\n")
783 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000784 self.assertTrue(not chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000785 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000786 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000787 self.assertTrue(not chk)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000788
Ezio Melottiafd0d112009-07-15 17:17:17 +0000789 def test_is_zip_valid_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000790 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000791 # - passing a filename
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000792 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
793 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
794
Guido van Rossumd8faa362007-04-27 19:54:29 +0000795 chk = zipfile.is_zipfile(TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000796 self.assertTrue(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000797 # - passing a file object
798 with open(TESTFN, "rb") as fp:
799 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000800 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000801 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000802 zip_contents = fp.read()
803 # - passing a file-like object
804 fp = io.BytesIO()
805 fp.write(zip_contents)
806 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000807 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000808 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000809 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000810 self.assertTrue(chk)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000811
Ezio Melottiafd0d112009-07-15 17:17:17 +0000812 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000813 # make sure we don't raise an AttributeError when a partially-constructed
814 # ZipFile instance is finalized; this tests for regression on SF tracker
815 # bug #403871.
816
817 # The bug we're testing for caused an AttributeError to be raised
818 # when a ZipFile instance was created for a file that did not
819 # exist; the .fp member was not initialized but was needed by the
820 # __del__() method. Since the AttributeError is in the __del__(),
821 # it is ignored, but the user should be sufficiently annoyed by
822 # the message on the output that regression will be noticed
823 # quickly.
824 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
825
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000826 def test_empty_file_raises_BadZipFile(self):
827 f = open(TESTFN, 'w')
828 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +0000829 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000830
Ezio Melotti35386712009-12-31 13:22:41 +0000831 with open(TESTFN, 'w') as fp:
832 fp.write("short file")
Georg Brandl4d540882010-10-28 06:42:33 +0000833 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000834
Ezio Melottiafd0d112009-07-15 17:17:17 +0000835 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000836 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000837 data = io.BytesIO()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000838 with zipfile.ZipFile(data, mode="w") as zipf:
839 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000840
841 # This is correct; calling .read on a closed ZipFile should throw
842 # a RuntimeError, and so should calling .testzip. An earlier
843 # version of .testzip would swallow this exception (and any other)
844 # and report that the first file in the archive was corrupt.
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000845 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
846 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000847 self.assertRaises(RuntimeError, zipf.testzip)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000848 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000849 with open(TESTFN, 'w') as f:
850 f.write('zipfile test data')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000851 self.assertRaises(RuntimeError, zipf.write, TESTFN)
852
Ezio Melottiafd0d112009-07-15 17:17:17 +0000853 def test_bad_constructor_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000854 """Check that bad modes passed to ZipFile constructor are caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000855 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
856
Ezio Melottiafd0d112009-07-15 17:17:17 +0000857 def test_bad_open_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000858 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000859 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
860 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
861
862 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000863 # read the data to make sure the file is there
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000864 zipf.read("foo.txt")
865 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000866
Ezio Melottiafd0d112009-07-15 17:17:17 +0000867 def test_read0(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000868 """Check that calling read(0) on a ZipExtFile object returns an empty
869 string and doesn't advance file pointer."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000870 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
871 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
872 # read the data to make sure the file is there
Brian Curtin8fb9b862010-11-18 02:15:28 +0000873 with zipf.open("foo.txt") as f:
874 for i in range(FIXEDTEST_SIZE):
875 self.assertEqual(f.read(0), b'')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000876
Brian Curtin8fb9b862010-11-18 02:15:28 +0000877 self.assertEqual(f.read(), b"O, for a Muse of Fire!")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000878
Ezio Melottiafd0d112009-07-15 17:17:17 +0000879 def test_open_non_existent_item(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000880 """Check that attempting to call open() for an item that doesn't
881 exist in the archive raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000882 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
883 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000884
Ezio Melottiafd0d112009-07-15 17:17:17 +0000885 def test_bad_compression_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000886 """Check that bad compression methods passed to ZipFile.open are
887 caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000888 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
889
Ezio Melottiafd0d112009-07-15 17:17:17 +0000890 def test_null_byte_in_filename(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000891 """Check that a filename containing a null byte is properly
892 terminated."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000893 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
894 zipf.writestr("foo.txt\x00qqq", b"O, for a Muse of Fire!")
895 self.assertEqual(zipf.namelist(), ['foo.txt'])
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000896
Ezio Melottiafd0d112009-07-15 17:17:17 +0000897 def test_struct_sizes(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000898 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000899 self.assertEqual(zipfile.sizeEndCentDir, 22)
900 self.assertEqual(zipfile.sizeCentralDir, 46)
901 self.assertEqual(zipfile.sizeEndCentDir64, 56)
902 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
903
Ezio Melottiafd0d112009-07-15 17:17:17 +0000904 def test_comments(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000905 """Check that comments on the archive are handled properly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000906
907 # check default comment is empty
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000908 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
909 self.assertEqual(zipf.comment, b'')
910 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
911
912 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
913 self.assertEqual(zipfr.comment, b'')
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000914
915 # check a simple short comment
916 comment = b'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000917 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
918 zipf.comment = comment
919 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
920 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
921 self.assertEqual(zipf.comment, comment)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000922
923 # check a comment of max length
924 comment2 = ''.join(['%d' % (i**3 % 10) for i in range((1 << 16)-1)])
925 comment2 = comment2.encode("ascii")
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000926 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
927 zipf.comment = comment2
928 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
929
930 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
931 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000932
933 # check a comment that is too long is truncated
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000934 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
935 zipf.comment = comment2 + b'oops'
936 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
937 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
938 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000939
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000940 def check_testzip_with_bad_crc(self, compression):
941 """Tests that files with bad CRCs return their name from testzip."""
942 zipdata = self.zips_with_bad_crc[compression]
943
944 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
945 # testzip returns the name of the first corrupt file, or None
946 self.assertEqual('afile', zipf.testzip())
947
948 def test_testzip_with_bad_crc_stored(self):
949 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
950
951 @skipUnless(zlib, "requires zlib")
952 def test_testzip_with_bad_crc_deflated(self):
953 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
954
955 def check_read_with_bad_crc(self, compression):
Georg Brandl4d540882010-10-28 06:42:33 +0000956 """Tests that files with bad CRCs raise a BadZipFile exception when read."""
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000957 zipdata = self.zips_with_bad_crc[compression]
958
959 # Using ZipFile.read()
960 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
Georg Brandl4d540882010-10-28 06:42:33 +0000961 self.assertRaises(zipfile.BadZipFile, zipf.read, 'afile')
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000962
963 # Using ZipExtFile.read()
964 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
965 with zipf.open('afile', 'r') as corrupt_file:
Georg Brandl4d540882010-10-28 06:42:33 +0000966 self.assertRaises(zipfile.BadZipFile, corrupt_file.read)
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000967
968 # Same with small reads (in order to exercise the buffering logic)
969 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
970 with zipf.open('afile', 'r') as corrupt_file:
971 corrupt_file.MIN_READ_SIZE = 2
Georg Brandl4d540882010-10-28 06:42:33 +0000972 with self.assertRaises(zipfile.BadZipFile):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000973 while corrupt_file.read(2):
974 pass
975
976 def test_read_with_bad_crc_stored(self):
977 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
978
979 @skipUnless(zlib, "requires zlib")
980 def test_read_with_bad_crc_deflated(self):
981 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
982
Antoine Pitrou6464d5f2010-09-12 14:51:20 +0000983 def check_read_return_size(self, compression):
984 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
985 # than requested.
986 for test_size in (1, 4095, 4096, 4097, 16384):
987 file_size = test_size + 1
988 junk = b''.join(struct.pack('B', randint(0, 255))
989 for x in range(file_size))
990 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
991 zipf.writestr('foo', junk)
992 with zipf.open('foo', 'r') as fp:
993 buf = fp.read(test_size)
994 self.assertEqual(len(buf), test_size)
995
996 def test_read_return_size_stored(self):
997 self.check_read_return_size(zipfile.ZIP_STORED)
998
999 @skipUnless(zlib, "requires zlib")
1000 def test_read_return_size_deflated(self):
1001 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1002
Georg Brandl268e4d42010-10-14 06:59:45 +00001003 def test_empty_zipfile(self):
1004 # Check that creating a file in 'w' or 'a' mode and closing without
1005 # adding any files to the archives creates a valid empty ZIP file
1006 zipf = zipfile.ZipFile(TESTFN, mode="w")
1007 zipf.close()
1008 try:
1009 zipf = zipfile.ZipFile(TESTFN, mode="r")
1010 except zipfile.BadZipFile:
1011 self.fail("Unable to create empty ZIP file in 'w' mode")
1012
1013 zipf = zipfile.ZipFile(TESTFN, mode="a")
1014 zipf.close()
1015 try:
1016 zipf = zipfile.ZipFile(TESTFN, mode="r")
1017 except:
1018 self.fail("Unable to create empty ZIP file in 'a' mode")
1019
1020 def test_open_empty_file(self):
1021 # Issue 1710703: Check that opening a file with less than 22 bytes
Georg Brandl4d540882010-10-28 06:42:33 +00001022 # raises a BadZipFile exception (rather than the previously unhelpful
Georg Brandl268e4d42010-10-14 06:59:45 +00001023 # IOError)
1024 f = open(TESTFN, 'w')
1025 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001026 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN, 'r')
Georg Brandl268e4d42010-10-14 06:59:45 +00001027
Guido van Rossumd8faa362007-04-27 19:54:29 +00001028 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001029 unlink(TESTFN)
1030 unlink(TESTFN2)
1031
Thomas Wouterscf297e42007-02-23 15:07:44 +00001032
1033class DecryptionTests(unittest.TestCase):
Ezio Melotti35386712009-12-31 13:22:41 +00001034 """Check that ZIP decryption works. Since the library does not
1035 support encryption at the moment, we use a pre-generated encrypted
1036 ZIP file."""
Thomas Wouterscf297e42007-02-23 15:07:44 +00001037
1038 data = (
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001039 b'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1040 b'\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1041 b'\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1042 b'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1043 b'\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1044 b'\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1045 b'\x00\x00L\x00\x00\x00\x00\x00' )
Christian Heimesfdab48e2008-01-20 09:06:41 +00001046 data2 = (
1047 b'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1048 b'\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1049 b'\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1050 b'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1051 b'\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1052 b'\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1053 b'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1054 b'\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Thomas Wouterscf297e42007-02-23 15:07:44 +00001055
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001056 plain = b'zipfile.py encryption test'
Christian Heimesfdab48e2008-01-20 09:06:41 +00001057 plain2 = b'\x00'*512
Thomas Wouterscf297e42007-02-23 15:07:44 +00001058
1059 def setUp(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001060 with open(TESTFN, "wb") as fp:
1061 fp.write(self.data)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001062 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti35386712009-12-31 13:22:41 +00001063 with open(TESTFN2, "wb") as fp:
1064 fp.write(self.data2)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001065 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001066
1067 def tearDown(self):
1068 self.zip.close()
1069 os.unlink(TESTFN)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001070 self.zip2.close()
1071 os.unlink(TESTFN2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001072
Ezio Melottiafd0d112009-07-15 17:17:17 +00001073 def test_no_password(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001074 # Reading the encrypted file without password
1075 # must generate a RunTime exception
1076 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001077 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001078
Ezio Melottiafd0d112009-07-15 17:17:17 +00001079 def test_bad_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001080 self.zip.setpassword(b"perl")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001081 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001082 self.zip2.setpassword(b"perl")
1083 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001084
Ezio Melotti78ea2022009-09-12 18:41:20 +00001085 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001086 def test_good_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001087 self.zip.setpassword(b"python")
Ezio Melotti35386712009-12-31 13:22:41 +00001088 self.assertEqual(self.zip.read("test.txt"), self.plain)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001089 self.zip2.setpassword(b"12345")
Ezio Melotti35386712009-12-31 13:22:41 +00001090 self.assertEqual(self.zip2.read("zero"), self.plain2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001091
R. David Murray8d855d82010-12-21 21:53:37 +00001092 def test_unicode_password(self):
1093 self.assertRaises(TypeError, self.zip.setpassword, "unicode")
1094 self.assertRaises(TypeError, self.zip.read, "test.txt", "python")
1095 self.assertRaises(TypeError, self.zip.open, "test.txt", pwd="python")
1096 self.assertRaises(TypeError, self.zip.extract, "test.txt", pwd="python")
1097
Guido van Rossumd8faa362007-04-27 19:54:29 +00001098
1099class TestsWithRandomBinaryFiles(unittest.TestCase):
1100 def setUp(self):
1101 datacount = randint(16, 64)*1024 + randint(1, 1024)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001102 self.data = b''.join(struct.pack('<f', random()*randint(-1000, 1000))
1103 for i in range(datacount))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001104
1105 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +00001106 with open(TESTFN, "wb") as fp:
1107 fp.write(self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001108
1109 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001110 unlink(TESTFN)
1111 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001112
Ezio Melottiafd0d112009-07-15 17:17:17 +00001113 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001114 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001115 with zipfile.ZipFile(f, "w", compression) as zipfp:
1116 zipfp.write(TESTFN, "another.name")
1117 zipfp.write(TESTFN, TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001118
Ezio Melottiafd0d112009-07-15 17:17:17 +00001119 def zip_test(self, f, compression):
1120 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001121
1122 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001123 with zipfile.ZipFile(f, "r", compression) as zipfp:
1124 testdata = zipfp.read(TESTFN)
1125 self.assertEqual(len(testdata), len(self.data))
1126 self.assertEqual(testdata, self.data)
1127 self.assertEqual(zipfp.read("another.name"), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001128 if not isinstance(f, str):
1129 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001130
Ezio Melottiafd0d112009-07-15 17:17:17 +00001131 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001132 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001133 self.zip_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001134
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001135 @skipUnless(zlib, "requires zlib")
1136 def test_deflated(self):
1137 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1138 self.zip_test(f, zipfile.ZIP_DEFLATED)
1139
Ezio Melottiafd0d112009-07-15 17:17:17 +00001140 def zip_open_test(self, f, compression):
1141 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001142
1143 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001144 with zipfile.ZipFile(f, "r", compression) as zipfp:
1145 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001146 with zipfp.open(TESTFN) as zipopen1:
1147 while True:
1148 read_data = zipopen1.read(256)
1149 if not read_data:
1150 break
1151 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001152
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001153 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001154 with zipfp.open("another.name") as zipopen2:
1155 while True:
1156 read_data = zipopen2.read(256)
1157 if not read_data:
1158 break
1159 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001160
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001161 testdata1 = b''.join(zipdata1)
1162 self.assertEqual(len(testdata1), len(self.data))
1163 self.assertEqual(testdata1, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001164
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001165 testdata2 = b''.join(zipdata2)
Ezio Melotti35386712009-12-31 13:22:41 +00001166 self.assertEqual(len(testdata2), len(self.data))
1167 self.assertEqual(testdata2, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001168 if not isinstance(f, str):
1169 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001170
Ezio Melottiafd0d112009-07-15 17:17:17 +00001171 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001172 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001173 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001174
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001175 @skipUnless(zlib, "requires zlib")
1176 def test_open_deflated(self):
1177 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1178 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1179
Ezio Melottiafd0d112009-07-15 17:17:17 +00001180 def zip_random_open_test(self, f, compression):
1181 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001182
1183 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001184 with zipfile.ZipFile(f, "r", compression) as zipfp:
1185 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001186 with zipfp.open(TESTFN) as zipopen1:
1187 while True:
1188 read_data = zipopen1.read(randint(1, 1024))
1189 if not read_data:
1190 break
1191 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001192
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001193 testdata = b''.join(zipdata1)
1194 self.assertEqual(len(testdata), len(self.data))
1195 self.assertEqual(testdata, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001196 if not isinstance(f, str):
1197 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001198
Ezio Melottiafd0d112009-07-15 17:17:17 +00001199 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001200 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001201 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001202
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001203 @skipUnless(zlib, "requires zlib")
1204 def test_random_open_deflated(self):
1205 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1206 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1207
Ezio Melotti76430242009-07-11 18:28:48 +00001208
Ezio Melotti78ea2022009-09-12 18:41:20 +00001209@skipUnless(zlib, "requires zlib")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001210class TestsWithMultipleOpens(unittest.TestCase):
1211 def setUp(self):
1212 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001213 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1214 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1215 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001216
Ezio Melottiafd0d112009-07-15 17:17:17 +00001217 def test_same_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001218 # Verify that (when the ZipFile is in control of creating file objects)
1219 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001220 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001221 with zipf.open('ones') as zopen1, zipf.open('ones') as zopen2:
1222 data1 = zopen1.read(500)
1223 data2 = zopen2.read(500)
1224 data1 += zopen1.read(500)
1225 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001226 self.assertEqual(data1, data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001227
Ezio Melottiafd0d112009-07-15 17:17:17 +00001228 def test_different_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001229 # Verify that (when the ZipFile is in control of creating file objects)
1230 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001231 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001232 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1233 data1 = zopen1.read(500)
1234 data2 = zopen2.read(500)
1235 data1 += zopen1.read(500)
1236 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001237 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1238 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001239
Ezio Melottiafd0d112009-07-15 17:17:17 +00001240 def test_interleaved(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001241 # Verify that (when the ZipFile is in control of creating file objects)
1242 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001243 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001244 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1245 data1 = zopen1.read(500)
1246 data2 = zopen2.read(500)
1247 data1 += zopen1.read(500)
1248 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001249 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1250 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001251
1252 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001253 unlink(TESTFN2)
1254
Guido van Rossumd8faa362007-04-27 19:54:29 +00001255
Martin v. Löwis59e47792009-01-24 14:10:07 +00001256class TestWithDirectory(unittest.TestCase):
1257 def setUp(self):
1258 os.mkdir(TESTFN2)
1259
Ezio Melottiafd0d112009-07-15 17:17:17 +00001260 def test_extract_dir(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001261 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1262 zipf.extractall(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001263 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1264 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1265 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1266
Ezio Melottiafd0d112009-07-15 17:17:17 +00001267 def test_bug_6050(self):
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001268 # Extraction should succeed if directories already exist
1269 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottiafd0d112009-07-15 17:17:17 +00001270 self.test_extract_dir()
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001271
Ezio Melottiafd0d112009-07-15 17:17:17 +00001272 def test_store_dir(self):
Martin v. Löwis59e47792009-01-24 14:10:07 +00001273 os.mkdir(os.path.join(TESTFN2, "x"))
1274 zipf = zipfile.ZipFile(TESTFN, "w")
1275 zipf.write(os.path.join(TESTFN2, "x"), "x")
1276 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1277
1278 def tearDown(self):
1279 shutil.rmtree(TESTFN2)
1280 if os.path.exists(TESTFN):
Ezio Melotti76430242009-07-11 18:28:48 +00001281 unlink(TESTFN)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001282
Guido van Rossumd8faa362007-04-27 19:54:29 +00001283
1284class UniversalNewlineTests(unittest.TestCase):
1285 def setUp(self):
Guido van Rossum9c627722007-08-27 18:31:48 +00001286 self.line_gen = [bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001287 for i in range(FIXEDTEST_SIZE)]
Guido van Rossumd8faa362007-04-27 19:54:29 +00001288 self.seps = ('\r', '\r\n', '\n')
1289 self.arcdata, self.arcfiles = {}, {}
1290 for n, s in enumerate(self.seps):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001291 b = s.encode("ascii")
1292 self.arcdata[s] = b.join(self.line_gen) + b
Guido van Rossumd8faa362007-04-27 19:54:29 +00001293 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001294 f = open(self.arcfiles[s], "wb")
1295 try:
1296 f.write(self.arcdata[s])
1297 finally:
1298 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001299
Ezio Melottiafd0d112009-07-15 17:17:17 +00001300 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001301 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001302 with zipfile.ZipFile(f, "w", compression) as zipfp:
1303 for fn in self.arcfiles.values():
1304 zipfp.write(fn, fn)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001305
Ezio Melottiafd0d112009-07-15 17:17:17 +00001306 def read_test(self, f, compression):
1307 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001308
1309 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001310 with zipfile.ZipFile(f, "r") as zipfp:
1311 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001312 with zipfp.open(fn, "rU") as fp:
1313 zipdata = fp.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001314 self.assertEqual(self.arcdata[sep], zipdata)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001315 if not isinstance(f, str):
1316 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001317
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001318 def readline_read_test(self, f, compression):
1319 self.make_test_archive(f, compression)
1320
1321 # Read the ZIP archive
Brian Curtin8fb9b862010-11-18 02:15:28 +00001322 with zipfile.ZipFile(f, "r") as zipfp:
1323 for sep, fn in self.arcfiles.items():
1324 with zipfp.open(fn, "rU") as zipopen:
1325 data = b''
1326 while True:
1327 read = zipopen.readline()
1328 if not read:
1329 break
1330 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001331
Brian Curtin8fb9b862010-11-18 02:15:28 +00001332 read = zipopen.read(5)
1333 if not read:
1334 break
1335 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001336
1337 self.assertEqual(data, self.arcdata['\n'])
1338
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001339 if not isinstance(f, str):
1340 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001341
Ezio Melottiafd0d112009-07-15 17:17:17 +00001342 def readline_test(self, f, compression):
1343 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001344
1345 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001346 with zipfile.ZipFile(f, "r") as zipfp:
1347 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001348 with zipfp.open(fn, "rU") as zipopen:
1349 for line in self.line_gen:
1350 linedata = zipopen.readline()
1351 self.assertEqual(linedata, line + b'\n')
1352 if not isinstance(f, str):
1353 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001354
Ezio Melottiafd0d112009-07-15 17:17:17 +00001355 def readlines_test(self, f, compression):
1356 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001357
1358 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001359 with zipfile.ZipFile(f, "r") as zipfp:
1360 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001361 with zipfp.open(fn, "rU") as fp:
1362 ziplines = fp.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001363 for line, zipline in zip(self.line_gen, ziplines):
1364 self.assertEqual(zipline, line + b'\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001365 if not isinstance(f, str):
1366 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001367
Ezio Melottiafd0d112009-07-15 17:17:17 +00001368 def iterlines_test(self, f, compression):
1369 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001370
1371 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001372 with zipfile.ZipFile(f, "r") as zipfp:
1373 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001374 with zipfp.open(fn, "rU") as fp:
1375 for line, zipline in zip(self.line_gen, fp):
1376 self.assertEqual(zipline, line + b'\n')
1377 if not isinstance(f, str):
1378 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001379
Ezio Melottiafd0d112009-07-15 17:17:17 +00001380 def test_read_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001381 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001382 self.read_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001383
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001384 def test_readline_read_stored(self):
1385 # Issue #7610: calls to readline() interleaved with calls to read().
1386 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1387 self.readline_read_test(f, zipfile.ZIP_STORED)
1388
Ezio Melottiafd0d112009-07-15 17:17:17 +00001389 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001390 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001391 self.readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001392
Ezio Melottiafd0d112009-07-15 17:17:17 +00001393 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001394 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001395 self.readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001396
Ezio Melottiafd0d112009-07-15 17:17:17 +00001397 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001398 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001399 self.iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001400
Ezio Melotti76430242009-07-11 18:28:48 +00001401 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001402 def test_read_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001403 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001404 self.read_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001405
Ezio Melotti76430242009-07-11 18:28:48 +00001406 @skipUnless(zlib, "requires zlib")
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001407 def test_readline_read_deflated(self):
1408 # Issue #7610: calls to readline() interleaved with calls to read().
1409 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1410 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1411
1412 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001413 def test_readline_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001414 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001415 self.readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001416
Ezio Melotti76430242009-07-11 18:28:48 +00001417 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001418 def test_readlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001419 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001420 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001421
Ezio Melotti76430242009-07-11 18:28:48 +00001422 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001423 def test_iterlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001424 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001425 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001426
1427 def tearDown(self):
1428 for sep, fn in self.arcfiles.items():
1429 os.remove(fn)
Ezio Melotti76430242009-07-11 18:28:48 +00001430 unlink(TESTFN)
1431 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001432
1433
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001434def test_main():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001435 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1436 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti76430242009-07-11 18:28:48 +00001437 TestWithDirectory, UniversalNewlineTests,
1438 TestsWithRandomBinaryFiles)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001439
1440if __name__ == "__main__":
1441 test_main()