blob: 90aab8689cde7933028265679b60f41dc9d20566 [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
Eric V. Smith91f03592011-03-14 11:57:16 -0400492 @skipUnless(zlib, "requires zlib")
Georg Brandl5ba11de2011-01-01 10:09:32 +0000493 def test_unicode_filenames(self):
Georg Brandl04480a82011-01-01 10:42:31 +0000494 # bug #10801
495 fname = findfile('zip_cp437_header.zip')
Georg Brandl5ba11de2011-01-01 10:09:32 +0000496 with zipfile.ZipFile(fname) as zipfp:
Georg Brandl04480a82011-01-01 10:42:31 +0000497 for name in zipfp.namelist():
498 zipfp.open(name).close()
Georg Brandl5ba11de2011-01-01 10:09:32 +0000499
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000500 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000501 unlink(TESTFN)
502 unlink(TESTFN2)
503
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000504
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000505class TestZip64InSmallFiles(unittest.TestCase):
506 # These tests test the ZIP64 functionality without using large files,
507 # see test_zipfile64 for proper tests.
508
509 def setUp(self):
510 self._limit = zipfile.ZIP64_LIMIT
511 zipfile.ZIP64_LIMIT = 5
512
Guido van Rossum9c627722007-08-27 18:31:48 +0000513 line_gen = (bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000514 for i in range(0, FIXEDTEST_SIZE))
515 self.data = b'\n'.join(line_gen)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000516
517 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +0000518 with open(TESTFN, "wb") as fp:
519 fp.write(self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000520
Ezio Melottiafd0d112009-07-15 17:17:17 +0000521 def large_file_exception_test(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000522 with zipfile.ZipFile(f, "w", compression) as zipfp:
523 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000524 zipfp.write, TESTFN, "another.name")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000525
Ezio Melottiafd0d112009-07-15 17:17:17 +0000526 def large_file_exception_test2(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000527 with zipfile.ZipFile(f, "w", compression) as zipfp:
528 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000529 zipfp.writestr, "another.name", self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000530 if not isinstance(f, str):
531 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000532
Ezio Melottiafd0d112009-07-15 17:17:17 +0000533 def test_large_file_exception(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000534 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000535 self.large_file_exception_test(f, zipfile.ZIP_STORED)
536 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000537
Ezio Melottiafd0d112009-07-15 17:17:17 +0000538 def zip_test(self, f, compression):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000539 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000540 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
541 zipfp.write(TESTFN, "another.name")
542 zipfp.write(TESTFN, TESTFN)
543 zipfp.writestr("strfile", self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000544
545 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000546 with zipfile.ZipFile(f, "r", compression) as zipfp:
547 self.assertEqual(zipfp.read(TESTFN), self.data)
548 self.assertEqual(zipfp.read("another.name"), self.data)
549 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000550
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000551 # Print the ZIP directory
552 fp = io.StringIO()
553 zipfp.printdir(fp)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000554
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000555 directory = fp.getvalue()
556 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +0000557 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000558
Benjamin Peterson577473f2010-01-19 00:09:57 +0000559 self.assertIn('File Name', lines[0])
560 self.assertIn('Modified', lines[0])
561 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000562
Ezio Melotti35386712009-12-31 13:22:41 +0000563 fn, date, time_, size = lines[1].split()
564 self.assertEqual(fn, 'another.name')
565 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
566 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
567 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000568
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000569 # Check the namelist
570 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +0000571 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000572 self.assertIn(TESTFN, names)
573 self.assertIn("another.name", names)
574 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000575
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000576 # Check infolist
577 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +0000578 names = [i.filename for i in infos]
579 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000580 self.assertIn(TESTFN, names)
581 self.assertIn("another.name", names)
582 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000583 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +0000584 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000585
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000586 # check getinfo
587 for nm in (TESTFN, "another.name", "strfile"):
588 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000589 self.assertEqual(info.filename, nm)
590 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000591
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000592 # Check that testzip doesn't raise an exception
593 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000594 if not isinstance(f, str):
595 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000596
Ezio Melottiafd0d112009-07-15 17:17:17 +0000597 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000598 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000599 self.zip_test(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000600
Ezio Melotti76430242009-07-11 18:28:48 +0000601 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000602 def test_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000603 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000604 self.zip_test(f, zipfile.ZIP_DEFLATED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000605
Ezio Melottiafd0d112009-07-15 17:17:17 +0000606 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000607 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
608 allowZip64=True) as zipfp:
609 zipfp.write(TESTFN, "/absolute")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000610
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000611 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
612 self.assertEqual(zipfp.namelist(), ["absolute"])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000613
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000614 def tearDown(self):
615 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti76430242009-07-11 18:28:48 +0000616 unlink(TESTFN)
617 unlink(TESTFN2)
618
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000619
620class PyZipFileTests(unittest.TestCase):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000621 def test_write_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000622 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000623 fn = __file__
624 if fn.endswith('.pyc') or fn.endswith('.pyo'):
Barry Warsaw28a691b2010-04-17 00:19:56 +0000625 path_split = fn.split(os.sep)
626 if os.altsep is not None:
627 path_split.extend(fn.split(os.altsep))
628 if '__pycache__' in path_split:
629 fn = imp.source_from_cache(fn)
630 else:
631 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000632
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000633 zipfp.writepy(fn)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000634
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000635 bn = os.path.basename(fn)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000636 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000637 self.assertTrue(bn + 'o' in zipfp.namelist() or
638 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000639
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000640 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000641 fn = __file__
Ezio Melotti35386712009-12-31 13:22:41 +0000642 if fn.endswith(('.pyc', '.pyo')):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000643 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000644
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000645 zipfp.writepy(fn, "testpackage")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000646
Ezio Melotti35386712009-12-31 13:22:41 +0000647 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Benjamin Peterson577473f2010-01-19 00:09:57 +0000648 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000649 self.assertTrue(bn + 'o' in zipfp.namelist() or
650 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000651
Ezio Melottiafd0d112009-07-15 17:17:17 +0000652 def test_write_python_package(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000653 import email
654 packagedir = os.path.dirname(email.__file__)
655
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000656 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000657 zipfp.writepy(packagedir)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000658
Ezio Melotti35386712009-12-31 13:22:41 +0000659 # Check for a couple of modules at different levels of the
660 # hierarchy
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000661 names = zipfp.namelist()
662 self.assertTrue('email/__init__.pyo' in names or
663 'email/__init__.pyc' in names)
664 self.assertTrue('email/mime/text.pyo' in names or
665 'email/mime/text.pyc' in names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000666
Georg Brandl8334fd92010-12-04 10:26:46 +0000667 def test_write_with_optimization(self):
668 import email
669 packagedir = os.path.dirname(email.__file__)
670 # use .pyc if running test in optimization mode,
671 # use .pyo if running test in debug mode
672 optlevel = 1 if __debug__ else 0
673 ext = '.pyo' if optlevel == 1 else '.pyc'
674
675 with TemporaryFile() as t, \
676 zipfile.PyZipFile(t, "w", optimize=optlevel) as zipfp:
677 zipfp.writepy(packagedir)
678
679 names = zipfp.namelist()
680 self.assertIn('email/__init__' + ext, names)
681 self.assertIn('email/mime/text' + ext, names)
682
Ezio Melottiafd0d112009-07-15 17:17:17 +0000683 def test_write_python_directory(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000684 os.mkdir(TESTFN2)
685 try:
Ezio Melotti35386712009-12-31 13:22:41 +0000686 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
687 fp.write("print(42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000688
Ezio Melotti35386712009-12-31 13:22:41 +0000689 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
690 fp.write("print(42 * 42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000691
Ezio Melotti35386712009-12-31 13:22:41 +0000692 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
693 fp.write("bla bla bla\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000694
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000695 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
696 zipfp.writepy(TESTFN2)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000697
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000698 names = zipfp.namelist()
699 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
700 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
701 self.assertNotIn('mod2.txt', names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000702
703 finally:
704 shutil.rmtree(TESTFN2)
705
Ezio Melottiafd0d112009-07-15 17:17:17 +0000706 def test_write_non_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000707 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000708 with open(TESTFN, 'w') as f:
709 f.write('most definitely not a python file')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000710 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
711 os.remove(TESTFN)
712
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000713
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000714class OtherTests(unittest.TestCase):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000715 zips_with_bad_crc = {
716 zipfile.ZIP_STORED: (
717 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
718 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
719 b'ilehello,AworldP'
720 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
721 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
722 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
723 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
724 b'\0\0/\0\0\0\0\0'),
725 zipfile.ZIP_DEFLATED: (
726 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
727 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
728 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
729 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
730 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
731 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
732 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
733 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
734 }
735
Ezio Melottiafd0d112009-07-15 17:17:17 +0000736 def test_unicode_filenames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000737 with zipfile.ZipFile(TESTFN, "w") as zf:
738 zf.writestr("foo.txt", "Test for unicode filename")
739 zf.writestr("\xf6.txt", "Test for unicode filename")
Ezio Melottie9615932010-01-24 19:26:24 +0000740 self.assertIsInstance(zf.infolist()[0].filename, str)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000741
742 with zipfile.ZipFile(TESTFN, "r") as zf:
743 self.assertEqual(zf.filelist[0].filename, "foo.txt")
744 self.assertEqual(zf.filelist[1].filename, "\xf6.txt")
Martin v. Löwis8570f6a2008-05-05 17:44:38 +0000745
Ezio Melottiafd0d112009-07-15 17:17:17 +0000746 def test_create_non_existent_file_for_append(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +0000747 if os.path.exists(TESTFN):
748 os.unlink(TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000749
Thomas Wouterscf297e42007-02-23 15:07:44 +0000750 filename = 'testfile.txt'
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000751 content = b'hello, world. this is some content.'
Guido van Rossumd8faa362007-04-27 19:54:29 +0000752
Thomas Wouterscf297e42007-02-23 15:07:44 +0000753 try:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000754 with zipfile.ZipFile(TESTFN, 'a') as zf:
755 zf.writestr(filename, content)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000756 except IOError:
757 self.fail('Could not append data to a non-existent zip file.')
758
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000759 self.assertTrue(os.path.exists(TESTFN))
Thomas Wouterscf297e42007-02-23 15:07:44 +0000760
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000761 with zipfile.ZipFile(TESTFN, 'r') as zf:
762 self.assertEqual(zf.read(filename), content)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000763
Ezio Melottiafd0d112009-07-15 17:17:17 +0000764 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000765 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti35386712009-12-31 13:22:41 +0000766 # it opens if there's an error in the file. If it doesn't, the
767 # traceback holds a reference to the ZipFile object and, indirectly,
768 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000769 # On Windows, this causes the os.unlink() call to fail because the
770 # underlying file is still open. This is SF bug #412214.
771 #
Ezio Melotti35386712009-12-31 13:22:41 +0000772 with open(TESTFN, "w") as fp:
773 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000774 try:
775 zf = zipfile.ZipFile(TESTFN)
Georg Brandl4d540882010-10-28 06:42:33 +0000776 except zipfile.BadZipFile:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000777 pass
778
Ezio Melottiafd0d112009-07-15 17:17:17 +0000779 def test_is_zip_erroneous_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000780 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000781 # - passing a filename
782 with open(TESTFN, "w") as fp:
783 fp.write("this is not a legal zip file\n")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000784 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti35386712009-12-31 13:22:41 +0000785 self.assertFalse(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000786 # - passing a file object
787 with open(TESTFN, "rb") as fp:
788 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000789 self.assertTrue(not chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000790 # - passing a file-like object
791 fp = io.BytesIO()
792 fp.write(b"this is not a legal zip file\n")
793 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000794 self.assertTrue(not chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000795 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000796 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000797 self.assertTrue(not chk)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000798
Ezio Melottiafd0d112009-07-15 17:17:17 +0000799 def test_is_zip_valid_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000800 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000801 # - passing a filename
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000802 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
803 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
804
Guido van Rossumd8faa362007-04-27 19:54:29 +0000805 chk = zipfile.is_zipfile(TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000806 self.assertTrue(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000807 # - passing a file object
808 with open(TESTFN, "rb") as fp:
809 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000810 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000811 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000812 zip_contents = fp.read()
813 # - passing a file-like object
814 fp = io.BytesIO()
815 fp.write(zip_contents)
816 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000817 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000818 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000819 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000820 self.assertTrue(chk)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000821
Ezio Melottiafd0d112009-07-15 17:17:17 +0000822 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000823 # make sure we don't raise an AttributeError when a partially-constructed
824 # ZipFile instance is finalized; this tests for regression on SF tracker
825 # bug #403871.
826
827 # The bug we're testing for caused an AttributeError to be raised
828 # when a ZipFile instance was created for a file that did not
829 # exist; the .fp member was not initialized but was needed by the
830 # __del__() method. Since the AttributeError is in the __del__(),
831 # it is ignored, but the user should be sufficiently annoyed by
832 # the message on the output that regression will be noticed
833 # quickly.
834 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
835
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000836 def test_empty_file_raises_BadZipFile(self):
837 f = open(TESTFN, 'w')
838 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +0000839 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000840
Ezio Melotti35386712009-12-31 13:22:41 +0000841 with open(TESTFN, 'w') as fp:
842 fp.write("short file")
Georg Brandl4d540882010-10-28 06:42:33 +0000843 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000844
Ezio Melottiafd0d112009-07-15 17:17:17 +0000845 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000846 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000847 data = io.BytesIO()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000848 with zipfile.ZipFile(data, mode="w") as zipf:
849 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000850
851 # This is correct; calling .read on a closed ZipFile should throw
852 # a RuntimeError, and so should calling .testzip. An earlier
853 # version of .testzip would swallow this exception (and any other)
854 # and report that the first file in the archive was corrupt.
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000855 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
856 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000857 self.assertRaises(RuntimeError, zipf.testzip)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000858 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000859 with open(TESTFN, 'w') as f:
860 f.write('zipfile test data')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000861 self.assertRaises(RuntimeError, zipf.write, TESTFN)
862
Ezio Melottiafd0d112009-07-15 17:17:17 +0000863 def test_bad_constructor_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000864 """Check that bad modes passed to ZipFile constructor are caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000865 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
866
Ezio Melottiafd0d112009-07-15 17:17:17 +0000867 def test_bad_open_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000868 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000869 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
870 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
871
872 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000873 # read the data to make sure the file is there
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000874 zipf.read("foo.txt")
875 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000876
Ezio Melottiafd0d112009-07-15 17:17:17 +0000877 def test_read0(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000878 """Check that calling read(0) on a ZipExtFile object returns an empty
879 string and doesn't advance file pointer."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000880 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
881 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
882 # read the data to make sure the file is there
Brian Curtin8fb9b862010-11-18 02:15:28 +0000883 with zipf.open("foo.txt") as f:
884 for i in range(FIXEDTEST_SIZE):
885 self.assertEqual(f.read(0), b'')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000886
Brian Curtin8fb9b862010-11-18 02:15:28 +0000887 self.assertEqual(f.read(), b"O, for a Muse of Fire!")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000888
Ezio Melottiafd0d112009-07-15 17:17:17 +0000889 def test_open_non_existent_item(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000890 """Check that attempting to call open() for an item that doesn't
891 exist in the archive raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000892 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
893 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000894
Ezio Melottiafd0d112009-07-15 17:17:17 +0000895 def test_bad_compression_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000896 """Check that bad compression methods passed to ZipFile.open are
897 caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000898 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
899
Ezio Melottiafd0d112009-07-15 17:17:17 +0000900 def test_null_byte_in_filename(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000901 """Check that a filename containing a null byte is properly
902 terminated."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000903 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
904 zipf.writestr("foo.txt\x00qqq", b"O, for a Muse of Fire!")
905 self.assertEqual(zipf.namelist(), ['foo.txt'])
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000906
Ezio Melottiafd0d112009-07-15 17:17:17 +0000907 def test_struct_sizes(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000908 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000909 self.assertEqual(zipfile.sizeEndCentDir, 22)
910 self.assertEqual(zipfile.sizeCentralDir, 46)
911 self.assertEqual(zipfile.sizeEndCentDir64, 56)
912 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
913
Ezio Melottiafd0d112009-07-15 17:17:17 +0000914 def test_comments(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000915 """Check that comments on the archive are handled properly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000916
917 # check default comment is empty
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000918 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
919 self.assertEqual(zipf.comment, b'')
920 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
921
922 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
923 self.assertEqual(zipfr.comment, b'')
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000924
925 # check a simple short comment
926 comment = b'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000927 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
928 zipf.comment = comment
929 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
930 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
931 self.assertEqual(zipf.comment, comment)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000932
933 # check a comment of max length
934 comment2 = ''.join(['%d' % (i**3 % 10) for i in range((1 << 16)-1)])
935 comment2 = comment2.encode("ascii")
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000936 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
937 zipf.comment = comment2
938 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
939
940 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
941 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000942
943 # check a comment that is too long is truncated
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000944 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
945 zipf.comment = comment2 + b'oops'
946 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
947 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
948 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000949
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000950 def check_testzip_with_bad_crc(self, compression):
951 """Tests that files with bad CRCs return their name from testzip."""
952 zipdata = self.zips_with_bad_crc[compression]
953
954 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
955 # testzip returns the name of the first corrupt file, or None
956 self.assertEqual('afile', zipf.testzip())
957
958 def test_testzip_with_bad_crc_stored(self):
959 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
960
961 @skipUnless(zlib, "requires zlib")
962 def test_testzip_with_bad_crc_deflated(self):
963 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
964
965 def check_read_with_bad_crc(self, compression):
Georg Brandl4d540882010-10-28 06:42:33 +0000966 """Tests that files with bad CRCs raise a BadZipFile exception when read."""
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000967 zipdata = self.zips_with_bad_crc[compression]
968
969 # Using ZipFile.read()
970 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
Georg Brandl4d540882010-10-28 06:42:33 +0000971 self.assertRaises(zipfile.BadZipFile, zipf.read, 'afile')
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000972
973 # Using ZipExtFile.read()
974 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
975 with zipf.open('afile', 'r') as corrupt_file:
Georg Brandl4d540882010-10-28 06:42:33 +0000976 self.assertRaises(zipfile.BadZipFile, corrupt_file.read)
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000977
978 # Same with small reads (in order to exercise the buffering logic)
979 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
980 with zipf.open('afile', 'r') as corrupt_file:
981 corrupt_file.MIN_READ_SIZE = 2
Georg Brandl4d540882010-10-28 06:42:33 +0000982 with self.assertRaises(zipfile.BadZipFile):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000983 while corrupt_file.read(2):
984 pass
985
986 def test_read_with_bad_crc_stored(self):
987 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
988
989 @skipUnless(zlib, "requires zlib")
990 def test_read_with_bad_crc_deflated(self):
991 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
992
Antoine Pitrou6464d5f2010-09-12 14:51:20 +0000993 def check_read_return_size(self, compression):
994 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
995 # than requested.
996 for test_size in (1, 4095, 4096, 4097, 16384):
997 file_size = test_size + 1
998 junk = b''.join(struct.pack('B', randint(0, 255))
999 for x in range(file_size))
1000 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
1001 zipf.writestr('foo', junk)
1002 with zipf.open('foo', 'r') as fp:
1003 buf = fp.read(test_size)
1004 self.assertEqual(len(buf), test_size)
1005
1006 def test_read_return_size_stored(self):
1007 self.check_read_return_size(zipfile.ZIP_STORED)
1008
1009 @skipUnless(zlib, "requires zlib")
1010 def test_read_return_size_deflated(self):
1011 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1012
Georg Brandl268e4d42010-10-14 06:59:45 +00001013 def test_empty_zipfile(self):
1014 # Check that creating a file in 'w' or 'a' mode and closing without
1015 # adding any files to the archives creates a valid empty ZIP file
1016 zipf = zipfile.ZipFile(TESTFN, mode="w")
1017 zipf.close()
1018 try:
1019 zipf = zipfile.ZipFile(TESTFN, mode="r")
1020 except zipfile.BadZipFile:
1021 self.fail("Unable to create empty ZIP file in 'w' mode")
1022
1023 zipf = zipfile.ZipFile(TESTFN, mode="a")
1024 zipf.close()
1025 try:
1026 zipf = zipfile.ZipFile(TESTFN, mode="r")
1027 except:
1028 self.fail("Unable to create empty ZIP file in 'a' mode")
1029
1030 def test_open_empty_file(self):
1031 # Issue 1710703: Check that opening a file with less than 22 bytes
Georg Brandl4d540882010-10-28 06:42:33 +00001032 # raises a BadZipFile exception (rather than the previously unhelpful
Georg Brandl268e4d42010-10-14 06:59:45 +00001033 # IOError)
1034 f = open(TESTFN, 'w')
1035 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001036 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN, 'r')
Georg Brandl268e4d42010-10-14 06:59:45 +00001037
Guido van Rossumd8faa362007-04-27 19:54:29 +00001038 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001039 unlink(TESTFN)
1040 unlink(TESTFN2)
1041
Thomas Wouterscf297e42007-02-23 15:07:44 +00001042
1043class DecryptionTests(unittest.TestCase):
Ezio Melotti35386712009-12-31 13:22:41 +00001044 """Check that ZIP decryption works. Since the library does not
1045 support encryption at the moment, we use a pre-generated encrypted
1046 ZIP file."""
Thomas Wouterscf297e42007-02-23 15:07:44 +00001047
1048 data = (
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001049 b'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1050 b'\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1051 b'\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1052 b'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1053 b'\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1054 b'\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1055 b'\x00\x00L\x00\x00\x00\x00\x00' )
Christian Heimesfdab48e2008-01-20 09:06:41 +00001056 data2 = (
1057 b'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1058 b'\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1059 b'\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1060 b'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1061 b'\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1062 b'\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1063 b'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1064 b'\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Thomas Wouterscf297e42007-02-23 15:07:44 +00001065
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001066 plain = b'zipfile.py encryption test'
Christian Heimesfdab48e2008-01-20 09:06:41 +00001067 plain2 = b'\x00'*512
Thomas Wouterscf297e42007-02-23 15:07:44 +00001068
1069 def setUp(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001070 with open(TESTFN, "wb") as fp:
1071 fp.write(self.data)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001072 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti35386712009-12-31 13:22:41 +00001073 with open(TESTFN2, "wb") as fp:
1074 fp.write(self.data2)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001075 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001076
1077 def tearDown(self):
1078 self.zip.close()
1079 os.unlink(TESTFN)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001080 self.zip2.close()
1081 os.unlink(TESTFN2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001082
Ezio Melottiafd0d112009-07-15 17:17:17 +00001083 def test_no_password(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001084 # Reading the encrypted file without password
1085 # must generate a RunTime exception
1086 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001087 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001088
Ezio Melottiafd0d112009-07-15 17:17:17 +00001089 def test_bad_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001090 self.zip.setpassword(b"perl")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001091 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001092 self.zip2.setpassword(b"perl")
1093 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001094
Ezio Melotti78ea2022009-09-12 18:41:20 +00001095 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001096 def test_good_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001097 self.zip.setpassword(b"python")
Ezio Melotti35386712009-12-31 13:22:41 +00001098 self.assertEqual(self.zip.read("test.txt"), self.plain)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001099 self.zip2.setpassword(b"12345")
Ezio Melotti35386712009-12-31 13:22:41 +00001100 self.assertEqual(self.zip2.read("zero"), self.plain2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001101
R. David Murray8d855d82010-12-21 21:53:37 +00001102 def test_unicode_password(self):
1103 self.assertRaises(TypeError, self.zip.setpassword, "unicode")
1104 self.assertRaises(TypeError, self.zip.read, "test.txt", "python")
1105 self.assertRaises(TypeError, self.zip.open, "test.txt", pwd="python")
1106 self.assertRaises(TypeError, self.zip.extract, "test.txt", pwd="python")
1107
Guido van Rossumd8faa362007-04-27 19:54:29 +00001108
1109class TestsWithRandomBinaryFiles(unittest.TestCase):
1110 def setUp(self):
1111 datacount = randint(16, 64)*1024 + randint(1, 1024)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001112 self.data = b''.join(struct.pack('<f', random()*randint(-1000, 1000))
1113 for i in range(datacount))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001114
1115 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +00001116 with open(TESTFN, "wb") as fp:
1117 fp.write(self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001118
1119 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001120 unlink(TESTFN)
1121 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001122
Ezio Melottiafd0d112009-07-15 17:17:17 +00001123 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001124 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001125 with zipfile.ZipFile(f, "w", compression) as zipfp:
1126 zipfp.write(TESTFN, "another.name")
1127 zipfp.write(TESTFN, TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001128
Ezio Melottiafd0d112009-07-15 17:17:17 +00001129 def zip_test(self, f, compression):
1130 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001131
1132 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001133 with zipfile.ZipFile(f, "r", compression) as zipfp:
1134 testdata = zipfp.read(TESTFN)
1135 self.assertEqual(len(testdata), len(self.data))
1136 self.assertEqual(testdata, self.data)
1137 self.assertEqual(zipfp.read("another.name"), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001138 if not isinstance(f, str):
1139 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001140
Ezio Melottiafd0d112009-07-15 17:17:17 +00001141 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001142 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001143 self.zip_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001144
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001145 @skipUnless(zlib, "requires zlib")
1146 def test_deflated(self):
1147 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1148 self.zip_test(f, zipfile.ZIP_DEFLATED)
1149
Ezio Melottiafd0d112009-07-15 17:17:17 +00001150 def zip_open_test(self, f, compression):
1151 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001152
1153 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001154 with zipfile.ZipFile(f, "r", compression) as zipfp:
1155 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001156 with zipfp.open(TESTFN) as zipopen1:
1157 while True:
1158 read_data = zipopen1.read(256)
1159 if not read_data:
1160 break
1161 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001162
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001163 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001164 with zipfp.open("another.name") as zipopen2:
1165 while True:
1166 read_data = zipopen2.read(256)
1167 if not read_data:
1168 break
1169 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001170
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001171 testdata1 = b''.join(zipdata1)
1172 self.assertEqual(len(testdata1), len(self.data))
1173 self.assertEqual(testdata1, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001174
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001175 testdata2 = b''.join(zipdata2)
Ezio Melotti35386712009-12-31 13:22:41 +00001176 self.assertEqual(len(testdata2), len(self.data))
1177 self.assertEqual(testdata2, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001178 if not isinstance(f, str):
1179 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001180
Ezio Melottiafd0d112009-07-15 17:17:17 +00001181 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001182 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001183 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001184
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001185 @skipUnless(zlib, "requires zlib")
1186 def test_open_deflated(self):
1187 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1188 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1189
Ezio Melottiafd0d112009-07-15 17:17:17 +00001190 def zip_random_open_test(self, f, compression):
1191 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001192
1193 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001194 with zipfile.ZipFile(f, "r", compression) as zipfp:
1195 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001196 with zipfp.open(TESTFN) as zipopen1:
1197 while True:
1198 read_data = zipopen1.read(randint(1, 1024))
1199 if not read_data:
1200 break
1201 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001202
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001203 testdata = b''.join(zipdata1)
1204 self.assertEqual(len(testdata), len(self.data))
1205 self.assertEqual(testdata, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001206 if not isinstance(f, str):
1207 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001208
Ezio Melottiafd0d112009-07-15 17:17:17 +00001209 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001210 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001211 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001212
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001213 @skipUnless(zlib, "requires zlib")
1214 def test_random_open_deflated(self):
1215 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1216 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1217
Ezio Melotti76430242009-07-11 18:28:48 +00001218
Ezio Melotti78ea2022009-09-12 18:41:20 +00001219@skipUnless(zlib, "requires zlib")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001220class TestsWithMultipleOpens(unittest.TestCase):
1221 def setUp(self):
1222 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001223 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1224 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1225 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001226
Ezio Melottiafd0d112009-07-15 17:17:17 +00001227 def test_same_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001228 # Verify that (when the ZipFile is in control of creating file objects)
1229 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001230 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001231 with zipf.open('ones') as zopen1, zipf.open('ones') as zopen2:
1232 data1 = zopen1.read(500)
1233 data2 = zopen2.read(500)
1234 data1 += zopen1.read(500)
1235 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001236 self.assertEqual(data1, data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001237
Ezio Melottiafd0d112009-07-15 17:17:17 +00001238 def test_different_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001239 # Verify that (when the ZipFile is in control of creating file objects)
1240 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001241 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001242 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1243 data1 = zopen1.read(500)
1244 data2 = zopen2.read(500)
1245 data1 += zopen1.read(500)
1246 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001247 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1248 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001249
Ezio Melottiafd0d112009-07-15 17:17:17 +00001250 def test_interleaved(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001251 # Verify that (when the ZipFile is in control of creating file objects)
1252 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001253 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001254 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1255 data1 = zopen1.read(500)
1256 data2 = zopen2.read(500)
1257 data1 += zopen1.read(500)
1258 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001259 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1260 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001261
1262 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001263 unlink(TESTFN2)
1264
Guido van Rossumd8faa362007-04-27 19:54:29 +00001265
Martin v. Löwis59e47792009-01-24 14:10:07 +00001266class TestWithDirectory(unittest.TestCase):
1267 def setUp(self):
1268 os.mkdir(TESTFN2)
1269
Ezio Melottiafd0d112009-07-15 17:17:17 +00001270 def test_extract_dir(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001271 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1272 zipf.extractall(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001273 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1274 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1275 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1276
Ezio Melottiafd0d112009-07-15 17:17:17 +00001277 def test_bug_6050(self):
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001278 # Extraction should succeed if directories already exist
1279 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottiafd0d112009-07-15 17:17:17 +00001280 self.test_extract_dir()
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001281
Ezio Melottiafd0d112009-07-15 17:17:17 +00001282 def test_store_dir(self):
Martin v. Löwis59e47792009-01-24 14:10:07 +00001283 os.mkdir(os.path.join(TESTFN2, "x"))
1284 zipf = zipfile.ZipFile(TESTFN, "w")
1285 zipf.write(os.path.join(TESTFN2, "x"), "x")
1286 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1287
1288 def tearDown(self):
1289 shutil.rmtree(TESTFN2)
1290 if os.path.exists(TESTFN):
Ezio Melotti76430242009-07-11 18:28:48 +00001291 unlink(TESTFN)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001292
Guido van Rossumd8faa362007-04-27 19:54:29 +00001293
1294class UniversalNewlineTests(unittest.TestCase):
1295 def setUp(self):
Guido van Rossum9c627722007-08-27 18:31:48 +00001296 self.line_gen = [bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001297 for i in range(FIXEDTEST_SIZE)]
Guido van Rossumd8faa362007-04-27 19:54:29 +00001298 self.seps = ('\r', '\r\n', '\n')
1299 self.arcdata, self.arcfiles = {}, {}
1300 for n, s in enumerate(self.seps):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001301 b = s.encode("ascii")
1302 self.arcdata[s] = b.join(self.line_gen) + b
Guido van Rossumd8faa362007-04-27 19:54:29 +00001303 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001304 f = open(self.arcfiles[s], "wb")
1305 try:
1306 f.write(self.arcdata[s])
1307 finally:
1308 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001309
Ezio Melottiafd0d112009-07-15 17:17:17 +00001310 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001311 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001312 with zipfile.ZipFile(f, "w", compression) as zipfp:
1313 for fn in self.arcfiles.values():
1314 zipfp.write(fn, fn)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001315
Ezio Melottiafd0d112009-07-15 17:17:17 +00001316 def read_test(self, f, compression):
1317 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001318
1319 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001320 with zipfile.ZipFile(f, "r") as zipfp:
1321 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001322 with zipfp.open(fn, "rU") as fp:
1323 zipdata = fp.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001324 self.assertEqual(self.arcdata[sep], zipdata)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001325 if not isinstance(f, str):
1326 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001327
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001328 def readline_read_test(self, f, compression):
1329 self.make_test_archive(f, compression)
1330
1331 # Read the ZIP archive
Brian Curtin8fb9b862010-11-18 02:15:28 +00001332 with zipfile.ZipFile(f, "r") as zipfp:
1333 for sep, fn in self.arcfiles.items():
1334 with zipfp.open(fn, "rU") as zipopen:
1335 data = b''
1336 while True:
1337 read = zipopen.readline()
1338 if not read:
1339 break
1340 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001341
Brian Curtin8fb9b862010-11-18 02:15:28 +00001342 read = zipopen.read(5)
1343 if not read:
1344 break
1345 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001346
1347 self.assertEqual(data, self.arcdata['\n'])
1348
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001349 if not isinstance(f, str):
1350 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001351
Ezio Melottiafd0d112009-07-15 17:17:17 +00001352 def readline_test(self, f, compression):
1353 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001354
1355 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001356 with zipfile.ZipFile(f, "r") as zipfp:
1357 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001358 with zipfp.open(fn, "rU") as zipopen:
1359 for line in self.line_gen:
1360 linedata = zipopen.readline()
1361 self.assertEqual(linedata, line + b'\n')
1362 if not isinstance(f, str):
1363 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001364
Ezio Melottiafd0d112009-07-15 17:17:17 +00001365 def readlines_test(self, f, compression):
1366 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001367
1368 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001369 with zipfile.ZipFile(f, "r") as zipfp:
1370 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001371 with zipfp.open(fn, "rU") as fp:
1372 ziplines = fp.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001373 for line, zipline in zip(self.line_gen, ziplines):
1374 self.assertEqual(zipline, line + b'\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001375 if not isinstance(f, str):
1376 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001377
Ezio Melottiafd0d112009-07-15 17:17:17 +00001378 def iterlines_test(self, f, compression):
1379 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001380
1381 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001382 with zipfile.ZipFile(f, "r") as zipfp:
1383 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001384 with zipfp.open(fn, "rU") as fp:
1385 for line, zipline in zip(self.line_gen, fp):
1386 self.assertEqual(zipline, line + b'\n')
1387 if not isinstance(f, str):
1388 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001389
Ezio Melottiafd0d112009-07-15 17:17:17 +00001390 def test_read_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001391 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001392 self.read_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001393
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001394 def test_readline_read_stored(self):
1395 # Issue #7610: calls to readline() interleaved with calls to read().
1396 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1397 self.readline_read_test(f, zipfile.ZIP_STORED)
1398
Ezio Melottiafd0d112009-07-15 17:17:17 +00001399 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001400 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001401 self.readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001402
Ezio Melottiafd0d112009-07-15 17:17:17 +00001403 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001404 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001405 self.readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001406
Ezio Melottiafd0d112009-07-15 17:17:17 +00001407 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001408 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001409 self.iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001410
Ezio Melotti76430242009-07-11 18:28:48 +00001411 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001412 def test_read_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001413 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001414 self.read_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001415
Ezio Melotti76430242009-07-11 18:28:48 +00001416 @skipUnless(zlib, "requires zlib")
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001417 def test_readline_read_deflated(self):
1418 # Issue #7610: calls to readline() interleaved with calls to read().
1419 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1420 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1421
1422 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001423 def test_readline_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.readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001426
Ezio Melotti76430242009-07-11 18:28:48 +00001427 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001428 def test_readlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001429 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001430 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001431
Ezio Melotti76430242009-07-11 18:28:48 +00001432 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001433 def test_iterlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001434 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001435 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001436
1437 def tearDown(self):
1438 for sep, fn in self.arcfiles.items():
1439 os.remove(fn)
Ezio Melotti76430242009-07-11 18:28:48 +00001440 unlink(TESTFN)
1441 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001442
1443
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001444def test_main():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001445 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1446 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti76430242009-07-11 18:28:48 +00001447 TestWithDirectory, UniversalNewlineTests,
1448 TestsWithRandomBinaryFiles)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001449
1450if __name__ == "__main__":
1451 test_main()