blob: 8d51528ecc7ceaaa5762b9a23864235a71b4c89f [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
Georg Brandl5ba11de2011-01-01 10:09:32 +00009import sys
Barry Warsaw28a691b2010-04-17 00:19:56 +000010import imp
Ezio Melotti35386712009-12-31 13:22:41 +000011import time
Ezio Melotti74c96ec2009-07-08 22:24:06 +000012import shutil
13import struct
14import zipfile
15import unittest
16
Tim Petersa45cacf2004-08-20 03:47:14 +000017
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000018from tempfile import TemporaryFile
Guido van Rossumd8faa362007-04-27 19:54:29 +000019from random import randint, random
Ezio Melotti74c96ec2009-07-08 22:24:06 +000020from unittest import skipUnless
Tim Petersa19a1682001-03-29 04:36:09 +000021
Ezio Melotti76430242009-07-11 18:28:48 +000022from test.support import TESTFN, run_unittest, findfile, unlink
Guido van Rossum368f04a2000-04-10 13:23:04 +000023
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000024TESTFN2 = TESTFN + "2"
Martin v. Löwis59e47792009-01-24 14:10:07 +000025TESTFNDIR = TESTFN + "d"
Guido van Rossumb5a755e2007-07-18 18:15:48 +000026FIXEDTEST_SIZE = 1000
Georg Brandl5ba11de2011-01-01 10:09:32 +000027DATAFILES_DIR = 'zipfile_datafiles'
Guido van Rossum368f04a2000-04-10 13:23:04 +000028
Christian Heimes790c8232008-01-07 21:14:23 +000029SMALL_TEST_DATA = [('_ziptest1', '1q2w3e4r5t'),
30 ('ziptest2dir/_ziptest2', 'qawsedrftg'),
31 ('/ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
32 ('ziptest2dir/ziptest3dir/ziptest4dir/_ziptest3', '6y7u8i9o0p')]
33
Ezio Melotti76430242009-07-11 18:28:48 +000034
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000035class TestsWithSourceFile(unittest.TestCase):
36 def setUp(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +000037 self.line_gen = (bytes("Zipfile test line %d. random float: %f" %
Guido van Rossum9c627722007-08-27 18:31:48 +000038 (i, random()), "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +000039 for i in range(FIXEDTEST_SIZE))
40 self.data = b'\n'.join(self.line_gen) + b'\n'
Fred Drake6e7e4852001-02-28 05:34:16 +000041
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000042 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +000043 with open(TESTFN, "wb") as fp:
44 fp.write(self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000045
Ezio Melottiafd0d112009-07-15 17:17:17 +000046 def make_test_archive(self, f, compression):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000047 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000048 with zipfile.ZipFile(f, "w", compression) as zipfp:
49 zipfp.write(TESTFN, "another.name")
50 zipfp.write(TESTFN, TESTFN)
51 zipfp.writestr("strfile", self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000052
Ezio Melottiafd0d112009-07-15 17:17:17 +000053 def zip_test(self, f, compression):
54 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +000055
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000056 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000057 with zipfile.ZipFile(f, "r", compression) as zipfp:
58 self.assertEqual(zipfp.read(TESTFN), self.data)
59 self.assertEqual(zipfp.read("another.name"), self.data)
60 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000061
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000062 # Print the ZIP directory
63 fp = io.StringIO()
64 zipfp.printdir(file=fp)
65 directory = fp.getvalue()
66 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +000067 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +000068
Benjamin Peterson577473f2010-01-19 00:09:57 +000069 self.assertIn('File Name', lines[0])
70 self.assertIn('Modified', lines[0])
71 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +000072
Ezio Melotti35386712009-12-31 13:22:41 +000073 fn, date, time_, size = lines[1].split()
74 self.assertEqual(fn, 'another.name')
75 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
76 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
77 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000078
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000079 # Check the namelist
80 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +000081 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000082 self.assertIn(TESTFN, names)
83 self.assertIn("another.name", names)
84 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000085
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000086 # Check infolist
87 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +000088 names = [i.filename for i in infos]
89 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000090 self.assertIn(TESTFN, names)
91 self.assertIn("another.name", names)
92 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000093 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +000094 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000095
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000096 # check getinfo
97 for nm in (TESTFN, "another.name", "strfile"):
98 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +000099 self.assertEqual(info.filename, nm)
100 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000101
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000102 # Check that testzip doesn't raise an exception
103 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000104 if not isinstance(f, str):
105 f.close()
Tim Peters7d3bad62001-04-04 18:56:49 +0000106
Ezio Melottiafd0d112009-07-15 17:17:17 +0000107 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000108 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000109 self.zip_test(f, zipfile.ZIP_STORED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000110
Ezio Melottiafd0d112009-07-15 17:17:17 +0000111 def zip_open_test(self, f, compression):
112 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000113
114 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000115 with zipfile.ZipFile(f, "r", compression) as zipfp:
116 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000117 with zipfp.open(TESTFN) as zipopen1:
118 while True:
119 read_data = zipopen1.read(256)
120 if not read_data:
121 break
122 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000123
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000124 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000125 with zipfp.open("another.name") as zipopen2:
126 while True:
127 read_data = zipopen2.read(256)
128 if not read_data:
129 break
130 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000131
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000132 self.assertEqual(b''.join(zipdata1), self.data)
133 self.assertEqual(b''.join(zipdata2), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000134 if not isinstance(f, str):
135 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000136
Ezio Melottiafd0d112009-07-15 17:17:17 +0000137 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000138 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000139 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000140
Ezio Melottiafd0d112009-07-15 17:17:17 +0000141 def test_open_via_zip_info(self):
Georg Brandlb533e262008-05-25 18:19:30 +0000142 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000143 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
144 zipfp.writestr("name", "foo")
145 zipfp.writestr("name", "bar")
Georg Brandlb533e262008-05-25 18:19:30 +0000146
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000147 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
148 infos = zipfp.infolist()
149 data = b""
150 for info in infos:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000151 with zipfp.open(info) as zipopen:
152 data += zipopen.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000153 self.assertTrue(data == b"foobar" or data == b"barfoo")
154 data = b""
155 for info in infos:
156 data += zipfp.read(info)
157 self.assertTrue(data == b"foobar" or data == b"barfoo")
Georg Brandlb533e262008-05-25 18:19:30 +0000158
Ezio Melottiafd0d112009-07-15 17:17:17 +0000159 def zip_random_open_test(self, f, compression):
160 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000161
162 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000163 with zipfile.ZipFile(f, "r", compression) as zipfp:
164 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000165 with zipfp.open(TESTFN) as zipopen1:
166 while True:
167 read_data = zipopen1.read(randint(1, 1024))
168 if not read_data:
169 break
170 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000171
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000172 self.assertEqual(b''.join(zipdata1), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000173 if not isinstance(f, str):
174 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000175
Ezio Melottiafd0d112009-07-15 17:17:17 +0000176 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000177 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000178 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000179
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000180 def test_univeral_readaheads(self):
181 f = io.BytesIO()
182
183 data = b'a\r\n' * 16 * 1024
184 zipfp = zipfile.ZipFile(f, 'w', zipfile.ZIP_STORED)
185 zipfp.writestr(TESTFN, data)
186 zipfp.close()
187
188 data2 = b''
189 zipfp = zipfile.ZipFile(f, 'r')
Brian Curtin8fb9b862010-11-18 02:15:28 +0000190 with zipfp.open(TESTFN, 'rU') as zipopen:
191 for line in zipopen:
192 data2 += line
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000193 zipfp.close()
194
195 self.assertEqual(data, data2.replace(b'\n', b'\r\n'))
196
197 def zip_readline_read_test(self, f, compression):
198 self.make_test_archive(f, compression)
199
200 # Read the ZIP archive
201 zipfp = zipfile.ZipFile(f, "r")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000202 with zipfp.open(TESTFN) as zipopen:
203 data = b''
204 while True:
205 read = zipopen.readline()
206 if not read:
207 break
208 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000209
Brian Curtin8fb9b862010-11-18 02:15:28 +0000210 read = zipopen.read(100)
211 if not read:
212 break
213 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000214
215 self.assertEqual(data, self.data)
216 zipfp.close()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000217 if not isinstance(f, str):
218 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000219
Ezio Melottiafd0d112009-07-15 17:17:17 +0000220 def zip_readline_test(self, f, compression):
221 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000222
223 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000224 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000225 with zipfp.open(TESTFN) as zipopen:
226 for line in self.line_gen:
227 linedata = zipopen.readline()
228 self.assertEqual(linedata, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000229 if not isinstance(f, str):
230 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000231
Ezio Melottiafd0d112009-07-15 17:17:17 +0000232 def zip_readlines_test(self, f, compression):
233 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000234
235 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000236 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000237 with zipfp.open(TESTFN) as zipopen:
238 ziplines = zipopen.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000239 for line, zipline in zip(self.line_gen, ziplines):
240 self.assertEqual(zipline, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000241 if not isinstance(f, str):
242 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000243
Ezio Melottiafd0d112009-07-15 17:17:17 +0000244 def zip_iterlines_test(self, f, compression):
245 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000246
247 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000248 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000249 with zipfp.open(TESTFN) as zipopen:
250 for line, zipline in zip(self.line_gen, zipopen):
251 self.assertEqual(zipline, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000252 if not isinstance(f, str):
253 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000254
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000255 def test_readline_read_stored(self):
256 # Issue #7610: calls to readline() interleaved with calls to read().
257 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
258 self.zip_readline_read_test(f, zipfile.ZIP_STORED)
259
Ezio Melottiafd0d112009-07-15 17:17:17 +0000260 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000261 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000262 self.zip_readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000263
Ezio Melottiafd0d112009-07-15 17:17:17 +0000264 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000265 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000266 self.zip_readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000267
Ezio Melottiafd0d112009-07-15 17:17:17 +0000268 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000269 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000270 self.zip_iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000271
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000272 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000273 def test_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000274 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000275 self.zip_test(f, zipfile.ZIP_DEFLATED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000276
Guido van Rossumd8faa362007-04-27 19:54:29 +0000277
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000278 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000279 def test_open_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000280 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000281 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000282
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000283 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000284 def test_random_open_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000285 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000286 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000287
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000288 @skipUnless(zlib, "requires zlib")
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000289 def test_readline_read_deflated(self):
290 # Issue #7610: calls to readline() interleaved with calls to read().
291 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
292 self.zip_readline_read_test(f, zipfile.ZIP_DEFLATED)
293
294 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000295 def test_readline_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000296 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000297 self.zip_readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000298
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000299 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000300 def test_readlines_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000301 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000302 self.zip_readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000303
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000304 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000305 def test_iterlines_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000306 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000307 self.zip_iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000308
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000309 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000310 def test_low_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000311 """Check for cases where compressed data is larger than original."""
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000312 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000313 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
314 zipfp.writestr("strfile", '12')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000315
316 # Get an open object for strfile
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000317 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_DEFLATED) as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000318 with zipfp.open("strfile") as openobj:
319 self.assertEqual(openobj.read(1), b'1')
320 self.assertEqual(openobj.read(1), b'2')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000321
Ezio Melottiafd0d112009-07-15 17:17:17 +0000322 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000323 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
324 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000325
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000326 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
327 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000328
Ezio Melottiafd0d112009-07-15 17:17:17 +0000329 def test_append_to_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000330 """Test appending to an existing zipfile."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000331 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
332 zipfp.write(TESTFN, TESTFN)
333
334 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
335 zipfp.writestr("strfile", self.data)
336 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000337
Ezio Melottiafd0d112009-07-15 17:17:17 +0000338 def test_append_to_non_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000339 """Test appending to an existing file that is not a zipfile."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000340 # NOTE: this test fails if len(d) < 22 because of the first
341 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti35386712009-12-31 13:22:41 +0000342 data = b'I am not a ZipFile!'*10
343 with open(TESTFN2, 'wb') as f:
344 f.write(data)
345
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000346 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
347 zipfp.write(TESTFN, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000348
Ezio Melotti35386712009-12-31 13:22:41 +0000349 with open(TESTFN2, 'rb') as f:
350 f.seek(len(data))
351 with zipfile.ZipFile(f, "r") as zipfp:
352 self.assertEqual(zipfp.namelist(), [TESTFN])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000353
Ezio Melottiafd0d112009-07-15 17:17:17 +0000354 def test_write_default_name(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000355 """Check that calling ZipFile.write without arcname specified
356 produces the expected result."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000357 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
358 zipfp.write(TESTFN)
Brian Curtin8fb9b862010-11-18 02:15:28 +0000359 with open(TESTFN, "rb") as f:
360 self.assertEqual(zipfp.read(TESTFN), f.read())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000361
Ezio Melotti78ea2022009-09-12 18:41:20 +0000362 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000363 def test_per_file_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000364 """Check that files within a Zip archive can have different
365 compression options."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000366 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
367 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
368 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
369 sinfo = zipfp.getinfo('storeme')
370 dinfo = zipfp.getinfo('deflateme')
371 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
372 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000373
Ezio Melottiafd0d112009-07-15 17:17:17 +0000374 def test_write_to_readonly(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000375 """Check that trying to call write() on a readonly ZipFile object
376 raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000377 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
378 zipfp.writestr("somefile.txt", "bogus")
379
380 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
381 self.assertRaises(RuntimeError, zipfp.write, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000382
Ezio Melottiafd0d112009-07-15 17:17:17 +0000383 def test_extract(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000384 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
385 for fpath, fdata in SMALL_TEST_DATA:
386 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000387
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000388 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
389 for fpath, fdata in SMALL_TEST_DATA:
390 writtenfile = zipfp.extract(fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000391
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000392 # make sure it was written to the right place
393 if os.path.isabs(fpath):
394 correctfile = os.path.join(os.getcwd(), fpath[1:])
395 else:
396 correctfile = os.path.join(os.getcwd(), fpath)
397 correctfile = os.path.normpath(correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000398
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000399 self.assertEqual(writtenfile, correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000400
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000401 # make sure correct data is in correct file
Brian Curtin8fb9b862010-11-18 02:15:28 +0000402 with open(writtenfile, "rb") as f:
403 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000404
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000405 os.remove(writtenfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000406
407 # remove the test file subdirectories
408 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
409
Ezio Melottiafd0d112009-07-15 17:17:17 +0000410 def test_extract_all(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000411 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
412 for fpath, fdata in SMALL_TEST_DATA:
413 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000414
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000415 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
416 zipfp.extractall()
417 for fpath, fdata in SMALL_TEST_DATA:
418 if os.path.isabs(fpath):
419 outfile = os.path.join(os.getcwd(), fpath[1:])
420 else:
421 outfile = os.path.join(os.getcwd(), fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000422
Brian Curtin8fb9b862010-11-18 02:15:28 +0000423 with open(outfile, "rb") as f:
424 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000425
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000426 os.remove(outfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000427
428 # remove the test file subdirectories
429 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
430
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000431 def test_writestr_compression(self):
432 zipfp = zipfile.ZipFile(TESTFN2, "w")
433 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
434 if zlib:
435 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
436
437 info = zipfp.getinfo('a.txt')
438 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
439
440 if zlib:
441 info = zipfp.getinfo('b.txt')
442 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
443
444
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000445 def zip_test_writestr_permissions(self, f, compression):
446 # Make sure that writestr creates files with mode 0600,
447 # when it is passed a name rather than a ZipInfo instance.
448
Ezio Melottiafd0d112009-07-15 17:17:17 +0000449 self.make_test_archive(f, compression)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000450 with zipfile.ZipFile(f, "r") as zipfp:
451 zinfo = zipfp.getinfo('strfile')
452 self.assertEqual(zinfo.external_attr, 0o600 << 16)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000453 if not isinstance(f, str):
454 f.close()
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000455
Ezio Melottiafd0d112009-07-15 17:17:17 +0000456 def test_writestr_permissions(self):
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000457 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
458 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
459
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000460 def test_writestr_extended_local_header_issue1202(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000461 with zipfile.ZipFile(TESTFN2, 'w') as orig_zip:
462 for data in 'abcdefghijklmnop':
463 zinfo = zipfile.ZipInfo(data)
464 zinfo.flag_bits |= 0x08 # Include an extended local header.
465 orig_zip.writestr(zinfo, data)
466
467 def test_close(self):
468 """Check that the zipfile is closed after the 'with' block."""
469 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
470 for fpath, fdata in SMALL_TEST_DATA:
471 zipfp.writestr(fpath, fdata)
472 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
473 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
474
475 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
476 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
477 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
478
479 def test_close_on_exception(self):
480 """Check that the zipfile is closed if an exception is raised in the
481 'with' block."""
482 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
483 for fpath, fdata in SMALL_TEST_DATA:
484 zipfp.writestr(fpath, fdata)
485
486 try:
487 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
Georg Brandl4d540882010-10-28 06:42:33 +0000488 raise zipfile.BadZipFile()
489 except zipfile.BadZipFile:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000490 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000491
Georg Brandl5ba11de2011-01-01 10:09:32 +0000492 def test_unicode_filenames(self):
Georg Brandl04480a82011-01-01 10:42:31 +0000493 # bug #10801
494 fname = findfile('zip_cp437_header.zip')
Georg Brandl5ba11de2011-01-01 10:09:32 +0000495 with zipfile.ZipFile(fname) as zipfp:
Georg Brandl04480a82011-01-01 10:42:31 +0000496 for name in zipfp.namelist():
497 zipfp.open(name).close()
Georg Brandl5ba11de2011-01-01 10:09:32 +0000498
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000499 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000500 unlink(TESTFN)
501 unlink(TESTFN2)
502
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000503
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000504class TestZip64InSmallFiles(unittest.TestCase):
505 # These tests test the ZIP64 functionality without using large files,
506 # see test_zipfile64 for proper tests.
507
508 def setUp(self):
509 self._limit = zipfile.ZIP64_LIMIT
510 zipfile.ZIP64_LIMIT = 5
511
Guido van Rossum9c627722007-08-27 18:31:48 +0000512 line_gen = (bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000513 for i in range(0, FIXEDTEST_SIZE))
514 self.data = b'\n'.join(line_gen)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000515
516 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +0000517 with open(TESTFN, "wb") as fp:
518 fp.write(self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000519
Ezio Melottiafd0d112009-07-15 17:17:17 +0000520 def large_file_exception_test(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000521 with zipfile.ZipFile(f, "w", compression) as zipfp:
522 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000523 zipfp.write, TESTFN, "another.name")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000524
Ezio Melottiafd0d112009-07-15 17:17:17 +0000525 def large_file_exception_test2(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000526 with zipfile.ZipFile(f, "w", compression) as zipfp:
527 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000528 zipfp.writestr, "another.name", self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000529 if not isinstance(f, str):
530 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000531
Ezio Melottiafd0d112009-07-15 17:17:17 +0000532 def test_large_file_exception(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000533 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000534 self.large_file_exception_test(f, zipfile.ZIP_STORED)
535 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000536
Ezio Melottiafd0d112009-07-15 17:17:17 +0000537 def zip_test(self, f, compression):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000538 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000539 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
540 zipfp.write(TESTFN, "another.name")
541 zipfp.write(TESTFN, TESTFN)
542 zipfp.writestr("strfile", self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000543
544 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000545 with zipfile.ZipFile(f, "r", compression) as zipfp:
546 self.assertEqual(zipfp.read(TESTFN), self.data)
547 self.assertEqual(zipfp.read("another.name"), self.data)
548 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000549
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000550 # Print the ZIP directory
551 fp = io.StringIO()
552 zipfp.printdir(fp)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000553
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000554 directory = fp.getvalue()
555 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +0000556 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000557
Benjamin Peterson577473f2010-01-19 00:09:57 +0000558 self.assertIn('File Name', lines[0])
559 self.assertIn('Modified', lines[0])
560 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000561
Ezio Melotti35386712009-12-31 13:22:41 +0000562 fn, date, time_, size = lines[1].split()
563 self.assertEqual(fn, 'another.name')
564 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
565 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
566 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000567
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000568 # Check the namelist
569 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +0000570 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000571 self.assertIn(TESTFN, names)
572 self.assertIn("another.name", names)
573 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000574
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000575 # Check infolist
576 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +0000577 names = [i.filename for i in infos]
578 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000579 self.assertIn(TESTFN, names)
580 self.assertIn("another.name", names)
581 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000582 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +0000583 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000584
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000585 # check getinfo
586 for nm in (TESTFN, "another.name", "strfile"):
587 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000588 self.assertEqual(info.filename, nm)
589 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000590
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000591 # Check that testzip doesn't raise an exception
592 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000593 if not isinstance(f, str):
594 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000595
Ezio Melottiafd0d112009-07-15 17:17:17 +0000596 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000597 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000598 self.zip_test(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000599
Ezio Melotti76430242009-07-11 18:28:48 +0000600 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000601 def test_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000602 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000603 self.zip_test(f, zipfile.ZIP_DEFLATED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000604
Ezio Melottiafd0d112009-07-15 17:17:17 +0000605 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000606 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
607 allowZip64=True) as zipfp:
608 zipfp.write(TESTFN, "/absolute")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000609
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000610 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
611 self.assertEqual(zipfp.namelist(), ["absolute"])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000612
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000613 def tearDown(self):
614 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti76430242009-07-11 18:28:48 +0000615 unlink(TESTFN)
616 unlink(TESTFN2)
617
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000618
619class PyZipFileTests(unittest.TestCase):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000620 def test_write_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000621 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000622 fn = __file__
623 if fn.endswith('.pyc') or fn.endswith('.pyo'):
Barry Warsaw28a691b2010-04-17 00:19:56 +0000624 path_split = fn.split(os.sep)
625 if os.altsep is not None:
626 path_split.extend(fn.split(os.altsep))
627 if '__pycache__' in path_split:
628 fn = imp.source_from_cache(fn)
629 else:
630 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000631
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000632 zipfp.writepy(fn)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000633
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000634 bn = os.path.basename(fn)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000635 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000636 self.assertTrue(bn + 'o' in zipfp.namelist() or
637 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000638
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000639 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000640 fn = __file__
Ezio Melotti35386712009-12-31 13:22:41 +0000641 if fn.endswith(('.pyc', '.pyo')):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000642 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000643
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000644 zipfp.writepy(fn, "testpackage")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000645
Ezio Melotti35386712009-12-31 13:22:41 +0000646 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Benjamin Peterson577473f2010-01-19 00:09:57 +0000647 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000648 self.assertTrue(bn + 'o' in zipfp.namelist() or
649 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000650
Ezio Melottiafd0d112009-07-15 17:17:17 +0000651 def test_write_python_package(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000652 import email
653 packagedir = os.path.dirname(email.__file__)
654
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000655 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000656 zipfp.writepy(packagedir)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000657
Ezio Melotti35386712009-12-31 13:22:41 +0000658 # Check for a couple of modules at different levels of the
659 # hierarchy
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000660 names = zipfp.namelist()
661 self.assertTrue('email/__init__.pyo' in names or
662 'email/__init__.pyc' in names)
663 self.assertTrue('email/mime/text.pyo' in names or
664 'email/mime/text.pyc' in names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000665
Georg Brandl8334fd92010-12-04 10:26:46 +0000666 def test_write_with_optimization(self):
667 import email
668 packagedir = os.path.dirname(email.__file__)
669 # use .pyc if running test in optimization mode,
670 # use .pyo if running test in debug mode
671 optlevel = 1 if __debug__ else 0
672 ext = '.pyo' if optlevel == 1 else '.pyc'
673
674 with TemporaryFile() as t, \
675 zipfile.PyZipFile(t, "w", optimize=optlevel) as zipfp:
676 zipfp.writepy(packagedir)
677
678 names = zipfp.namelist()
679 self.assertIn('email/__init__' + ext, names)
680 self.assertIn('email/mime/text' + ext, names)
681
Ezio Melottiafd0d112009-07-15 17:17:17 +0000682 def test_write_python_directory(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000683 os.mkdir(TESTFN2)
684 try:
Ezio Melotti35386712009-12-31 13:22:41 +0000685 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
686 fp.write("print(42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000687
Ezio Melotti35386712009-12-31 13:22:41 +0000688 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
689 fp.write("print(42 * 42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000690
Ezio Melotti35386712009-12-31 13:22:41 +0000691 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
692 fp.write("bla bla bla\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000693
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000694 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
695 zipfp.writepy(TESTFN2)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000696
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000697 names = zipfp.namelist()
698 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
699 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
700 self.assertNotIn('mod2.txt', names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000701
702 finally:
703 shutil.rmtree(TESTFN2)
704
Ezio Melottiafd0d112009-07-15 17:17:17 +0000705 def test_write_non_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000706 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000707 with open(TESTFN, 'w') as f:
708 f.write('most definitely not a python file')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000709 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
710 os.remove(TESTFN)
711
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000712
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000713class OtherTests(unittest.TestCase):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000714 zips_with_bad_crc = {
715 zipfile.ZIP_STORED: (
716 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
717 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
718 b'ilehello,AworldP'
719 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
720 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
721 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
722 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
723 b'\0\0/\0\0\0\0\0'),
724 zipfile.ZIP_DEFLATED: (
725 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
726 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
727 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
728 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
729 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
730 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
731 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
732 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
733 }
734
Ezio Melottiafd0d112009-07-15 17:17:17 +0000735 def test_unicode_filenames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000736 with zipfile.ZipFile(TESTFN, "w") as zf:
737 zf.writestr("foo.txt", "Test for unicode filename")
738 zf.writestr("\xf6.txt", "Test for unicode filename")
Ezio Melottie9615932010-01-24 19:26:24 +0000739 self.assertIsInstance(zf.infolist()[0].filename, str)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000740
741 with zipfile.ZipFile(TESTFN, "r") as zf:
742 self.assertEqual(zf.filelist[0].filename, "foo.txt")
743 self.assertEqual(zf.filelist[1].filename, "\xf6.txt")
Martin v. Löwis8570f6a2008-05-05 17:44:38 +0000744
Ezio Melottiafd0d112009-07-15 17:17:17 +0000745 def test_create_non_existent_file_for_append(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +0000746 if os.path.exists(TESTFN):
747 os.unlink(TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000748
Thomas Wouterscf297e42007-02-23 15:07:44 +0000749 filename = 'testfile.txt'
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000750 content = b'hello, world. this is some content.'
Guido van Rossumd8faa362007-04-27 19:54:29 +0000751
Thomas Wouterscf297e42007-02-23 15:07:44 +0000752 try:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000753 with zipfile.ZipFile(TESTFN, 'a') as zf:
754 zf.writestr(filename, content)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000755 except IOError:
756 self.fail('Could not append data to a non-existent zip file.')
757
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000758 self.assertTrue(os.path.exists(TESTFN))
Thomas Wouterscf297e42007-02-23 15:07:44 +0000759
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000760 with zipfile.ZipFile(TESTFN, 'r') as zf:
761 self.assertEqual(zf.read(filename), content)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000762
Ezio Melottiafd0d112009-07-15 17:17:17 +0000763 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000764 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti35386712009-12-31 13:22:41 +0000765 # it opens if there's an error in the file. If it doesn't, the
766 # traceback holds a reference to the ZipFile object and, indirectly,
767 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000768 # On Windows, this causes the os.unlink() call to fail because the
769 # underlying file is still open. This is SF bug #412214.
770 #
Ezio Melotti35386712009-12-31 13:22:41 +0000771 with open(TESTFN, "w") as fp:
772 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000773 try:
774 zf = zipfile.ZipFile(TESTFN)
Georg Brandl4d540882010-10-28 06:42:33 +0000775 except zipfile.BadZipFile:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000776 pass
777
Ezio Melottiafd0d112009-07-15 17:17:17 +0000778 def test_is_zip_erroneous_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000779 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000780 # - passing a filename
781 with open(TESTFN, "w") as fp:
782 fp.write("this is not a legal zip file\n")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000783 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti35386712009-12-31 13:22:41 +0000784 self.assertFalse(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000785 # - passing a file object
786 with open(TESTFN, "rb") as fp:
787 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000788 self.assertTrue(not chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000789 # - passing a file-like object
790 fp = io.BytesIO()
791 fp.write(b"this is not a legal zip file\n")
792 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000793 self.assertTrue(not chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000794 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000795 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000796 self.assertTrue(not chk)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000797
Ezio Melottiafd0d112009-07-15 17:17:17 +0000798 def test_is_zip_valid_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000799 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000800 # - passing a filename
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000801 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
802 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
803
Guido van Rossumd8faa362007-04-27 19:54:29 +0000804 chk = zipfile.is_zipfile(TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000805 self.assertTrue(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000806 # - passing a file object
807 with open(TESTFN, "rb") as fp:
808 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000809 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000810 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000811 zip_contents = fp.read()
812 # - passing a file-like object
813 fp = io.BytesIO()
814 fp.write(zip_contents)
815 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000816 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000817 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000818 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000819 self.assertTrue(chk)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000820
Ezio Melottiafd0d112009-07-15 17:17:17 +0000821 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000822 # make sure we don't raise an AttributeError when a partially-constructed
823 # ZipFile instance is finalized; this tests for regression on SF tracker
824 # bug #403871.
825
826 # The bug we're testing for caused an AttributeError to be raised
827 # when a ZipFile instance was created for a file that did not
828 # exist; the .fp member was not initialized but was needed by the
829 # __del__() method. Since the AttributeError is in the __del__(),
830 # it is ignored, but the user should be sufficiently annoyed by
831 # the message on the output that regression will be noticed
832 # quickly.
833 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
834
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000835 def test_empty_file_raises_BadZipFile(self):
836 f = open(TESTFN, 'w')
837 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +0000838 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000839
Ezio Melotti35386712009-12-31 13:22:41 +0000840 with open(TESTFN, 'w') as fp:
841 fp.write("short file")
Georg Brandl4d540882010-10-28 06:42:33 +0000842 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000843
Ezio Melottiafd0d112009-07-15 17:17:17 +0000844 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000845 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000846 data = io.BytesIO()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000847 with zipfile.ZipFile(data, mode="w") as zipf:
848 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000849
850 # This is correct; calling .read on a closed ZipFile should throw
851 # a RuntimeError, and so should calling .testzip. An earlier
852 # version of .testzip would swallow this exception (and any other)
853 # and report that the first file in the archive was corrupt.
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000854 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
855 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000856 self.assertRaises(RuntimeError, zipf.testzip)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000857 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000858 with open(TESTFN, 'w') as f:
859 f.write('zipfile test data')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000860 self.assertRaises(RuntimeError, zipf.write, TESTFN)
861
Ezio Melottiafd0d112009-07-15 17:17:17 +0000862 def test_bad_constructor_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000863 """Check that bad modes passed to ZipFile constructor are caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000864 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
865
Ezio Melottiafd0d112009-07-15 17:17:17 +0000866 def test_bad_open_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000867 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000868 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
869 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
870
871 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000872 # read the data to make sure the file is there
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000873 zipf.read("foo.txt")
874 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000875
Ezio Melottiafd0d112009-07-15 17:17:17 +0000876 def test_read0(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000877 """Check that calling read(0) on a ZipExtFile object returns an empty
878 string and doesn't advance file pointer."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000879 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
880 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
881 # read the data to make sure the file is there
Brian Curtin8fb9b862010-11-18 02:15:28 +0000882 with zipf.open("foo.txt") as f:
883 for i in range(FIXEDTEST_SIZE):
884 self.assertEqual(f.read(0), b'')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000885
Brian Curtin8fb9b862010-11-18 02:15:28 +0000886 self.assertEqual(f.read(), b"O, for a Muse of Fire!")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000887
Ezio Melottiafd0d112009-07-15 17:17:17 +0000888 def test_open_non_existent_item(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000889 """Check that attempting to call open() for an item that doesn't
890 exist in the archive raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000891 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
892 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000893
Ezio Melottiafd0d112009-07-15 17:17:17 +0000894 def test_bad_compression_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000895 """Check that bad compression methods passed to ZipFile.open are
896 caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000897 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
898
Ezio Melottiafd0d112009-07-15 17:17:17 +0000899 def test_null_byte_in_filename(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000900 """Check that a filename containing a null byte is properly
901 terminated."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000902 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
903 zipf.writestr("foo.txt\x00qqq", b"O, for a Muse of Fire!")
904 self.assertEqual(zipf.namelist(), ['foo.txt'])
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000905
Ezio Melottiafd0d112009-07-15 17:17:17 +0000906 def test_struct_sizes(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000907 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000908 self.assertEqual(zipfile.sizeEndCentDir, 22)
909 self.assertEqual(zipfile.sizeCentralDir, 46)
910 self.assertEqual(zipfile.sizeEndCentDir64, 56)
911 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
912
Ezio Melottiafd0d112009-07-15 17:17:17 +0000913 def test_comments(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000914 """Check that comments on the archive are handled properly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000915
916 # check default comment is empty
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000917 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
918 self.assertEqual(zipf.comment, b'')
919 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
920
921 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
922 self.assertEqual(zipfr.comment, b'')
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000923
924 # check a simple short comment
925 comment = b'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000926 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
927 zipf.comment = comment
928 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
929 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
930 self.assertEqual(zipf.comment, comment)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000931
932 # check a comment of max length
933 comment2 = ''.join(['%d' % (i**3 % 10) for i in range((1 << 16)-1)])
934 comment2 = comment2.encode("ascii")
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000935 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
936 zipf.comment = comment2
937 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
938
939 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
940 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000941
942 # check a comment that is too long is truncated
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000943 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
944 zipf.comment = comment2 + b'oops'
945 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
946 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
947 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000948
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000949 def check_testzip_with_bad_crc(self, compression):
950 """Tests that files with bad CRCs return their name from testzip."""
951 zipdata = self.zips_with_bad_crc[compression]
952
953 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
954 # testzip returns the name of the first corrupt file, or None
955 self.assertEqual('afile', zipf.testzip())
956
957 def test_testzip_with_bad_crc_stored(self):
958 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
959
960 @skipUnless(zlib, "requires zlib")
961 def test_testzip_with_bad_crc_deflated(self):
962 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
963
964 def check_read_with_bad_crc(self, compression):
Georg Brandl4d540882010-10-28 06:42:33 +0000965 """Tests that files with bad CRCs raise a BadZipFile exception when read."""
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000966 zipdata = self.zips_with_bad_crc[compression]
967
968 # Using ZipFile.read()
969 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
Georg Brandl4d540882010-10-28 06:42:33 +0000970 self.assertRaises(zipfile.BadZipFile, zipf.read, 'afile')
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000971
972 # Using ZipExtFile.read()
973 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
974 with zipf.open('afile', 'r') as corrupt_file:
Georg Brandl4d540882010-10-28 06:42:33 +0000975 self.assertRaises(zipfile.BadZipFile, corrupt_file.read)
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000976
977 # Same with small reads (in order to exercise the buffering logic)
978 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
979 with zipf.open('afile', 'r') as corrupt_file:
980 corrupt_file.MIN_READ_SIZE = 2
Georg Brandl4d540882010-10-28 06:42:33 +0000981 with self.assertRaises(zipfile.BadZipFile):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000982 while corrupt_file.read(2):
983 pass
984
985 def test_read_with_bad_crc_stored(self):
986 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
987
988 @skipUnless(zlib, "requires zlib")
989 def test_read_with_bad_crc_deflated(self):
990 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
991
Antoine Pitrou6464d5f2010-09-12 14:51:20 +0000992 def check_read_return_size(self, compression):
993 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
994 # than requested.
995 for test_size in (1, 4095, 4096, 4097, 16384):
996 file_size = test_size + 1
997 junk = b''.join(struct.pack('B', randint(0, 255))
998 for x in range(file_size))
999 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
1000 zipf.writestr('foo', junk)
1001 with zipf.open('foo', 'r') as fp:
1002 buf = fp.read(test_size)
1003 self.assertEqual(len(buf), test_size)
1004
1005 def test_read_return_size_stored(self):
1006 self.check_read_return_size(zipfile.ZIP_STORED)
1007
1008 @skipUnless(zlib, "requires zlib")
1009 def test_read_return_size_deflated(self):
1010 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1011
Georg Brandl268e4d42010-10-14 06:59:45 +00001012 def test_empty_zipfile(self):
1013 # Check that creating a file in 'w' or 'a' mode and closing without
1014 # adding any files to the archives creates a valid empty ZIP file
1015 zipf = zipfile.ZipFile(TESTFN, mode="w")
1016 zipf.close()
1017 try:
1018 zipf = zipfile.ZipFile(TESTFN, mode="r")
1019 except zipfile.BadZipFile:
1020 self.fail("Unable to create empty ZIP file in 'w' mode")
1021
1022 zipf = zipfile.ZipFile(TESTFN, mode="a")
1023 zipf.close()
1024 try:
1025 zipf = zipfile.ZipFile(TESTFN, mode="r")
1026 except:
1027 self.fail("Unable to create empty ZIP file in 'a' mode")
1028
1029 def test_open_empty_file(self):
1030 # Issue 1710703: Check that opening a file with less than 22 bytes
Georg Brandl4d540882010-10-28 06:42:33 +00001031 # raises a BadZipFile exception (rather than the previously unhelpful
Georg Brandl268e4d42010-10-14 06:59:45 +00001032 # IOError)
1033 f = open(TESTFN, 'w')
1034 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001035 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN, 'r')
Georg Brandl268e4d42010-10-14 06:59:45 +00001036
Guido van Rossumd8faa362007-04-27 19:54:29 +00001037 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001038 unlink(TESTFN)
1039 unlink(TESTFN2)
1040
Thomas Wouterscf297e42007-02-23 15:07:44 +00001041
1042class DecryptionTests(unittest.TestCase):
Ezio Melotti35386712009-12-31 13:22:41 +00001043 """Check that ZIP decryption works. Since the library does not
1044 support encryption at the moment, we use a pre-generated encrypted
1045 ZIP file."""
Thomas Wouterscf297e42007-02-23 15:07:44 +00001046
1047 data = (
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001048 b'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1049 b'\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1050 b'\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1051 b'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1052 b'\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1053 b'\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1054 b'\x00\x00L\x00\x00\x00\x00\x00' )
Christian Heimesfdab48e2008-01-20 09:06:41 +00001055 data2 = (
1056 b'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1057 b'\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1058 b'\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1059 b'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1060 b'\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1061 b'\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1062 b'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1063 b'\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Thomas Wouterscf297e42007-02-23 15:07:44 +00001064
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001065 plain = b'zipfile.py encryption test'
Christian Heimesfdab48e2008-01-20 09:06:41 +00001066 plain2 = b'\x00'*512
Thomas Wouterscf297e42007-02-23 15:07:44 +00001067
1068 def setUp(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001069 with open(TESTFN, "wb") as fp:
1070 fp.write(self.data)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001071 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti35386712009-12-31 13:22:41 +00001072 with open(TESTFN2, "wb") as fp:
1073 fp.write(self.data2)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001074 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001075
1076 def tearDown(self):
1077 self.zip.close()
1078 os.unlink(TESTFN)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001079 self.zip2.close()
1080 os.unlink(TESTFN2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001081
Ezio Melottiafd0d112009-07-15 17:17:17 +00001082 def test_no_password(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001083 # Reading the encrypted file without password
1084 # must generate a RunTime exception
1085 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001086 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001087
Ezio Melottiafd0d112009-07-15 17:17:17 +00001088 def test_bad_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001089 self.zip.setpassword(b"perl")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001090 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001091 self.zip2.setpassword(b"perl")
1092 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001093
Ezio Melotti78ea2022009-09-12 18:41:20 +00001094 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001095 def test_good_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001096 self.zip.setpassword(b"python")
Ezio Melotti35386712009-12-31 13:22:41 +00001097 self.assertEqual(self.zip.read("test.txt"), self.plain)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001098 self.zip2.setpassword(b"12345")
Ezio Melotti35386712009-12-31 13:22:41 +00001099 self.assertEqual(self.zip2.read("zero"), self.plain2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001100
R. David Murray8d855d82010-12-21 21:53:37 +00001101 def test_unicode_password(self):
1102 self.assertRaises(TypeError, self.zip.setpassword, "unicode")
1103 self.assertRaises(TypeError, self.zip.read, "test.txt", "python")
1104 self.assertRaises(TypeError, self.zip.open, "test.txt", pwd="python")
1105 self.assertRaises(TypeError, self.zip.extract, "test.txt", pwd="python")
1106
Guido van Rossumd8faa362007-04-27 19:54:29 +00001107
1108class TestsWithRandomBinaryFiles(unittest.TestCase):
1109 def setUp(self):
1110 datacount = randint(16, 64)*1024 + randint(1, 1024)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001111 self.data = b''.join(struct.pack('<f', random()*randint(-1000, 1000))
1112 for i in range(datacount))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001113
1114 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +00001115 with open(TESTFN, "wb") as fp:
1116 fp.write(self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001117
1118 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001119 unlink(TESTFN)
1120 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001121
Ezio Melottiafd0d112009-07-15 17:17:17 +00001122 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001123 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001124 with zipfile.ZipFile(f, "w", compression) as zipfp:
1125 zipfp.write(TESTFN, "another.name")
1126 zipfp.write(TESTFN, TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001127
Ezio Melottiafd0d112009-07-15 17:17:17 +00001128 def zip_test(self, f, compression):
1129 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001130
1131 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001132 with zipfile.ZipFile(f, "r", compression) as zipfp:
1133 testdata = zipfp.read(TESTFN)
1134 self.assertEqual(len(testdata), len(self.data))
1135 self.assertEqual(testdata, self.data)
1136 self.assertEqual(zipfp.read("another.name"), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001137 if not isinstance(f, str):
1138 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001139
Ezio Melottiafd0d112009-07-15 17:17:17 +00001140 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001141 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001142 self.zip_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001143
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001144 @skipUnless(zlib, "requires zlib")
1145 def test_deflated(self):
1146 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1147 self.zip_test(f, zipfile.ZIP_DEFLATED)
1148
Ezio Melottiafd0d112009-07-15 17:17:17 +00001149 def zip_open_test(self, f, compression):
1150 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001151
1152 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001153 with zipfile.ZipFile(f, "r", compression) as zipfp:
1154 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001155 with zipfp.open(TESTFN) as zipopen1:
1156 while True:
1157 read_data = zipopen1.read(256)
1158 if not read_data:
1159 break
1160 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001161
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001162 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001163 with zipfp.open("another.name") as zipopen2:
1164 while True:
1165 read_data = zipopen2.read(256)
1166 if not read_data:
1167 break
1168 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001169
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001170 testdata1 = b''.join(zipdata1)
1171 self.assertEqual(len(testdata1), len(self.data))
1172 self.assertEqual(testdata1, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001173
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001174 testdata2 = b''.join(zipdata2)
Ezio Melotti35386712009-12-31 13:22:41 +00001175 self.assertEqual(len(testdata2), len(self.data))
1176 self.assertEqual(testdata2, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001177 if not isinstance(f, str):
1178 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001179
Ezio Melottiafd0d112009-07-15 17:17:17 +00001180 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001181 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001182 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001183
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001184 @skipUnless(zlib, "requires zlib")
1185 def test_open_deflated(self):
1186 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1187 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1188
Ezio Melottiafd0d112009-07-15 17:17:17 +00001189 def zip_random_open_test(self, f, compression):
1190 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001191
1192 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001193 with zipfile.ZipFile(f, "r", compression) as zipfp:
1194 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001195 with zipfp.open(TESTFN) as zipopen1:
1196 while True:
1197 read_data = zipopen1.read(randint(1, 1024))
1198 if not read_data:
1199 break
1200 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001201
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001202 testdata = b''.join(zipdata1)
1203 self.assertEqual(len(testdata), len(self.data))
1204 self.assertEqual(testdata, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001205 if not isinstance(f, str):
1206 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001207
Ezio Melottiafd0d112009-07-15 17:17:17 +00001208 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001209 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001210 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001211
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001212 @skipUnless(zlib, "requires zlib")
1213 def test_random_open_deflated(self):
1214 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1215 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1216
Ezio Melotti76430242009-07-11 18:28:48 +00001217
Ezio Melotti78ea2022009-09-12 18:41:20 +00001218@skipUnless(zlib, "requires zlib")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001219class TestsWithMultipleOpens(unittest.TestCase):
1220 def setUp(self):
1221 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001222 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1223 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1224 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001225
Ezio Melottiafd0d112009-07-15 17:17:17 +00001226 def test_same_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001227 # Verify that (when the ZipFile is in control of creating file objects)
1228 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001229 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001230 with zipf.open('ones') as zopen1, zipf.open('ones') as zopen2:
1231 data1 = zopen1.read(500)
1232 data2 = zopen2.read(500)
1233 data1 += zopen1.read(500)
1234 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001235 self.assertEqual(data1, data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001236
Ezio Melottiafd0d112009-07-15 17:17:17 +00001237 def test_different_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001238 # Verify that (when the ZipFile is in control of creating file objects)
1239 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001240 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001241 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1242 data1 = zopen1.read(500)
1243 data2 = zopen2.read(500)
1244 data1 += zopen1.read(500)
1245 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001246 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1247 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001248
Ezio Melottiafd0d112009-07-15 17:17:17 +00001249 def test_interleaved(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001250 # Verify that (when the ZipFile is in control of creating file objects)
1251 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001252 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001253 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1254 data1 = zopen1.read(500)
1255 data2 = zopen2.read(500)
1256 data1 += zopen1.read(500)
1257 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001258 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1259 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001260
1261 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001262 unlink(TESTFN2)
1263
Guido van Rossumd8faa362007-04-27 19:54:29 +00001264
Martin v. Löwis59e47792009-01-24 14:10:07 +00001265class TestWithDirectory(unittest.TestCase):
1266 def setUp(self):
1267 os.mkdir(TESTFN2)
1268
Ezio Melottiafd0d112009-07-15 17:17:17 +00001269 def test_extract_dir(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001270 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1271 zipf.extractall(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001272 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1273 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1274 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1275
Ezio Melottiafd0d112009-07-15 17:17:17 +00001276 def test_bug_6050(self):
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001277 # Extraction should succeed if directories already exist
1278 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottiafd0d112009-07-15 17:17:17 +00001279 self.test_extract_dir()
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001280
Ezio Melottiafd0d112009-07-15 17:17:17 +00001281 def test_store_dir(self):
Martin v. Löwis59e47792009-01-24 14:10:07 +00001282 os.mkdir(os.path.join(TESTFN2, "x"))
1283 zipf = zipfile.ZipFile(TESTFN, "w")
1284 zipf.write(os.path.join(TESTFN2, "x"), "x")
1285 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1286
1287 def tearDown(self):
1288 shutil.rmtree(TESTFN2)
1289 if os.path.exists(TESTFN):
Ezio Melotti76430242009-07-11 18:28:48 +00001290 unlink(TESTFN)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001291
Guido van Rossumd8faa362007-04-27 19:54:29 +00001292
1293class UniversalNewlineTests(unittest.TestCase):
1294 def setUp(self):
Guido van Rossum9c627722007-08-27 18:31:48 +00001295 self.line_gen = [bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001296 for i in range(FIXEDTEST_SIZE)]
Guido van Rossumd8faa362007-04-27 19:54:29 +00001297 self.seps = ('\r', '\r\n', '\n')
1298 self.arcdata, self.arcfiles = {}, {}
1299 for n, s in enumerate(self.seps):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001300 b = s.encode("ascii")
1301 self.arcdata[s] = b.join(self.line_gen) + b
Guido van Rossumd8faa362007-04-27 19:54:29 +00001302 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001303 f = open(self.arcfiles[s], "wb")
1304 try:
1305 f.write(self.arcdata[s])
1306 finally:
1307 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001308
Ezio Melottiafd0d112009-07-15 17:17:17 +00001309 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001310 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001311 with zipfile.ZipFile(f, "w", compression) as zipfp:
1312 for fn in self.arcfiles.values():
1313 zipfp.write(fn, fn)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001314
Ezio Melottiafd0d112009-07-15 17:17:17 +00001315 def read_test(self, f, compression):
1316 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001317
1318 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001319 with zipfile.ZipFile(f, "r") as zipfp:
1320 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001321 with zipfp.open(fn, "rU") as fp:
1322 zipdata = fp.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001323 self.assertEqual(self.arcdata[sep], zipdata)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001324 if not isinstance(f, str):
1325 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001326
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001327 def readline_read_test(self, f, compression):
1328 self.make_test_archive(f, compression)
1329
1330 # Read the ZIP archive
Brian Curtin8fb9b862010-11-18 02:15:28 +00001331 with zipfile.ZipFile(f, "r") as zipfp:
1332 for sep, fn in self.arcfiles.items():
1333 with zipfp.open(fn, "rU") as zipopen:
1334 data = b''
1335 while True:
1336 read = zipopen.readline()
1337 if not read:
1338 break
1339 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001340
Brian Curtin8fb9b862010-11-18 02:15:28 +00001341 read = zipopen.read(5)
1342 if not read:
1343 break
1344 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001345
1346 self.assertEqual(data, self.arcdata['\n'])
1347
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001348 if not isinstance(f, str):
1349 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001350
Ezio Melottiafd0d112009-07-15 17:17:17 +00001351 def readline_test(self, f, compression):
1352 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001353
1354 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001355 with zipfile.ZipFile(f, "r") as zipfp:
1356 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001357 with zipfp.open(fn, "rU") as zipopen:
1358 for line in self.line_gen:
1359 linedata = zipopen.readline()
1360 self.assertEqual(linedata, line + b'\n')
1361 if not isinstance(f, str):
1362 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001363
Ezio Melottiafd0d112009-07-15 17:17:17 +00001364 def readlines_test(self, f, compression):
1365 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001366
1367 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001368 with zipfile.ZipFile(f, "r") as zipfp:
1369 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001370 with zipfp.open(fn, "rU") as fp:
1371 ziplines = fp.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001372 for line, zipline in zip(self.line_gen, ziplines):
1373 self.assertEqual(zipline, line + b'\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001374 if not isinstance(f, str):
1375 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001376
Ezio Melottiafd0d112009-07-15 17:17:17 +00001377 def iterlines_test(self, f, compression):
1378 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001379
1380 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001381 with zipfile.ZipFile(f, "r") as zipfp:
1382 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001383 with zipfp.open(fn, "rU") as fp:
1384 for line, zipline in zip(self.line_gen, fp):
1385 self.assertEqual(zipline, line + b'\n')
1386 if not isinstance(f, str):
1387 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001388
Ezio Melottiafd0d112009-07-15 17:17:17 +00001389 def test_read_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.read_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001392
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001393 def test_readline_read_stored(self):
1394 # Issue #7610: calls to readline() interleaved with calls to read().
1395 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1396 self.readline_read_test(f, zipfile.ZIP_STORED)
1397
Ezio Melottiafd0d112009-07-15 17:17:17 +00001398 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001399 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001400 self.readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001401
Ezio Melottiafd0d112009-07-15 17:17:17 +00001402 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001403 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001404 self.readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001405
Ezio Melottiafd0d112009-07-15 17:17:17 +00001406 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001407 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001408 self.iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001409
Ezio Melotti76430242009-07-11 18:28:48 +00001410 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001411 def test_read_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001412 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001413 self.read_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001414
Ezio Melotti76430242009-07-11 18:28:48 +00001415 @skipUnless(zlib, "requires zlib")
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001416 def test_readline_read_deflated(self):
1417 # Issue #7610: calls to readline() interleaved with calls to read().
1418 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1419 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1420
1421 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001422 def test_readline_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001423 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001424 self.readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001425
Ezio Melotti76430242009-07-11 18:28:48 +00001426 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001427 def test_readlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001428 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001429 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001430
Ezio Melotti76430242009-07-11 18:28:48 +00001431 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001432 def test_iterlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001433 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001434 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001435
1436 def tearDown(self):
1437 for sep, fn in self.arcfiles.items():
1438 os.remove(fn)
Ezio Melotti76430242009-07-11 18:28:48 +00001439 unlink(TESTFN)
1440 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001441
1442
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001443def test_main():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001444 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1445 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti76430242009-07-11 18:28:48 +00001446 TestWithDirectory, UniversalNewlineTests,
1447 TestsWithRandomBinaryFiles)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001448
1449if __name__ == "__main__":
1450 test_main()