blob: 85cd0742b7f2dc05e497f8c7818becfc0996b0af [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
Serhiy Storchaka45c43752013-01-29 20:10:28 +020022from test.support import (TESTFN, run_unittest, findfile, unlink,
23 captured_stdout)
Guido van Rossum368f04a2000-04-10 13:23:04 +000024
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000025TESTFN2 = TESTFN + "2"
Martin v. Löwis59e47792009-01-24 14:10:07 +000026TESTFNDIR = TESTFN + "d"
Guido van Rossumb5a755e2007-07-18 18:15:48 +000027FIXEDTEST_SIZE = 1000
Georg Brandl5ba11de2011-01-01 10:09:32 +000028DATAFILES_DIR = 'zipfile_datafiles'
Guido van Rossum368f04a2000-04-10 13:23:04 +000029
Christian Heimes790c8232008-01-07 21:14:23 +000030SMALL_TEST_DATA = [('_ziptest1', '1q2w3e4r5t'),
31 ('ziptest2dir/_ziptest2', 'qawsedrftg'),
Gregory P. Smithb47acbf2013-02-01 11:22:43 -080032 ('ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
Christian Heimes790c8232008-01-07 21:14:23 +000033 ('ziptest2dir/ziptest3dir/ziptest4dir/_ziptest3', '6y7u8i9o0p')]
34
Ezio Melotti76430242009-07-11 18:28:48 +000035
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000036class TestsWithSourceFile(unittest.TestCase):
37 def setUp(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +000038 self.line_gen = (bytes("Zipfile test line %d. random float: %f" %
Guido van Rossum9c627722007-08-27 18:31:48 +000039 (i, random()), "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +000040 for i in range(FIXEDTEST_SIZE))
41 self.data = b'\n'.join(self.line_gen) + b'\n'
Fred Drake6e7e4852001-02-28 05:34:16 +000042
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000043 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +000044 with open(TESTFN, "wb") as fp:
45 fp.write(self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000046
Ezio Melottiafd0d112009-07-15 17:17:17 +000047 def make_test_archive(self, f, compression):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000048 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000049 with zipfile.ZipFile(f, "w", compression) as zipfp:
50 zipfp.write(TESTFN, "another.name")
51 zipfp.write(TESTFN, TESTFN)
52 zipfp.writestr("strfile", self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000053
Ezio Melottiafd0d112009-07-15 17:17:17 +000054 def zip_test(self, f, compression):
55 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +000056
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000057 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000058 with zipfile.ZipFile(f, "r", compression) as zipfp:
59 self.assertEqual(zipfp.read(TESTFN), self.data)
60 self.assertEqual(zipfp.read("another.name"), self.data)
61 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000062
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000063 # Print the ZIP directory
64 fp = io.StringIO()
65 zipfp.printdir(file=fp)
66 directory = fp.getvalue()
67 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +000068 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +000069
Benjamin Peterson577473f2010-01-19 00:09:57 +000070 self.assertIn('File Name', lines[0])
71 self.assertIn('Modified', lines[0])
72 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +000073
Ezio Melotti35386712009-12-31 13:22:41 +000074 fn, date, time_, size = lines[1].split()
75 self.assertEqual(fn, 'another.name')
76 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
77 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
78 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000079
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000080 # Check the namelist
81 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +000082 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000083 self.assertIn(TESTFN, names)
84 self.assertIn("another.name", names)
85 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000086
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000087 # Check infolist
88 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +000089 names = [i.filename for i in infos]
90 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000091 self.assertIn(TESTFN, names)
92 self.assertIn("another.name", names)
93 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000094 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +000095 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000096
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000097 # check getinfo
98 for nm in (TESTFN, "another.name", "strfile"):
99 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000100 self.assertEqual(info.filename, nm)
101 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000102
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000103 # Check that testzip doesn't raise an exception
104 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000105 if not isinstance(f, str):
106 f.close()
Tim Peters7d3bad62001-04-04 18:56:49 +0000107
Ezio Melottiafd0d112009-07-15 17:17:17 +0000108 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000109 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000110 self.zip_test(f, zipfile.ZIP_STORED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000111
Ezio Melottiafd0d112009-07-15 17:17:17 +0000112 def zip_open_test(self, f, compression):
113 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000114
115 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000116 with zipfile.ZipFile(f, "r", compression) as zipfp:
117 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000118 with zipfp.open(TESTFN) as zipopen1:
119 while True:
120 read_data = zipopen1.read(256)
121 if not read_data:
122 break
123 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000124
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000125 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000126 with zipfp.open("another.name") as zipopen2:
127 while True:
128 read_data = zipopen2.read(256)
129 if not read_data:
130 break
131 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000132
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000133 self.assertEqual(b''.join(zipdata1), self.data)
134 self.assertEqual(b''.join(zipdata2), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000135 if not isinstance(f, str):
136 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000137
Ezio Melottiafd0d112009-07-15 17:17:17 +0000138 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000139 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000140 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000141
Ezio Melottiafd0d112009-07-15 17:17:17 +0000142 def test_open_via_zip_info(self):
Georg Brandlb533e262008-05-25 18:19:30 +0000143 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000144 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
145 zipfp.writestr("name", "foo")
146 zipfp.writestr("name", "bar")
Georg Brandlb533e262008-05-25 18:19:30 +0000147
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000148 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
149 infos = zipfp.infolist()
150 data = b""
151 for info in infos:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000152 with zipfp.open(info) as zipopen:
153 data += zipopen.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000154 self.assertTrue(data == b"foobar" or data == b"barfoo")
155 data = b""
156 for info in infos:
157 data += zipfp.read(info)
158 self.assertTrue(data == b"foobar" or data == b"barfoo")
Georg Brandlb533e262008-05-25 18:19:30 +0000159
Ezio Melottiafd0d112009-07-15 17:17:17 +0000160 def zip_random_open_test(self, f, compression):
161 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000162
163 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000164 with zipfile.ZipFile(f, "r", compression) as zipfp:
165 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000166 with zipfp.open(TESTFN) as zipopen1:
167 while True:
168 read_data = zipopen1.read(randint(1, 1024))
169 if not read_data:
170 break
171 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000172
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000173 self.assertEqual(b''.join(zipdata1), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000174 if not isinstance(f, str):
175 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000176
Ezio Melottiafd0d112009-07-15 17:17:17 +0000177 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000178 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000179 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000180
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000181 def test_univeral_readaheads(self):
182 f = io.BytesIO()
183
184 data = b'a\r\n' * 16 * 1024
185 zipfp = zipfile.ZipFile(f, 'w', zipfile.ZIP_STORED)
186 zipfp.writestr(TESTFN, data)
187 zipfp.close()
188
189 data2 = b''
190 zipfp = zipfile.ZipFile(f, 'r')
Brian Curtin8fb9b862010-11-18 02:15:28 +0000191 with zipfp.open(TESTFN, 'rU') as zipopen:
192 for line in zipopen:
193 data2 += line
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000194 zipfp.close()
195
196 self.assertEqual(data, data2.replace(b'\n', b'\r\n'))
197
198 def zip_readline_read_test(self, f, compression):
199 self.make_test_archive(f, compression)
200
201 # Read the ZIP archive
202 zipfp = zipfile.ZipFile(f, "r")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000203 with zipfp.open(TESTFN) as zipopen:
204 data = b''
205 while True:
206 read = zipopen.readline()
207 if not read:
208 break
209 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000210
Brian Curtin8fb9b862010-11-18 02:15:28 +0000211 read = zipopen.read(100)
212 if not read:
213 break
214 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000215
216 self.assertEqual(data, self.data)
217 zipfp.close()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000218 if not isinstance(f, str):
219 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000220
Ezio Melottiafd0d112009-07-15 17:17:17 +0000221 def zip_readline_test(self, f, compression):
222 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000223
224 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000225 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000226 with zipfp.open(TESTFN) as zipopen:
227 for line in self.line_gen:
228 linedata = zipopen.readline()
229 self.assertEqual(linedata, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000230 if not isinstance(f, str):
231 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000232
Ezio Melottiafd0d112009-07-15 17:17:17 +0000233 def zip_readlines_test(self, f, compression):
234 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000235
236 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000237 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000238 with zipfp.open(TESTFN) as zipopen:
239 ziplines = zipopen.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000240 for line, zipline in zip(self.line_gen, ziplines):
241 self.assertEqual(zipline, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000242 if not isinstance(f, str):
243 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000244
Ezio Melottiafd0d112009-07-15 17:17:17 +0000245 def zip_iterlines_test(self, f, compression):
246 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000247
248 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000249 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000250 with zipfp.open(TESTFN) as zipopen:
251 for line, zipline in zip(self.line_gen, zipopen):
252 self.assertEqual(zipline, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000253 if not isinstance(f, str):
254 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000255
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000256 def test_readline_read_stored(self):
257 # Issue #7610: calls to readline() interleaved with calls to read().
258 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
259 self.zip_readline_read_test(f, zipfile.ZIP_STORED)
260
Ezio Melottiafd0d112009-07-15 17:17:17 +0000261 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000262 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000263 self.zip_readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000264
Ezio Melottiafd0d112009-07-15 17:17:17 +0000265 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000266 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000267 self.zip_readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000268
Ezio Melottiafd0d112009-07-15 17:17:17 +0000269 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000270 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000271 self.zip_iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000272
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000273 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000274 def test_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000275 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000276 self.zip_test(f, zipfile.ZIP_DEFLATED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000277
Guido van Rossumd8faa362007-04-27 19:54:29 +0000278
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000279 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000280 def test_open_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000281 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000282 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000283
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000284 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000285 def test_random_open_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000286 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000287 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000288
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000289 @skipUnless(zlib, "requires zlib")
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000290 def test_readline_read_deflated(self):
291 # Issue #7610: calls to readline() interleaved with calls to read().
292 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
293 self.zip_readline_read_test(f, zipfile.ZIP_DEFLATED)
294
295 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000296 def test_readline_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000297 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000298 self.zip_readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000299
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000300 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000301 def test_readlines_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000302 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000303 self.zip_readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000304
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000305 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000306 def test_iterlines_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000307 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000308 self.zip_iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000309
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000310 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000311 def test_low_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000312 """Check for cases where compressed data is larger than original."""
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000313 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000314 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
315 zipfp.writestr("strfile", '12')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000316
317 # Get an open object for strfile
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000318 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_DEFLATED) as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000319 with zipfp.open("strfile") as openobj:
320 self.assertEqual(openobj.read(1), b'1')
321 self.assertEqual(openobj.read(1), b'2')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000322
Ezio Melottiafd0d112009-07-15 17:17:17 +0000323 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000324 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
325 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000326
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000327 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
328 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000329
Ezio Melottiafd0d112009-07-15 17:17:17 +0000330 def test_append_to_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000331 """Test appending to an existing zipfile."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000332 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
333 zipfp.write(TESTFN, TESTFN)
334
335 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
336 zipfp.writestr("strfile", self.data)
337 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000338
Ezio Melottiafd0d112009-07-15 17:17:17 +0000339 def test_append_to_non_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000340 """Test appending to an existing file that is not a zipfile."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000341 # NOTE: this test fails if len(d) < 22 because of the first
342 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti35386712009-12-31 13:22:41 +0000343 data = b'I am not a ZipFile!'*10
344 with open(TESTFN2, 'wb') as f:
345 f.write(data)
346
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000347 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
348 zipfp.write(TESTFN, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000349
Ezio Melotti35386712009-12-31 13:22:41 +0000350 with open(TESTFN2, 'rb') as f:
351 f.seek(len(data))
352 with zipfile.ZipFile(f, "r") as zipfp:
353 self.assertEqual(zipfp.namelist(), [TESTFN])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000354
R David Murray4fbb9db2011-06-09 15:50:51 -0400355 def test_ignores_newline_at_end(self):
356 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
357 zipfp.write(TESTFN, TESTFN)
358 with open(TESTFN2, 'a') as f:
359 f.write("\r\n\00\00\00")
360 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
361 self.assertIsInstance(zipfp, zipfile.ZipFile)
362
363 def test_ignores_stuff_appended_past_comments(self):
364 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
365 zipfp.comment = b"this is a comment"
366 zipfp.write(TESTFN, TESTFN)
367 with open(TESTFN2, 'a') as f:
368 f.write("abcdef\r\n")
369 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
370 self.assertIsInstance(zipfp, zipfile.ZipFile)
371 self.assertEqual(zipfp.comment, b"this is a comment")
372
Ezio Melottiafd0d112009-07-15 17:17:17 +0000373 def test_write_default_name(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000374 """Check that calling ZipFile.write without arcname specified
375 produces the expected result."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000376 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
377 zipfp.write(TESTFN)
Brian Curtin8fb9b862010-11-18 02:15:28 +0000378 with open(TESTFN, "rb") as f:
379 self.assertEqual(zipfp.read(TESTFN), f.read())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000380
Ezio Melotti78ea2022009-09-12 18:41:20 +0000381 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000382 def test_per_file_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000383 """Check that files within a Zip archive can have different
384 compression options."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000385 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
386 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
387 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
388 sinfo = zipfp.getinfo('storeme')
389 dinfo = zipfp.getinfo('deflateme')
390 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
391 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000392
Ezio Melottiafd0d112009-07-15 17:17:17 +0000393 def test_write_to_readonly(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000394 """Check that trying to call write() on a readonly ZipFile object
395 raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000396 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
397 zipfp.writestr("somefile.txt", "bogus")
398
399 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
400 self.assertRaises(RuntimeError, zipfp.write, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000401
Ezio Melottiafd0d112009-07-15 17:17:17 +0000402 def test_extract(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000403 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
404 for fpath, fdata in SMALL_TEST_DATA:
405 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000406
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000407 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
408 for fpath, fdata in SMALL_TEST_DATA:
409 writtenfile = zipfp.extract(fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000410
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000411 # make sure it was written to the right place
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800412 correctfile = os.path.join(os.getcwd(), fpath)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000413 correctfile = os.path.normpath(correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000414
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000415 self.assertEqual(writtenfile, correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000416
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000417 # make sure correct data is in correct file
Brian Curtin8fb9b862010-11-18 02:15:28 +0000418 with open(writtenfile, "rb") as f:
419 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000420
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000421 os.remove(writtenfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000422
423 # remove the test file subdirectories
424 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
425
Ezio Melottiafd0d112009-07-15 17:17:17 +0000426 def test_extract_all(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000427 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
428 for fpath, fdata in SMALL_TEST_DATA:
429 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000430
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000431 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
432 zipfp.extractall()
433 for fpath, fdata in SMALL_TEST_DATA:
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800434 outfile = os.path.join(os.getcwd(), fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000435
Brian Curtin8fb9b862010-11-18 02:15:28 +0000436 with open(outfile, "rb") as f:
437 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000438
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000439 os.remove(outfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000440
441 # remove the test file subdirectories
442 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
443
Gregory P. Smithb47acbf2013-02-01 11:22:43 -0800444 def check_file(self, filename, content):
445 self.assertTrue(os.path.isfile(filename))
446 with open(filename, 'rb') as f:
447 self.assertEqual(f.read(), content)
448
449 def test_extract_hackers_arcnames(self):
450 hacknames = [
451 ('../foo/bar', 'foo/bar'),
452 ('foo/../bar', 'foo/bar'),
453 ('foo/../../bar', 'foo/bar'),
454 ('foo/bar/..', 'foo/bar'),
455 ('./../foo/bar', 'foo/bar'),
456 ('/foo/bar', 'foo/bar'),
457 ('/foo/../bar', 'foo/bar'),
458 ('/foo/../../bar', 'foo/bar'),
459 ('//foo/bar', 'foo/bar'),
460 ('../../foo../../ba..r', 'foo../ba..r'),
461 ]
462 if os.path.sep == '\\': # Windows.
463 hacknames.extend([
464 (r'..\foo\bar', 'foo/bar'),
465 (r'..\/foo\/bar', 'foo/bar'),
466 (r'foo/\..\/bar', 'foo/bar'),
467 (r'foo\/../\bar', 'foo/bar'),
468 (r'C:foo/bar', 'foo/bar'),
469 (r'C:/foo/bar', 'foo/bar'),
470 (r'C://foo/bar', 'foo/bar'),
471 (r'C:\foo\bar', 'foo/bar'),
472 (r'//conky/mountpoint/foo/bar', 'foo/bar'),
473 (r'\\conky\mountpoint\foo\bar', 'foo/bar'),
474 (r'///conky/mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
475 (r'\\\conky\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
476 (r'//conky//mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
477 (r'\\conky\\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
478 (r'//?/C:/foo/bar', 'foo/bar'),
479 (r'\\?\C:\foo\bar', 'foo/bar'),
480 (r'C:/../C:/foo/bar', 'C_/foo/bar'),
481 (r'a:b\c<d>e|f"g?h*i', 'b/c_d_e_f_g_h_i'),
482 ])
483
484 for arcname, fixedname in hacknames:
485 content = b'foobar' + arcname.encode()
486 with zipfile.ZipFile(TESTFN2, 'w', zipfile.ZIP_STORED) as zipfp:
487 zipfp.writestr(arcname, content)
488
489 targetpath = os.path.join('target', 'subdir', 'subsub')
490 correctfile = os.path.join(targetpath, *fixedname.split('/'))
491
492 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
493 writtenfile = zipfp.extract(arcname, targetpath)
494 self.assertEqual(writtenfile, correctfile)
495 self.check_file(correctfile, content)
496 shutil.rmtree('target')
497
498 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
499 zipfp.extractall(targetpath)
500 self.check_file(correctfile, content)
501 shutil.rmtree('target')
502
503 correctfile = os.path.join(os.getcwd(), *fixedname.split('/'))
504
505 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
506 writtenfile = zipfp.extract(arcname)
507 self.assertEqual(writtenfile, correctfile)
508 self.check_file(correctfile, content)
509 shutil.rmtree(fixedname.split('/')[0])
510
511 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
512 zipfp.extractall()
513 self.check_file(correctfile, content)
514 shutil.rmtree(fixedname.split('/')[0])
515
516 os.remove(TESTFN2)
517
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000518 def test_writestr_compression(self):
519 zipfp = zipfile.ZipFile(TESTFN2, "w")
520 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
521 if zlib:
522 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
523
524 info = zipfp.getinfo('a.txt')
525 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
526
527 if zlib:
528 info = zipfp.getinfo('b.txt')
529 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
530
531
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000532 def zip_test_writestr_permissions(self, f, compression):
533 # Make sure that writestr creates files with mode 0600,
534 # when it is passed a name rather than a ZipInfo instance.
535
Ezio Melottiafd0d112009-07-15 17:17:17 +0000536 self.make_test_archive(f, compression)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000537 with zipfile.ZipFile(f, "r") as zipfp:
538 zinfo = zipfp.getinfo('strfile')
539 self.assertEqual(zinfo.external_attr, 0o600 << 16)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000540 if not isinstance(f, str):
541 f.close()
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000542
Ezio Melottiafd0d112009-07-15 17:17:17 +0000543 def test_writestr_permissions(self):
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000544 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
545 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
546
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000547 def test_writestr_extended_local_header_issue1202(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000548 with zipfile.ZipFile(TESTFN2, 'w') as orig_zip:
549 for data in 'abcdefghijklmnop':
550 zinfo = zipfile.ZipInfo(data)
551 zinfo.flag_bits |= 0x08 # Include an extended local header.
552 orig_zip.writestr(zinfo, data)
553
554 def test_close(self):
555 """Check that the zipfile is closed after the 'with' block."""
556 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
557 for fpath, fdata in SMALL_TEST_DATA:
558 zipfp.writestr(fpath, fdata)
559 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
560 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
561
562 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
563 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
564 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
565
566 def test_close_on_exception(self):
567 """Check that the zipfile is closed if an exception is raised in the
568 'with' block."""
569 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
570 for fpath, fdata in SMALL_TEST_DATA:
571 zipfp.writestr(fpath, fdata)
572
573 try:
574 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
Georg Brandl4d540882010-10-28 06:42:33 +0000575 raise zipfile.BadZipFile()
576 except zipfile.BadZipFile:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000577 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000578
Senthil Kumaran29fa9d42011-10-20 01:46:00 +0800579 def test_add_file_before_1980(self):
580 # Set atime and mtime to 1970-01-01
581 os.utime(TESTFN, (0, 0))
582 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
583 self.assertRaises(ValueError, zipfp.write, TESTFN)
584
585
Ezio Melottid9a7c4b2011-03-14 18:57:02 +0200586 @skipUnless(zlib, "requires zlib")
Georg Brandl5ba11de2011-01-01 10:09:32 +0000587 def test_unicode_filenames(self):
Georg Brandl04480a82011-01-01 10:42:31 +0000588 # bug #10801
589 fname = findfile('zip_cp437_header.zip')
Georg Brandl5ba11de2011-01-01 10:09:32 +0000590 with zipfile.ZipFile(fname) as zipfp:
Georg Brandl04480a82011-01-01 10:42:31 +0000591 for name in zipfp.namelist():
592 zipfp.open(name).close()
Georg Brandl5ba11de2011-01-01 10:09:32 +0000593
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000594 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000595 unlink(TESTFN)
596 unlink(TESTFN2)
597
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000598
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000599class TestZip64InSmallFiles(unittest.TestCase):
600 # These tests test the ZIP64 functionality without using large files,
601 # see test_zipfile64 for proper tests.
602
603 def setUp(self):
604 self._limit = zipfile.ZIP64_LIMIT
605 zipfile.ZIP64_LIMIT = 5
606
Guido van Rossum9c627722007-08-27 18:31:48 +0000607 line_gen = (bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000608 for i in range(0, FIXEDTEST_SIZE))
609 self.data = b'\n'.join(line_gen)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000610
611 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +0000612 with open(TESTFN, "wb") as fp:
613 fp.write(self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000614
Ezio Melottiafd0d112009-07-15 17:17:17 +0000615 def large_file_exception_test(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000616 with zipfile.ZipFile(f, "w", compression) as zipfp:
617 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000618 zipfp.write, TESTFN, "another.name")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000619
Ezio Melottiafd0d112009-07-15 17:17:17 +0000620 def large_file_exception_test2(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000621 with zipfile.ZipFile(f, "w", compression) as zipfp:
622 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000623 zipfp.writestr, "another.name", self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000624 if not isinstance(f, str):
625 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000626
Ezio Melottiafd0d112009-07-15 17:17:17 +0000627 def test_large_file_exception(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000628 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000629 self.large_file_exception_test(f, zipfile.ZIP_STORED)
630 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000631
Ezio Melottiafd0d112009-07-15 17:17:17 +0000632 def zip_test(self, f, compression):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000633 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000634 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
635 zipfp.write(TESTFN, "another.name")
636 zipfp.write(TESTFN, TESTFN)
637 zipfp.writestr("strfile", self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000638
639 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000640 with zipfile.ZipFile(f, "r", compression) as zipfp:
641 self.assertEqual(zipfp.read(TESTFN), self.data)
642 self.assertEqual(zipfp.read("another.name"), self.data)
643 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000644
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000645 # Print the ZIP directory
646 fp = io.StringIO()
647 zipfp.printdir(fp)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000648
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000649 directory = fp.getvalue()
650 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +0000651 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000652
Benjamin Peterson577473f2010-01-19 00:09:57 +0000653 self.assertIn('File Name', lines[0])
654 self.assertIn('Modified', lines[0])
655 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000656
Ezio Melotti35386712009-12-31 13:22:41 +0000657 fn, date, time_, size = lines[1].split()
658 self.assertEqual(fn, 'another.name')
659 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
660 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
661 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000662
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000663 # Check the namelist
664 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +0000665 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000666 self.assertIn(TESTFN, names)
667 self.assertIn("another.name", names)
668 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000669
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000670 # Check infolist
671 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +0000672 names = [i.filename for i in infos]
673 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000674 self.assertIn(TESTFN, names)
675 self.assertIn("another.name", names)
676 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000677 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +0000678 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000679
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000680 # check getinfo
681 for nm in (TESTFN, "another.name", "strfile"):
682 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000683 self.assertEqual(info.filename, nm)
684 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000685
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000686 # Check that testzip doesn't raise an exception
687 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000688 if not isinstance(f, str):
689 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000690
Ezio Melottiafd0d112009-07-15 17:17:17 +0000691 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000692 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000693 self.zip_test(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000694
Ezio Melotti76430242009-07-11 18:28:48 +0000695 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +0000696 def test_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000697 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000698 self.zip_test(f, zipfile.ZIP_DEFLATED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000699
Ezio Melottiafd0d112009-07-15 17:17:17 +0000700 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000701 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
702 allowZip64=True) as zipfp:
703 zipfp.write(TESTFN, "/absolute")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000704
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000705 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
706 self.assertEqual(zipfp.namelist(), ["absolute"])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000707
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000708 def tearDown(self):
709 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti76430242009-07-11 18:28:48 +0000710 unlink(TESTFN)
711 unlink(TESTFN2)
712
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000713
714class PyZipFileTests(unittest.TestCase):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000715 def test_write_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000716 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000717 fn = __file__
718 if fn.endswith('.pyc') or fn.endswith('.pyo'):
Barry Warsaw28a691b2010-04-17 00:19:56 +0000719 path_split = fn.split(os.sep)
720 if os.altsep is not None:
721 path_split.extend(fn.split(os.altsep))
722 if '__pycache__' in path_split:
723 fn = imp.source_from_cache(fn)
724 else:
725 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000726
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000727 zipfp.writepy(fn)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000728
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000729 bn = os.path.basename(fn)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000730 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000731 self.assertTrue(bn + 'o' in zipfp.namelist() or
732 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000733
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000734 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000735 fn = __file__
Ezio Melotti35386712009-12-31 13:22:41 +0000736 if fn.endswith(('.pyc', '.pyo')):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000737 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000738
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000739 zipfp.writepy(fn, "testpackage")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000740
Ezio Melotti35386712009-12-31 13:22:41 +0000741 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Benjamin Peterson577473f2010-01-19 00:09:57 +0000742 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000743 self.assertTrue(bn + 'o' in zipfp.namelist() or
744 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000745
Ezio Melottiafd0d112009-07-15 17:17:17 +0000746 def test_write_python_package(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000747 import email
748 packagedir = os.path.dirname(email.__file__)
749
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000750 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000751 zipfp.writepy(packagedir)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000752
Ezio Melotti35386712009-12-31 13:22:41 +0000753 # Check for a couple of modules at different levels of the
754 # hierarchy
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000755 names = zipfp.namelist()
756 self.assertTrue('email/__init__.pyo' in names or
757 'email/__init__.pyc' in names)
758 self.assertTrue('email/mime/text.pyo' in names or
759 'email/mime/text.pyc' in names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000760
Georg Brandl8334fd92010-12-04 10:26:46 +0000761 def test_write_with_optimization(self):
762 import email
763 packagedir = os.path.dirname(email.__file__)
764 # use .pyc if running test in optimization mode,
765 # use .pyo if running test in debug mode
766 optlevel = 1 if __debug__ else 0
767 ext = '.pyo' if optlevel == 1 else '.pyc'
768
769 with TemporaryFile() as t, \
770 zipfile.PyZipFile(t, "w", optimize=optlevel) as zipfp:
771 zipfp.writepy(packagedir)
772
773 names = zipfp.namelist()
774 self.assertIn('email/__init__' + ext, names)
775 self.assertIn('email/mime/text' + ext, names)
776
Ezio Melottiafd0d112009-07-15 17:17:17 +0000777 def test_write_python_directory(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000778 os.mkdir(TESTFN2)
779 try:
Ezio Melotti35386712009-12-31 13:22:41 +0000780 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
781 fp.write("print(42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000782
Ezio Melotti35386712009-12-31 13:22:41 +0000783 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
784 fp.write("print(42 * 42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000785
Ezio Melotti35386712009-12-31 13:22:41 +0000786 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
787 fp.write("bla bla bla\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000788
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000789 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
790 zipfp.writepy(TESTFN2)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000791
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000792 names = zipfp.namelist()
793 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
794 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
795 self.assertNotIn('mod2.txt', names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000796
797 finally:
798 shutil.rmtree(TESTFN2)
799
Ezio Melottiafd0d112009-07-15 17:17:17 +0000800 def test_write_non_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000801 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000802 with open(TESTFN, 'w') as f:
803 f.write('most definitely not a python file')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000804 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
805 os.remove(TESTFN)
806
Serhiy Storchaka45c43752013-01-29 20:10:28 +0200807 def test_write_pyfile_bad_syntax(self):
808 os.mkdir(TESTFN2)
809 try:
810 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
811 fp.write("Bad syntax in python file\n")
812
813 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
814 # syntax errors are printed to stdout
815 with captured_stdout() as s:
816 zipfp.writepy(os.path.join(TESTFN2, "mod1.py"))
817
818 self.assertIn("SyntaxError", s.getvalue())
819
820 # as it will not have compiled the python file, it will
821 # include the .py file not .pyc or .pyo
822 names = zipfp.namelist()
823 self.assertIn('mod1.py', names)
824 self.assertNotIn('mod1.pyc', names)
825 self.assertNotIn('mod1.pyo', names)
826
827 finally:
828 shutil.rmtree(TESTFN2)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000829
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000830class OtherTests(unittest.TestCase):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000831 zips_with_bad_crc = {
832 zipfile.ZIP_STORED: (
833 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
834 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
835 b'ilehello,AworldP'
836 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
837 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
838 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
839 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
840 b'\0\0/\0\0\0\0\0'),
841 zipfile.ZIP_DEFLATED: (
842 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
843 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
844 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
845 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
846 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
847 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
848 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
849 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
850 }
851
Ezio Melottiafd0d112009-07-15 17:17:17 +0000852 def test_unicode_filenames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000853 with zipfile.ZipFile(TESTFN, "w") as zf:
854 zf.writestr("foo.txt", "Test for unicode filename")
855 zf.writestr("\xf6.txt", "Test for unicode filename")
Ezio Melottie9615932010-01-24 19:26:24 +0000856 self.assertIsInstance(zf.infolist()[0].filename, str)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000857
858 with zipfile.ZipFile(TESTFN, "r") as zf:
859 self.assertEqual(zf.filelist[0].filename, "foo.txt")
860 self.assertEqual(zf.filelist[1].filename, "\xf6.txt")
Martin v. Löwis8570f6a2008-05-05 17:44:38 +0000861
Ezio Melottiafd0d112009-07-15 17:17:17 +0000862 def test_create_non_existent_file_for_append(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +0000863 if os.path.exists(TESTFN):
864 os.unlink(TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000865
Thomas Wouterscf297e42007-02-23 15:07:44 +0000866 filename = 'testfile.txt'
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000867 content = b'hello, world. this is some content.'
Guido van Rossumd8faa362007-04-27 19:54:29 +0000868
Thomas Wouterscf297e42007-02-23 15:07:44 +0000869 try:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000870 with zipfile.ZipFile(TESTFN, 'a') as zf:
871 zf.writestr(filename, content)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000872 except IOError:
873 self.fail('Could not append data to a non-existent zip file.')
874
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000875 self.assertTrue(os.path.exists(TESTFN))
Thomas Wouterscf297e42007-02-23 15:07:44 +0000876
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000877 with zipfile.ZipFile(TESTFN, 'r') as zf:
878 self.assertEqual(zf.read(filename), content)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000879
Ezio Melottiafd0d112009-07-15 17:17:17 +0000880 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000881 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti35386712009-12-31 13:22:41 +0000882 # it opens if there's an error in the file. If it doesn't, the
883 # traceback holds a reference to the ZipFile object and, indirectly,
884 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000885 # On Windows, this causes the os.unlink() call to fail because the
886 # underlying file is still open. This is SF bug #412214.
887 #
Ezio Melotti35386712009-12-31 13:22:41 +0000888 with open(TESTFN, "w") as fp:
889 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000890 try:
891 zf = zipfile.ZipFile(TESTFN)
Georg Brandl4d540882010-10-28 06:42:33 +0000892 except zipfile.BadZipFile:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000893 pass
894
Ezio Melottiafd0d112009-07-15 17:17:17 +0000895 def test_is_zip_erroneous_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000896 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000897 # - passing a filename
898 with open(TESTFN, "w") as fp:
899 fp.write("this is not a legal zip file\n")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000900 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti35386712009-12-31 13:22:41 +0000901 self.assertFalse(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000902 # - passing a file object
903 with open(TESTFN, "rb") as fp:
904 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000905 self.assertTrue(not chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000906 # - passing a file-like object
907 fp = io.BytesIO()
908 fp.write(b"this is not a legal zip file\n")
909 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000910 self.assertTrue(not chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000911 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000912 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000913 self.assertTrue(not chk)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000914
Serhiy Storchakad2b15272013-01-31 15:27:07 +0200915 def test_damaged_zipfile(self):
916 """Check that zipfiles with missing bytes at the end raise BadZipFile."""
917 # - Create a valid zip file
918 fp = io.BytesIO()
919 with zipfile.ZipFile(fp, mode="w") as zipf:
920 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
921 zipfiledata = fp.getvalue()
922
923 # - Now create copies of it missing the last N bytes and make sure
924 # a BadZipFile exception is raised when we try to open it
925 for N in range(len(zipfiledata)):
926 fp = io.BytesIO(zipfiledata[:N])
927 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, fp)
928
Ezio Melottiafd0d112009-07-15 17:17:17 +0000929 def test_is_zip_valid_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000930 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000931 # - passing a filename
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000932 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
933 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
934
Guido van Rossumd8faa362007-04-27 19:54:29 +0000935 chk = zipfile.is_zipfile(TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000936 self.assertTrue(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000937 # - passing a file object
938 with open(TESTFN, "rb") as fp:
939 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000940 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000941 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000942 zip_contents = fp.read()
943 # - passing a file-like object
944 fp = io.BytesIO()
945 fp.write(zip_contents)
946 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000947 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000948 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000949 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000950 self.assertTrue(chk)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000951
Ezio Melottiafd0d112009-07-15 17:17:17 +0000952 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000953 # make sure we don't raise an AttributeError when a partially-constructed
954 # ZipFile instance is finalized; this tests for regression on SF tracker
955 # bug #403871.
956
957 # The bug we're testing for caused an AttributeError to be raised
958 # when a ZipFile instance was created for a file that did not
959 # exist; the .fp member was not initialized but was needed by the
960 # __del__() method. Since the AttributeError is in the __del__(),
961 # it is ignored, but the user should be sufficiently annoyed by
962 # the message on the output that regression will be noticed
963 # quickly.
964 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
965
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000966 def test_empty_file_raises_BadZipFile(self):
967 f = open(TESTFN, 'w')
968 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +0000969 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000970
Ezio Melotti35386712009-12-31 13:22:41 +0000971 with open(TESTFN, 'w') as fp:
972 fp.write("short file")
Georg Brandl4d540882010-10-28 06:42:33 +0000973 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000974
Ezio Melottiafd0d112009-07-15 17:17:17 +0000975 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000976 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000977 data = io.BytesIO()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000978 with zipfile.ZipFile(data, mode="w") as zipf:
979 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000980
Andrew Svetlov737fb892012-12-18 21:14:22 +0200981 # This is correct; calling .read on a closed ZipFile should raise
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000982 # a RuntimeError, and so should calling .testzip. An earlier
983 # version of .testzip would swallow this exception (and any other)
984 # and report that the first file in the archive was corrupt.
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000985 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
986 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000987 self.assertRaises(RuntimeError, zipf.testzip)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000988 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000989 with open(TESTFN, 'w') as f:
990 f.write('zipfile test data')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000991 self.assertRaises(RuntimeError, zipf.write, TESTFN)
992
Ezio Melottiafd0d112009-07-15 17:17:17 +0000993 def test_bad_constructor_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000994 """Check that bad modes passed to ZipFile constructor are caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000995 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
996
Ezio Melottiafd0d112009-07-15 17:17:17 +0000997 def test_bad_open_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000998 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000999 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1000 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1001
1002 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001003 # read the data to make sure the file is there
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001004 zipf.read("foo.txt")
1005 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001006
Ezio Melottiafd0d112009-07-15 17:17:17 +00001007 def test_read0(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001008 """Check that calling read(0) on a ZipExtFile object returns an empty
1009 string and doesn't advance file pointer."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001010 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1011 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1012 # read the data to make sure the file is there
Brian Curtin8fb9b862010-11-18 02:15:28 +00001013 with zipf.open("foo.txt") as f:
1014 for i in range(FIXEDTEST_SIZE):
1015 self.assertEqual(f.read(0), b'')
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001016
Brian Curtin8fb9b862010-11-18 02:15:28 +00001017 self.assertEqual(f.read(), b"O, for a Muse of Fire!")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001018
Ezio Melottiafd0d112009-07-15 17:17:17 +00001019 def test_open_non_existent_item(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001020 """Check that attempting to call open() for an item that doesn't
1021 exist in the archive raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001022 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1023 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001024
Ezio Melottiafd0d112009-07-15 17:17:17 +00001025 def test_bad_compression_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001026 """Check that bad compression methods passed to ZipFile.open are
1027 caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +00001028 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
1029
Ezio Melotti6a5fc4c2012-11-18 13:20:36 +02001030 def test_unsupported_compression(self):
1031 # data is declared as shrunk, but actually deflated
1032 data = (b'PK\x03\x04.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00'
1033 b'\x00\x02\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00x\x03\x00PK\x01'
1034 b'\x02.\x03.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00\x00\x02\x00\x00'
1035 b'\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
1036 b'\x80\x01\x00\x00\x00\x00xPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00'
1037 b'/\x00\x00\x00!\x00\x00\x00\x00\x00')
1038 with zipfile.ZipFile(io.BytesIO(data), 'r') as zipf:
1039 self.assertRaises(NotImplementedError, zipf.open, 'x')
1040
Ezio Melottiafd0d112009-07-15 17:17:17 +00001041 def test_null_byte_in_filename(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001042 """Check that a filename containing a null byte is properly
1043 terminated."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001044 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1045 zipf.writestr("foo.txt\x00qqq", b"O, for a Muse of Fire!")
1046 self.assertEqual(zipf.namelist(), ['foo.txt'])
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001047
Ezio Melottiafd0d112009-07-15 17:17:17 +00001048 def test_struct_sizes(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001049 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001050 self.assertEqual(zipfile.sizeEndCentDir, 22)
1051 self.assertEqual(zipfile.sizeCentralDir, 46)
1052 self.assertEqual(zipfile.sizeEndCentDir64, 56)
1053 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
1054
Ezio Melottiafd0d112009-07-15 17:17:17 +00001055 def test_comments(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001056 """Check that comments on the archive are handled properly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001057
1058 # check default comment is empty
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001059 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1060 self.assertEqual(zipf.comment, b'')
1061 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1062
1063 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1064 self.assertEqual(zipfr.comment, b'')
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001065
1066 # check a simple short comment
1067 comment = b'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001068 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1069 zipf.comment = comment
1070 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1071 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1072 self.assertEqual(zipf.comment, comment)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001073
1074 # check a comment of max length
1075 comment2 = ''.join(['%d' % (i**3 % 10) for i in range((1 << 16)-1)])
1076 comment2 = comment2.encode("ascii")
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001077 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1078 zipf.comment = comment2
1079 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1080
1081 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1082 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001083
1084 # check a comment that is too long is truncated
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001085 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1086 zipf.comment = comment2 + b'oops'
1087 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1088 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1089 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001090
Antoine Pitrouc3991852012-06-30 17:31:37 +02001091 # check that comments are correctly modified in append mode
1092 with zipfile.ZipFile(TESTFN,mode="w") as zipf:
1093 zipf.comment = b"original comment"
1094 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1095 with zipfile.ZipFile(TESTFN,mode="a") as zipf:
1096 zipf.comment = b"an updated comment"
1097 with zipfile.ZipFile(TESTFN,mode="r") as zipf:
1098 self.assertEqual(zipf.comment, b"an updated comment")
1099
1100 # check that comments are correctly shortened in append mode
1101 with zipfile.ZipFile(TESTFN,mode="w") as zipf:
1102 zipf.comment = b"original comment that's longer"
1103 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1104 with zipfile.ZipFile(TESTFN,mode="a") as zipf:
1105 zipf.comment = b"shorter comment"
1106 with zipfile.ZipFile(TESTFN,mode="r") as zipf:
1107 self.assertEqual(zipf.comment, b"shorter comment")
1108
R David Murray51804e92012-04-12 18:44:42 -04001109 def test_unicode_comment(self):
1110 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1111 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1112 with self.assertRaises(TypeError):
1113 zipf.comment = "this is an error"
1114
1115 def test_change_comment_in_empty_archive(self):
1116 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1117 self.assertFalse(zipf.filelist)
1118 zipf.comment = b"this is a comment"
1119 with zipfile.ZipFile(TESTFN, "r") as zipf:
1120 self.assertEqual(zipf.comment, b"this is a comment")
1121
1122 def test_change_comment_in_nonempty_archive(self):
1123 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1124 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1125 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1126 self.assertTrue(zipf.filelist)
1127 zipf.comment = b"this is a comment"
1128 with zipfile.ZipFile(TESTFN, "r") as zipf:
1129 self.assertEqual(zipf.comment, b"this is a comment")
1130
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001131 def check_testzip_with_bad_crc(self, compression):
1132 """Tests that files with bad CRCs return their name from testzip."""
1133 zipdata = self.zips_with_bad_crc[compression]
1134
1135 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1136 # testzip returns the name of the first corrupt file, or None
1137 self.assertEqual('afile', zipf.testzip())
1138
1139 def test_testzip_with_bad_crc_stored(self):
1140 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
1141
1142 @skipUnless(zlib, "requires zlib")
1143 def test_testzip_with_bad_crc_deflated(self):
1144 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
1145
1146 def check_read_with_bad_crc(self, compression):
Georg Brandl4d540882010-10-28 06:42:33 +00001147 """Tests that files with bad CRCs raise a BadZipFile exception when read."""
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001148 zipdata = self.zips_with_bad_crc[compression]
1149
1150 # Using ZipFile.read()
1151 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
Georg Brandl4d540882010-10-28 06:42:33 +00001152 self.assertRaises(zipfile.BadZipFile, zipf.read, 'afile')
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001153
1154 # Using ZipExtFile.read()
1155 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1156 with zipf.open('afile', 'r') as corrupt_file:
Georg Brandl4d540882010-10-28 06:42:33 +00001157 self.assertRaises(zipfile.BadZipFile, corrupt_file.read)
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001158
1159 # Same with small reads (in order to exercise the buffering logic)
1160 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1161 with zipf.open('afile', 'r') as corrupt_file:
1162 corrupt_file.MIN_READ_SIZE = 2
Georg Brandl4d540882010-10-28 06:42:33 +00001163 with self.assertRaises(zipfile.BadZipFile):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001164 while corrupt_file.read(2):
1165 pass
1166
1167 def test_read_with_bad_crc_stored(self):
1168 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
1169
1170 @skipUnless(zlib, "requires zlib")
1171 def test_read_with_bad_crc_deflated(self):
1172 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
1173
Antoine Pitrou6464d5f2010-09-12 14:51:20 +00001174 def check_read_return_size(self, compression):
1175 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
1176 # than requested.
1177 for test_size in (1, 4095, 4096, 4097, 16384):
1178 file_size = test_size + 1
1179 junk = b''.join(struct.pack('B', randint(0, 255))
1180 for x in range(file_size))
1181 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
1182 zipf.writestr('foo', junk)
1183 with zipf.open('foo', 'r') as fp:
1184 buf = fp.read(test_size)
1185 self.assertEqual(len(buf), test_size)
1186
1187 def test_read_return_size_stored(self):
1188 self.check_read_return_size(zipfile.ZIP_STORED)
1189
1190 @skipUnless(zlib, "requires zlib")
1191 def test_read_return_size_deflated(self):
1192 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1193
Georg Brandl268e4d42010-10-14 06:59:45 +00001194 def test_empty_zipfile(self):
1195 # Check that creating a file in 'w' or 'a' mode and closing without
1196 # adding any files to the archives creates a valid empty ZIP file
1197 zipf = zipfile.ZipFile(TESTFN, mode="w")
1198 zipf.close()
1199 try:
1200 zipf = zipfile.ZipFile(TESTFN, mode="r")
1201 except zipfile.BadZipFile:
1202 self.fail("Unable to create empty ZIP file in 'w' mode")
1203
1204 zipf = zipfile.ZipFile(TESTFN, mode="a")
1205 zipf.close()
1206 try:
1207 zipf = zipfile.ZipFile(TESTFN, mode="r")
1208 except:
1209 self.fail("Unable to create empty ZIP file in 'a' mode")
1210
1211 def test_open_empty_file(self):
1212 # Issue 1710703: Check that opening a file with less than 22 bytes
Georg Brandl4d540882010-10-28 06:42:33 +00001213 # raises a BadZipFile exception (rather than the previously unhelpful
Georg Brandl268e4d42010-10-14 06:59:45 +00001214 # IOError)
1215 f = open(TESTFN, 'w')
1216 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001217 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN, 'r')
Georg Brandl268e4d42010-10-14 06:59:45 +00001218
Senthil Kumaran29fa9d42011-10-20 01:46:00 +08001219 def test_create_zipinfo_before_1980(self):
1220 self.assertRaises(ValueError,
1221 zipfile.ZipInfo, 'seventies', (1979, 1, 1, 0, 0, 0))
1222
Guido van Rossumd8faa362007-04-27 19:54:29 +00001223 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001224 unlink(TESTFN)
1225 unlink(TESTFN2)
1226
Thomas Wouterscf297e42007-02-23 15:07:44 +00001227
1228class DecryptionTests(unittest.TestCase):
Ezio Melotti35386712009-12-31 13:22:41 +00001229 """Check that ZIP decryption works. Since the library does not
1230 support encryption at the moment, we use a pre-generated encrypted
1231 ZIP file."""
Thomas Wouterscf297e42007-02-23 15:07:44 +00001232
1233 data = (
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001234 b'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1235 b'\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1236 b'\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1237 b'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1238 b'\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1239 b'\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1240 b'\x00\x00L\x00\x00\x00\x00\x00' )
Christian Heimesfdab48e2008-01-20 09:06:41 +00001241 data2 = (
1242 b'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1243 b'\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1244 b'\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1245 b'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1246 b'\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1247 b'\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1248 b'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1249 b'\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Thomas Wouterscf297e42007-02-23 15:07:44 +00001250
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001251 plain = b'zipfile.py encryption test'
Christian Heimesfdab48e2008-01-20 09:06:41 +00001252 plain2 = b'\x00'*512
Thomas Wouterscf297e42007-02-23 15:07:44 +00001253
1254 def setUp(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001255 with open(TESTFN, "wb") as fp:
1256 fp.write(self.data)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001257 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti35386712009-12-31 13:22:41 +00001258 with open(TESTFN2, "wb") as fp:
1259 fp.write(self.data2)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001260 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001261
1262 def tearDown(self):
1263 self.zip.close()
1264 os.unlink(TESTFN)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001265 self.zip2.close()
1266 os.unlink(TESTFN2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001267
Ezio Melottiafd0d112009-07-15 17:17:17 +00001268 def test_no_password(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001269 # Reading the encrypted file without password
1270 # must generate a RunTime exception
1271 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001272 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001273
Ezio Melottiafd0d112009-07-15 17:17:17 +00001274 def test_bad_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001275 self.zip.setpassword(b"perl")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001276 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001277 self.zip2.setpassword(b"perl")
1278 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001279
Ezio Melotti78ea2022009-09-12 18:41:20 +00001280 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001281 def test_good_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001282 self.zip.setpassword(b"python")
Ezio Melotti35386712009-12-31 13:22:41 +00001283 self.assertEqual(self.zip.read("test.txt"), self.plain)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001284 self.zip2.setpassword(b"12345")
Ezio Melotti35386712009-12-31 13:22:41 +00001285 self.assertEqual(self.zip2.read("zero"), self.plain2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001286
R. David Murray8d855d82010-12-21 21:53:37 +00001287 def test_unicode_password(self):
1288 self.assertRaises(TypeError, self.zip.setpassword, "unicode")
1289 self.assertRaises(TypeError, self.zip.read, "test.txt", "python")
1290 self.assertRaises(TypeError, self.zip.open, "test.txt", pwd="python")
1291 self.assertRaises(TypeError, self.zip.extract, "test.txt", pwd="python")
1292
Guido van Rossumd8faa362007-04-27 19:54:29 +00001293
1294class TestsWithRandomBinaryFiles(unittest.TestCase):
1295 def setUp(self):
1296 datacount = randint(16, 64)*1024 + randint(1, 1024)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001297 self.data = b''.join(struct.pack('<f', random()*randint(-1000, 1000))
1298 for i in range(datacount))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001299
1300 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +00001301 with open(TESTFN, "wb") as fp:
1302 fp.write(self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001303
1304 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001305 unlink(TESTFN)
1306 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001307
Ezio Melottiafd0d112009-07-15 17:17:17 +00001308 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001309 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001310 with zipfile.ZipFile(f, "w", compression) as zipfp:
1311 zipfp.write(TESTFN, "another.name")
1312 zipfp.write(TESTFN, TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001313
Ezio Melottiafd0d112009-07-15 17:17:17 +00001314 def zip_test(self, f, compression):
1315 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001316
1317 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001318 with zipfile.ZipFile(f, "r", compression) as zipfp:
1319 testdata = zipfp.read(TESTFN)
1320 self.assertEqual(len(testdata), len(self.data))
1321 self.assertEqual(testdata, self.data)
1322 self.assertEqual(zipfp.read("another.name"), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001323 if not isinstance(f, str):
1324 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001325
Ezio Melottiafd0d112009-07-15 17:17:17 +00001326 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001327 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001328 self.zip_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001329
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001330 @skipUnless(zlib, "requires zlib")
1331 def test_deflated(self):
1332 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1333 self.zip_test(f, zipfile.ZIP_DEFLATED)
1334
Ezio Melottiafd0d112009-07-15 17:17:17 +00001335 def zip_open_test(self, f, compression):
1336 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001337
1338 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001339 with zipfile.ZipFile(f, "r", compression) as zipfp:
1340 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001341 with zipfp.open(TESTFN) as zipopen1:
1342 while True:
1343 read_data = zipopen1.read(256)
1344 if not read_data:
1345 break
1346 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001347
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001348 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001349 with zipfp.open("another.name") as zipopen2:
1350 while True:
1351 read_data = zipopen2.read(256)
1352 if not read_data:
1353 break
1354 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001355
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001356 testdata1 = b''.join(zipdata1)
1357 self.assertEqual(len(testdata1), len(self.data))
1358 self.assertEqual(testdata1, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001359
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001360 testdata2 = b''.join(zipdata2)
Ezio Melotti35386712009-12-31 13:22:41 +00001361 self.assertEqual(len(testdata2), len(self.data))
1362 self.assertEqual(testdata2, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001363 if not isinstance(f, str):
1364 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001365
Ezio Melottiafd0d112009-07-15 17:17:17 +00001366 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001367 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001368 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001369
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001370 @skipUnless(zlib, "requires zlib")
1371 def test_open_deflated(self):
1372 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1373 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1374
Ezio Melottiafd0d112009-07-15 17:17:17 +00001375 def zip_random_open_test(self, f, compression):
1376 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001377
1378 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001379 with zipfile.ZipFile(f, "r", compression) as zipfp:
1380 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001381 with zipfp.open(TESTFN) as zipopen1:
1382 while True:
1383 read_data = zipopen1.read(randint(1, 1024))
1384 if not read_data:
1385 break
1386 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001387
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001388 testdata = b''.join(zipdata1)
1389 self.assertEqual(len(testdata), len(self.data))
1390 self.assertEqual(testdata, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001391 if not isinstance(f, str):
1392 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001393
Ezio Melottiafd0d112009-07-15 17:17:17 +00001394 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001395 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001396 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001397
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001398 @skipUnless(zlib, "requires zlib")
1399 def test_random_open_deflated(self):
1400 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1401 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1402
Ezio Melotti76430242009-07-11 18:28:48 +00001403
Ezio Melotti78ea2022009-09-12 18:41:20 +00001404@skipUnless(zlib, "requires zlib")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001405class TestsWithMultipleOpens(unittest.TestCase):
1406 def setUp(self):
1407 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001408 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1409 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1410 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001411
Ezio Melottiafd0d112009-07-15 17:17:17 +00001412 def test_same_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001413 # Verify that (when the ZipFile is in control of creating file objects)
1414 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001415 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001416 with zipf.open('ones') as zopen1, zipf.open('ones') as zopen2:
1417 data1 = zopen1.read(500)
1418 data2 = zopen2.read(500)
1419 data1 += zopen1.read(500)
1420 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001421 self.assertEqual(data1, data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001422
Ezio Melottiafd0d112009-07-15 17:17:17 +00001423 def test_different_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001424 # Verify that (when the ZipFile is in control of creating file objects)
1425 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001426 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001427 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1428 data1 = zopen1.read(500)
1429 data2 = zopen2.read(500)
1430 data1 += zopen1.read(500)
1431 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001432 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1433 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001434
Ezio Melottiafd0d112009-07-15 17:17:17 +00001435 def test_interleaved(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001436 # Verify that (when the ZipFile is in control of creating file objects)
1437 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001438 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001439 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1440 data1 = zopen1.read(500)
1441 data2 = zopen2.read(500)
1442 data1 += zopen1.read(500)
1443 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001444 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1445 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001446
1447 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001448 unlink(TESTFN2)
1449
Guido van Rossumd8faa362007-04-27 19:54:29 +00001450
Martin v. Löwis59e47792009-01-24 14:10:07 +00001451class TestWithDirectory(unittest.TestCase):
1452 def setUp(self):
1453 os.mkdir(TESTFN2)
1454
Ezio Melottiafd0d112009-07-15 17:17:17 +00001455 def test_extract_dir(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001456 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1457 zipf.extractall(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001458 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1459 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1460 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1461
Ezio Melottiafd0d112009-07-15 17:17:17 +00001462 def test_bug_6050(self):
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001463 # Extraction should succeed if directories already exist
1464 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottiafd0d112009-07-15 17:17:17 +00001465 self.test_extract_dir()
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001466
Ezio Melottiafd0d112009-07-15 17:17:17 +00001467 def test_store_dir(self):
Martin v. Löwis59e47792009-01-24 14:10:07 +00001468 os.mkdir(os.path.join(TESTFN2, "x"))
1469 zipf = zipfile.ZipFile(TESTFN, "w")
1470 zipf.write(os.path.join(TESTFN2, "x"), "x")
1471 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1472
1473 def tearDown(self):
1474 shutil.rmtree(TESTFN2)
1475 if os.path.exists(TESTFN):
Ezio Melotti76430242009-07-11 18:28:48 +00001476 unlink(TESTFN)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001477
Guido van Rossumd8faa362007-04-27 19:54:29 +00001478
1479class UniversalNewlineTests(unittest.TestCase):
1480 def setUp(self):
Guido van Rossum9c627722007-08-27 18:31:48 +00001481 self.line_gen = [bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001482 for i in range(FIXEDTEST_SIZE)]
Guido van Rossumd8faa362007-04-27 19:54:29 +00001483 self.seps = ('\r', '\r\n', '\n')
1484 self.arcdata, self.arcfiles = {}, {}
1485 for n, s in enumerate(self.seps):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001486 b = s.encode("ascii")
1487 self.arcdata[s] = b.join(self.line_gen) + b
Guido van Rossumd8faa362007-04-27 19:54:29 +00001488 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001489 f = open(self.arcfiles[s], "wb")
1490 try:
1491 f.write(self.arcdata[s])
1492 finally:
1493 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001494
Ezio Melottiafd0d112009-07-15 17:17:17 +00001495 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001496 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001497 with zipfile.ZipFile(f, "w", compression) as zipfp:
1498 for fn in self.arcfiles.values():
1499 zipfp.write(fn, fn)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001500
Ezio Melottiafd0d112009-07-15 17:17:17 +00001501 def read_test(self, f, compression):
1502 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001503
1504 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001505 with zipfile.ZipFile(f, "r") as zipfp:
1506 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001507 with zipfp.open(fn, "rU") as fp:
1508 zipdata = fp.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001509 self.assertEqual(self.arcdata[sep], zipdata)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001510 if not isinstance(f, str):
1511 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001512
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001513 def readline_read_test(self, f, compression):
1514 self.make_test_archive(f, compression)
1515
1516 # Read the ZIP archive
Brian Curtin8fb9b862010-11-18 02:15:28 +00001517 with zipfile.ZipFile(f, "r") as zipfp:
1518 for sep, fn in self.arcfiles.items():
1519 with zipfp.open(fn, "rU") as zipopen:
1520 data = b''
1521 while True:
1522 read = zipopen.readline()
1523 if not read:
1524 break
1525 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001526
Brian Curtin8fb9b862010-11-18 02:15:28 +00001527 read = zipopen.read(5)
1528 if not read:
1529 break
1530 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001531
1532 self.assertEqual(data, self.arcdata['\n'])
1533
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001534 if not isinstance(f, str):
1535 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001536
Ezio Melottiafd0d112009-07-15 17:17:17 +00001537 def readline_test(self, f, compression):
1538 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001539
1540 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001541 with zipfile.ZipFile(f, "r") as zipfp:
1542 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001543 with zipfp.open(fn, "rU") as zipopen:
1544 for line in self.line_gen:
1545 linedata = zipopen.readline()
1546 self.assertEqual(linedata, line + b'\n')
1547 if not isinstance(f, str):
1548 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001549
Ezio Melottiafd0d112009-07-15 17:17:17 +00001550 def readlines_test(self, f, compression):
1551 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001552
1553 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001554 with zipfile.ZipFile(f, "r") as zipfp:
1555 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001556 with zipfp.open(fn, "rU") as fp:
1557 ziplines = fp.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001558 for line, zipline in zip(self.line_gen, ziplines):
1559 self.assertEqual(zipline, line + b'\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001560 if not isinstance(f, str):
1561 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001562
Ezio Melottiafd0d112009-07-15 17:17:17 +00001563 def iterlines_test(self, f, compression):
1564 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001565
1566 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001567 with zipfile.ZipFile(f, "r") as zipfp:
1568 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001569 with zipfp.open(fn, "rU") as fp:
1570 for line, zipline in zip(self.line_gen, fp):
1571 self.assertEqual(zipline, line + b'\n')
1572 if not isinstance(f, str):
1573 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001574
Ezio Melottiafd0d112009-07-15 17:17:17 +00001575 def test_read_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001576 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001577 self.read_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001578
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001579 def test_readline_read_stored(self):
1580 # Issue #7610: calls to readline() interleaved with calls to read().
1581 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1582 self.readline_read_test(f, zipfile.ZIP_STORED)
1583
Ezio Melottiafd0d112009-07-15 17:17:17 +00001584 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001585 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001586 self.readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001587
Ezio Melottiafd0d112009-07-15 17:17:17 +00001588 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001589 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001590 self.readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001591
Ezio Melottiafd0d112009-07-15 17:17:17 +00001592 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001593 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001594 self.iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001595
Ezio Melotti76430242009-07-11 18:28:48 +00001596 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001597 def test_read_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001598 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001599 self.read_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001600
Ezio Melotti76430242009-07-11 18:28:48 +00001601 @skipUnless(zlib, "requires zlib")
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001602 def test_readline_read_deflated(self):
1603 # Issue #7610: calls to readline() interleaved with calls to read().
1604 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1605 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1606
1607 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001608 def test_readline_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001609 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001610 self.readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001611
Ezio Melotti76430242009-07-11 18:28:48 +00001612 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001613 def test_readlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001614 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001615 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001616
Ezio Melotti76430242009-07-11 18:28:48 +00001617 @skipUnless(zlib, "requires zlib")
Ezio Melottiafd0d112009-07-15 17:17:17 +00001618 def test_iterlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001619 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001620 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001621
1622 def tearDown(self):
1623 for sep, fn in self.arcfiles.items():
1624 os.remove(fn)
Ezio Melotti76430242009-07-11 18:28:48 +00001625 unlink(TESTFN)
1626 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001627
1628
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001629def test_main():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001630 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1631 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti76430242009-07-11 18:28:48 +00001632 TestWithDirectory, UniversalNewlineTests,
1633 TestsWithRandomBinaryFiles)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001634
1635if __name__ == "__main__":
1636 test_main()