blob: c6039ccf2cc803c14c4c09920bea0bd7979d0ffa [file] [log] [blame]
Ezio Melotti74c96ec2009-07-08 22:24:06 +00001import io
2import os
Georg Brandl5ba11de2011-01-01 10:09:32 +00003import sys
Barry Warsaw28a691b2010-04-17 00:19:56 +00004import imp
Ezio Melotti35386712009-12-31 13:22:41 +00005import time
Ezio Melotti74c96ec2009-07-08 22:24:06 +00006import shutil
7import struct
8import zipfile
9import unittest
10
Tim Petersa45cacf2004-08-20 03:47:14 +000011
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000012from tempfile import TemporaryFile
Guido van Rossumd8faa362007-04-27 19:54:29 +000013from random import randint, random
Ezio Melotti74c96ec2009-07-08 22:24:06 +000014from unittest import skipUnless
Tim Petersa19a1682001-03-29 04:36:09 +000015
Martin v. Löwisf6b16a42012-05-01 07:58:44 +020016from test.support import TESTFN, run_unittest, findfile, unlink, requires_zlib, requires_bz2
Guido van Rossum368f04a2000-04-10 13:23:04 +000017
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000018TESTFN2 = TESTFN + "2"
Martin v. Löwis59e47792009-01-24 14:10:07 +000019TESTFNDIR = TESTFN + "d"
Guido van Rossumb5a755e2007-07-18 18:15:48 +000020FIXEDTEST_SIZE = 1000
Georg Brandl5ba11de2011-01-01 10:09:32 +000021DATAFILES_DIR = 'zipfile_datafiles'
Guido van Rossum368f04a2000-04-10 13:23:04 +000022
Christian Heimes790c8232008-01-07 21:14:23 +000023SMALL_TEST_DATA = [('_ziptest1', '1q2w3e4r5t'),
24 ('ziptest2dir/_ziptest2', 'qawsedrftg'),
25 ('/ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
26 ('ziptest2dir/ziptest3dir/ziptest4dir/_ziptest3', '6y7u8i9o0p')]
27
Ezio Melotti76430242009-07-11 18:28:48 +000028
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000029class TestsWithSourceFile(unittest.TestCase):
30 def setUp(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +000031 self.line_gen = (bytes("Zipfile test line %d. random float: %f" %
Guido van Rossum9c627722007-08-27 18:31:48 +000032 (i, random()), "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +000033 for i in range(FIXEDTEST_SIZE))
34 self.data = b'\n'.join(self.line_gen) + b'\n'
Fred Drake6e7e4852001-02-28 05:34:16 +000035
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000036 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +000037 with open(TESTFN, "wb") as fp:
38 fp.write(self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000039
Ezio Melottiafd0d112009-07-15 17:17:17 +000040 def make_test_archive(self, f, compression):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000041 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000042 with zipfile.ZipFile(f, "w", compression) as zipfp:
43 zipfp.write(TESTFN, "another.name")
44 zipfp.write(TESTFN, TESTFN)
45 zipfp.writestr("strfile", self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000046
Ezio Melottiafd0d112009-07-15 17:17:17 +000047 def zip_test(self, f, compression):
48 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +000049
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000050 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000051 with zipfile.ZipFile(f, "r", compression) as zipfp:
52 self.assertEqual(zipfp.read(TESTFN), self.data)
53 self.assertEqual(zipfp.read("another.name"), self.data)
54 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000055
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000056 # Print the ZIP directory
57 fp = io.StringIO()
58 zipfp.printdir(file=fp)
59 directory = fp.getvalue()
60 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +000061 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +000062
Benjamin Peterson577473f2010-01-19 00:09:57 +000063 self.assertIn('File Name', lines[0])
64 self.assertIn('Modified', lines[0])
65 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +000066
Ezio Melotti35386712009-12-31 13:22:41 +000067 fn, date, time_, size = lines[1].split()
68 self.assertEqual(fn, 'another.name')
69 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
70 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
71 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000072
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000073 # Check the namelist
74 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +000075 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000076 self.assertIn(TESTFN, names)
77 self.assertIn("another.name", names)
78 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000079
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000080 # Check infolist
81 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +000082 names = [i.filename for i in infos]
83 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +000084 self.assertIn(TESTFN, names)
85 self.assertIn("another.name", names)
86 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000087 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +000088 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000089
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000090 # check getinfo
91 for nm in (TESTFN, "another.name", "strfile"):
92 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +000093 self.assertEqual(info.filename, nm)
94 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +000095
Ezio Melottifaa6b7f2009-12-30 12:34:59 +000096 # Check that testzip doesn't raise an exception
97 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +000098 if not isinstance(f, str):
99 f.close()
Tim Peters7d3bad62001-04-04 18:56:49 +0000100
Ezio Melottiafd0d112009-07-15 17:17:17 +0000101 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000102 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000103 self.zip_test(f, zipfile.ZIP_STORED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000104
Ezio Melottiafd0d112009-07-15 17:17:17 +0000105 def zip_open_test(self, f, compression):
106 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000107
108 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000109 with zipfile.ZipFile(f, "r", compression) as zipfp:
110 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000111 with zipfp.open(TESTFN) as zipopen1:
112 while True:
113 read_data = zipopen1.read(256)
114 if not read_data:
115 break
116 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000117
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000118 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000119 with zipfp.open("another.name") as zipopen2:
120 while True:
121 read_data = zipopen2.read(256)
122 if not read_data:
123 break
124 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000125
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000126 self.assertEqual(b''.join(zipdata1), self.data)
127 self.assertEqual(b''.join(zipdata2), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000128 if not isinstance(f, str):
129 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000130
Ezio Melottiafd0d112009-07-15 17:17:17 +0000131 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000132 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000133 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000134
Ezio Melottiafd0d112009-07-15 17:17:17 +0000135 def test_open_via_zip_info(self):
Georg Brandlb533e262008-05-25 18:19:30 +0000136 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000137 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
138 zipfp.writestr("name", "foo")
139 zipfp.writestr("name", "bar")
Georg Brandlb533e262008-05-25 18:19:30 +0000140
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000141 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
142 infos = zipfp.infolist()
143 data = b""
144 for info in infos:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000145 with zipfp.open(info) as zipopen:
146 data += zipopen.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000147 self.assertTrue(data == b"foobar" or data == b"barfoo")
148 data = b""
149 for info in infos:
150 data += zipfp.read(info)
151 self.assertTrue(data == b"foobar" or data == b"barfoo")
Georg Brandlb533e262008-05-25 18:19:30 +0000152
Ezio Melottiafd0d112009-07-15 17:17:17 +0000153 def zip_random_open_test(self, f, compression):
154 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000155
156 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000157 with zipfile.ZipFile(f, "r", compression) as zipfp:
158 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +0000159 with zipfp.open(TESTFN) as zipopen1:
160 while True:
161 read_data = zipopen1.read(randint(1, 1024))
162 if not read_data:
163 break
164 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000165
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000166 self.assertEqual(b''.join(zipdata1), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000167 if not isinstance(f, str):
168 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000169
Ezio Melottiafd0d112009-07-15 17:17:17 +0000170 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000171 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000172 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000173
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000174 def test_univeral_readaheads(self):
175 f = io.BytesIO()
176
177 data = b'a\r\n' * 16 * 1024
178 zipfp = zipfile.ZipFile(f, 'w', zipfile.ZIP_STORED)
179 zipfp.writestr(TESTFN, data)
180 zipfp.close()
181
182 data2 = b''
183 zipfp = zipfile.ZipFile(f, 'r')
Brian Curtin8fb9b862010-11-18 02:15:28 +0000184 with zipfp.open(TESTFN, 'rU') as zipopen:
185 for line in zipopen:
186 data2 += line
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000187 zipfp.close()
188
189 self.assertEqual(data, data2.replace(b'\n', b'\r\n'))
190
191 def zip_readline_read_test(self, f, compression):
192 self.make_test_archive(f, compression)
193
194 # Read the ZIP archive
195 zipfp = zipfile.ZipFile(f, "r")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000196 with zipfp.open(TESTFN) as zipopen:
197 data = b''
198 while True:
199 read = zipopen.readline()
200 if not read:
201 break
202 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000203
Brian Curtin8fb9b862010-11-18 02:15:28 +0000204 read = zipopen.read(100)
205 if not read:
206 break
207 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000208
209 self.assertEqual(data, self.data)
210 zipfp.close()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000211 if not isinstance(f, str):
212 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000213
Ezio Melottiafd0d112009-07-15 17:17:17 +0000214 def zip_readline_test(self, f, compression):
215 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000216
217 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000218 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000219 with zipfp.open(TESTFN) as zipopen:
220 for line in self.line_gen:
221 linedata = zipopen.readline()
222 self.assertEqual(linedata, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000223 if not isinstance(f, str):
224 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000225
Ezio Melottiafd0d112009-07-15 17:17:17 +0000226 def zip_readlines_test(self, f, compression):
227 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000228
229 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000230 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000231 with zipfp.open(TESTFN) as zipopen:
232 ziplines = zipopen.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000233 for line, zipline in zip(self.line_gen, ziplines):
234 self.assertEqual(zipline, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000235 if not isinstance(f, str):
236 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000237
Ezio Melottiafd0d112009-07-15 17:17:17 +0000238 def zip_iterlines_test(self, f, compression):
239 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000240
241 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000242 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000243 with zipfp.open(TESTFN) as zipopen:
244 for line, zipline in zip(self.line_gen, zipopen):
245 self.assertEqual(zipline, line + '\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000246 if not isinstance(f, str):
247 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000248
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000249 def test_readline_read_stored(self):
250 # Issue #7610: calls to readline() interleaved with calls to read().
251 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
252 self.zip_readline_read_test(f, zipfile.ZIP_STORED)
253
Ezio Melottiafd0d112009-07-15 17:17:17 +0000254 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000255 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000256 self.zip_readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000257
Ezio Melottiafd0d112009-07-15 17:17:17 +0000258 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000259 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000260 self.zip_readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000261
Ezio Melottiafd0d112009-07-15 17:17:17 +0000262 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000263 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000264 self.zip_iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000265
Ezio Melotti975077a2011-05-19 22:03:22 +0300266 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000267 def test_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000268 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000269 self.zip_test(f, zipfile.ZIP_DEFLATED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000270
Guido van Rossumd8faa362007-04-27 19:54:29 +0000271
Ezio Melotti975077a2011-05-19 22:03:22 +0300272 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000273 def test_open_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_open_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000276
Ezio Melotti975077a2011-05-19 22:03:22 +0300277 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000278 def test_random_open_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000279 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000280 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000281
Ezio Melotti975077a2011-05-19 22:03:22 +0300282 @requires_zlib
Antoine Pitroua32f9a22010-01-27 21:18:57 +0000283 def test_readline_read_deflated(self):
284 # Issue #7610: calls to readline() interleaved with calls to read().
285 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
286 self.zip_readline_read_test(f, zipfile.ZIP_DEFLATED)
287
Ezio Melotti975077a2011-05-19 22:03:22 +0300288 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000289 def test_readline_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000290 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000291 self.zip_readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000292
Ezio Melotti975077a2011-05-19 22:03:22 +0300293 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000294 def test_readlines_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000295 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000296 self.zip_readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000297
Ezio Melotti975077a2011-05-19 22:03:22 +0300298 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000299 def test_iterlines_deflated(self):
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000300 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000301 self.zip_iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000302
Ezio Melotti975077a2011-05-19 22:03:22 +0300303 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000304 def test_low_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000305 """Check for cases where compressed data is larger than original."""
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000306 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000307 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
308 zipfp.writestr("strfile", '12')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000309
310 # Get an open object for strfile
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000311 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_DEFLATED) as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000312 with zipfp.open("strfile") as openobj:
313 self.assertEqual(openobj.read(1), b'1')
314 self.assertEqual(openobj.read(1), b'2')
Ezio Melotti74c96ec2009-07-08 22:24:06 +0000315
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200316 @requires_bz2
317 def test_bzip2(self):
318 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
319 self.zip_test(f, zipfile.ZIP_BZIP2)
320
321 @requires_bz2
322 def test_open_bzip2(self):
323 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
324 self.zip_open_test(f, zipfile.ZIP_BZIP2)
325
326 @requires_bz2
327 def test_random_open_bzip2(self):
328 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
329 self.zip_random_open_test(f, zipfile.ZIP_BZIP2)
330
331 @requires_bz2
332 def test_readline_read_bzip2(self):
333 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
334 self.zip_readline_read_test(f, zipfile.ZIP_BZIP2)
335
336 @requires_bz2
337 def test_readline_bzip2(self):
338 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
339 self.zip_readline_test(f, zipfile.ZIP_BZIP2)
340
341 @requires_bz2
342 def test_readlines_bzip2(self):
343 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
344 self.zip_readlines_test(f, zipfile.ZIP_BZIP2)
345
346 @requires_bz2
347 def test_iterlines_bzip2(self):
348 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
349 self.zip_iterlines_test(f, zipfile.ZIP_BZIP2)
350
351 @requires_bz2
352 def test_low_compression_bzip2(self):
353 """Check for cases where compressed data is larger than original."""
354 # Create the ZIP archive
355 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_BZIP2) as zipfp:
356 zipfp.writestr("strfile", '12')
357
358 # Get an open object for strfile
359 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_BZIP2) as zipfp:
360 with zipfp.open("strfile") as openobj:
361 self.assertEqual(openobj.read(1), b'1')
362 self.assertEqual(openobj.read(1), b'2')
363
Ezio Melottiafd0d112009-07-15 17:17:17 +0000364 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000365 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
366 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000367
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000368 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
369 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000370
Ezio Melottiafd0d112009-07-15 17:17:17 +0000371 def test_append_to_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000372 """Test appending to an existing zipfile."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000373 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
374 zipfp.write(TESTFN, TESTFN)
375
376 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
377 zipfp.writestr("strfile", self.data)
378 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000379
Ezio Melottiafd0d112009-07-15 17:17:17 +0000380 def test_append_to_non_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000381 """Test appending to an existing file that is not a zipfile."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000382 # NOTE: this test fails if len(d) < 22 because of the first
383 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti35386712009-12-31 13:22:41 +0000384 data = b'I am not a ZipFile!'*10
385 with open(TESTFN2, 'wb') as f:
386 f.write(data)
387
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000388 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
389 zipfp.write(TESTFN, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000390
Ezio Melotti35386712009-12-31 13:22:41 +0000391 with open(TESTFN2, 'rb') as f:
392 f.seek(len(data))
393 with zipfile.ZipFile(f, "r") as zipfp:
394 self.assertEqual(zipfp.namelist(), [TESTFN])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000395
R David Murray4fbb9db2011-06-09 15:50:51 -0400396 def test_ignores_newline_at_end(self):
397 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
398 zipfp.write(TESTFN, TESTFN)
399 with open(TESTFN2, 'a') as f:
400 f.write("\r\n\00\00\00")
401 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
402 self.assertIsInstance(zipfp, zipfile.ZipFile)
403
404 def test_ignores_stuff_appended_past_comments(self):
405 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
406 zipfp.comment = b"this is a comment"
407 zipfp.write(TESTFN, TESTFN)
408 with open(TESTFN2, 'a') as f:
409 f.write("abcdef\r\n")
410 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
411 self.assertIsInstance(zipfp, zipfile.ZipFile)
412 self.assertEqual(zipfp.comment, b"this is a comment")
413
Ezio Melottiafd0d112009-07-15 17:17:17 +0000414 def test_write_default_name(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000415 """Check that calling ZipFile.write without arcname specified
416 produces the expected result."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000417 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
418 zipfp.write(TESTFN)
Brian Curtin8fb9b862010-11-18 02:15:28 +0000419 with open(TESTFN, "rb") as f:
420 self.assertEqual(zipfp.read(TESTFN), f.read())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000421
Ezio Melotti975077a2011-05-19 22:03:22 +0300422 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000423 def test_per_file_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000424 """Check that files within a Zip archive can have different
425 compression options."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000426 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
427 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
428 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
429 sinfo = zipfp.getinfo('storeme')
430 dinfo = zipfp.getinfo('deflateme')
431 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
432 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000433
Ezio Melottiafd0d112009-07-15 17:17:17 +0000434 def test_write_to_readonly(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000435 """Check that trying to call write() on a readonly ZipFile object
436 raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000437 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
438 zipfp.writestr("somefile.txt", "bogus")
439
440 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
441 self.assertRaises(RuntimeError, zipfp.write, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000442
Ezio Melottiafd0d112009-07-15 17:17:17 +0000443 def test_extract(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000444 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
445 for fpath, fdata in SMALL_TEST_DATA:
446 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000447
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000448 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
449 for fpath, fdata in SMALL_TEST_DATA:
450 writtenfile = zipfp.extract(fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000451
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000452 # make sure it was written to the right place
453 if os.path.isabs(fpath):
454 correctfile = os.path.join(os.getcwd(), fpath[1:])
455 else:
456 correctfile = os.path.join(os.getcwd(), fpath)
457 correctfile = os.path.normpath(correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000458
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000459 self.assertEqual(writtenfile, correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000460
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000461 # make sure correct data is in correct file
Brian Curtin8fb9b862010-11-18 02:15:28 +0000462 with open(writtenfile, "rb") as f:
463 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000464
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000465 os.remove(writtenfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000466
467 # remove the test file subdirectories
468 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
469
Ezio Melottiafd0d112009-07-15 17:17:17 +0000470 def test_extract_all(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000471 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
472 for fpath, fdata in SMALL_TEST_DATA:
473 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000474
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000475 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
476 zipfp.extractall()
477 for fpath, fdata in SMALL_TEST_DATA:
478 if os.path.isabs(fpath):
479 outfile = os.path.join(os.getcwd(), fpath[1:])
480 else:
481 outfile = os.path.join(os.getcwd(), fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000482
Brian Curtin8fb9b862010-11-18 02:15:28 +0000483 with open(outfile, "rb") as f:
484 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000485
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000486 os.remove(outfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000487
488 # remove the test file subdirectories
489 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
490
Ezio Melotti975077a2011-05-19 22:03:22 +0300491 def test_writestr_compression_stored(self):
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000492 zipfp = zipfile.ZipFile(TESTFN2, "w")
493 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000494 info = zipfp.getinfo('a.txt')
495 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
496
Ezio Melotti975077a2011-05-19 22:03:22 +0300497 @requires_zlib
498 def test_writestr_compression_deflated(self):
499 zipfp = zipfile.ZipFile(TESTFN2, "w")
500 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
501 info = zipfp.getinfo('b.txt')
502 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000503
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200504 @requires_bz2
505 def test_writestr_compression_bzip2(self):
506 zipfp = zipfile.ZipFile(TESTFN2, "w")
507 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_BZIP2)
508 info = zipfp.getinfo('b.txt')
509 self.assertEqual(info.compress_type, zipfile.ZIP_BZIP2)
510
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000511 def zip_test_writestr_permissions(self, f, compression):
512 # Make sure that writestr creates files with mode 0600,
513 # when it is passed a name rather than a ZipInfo instance.
514
Ezio Melottiafd0d112009-07-15 17:17:17 +0000515 self.make_test_archive(f, compression)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000516 with zipfile.ZipFile(f, "r") as zipfp:
517 zinfo = zipfp.getinfo('strfile')
518 self.assertEqual(zinfo.external_attr, 0o600 << 16)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000519 if not isinstance(f, str):
520 f.close()
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000521
Ezio Melottiafd0d112009-07-15 17:17:17 +0000522 def test_writestr_permissions(self):
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000523 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
524 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
525
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000526 def test_writestr_extended_local_header_issue1202(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000527 with zipfile.ZipFile(TESTFN2, 'w') as orig_zip:
528 for data in 'abcdefghijklmnop':
529 zinfo = zipfile.ZipInfo(data)
530 zinfo.flag_bits |= 0x08 # Include an extended local header.
531 orig_zip.writestr(zinfo, data)
532
533 def test_close(self):
534 """Check that the zipfile is closed after the 'with' block."""
535 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
536 for fpath, fdata in SMALL_TEST_DATA:
537 zipfp.writestr(fpath, fdata)
538 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
539 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
540
541 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
542 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
543 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
544
545 def test_close_on_exception(self):
546 """Check that the zipfile is closed if an exception is raised in the
547 'with' block."""
548 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
549 for fpath, fdata in SMALL_TEST_DATA:
550 zipfp.writestr(fpath, fdata)
551
552 try:
553 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
Georg Brandl4d540882010-10-28 06:42:33 +0000554 raise zipfile.BadZipFile()
555 except zipfile.BadZipFile:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000556 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000557
Senthil Kumaran29fa9d42011-10-20 01:46:00 +0800558 def test_add_file_before_1980(self):
559 # Set atime and mtime to 1970-01-01
560 os.utime(TESTFN, (0, 0))
561 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
562 self.assertRaises(ValueError, zipfp.write, TESTFN)
563
564
Senthil Kumaran7e3062b2011-10-20 01:52:41 +0800565
566
567
568
569
Ezio Melotti975077a2011-05-19 22:03:22 +0300570 @requires_zlib
Georg Brandl5ba11de2011-01-01 10:09:32 +0000571 def test_unicode_filenames(self):
Georg Brandl04480a82011-01-01 10:42:31 +0000572 # bug #10801
573 fname = findfile('zip_cp437_header.zip')
Georg Brandl5ba11de2011-01-01 10:09:32 +0000574 with zipfile.ZipFile(fname) as zipfp:
Georg Brandl04480a82011-01-01 10:42:31 +0000575 for name in zipfp.namelist():
576 zipfp.open(name).close()
Georg Brandl5ba11de2011-01-01 10:09:32 +0000577
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000578 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000579 unlink(TESTFN)
580 unlink(TESTFN2)
581
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000582
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000583class TestZip64InSmallFiles(unittest.TestCase):
584 # These tests test the ZIP64 functionality without using large files,
585 # see test_zipfile64 for proper tests.
586
587 def setUp(self):
588 self._limit = zipfile.ZIP64_LIMIT
589 zipfile.ZIP64_LIMIT = 5
590
Guido van Rossum9c627722007-08-27 18:31:48 +0000591 line_gen = (bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000592 for i in range(0, FIXEDTEST_SIZE))
593 self.data = b'\n'.join(line_gen)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000594
595 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +0000596 with open(TESTFN, "wb") as fp:
597 fp.write(self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000598
Ezio Melottiafd0d112009-07-15 17:17:17 +0000599 def large_file_exception_test(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000600 with zipfile.ZipFile(f, "w", compression) as zipfp:
601 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000602 zipfp.write, TESTFN, "another.name")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000603
Ezio Melottiafd0d112009-07-15 17:17:17 +0000604 def large_file_exception_test2(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000605 with zipfile.ZipFile(f, "w", compression) as zipfp:
606 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000607 zipfp.writestr, "another.name", self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000608 if not isinstance(f, str):
609 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000610
Ezio Melottiafd0d112009-07-15 17:17:17 +0000611 def test_large_file_exception(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000612 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000613 self.large_file_exception_test(f, zipfile.ZIP_STORED)
614 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000615
Ezio Melottiafd0d112009-07-15 17:17:17 +0000616 def zip_test(self, f, compression):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000617 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000618 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
619 zipfp.write(TESTFN, "another.name")
620 zipfp.write(TESTFN, TESTFN)
621 zipfp.writestr("strfile", self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000622
623 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000624 with zipfile.ZipFile(f, "r", compression) as zipfp:
625 self.assertEqual(zipfp.read(TESTFN), self.data)
626 self.assertEqual(zipfp.read("another.name"), self.data)
627 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000628
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000629 # Print the ZIP directory
630 fp = io.StringIO()
631 zipfp.printdir(fp)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000632
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000633 directory = fp.getvalue()
634 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +0000635 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000636
Benjamin Peterson577473f2010-01-19 00:09:57 +0000637 self.assertIn('File Name', lines[0])
638 self.assertIn('Modified', lines[0])
639 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000640
Ezio Melotti35386712009-12-31 13:22:41 +0000641 fn, date, time_, size = lines[1].split()
642 self.assertEqual(fn, 'another.name')
643 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
644 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
645 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000646
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000647 # Check the namelist
648 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +0000649 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000650 self.assertIn(TESTFN, names)
651 self.assertIn("another.name", names)
652 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000653
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000654 # Check infolist
655 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +0000656 names = [i.filename for i in infos]
657 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000658 self.assertIn(TESTFN, names)
659 self.assertIn("another.name", names)
660 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000661 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +0000662 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000663
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000664 # check getinfo
665 for nm in (TESTFN, "another.name", "strfile"):
666 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000667 self.assertEqual(info.filename, nm)
668 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000669
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000670 # Check that testzip doesn't raise an exception
671 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000672 if not isinstance(f, str):
673 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000674
Ezio Melottiafd0d112009-07-15 17:17:17 +0000675 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000676 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000677 self.zip_test(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000678
Ezio Melotti975077a2011-05-19 22:03:22 +0300679 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000680 def test_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000681 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000682 self.zip_test(f, zipfile.ZIP_DEFLATED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000683
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200684 @requires_bz2
685 def test_bzip2(self):
686 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
687 self.zip_test(f, zipfile.ZIP_BZIP2)
688
Ezio Melottiafd0d112009-07-15 17:17:17 +0000689 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000690 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
691 allowZip64=True) as zipfp:
692 zipfp.write(TESTFN, "/absolute")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000693
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000694 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
695 self.assertEqual(zipfp.namelist(), ["absolute"])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000696
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000697 def tearDown(self):
698 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti76430242009-07-11 18:28:48 +0000699 unlink(TESTFN)
700 unlink(TESTFN2)
701
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000702
703class PyZipFileTests(unittest.TestCase):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000704 def test_write_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000705 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000706 fn = __file__
707 if fn.endswith('.pyc') or fn.endswith('.pyo'):
Barry Warsaw28a691b2010-04-17 00:19:56 +0000708 path_split = fn.split(os.sep)
709 if os.altsep is not None:
710 path_split.extend(fn.split(os.altsep))
711 if '__pycache__' in path_split:
712 fn = imp.source_from_cache(fn)
713 else:
714 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000715
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000716 zipfp.writepy(fn)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000717
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000718 bn = os.path.basename(fn)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000719 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000720 self.assertTrue(bn + 'o' in zipfp.namelist() or
721 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000722
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000723 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000724 fn = __file__
Ezio Melotti35386712009-12-31 13:22:41 +0000725 if fn.endswith(('.pyc', '.pyo')):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000726 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000727
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000728 zipfp.writepy(fn, "testpackage")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000729
Ezio Melotti35386712009-12-31 13:22:41 +0000730 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Benjamin Peterson577473f2010-01-19 00:09:57 +0000731 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000732 self.assertTrue(bn + 'o' in zipfp.namelist() or
733 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000734
Ezio Melottiafd0d112009-07-15 17:17:17 +0000735 def test_write_python_package(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000736 import email
737 packagedir = os.path.dirname(email.__file__)
738
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000739 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000740 zipfp.writepy(packagedir)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000741
Ezio Melotti35386712009-12-31 13:22:41 +0000742 # Check for a couple of modules at different levels of the
743 # hierarchy
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000744 names = zipfp.namelist()
745 self.assertTrue('email/__init__.pyo' in names or
746 'email/__init__.pyc' in names)
747 self.assertTrue('email/mime/text.pyo' in names or
748 'email/mime/text.pyc' in names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000749
Georg Brandl8334fd92010-12-04 10:26:46 +0000750 def test_write_with_optimization(self):
751 import email
752 packagedir = os.path.dirname(email.__file__)
753 # use .pyc if running test in optimization mode,
754 # use .pyo if running test in debug mode
755 optlevel = 1 if __debug__ else 0
756 ext = '.pyo' if optlevel == 1 else '.pyc'
757
758 with TemporaryFile() as t, \
759 zipfile.PyZipFile(t, "w", optimize=optlevel) as zipfp:
760 zipfp.writepy(packagedir)
761
762 names = zipfp.namelist()
763 self.assertIn('email/__init__' + ext, names)
764 self.assertIn('email/mime/text' + ext, names)
765
Ezio Melottiafd0d112009-07-15 17:17:17 +0000766 def test_write_python_directory(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000767 os.mkdir(TESTFN2)
768 try:
Ezio Melotti35386712009-12-31 13:22:41 +0000769 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
770 fp.write("print(42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000771
Ezio Melotti35386712009-12-31 13:22:41 +0000772 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
773 fp.write("print(42 * 42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000774
Ezio Melotti35386712009-12-31 13:22:41 +0000775 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
776 fp.write("bla bla bla\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000777
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000778 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
779 zipfp.writepy(TESTFN2)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000780
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000781 names = zipfp.namelist()
782 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
783 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
784 self.assertNotIn('mod2.txt', names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000785
786 finally:
787 shutil.rmtree(TESTFN2)
788
Ezio Melottiafd0d112009-07-15 17:17:17 +0000789 def test_write_non_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000790 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000791 with open(TESTFN, 'w') as f:
792 f.write('most definitely not a python file')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000793 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
794 os.remove(TESTFN)
795
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000796
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000797class OtherTests(unittest.TestCase):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000798 zips_with_bad_crc = {
799 zipfile.ZIP_STORED: (
800 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
801 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
802 b'ilehello,AworldP'
803 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
804 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
805 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
806 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
807 b'\0\0/\0\0\0\0\0'),
808 zipfile.ZIP_DEFLATED: (
809 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
810 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
811 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
812 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
813 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
814 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
815 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
816 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
Martin v. Löwisf6b16a42012-05-01 07:58:44 +0200817 zipfile.ZIP_BZIP2: (
818 b'PK\x03\x04\x14\x03\x00\x00\x0c\x00nu\x0c=FA'
819 b'KE8\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
820 b'ileBZh91AY&SY\xd4\xa8\xca'
821 b'\x7f\x00\x00\x0f\x11\x80@\x00\x06D\x90\x80 \x00 \xa5'
822 b'P\xd9!\x03\x03\x13\x13\x13\x89\xa9\xa9\xc2u5:\x9f'
823 b'\x8b\xb9"\x9c(HjTe?\x80PK\x01\x02\x14'
824 b'\x03\x14\x03\x00\x00\x0c\x00nu\x0c=FAKE8'
825 b'\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00\x00\x00\x00\x00\x00'
826 b'\x00 \x80\x80\x81\x00\x00\x00\x00afilePK'
827 b'\x05\x06\x00\x00\x00\x00\x01\x00\x01\x003\x00\x00\x00[\x00'
828 b'\x00\x00\x00\x00'),
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000829 }
830
Ezio Melottiafd0d112009-07-15 17:17:17 +0000831 def test_unicode_filenames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000832 with zipfile.ZipFile(TESTFN, "w") as zf:
833 zf.writestr("foo.txt", "Test for unicode filename")
834 zf.writestr("\xf6.txt", "Test for unicode filename")
Ezio Melottie9615932010-01-24 19:26:24 +0000835 self.assertIsInstance(zf.infolist()[0].filename, str)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000836
837 with zipfile.ZipFile(TESTFN, "r") as zf:
838 self.assertEqual(zf.filelist[0].filename, "foo.txt")
839 self.assertEqual(zf.filelist[1].filename, "\xf6.txt")
Martin v. Löwis8570f6a2008-05-05 17:44:38 +0000840
Ezio Melottiafd0d112009-07-15 17:17:17 +0000841 def test_create_non_existent_file_for_append(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +0000842 if os.path.exists(TESTFN):
843 os.unlink(TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000844
Thomas Wouterscf297e42007-02-23 15:07:44 +0000845 filename = 'testfile.txt'
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000846 content = b'hello, world. this is some content.'
Guido van Rossumd8faa362007-04-27 19:54:29 +0000847
Thomas Wouterscf297e42007-02-23 15:07:44 +0000848 try:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000849 with zipfile.ZipFile(TESTFN, 'a') as zf:
850 zf.writestr(filename, content)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000851 except IOError:
852 self.fail('Could not append data to a non-existent zip file.')
853
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000854 self.assertTrue(os.path.exists(TESTFN))
Thomas Wouterscf297e42007-02-23 15:07:44 +0000855
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000856 with zipfile.ZipFile(TESTFN, 'r') as zf:
857 self.assertEqual(zf.read(filename), content)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000858
Ezio Melottiafd0d112009-07-15 17:17:17 +0000859 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000860 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti35386712009-12-31 13:22:41 +0000861 # it opens if there's an error in the file. If it doesn't, the
862 # traceback holds a reference to the ZipFile object and, indirectly,
863 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000864 # On Windows, this causes the os.unlink() call to fail because the
865 # underlying file is still open. This is SF bug #412214.
866 #
Ezio Melotti35386712009-12-31 13:22:41 +0000867 with open(TESTFN, "w") as fp:
868 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000869 try:
870 zf = zipfile.ZipFile(TESTFN)
Georg Brandl4d540882010-10-28 06:42:33 +0000871 except zipfile.BadZipFile:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000872 pass
873
Ezio Melottiafd0d112009-07-15 17:17:17 +0000874 def test_is_zip_erroneous_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000875 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000876 # - passing a filename
877 with open(TESTFN, "w") as fp:
878 fp.write("this is not a legal zip file\n")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000879 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti35386712009-12-31 13:22:41 +0000880 self.assertFalse(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000881 # - passing a file object
882 with open(TESTFN, "rb") as fp:
883 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000884 self.assertTrue(not chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000885 # - passing a file-like object
886 fp = io.BytesIO()
887 fp.write(b"this is not a legal zip file\n")
888 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000889 self.assertTrue(not chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000890 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000891 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000892 self.assertTrue(not chk)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000893
Ezio Melottiafd0d112009-07-15 17:17:17 +0000894 def test_is_zip_valid_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000895 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000896 # - passing a filename
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000897 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
898 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
899
Guido van Rossumd8faa362007-04-27 19:54:29 +0000900 chk = zipfile.is_zipfile(TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000901 self.assertTrue(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(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000906 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000907 zip_contents = fp.read()
908 # - passing a file-like object
909 fp = io.BytesIO()
910 fp.write(zip_contents)
911 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000912 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000913 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000914 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000915 self.assertTrue(chk)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000916
Ezio Melottiafd0d112009-07-15 17:17:17 +0000917 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000918 # make sure we don't raise an AttributeError when a partially-constructed
919 # ZipFile instance is finalized; this tests for regression on SF tracker
920 # bug #403871.
921
922 # The bug we're testing for caused an AttributeError to be raised
923 # when a ZipFile instance was created for a file that did not
924 # exist; the .fp member was not initialized but was needed by the
925 # __del__() method. Since the AttributeError is in the __del__(),
926 # it is ignored, but the user should be sufficiently annoyed by
927 # the message on the output that regression will be noticed
928 # quickly.
929 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
930
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000931 def test_empty_file_raises_BadZipFile(self):
932 f = open(TESTFN, 'w')
933 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +0000934 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000935
Ezio Melotti35386712009-12-31 13:22:41 +0000936 with open(TESTFN, 'w') as fp:
937 fp.write("short file")
Georg Brandl4d540882010-10-28 06:42:33 +0000938 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000939
Ezio Melottiafd0d112009-07-15 17:17:17 +0000940 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000941 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000942 data = io.BytesIO()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000943 with zipfile.ZipFile(data, mode="w") as zipf:
944 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000945
946 # This is correct; calling .read on a closed ZipFile should throw
947 # a RuntimeError, and so should calling .testzip. An earlier
948 # version of .testzip would swallow this exception (and any other)
949 # and report that the first file in the archive was corrupt.
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000950 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
951 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000952 self.assertRaises(RuntimeError, zipf.testzip)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000953 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000954 with open(TESTFN, 'w') as f:
955 f.write('zipfile test data')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000956 self.assertRaises(RuntimeError, zipf.write, TESTFN)
957
Ezio Melottiafd0d112009-07-15 17:17:17 +0000958 def test_bad_constructor_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000959 """Check that bad modes passed to ZipFile constructor are caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000960 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
961
Ezio Melottiafd0d112009-07-15 17:17:17 +0000962 def test_bad_open_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000963 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000964 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
965 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
966
967 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000968 # read the data to make sure the file is there
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000969 zipf.read("foo.txt")
970 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000971
Ezio Melottiafd0d112009-07-15 17:17:17 +0000972 def test_read0(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000973 """Check that calling read(0) on a ZipExtFile object returns an empty
974 string and doesn't advance file pointer."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000975 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
976 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
977 # read the data to make sure the file is there
Brian Curtin8fb9b862010-11-18 02:15:28 +0000978 with zipf.open("foo.txt") as f:
979 for i in range(FIXEDTEST_SIZE):
980 self.assertEqual(f.read(0), b'')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000981
Brian Curtin8fb9b862010-11-18 02:15:28 +0000982 self.assertEqual(f.read(), b"O, for a Muse of Fire!")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000983
Ezio Melottiafd0d112009-07-15 17:17:17 +0000984 def test_open_non_existent_item(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000985 """Check that attempting to call open() for an item that doesn't
986 exist in the archive raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000987 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
988 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000989
Ezio Melottiafd0d112009-07-15 17:17:17 +0000990 def test_bad_compression_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000991 """Check that bad compression methods passed to ZipFile.open are
992 caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000993 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
994
Ezio Melottiafd0d112009-07-15 17:17:17 +0000995 def test_null_byte_in_filename(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000996 """Check that a filename containing a null byte is properly
997 terminated."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000998 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
999 zipf.writestr("foo.txt\x00qqq", b"O, for a Muse of Fire!")
1000 self.assertEqual(zipf.namelist(), ['foo.txt'])
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001001
Ezio Melottiafd0d112009-07-15 17:17:17 +00001002 def test_struct_sizes(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001003 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001004 self.assertEqual(zipfile.sizeEndCentDir, 22)
1005 self.assertEqual(zipfile.sizeCentralDir, 46)
1006 self.assertEqual(zipfile.sizeEndCentDir64, 56)
1007 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
1008
Ezio Melottiafd0d112009-07-15 17:17:17 +00001009 def test_comments(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001010 """Check that comments on the archive are handled properly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001011
1012 # check default comment is empty
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001013 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1014 self.assertEqual(zipf.comment, b'')
1015 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1016
1017 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1018 self.assertEqual(zipfr.comment, b'')
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001019
1020 # check a simple short comment
1021 comment = b'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001022 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1023 zipf.comment = comment
1024 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1025 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1026 self.assertEqual(zipf.comment, comment)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001027
1028 # check a comment of max length
1029 comment2 = ''.join(['%d' % (i**3 % 10) for i in range((1 << 16)-1)])
1030 comment2 = comment2.encode("ascii")
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001031 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1032 zipf.comment = comment2
1033 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1034
1035 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1036 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001037
1038 # check a comment that is too long is truncated
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001039 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1040 zipf.comment = comment2 + b'oops'
1041 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1042 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
1043 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +00001044
R David Murrayf50b38a2012-04-12 18:44:58 -04001045 def test_unicode_comment(self):
1046 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1047 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1048 with self.assertRaises(TypeError):
1049 zipf.comment = "this is an error"
1050
1051 def test_change_comment_in_empty_archive(self):
1052 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1053 self.assertFalse(zipf.filelist)
1054 zipf.comment = b"this is a comment"
1055 with zipfile.ZipFile(TESTFN, "r") as zipf:
1056 self.assertEqual(zipf.comment, b"this is a comment")
1057
1058 def test_change_comment_in_nonempty_archive(self):
1059 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1060 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1061 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1062 self.assertTrue(zipf.filelist)
1063 zipf.comment = b"this is a comment"
1064 with zipfile.ZipFile(TESTFN, "r") as zipf:
1065 self.assertEqual(zipf.comment, b"this is a comment")
1066
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001067 def check_testzip_with_bad_crc(self, compression):
1068 """Tests that files with bad CRCs return their name from testzip."""
1069 zipdata = self.zips_with_bad_crc[compression]
1070
1071 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1072 # testzip returns the name of the first corrupt file, or None
1073 self.assertEqual('afile', zipf.testzip())
1074
1075 def test_testzip_with_bad_crc_stored(self):
1076 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
1077
Ezio Melotti975077a2011-05-19 22:03:22 +03001078 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001079 def test_testzip_with_bad_crc_deflated(self):
1080 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
1081
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001082 @requires_bz2
1083 def test_testzip_with_bad_crc_bzip2(self):
1084 self.check_testzip_with_bad_crc(zipfile.ZIP_BZIP2)
1085
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001086 def check_read_with_bad_crc(self, compression):
Georg Brandl4d540882010-10-28 06:42:33 +00001087 """Tests that files with bad CRCs raise a BadZipFile exception when read."""
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001088 zipdata = self.zips_with_bad_crc[compression]
1089
1090 # Using ZipFile.read()
1091 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
Georg Brandl4d540882010-10-28 06:42:33 +00001092 self.assertRaises(zipfile.BadZipFile, zipf.read, 'afile')
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001093
1094 # Using ZipExtFile.read()
1095 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1096 with zipf.open('afile', 'r') as corrupt_file:
Georg Brandl4d540882010-10-28 06:42:33 +00001097 self.assertRaises(zipfile.BadZipFile, corrupt_file.read)
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001098
1099 # Same with small reads (in order to exercise the buffering logic)
1100 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1101 with zipf.open('afile', 'r') as corrupt_file:
1102 corrupt_file.MIN_READ_SIZE = 2
Georg Brandl4d540882010-10-28 06:42:33 +00001103 with self.assertRaises(zipfile.BadZipFile):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001104 while corrupt_file.read(2):
1105 pass
1106
1107 def test_read_with_bad_crc_stored(self):
1108 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
1109
Ezio Melotti975077a2011-05-19 22:03:22 +03001110 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001111 def test_read_with_bad_crc_deflated(self):
1112 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
1113
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001114 @requires_bz2
1115 def test_read_with_bad_crc_bzip2(self):
1116 self.check_read_with_bad_crc(zipfile.ZIP_BZIP2)
1117
Antoine Pitrou6464d5f2010-09-12 14:51:20 +00001118 def check_read_return_size(self, compression):
1119 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
1120 # than requested.
1121 for test_size in (1, 4095, 4096, 4097, 16384):
1122 file_size = test_size + 1
1123 junk = b''.join(struct.pack('B', randint(0, 255))
1124 for x in range(file_size))
1125 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
1126 zipf.writestr('foo', junk)
1127 with zipf.open('foo', 'r') as fp:
1128 buf = fp.read(test_size)
1129 self.assertEqual(len(buf), test_size)
1130
1131 def test_read_return_size_stored(self):
1132 self.check_read_return_size(zipfile.ZIP_STORED)
1133
Ezio Melotti975077a2011-05-19 22:03:22 +03001134 @requires_zlib
Antoine Pitrou6464d5f2010-09-12 14:51:20 +00001135 def test_read_return_size_deflated(self):
1136 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1137
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001138 @requires_bz2
1139 def test_read_return_size_bzip2(self):
1140 self.check_read_return_size(zipfile.ZIP_BZIP2)
1141
Georg Brandl268e4d42010-10-14 06:59:45 +00001142 def test_empty_zipfile(self):
1143 # Check that creating a file in 'w' or 'a' mode and closing without
1144 # adding any files to the archives creates a valid empty ZIP file
1145 zipf = zipfile.ZipFile(TESTFN, mode="w")
1146 zipf.close()
1147 try:
1148 zipf = zipfile.ZipFile(TESTFN, mode="r")
1149 except zipfile.BadZipFile:
1150 self.fail("Unable to create empty ZIP file in 'w' mode")
1151
1152 zipf = zipfile.ZipFile(TESTFN, mode="a")
1153 zipf.close()
1154 try:
1155 zipf = zipfile.ZipFile(TESTFN, mode="r")
1156 except:
1157 self.fail("Unable to create empty ZIP file in 'a' mode")
1158
1159 def test_open_empty_file(self):
1160 # Issue 1710703: Check that opening a file with less than 22 bytes
Georg Brandl4d540882010-10-28 06:42:33 +00001161 # raises a BadZipFile exception (rather than the previously unhelpful
Georg Brandl268e4d42010-10-14 06:59:45 +00001162 # IOError)
1163 f = open(TESTFN, 'w')
1164 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001165 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN, 'r')
Georg Brandl268e4d42010-10-14 06:59:45 +00001166
Senthil Kumaran29fa9d42011-10-20 01:46:00 +08001167 def test_create_zipinfo_before_1980(self):
1168 self.assertRaises(ValueError,
1169 zipfile.ZipInfo, 'seventies', (1979, 1, 1, 0, 0, 0))
1170
Guido van Rossumd8faa362007-04-27 19:54:29 +00001171 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001172 unlink(TESTFN)
1173 unlink(TESTFN2)
1174
Thomas Wouterscf297e42007-02-23 15:07:44 +00001175
1176class DecryptionTests(unittest.TestCase):
Ezio Melotti35386712009-12-31 13:22:41 +00001177 """Check that ZIP decryption works. Since the library does not
1178 support encryption at the moment, we use a pre-generated encrypted
1179 ZIP file."""
Thomas Wouterscf297e42007-02-23 15:07:44 +00001180
1181 data = (
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001182 b'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1183 b'\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1184 b'\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1185 b'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1186 b'\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1187 b'\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1188 b'\x00\x00L\x00\x00\x00\x00\x00' )
Christian Heimesfdab48e2008-01-20 09:06:41 +00001189 data2 = (
1190 b'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1191 b'\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1192 b'\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1193 b'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1194 b'\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1195 b'\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1196 b'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1197 b'\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Thomas Wouterscf297e42007-02-23 15:07:44 +00001198
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001199 plain = b'zipfile.py encryption test'
Christian Heimesfdab48e2008-01-20 09:06:41 +00001200 plain2 = b'\x00'*512
Thomas Wouterscf297e42007-02-23 15:07:44 +00001201
1202 def setUp(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001203 with open(TESTFN, "wb") as fp:
1204 fp.write(self.data)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001205 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti35386712009-12-31 13:22:41 +00001206 with open(TESTFN2, "wb") as fp:
1207 fp.write(self.data2)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001208 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001209
1210 def tearDown(self):
1211 self.zip.close()
1212 os.unlink(TESTFN)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001213 self.zip2.close()
1214 os.unlink(TESTFN2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001215
Ezio Melottiafd0d112009-07-15 17:17:17 +00001216 def test_no_password(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001217 # Reading the encrypted file without password
1218 # must generate a RunTime exception
1219 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001220 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001221
Ezio Melottiafd0d112009-07-15 17:17:17 +00001222 def test_bad_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001223 self.zip.setpassword(b"perl")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001224 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001225 self.zip2.setpassword(b"perl")
1226 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001227
Ezio Melotti975077a2011-05-19 22:03:22 +03001228 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001229 def test_good_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001230 self.zip.setpassword(b"python")
Ezio Melotti35386712009-12-31 13:22:41 +00001231 self.assertEqual(self.zip.read("test.txt"), self.plain)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001232 self.zip2.setpassword(b"12345")
Ezio Melotti35386712009-12-31 13:22:41 +00001233 self.assertEqual(self.zip2.read("zero"), self.plain2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001234
R. David Murray8d855d82010-12-21 21:53:37 +00001235 def test_unicode_password(self):
1236 self.assertRaises(TypeError, self.zip.setpassword, "unicode")
1237 self.assertRaises(TypeError, self.zip.read, "test.txt", "python")
1238 self.assertRaises(TypeError, self.zip.open, "test.txt", pwd="python")
1239 self.assertRaises(TypeError, self.zip.extract, "test.txt", pwd="python")
1240
Guido van Rossumd8faa362007-04-27 19:54:29 +00001241
1242class TestsWithRandomBinaryFiles(unittest.TestCase):
1243 def setUp(self):
1244 datacount = randint(16, 64)*1024 + randint(1, 1024)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001245 self.data = b''.join(struct.pack('<f', random()*randint(-1000, 1000))
1246 for i in range(datacount))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001247
1248 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +00001249 with open(TESTFN, "wb") as fp:
1250 fp.write(self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001251
1252 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001253 unlink(TESTFN)
1254 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001255
Ezio Melottiafd0d112009-07-15 17:17:17 +00001256 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001257 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001258 with zipfile.ZipFile(f, "w", compression) as zipfp:
1259 zipfp.write(TESTFN, "another.name")
1260 zipfp.write(TESTFN, TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001261
Ezio Melottiafd0d112009-07-15 17:17:17 +00001262 def zip_test(self, f, compression):
1263 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001264
1265 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001266 with zipfile.ZipFile(f, "r", compression) as zipfp:
1267 testdata = zipfp.read(TESTFN)
1268 self.assertEqual(len(testdata), len(self.data))
1269 self.assertEqual(testdata, self.data)
1270 self.assertEqual(zipfp.read("another.name"), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001271 if not isinstance(f, str):
1272 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001273
Ezio Melottiafd0d112009-07-15 17:17:17 +00001274 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001275 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001276 self.zip_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001277
Ezio Melotti975077a2011-05-19 22:03:22 +03001278 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001279 def test_deflated(self):
1280 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1281 self.zip_test(f, zipfile.ZIP_DEFLATED)
1282
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001283 @requires_bz2
1284 def test_bzip2(self):
1285 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1286 self.zip_test(f, zipfile.ZIP_BZIP2)
1287
Ezio Melottiafd0d112009-07-15 17:17:17 +00001288 def zip_open_test(self, f, compression):
1289 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001290
1291 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001292 with zipfile.ZipFile(f, "r", compression) as zipfp:
1293 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001294 with zipfp.open(TESTFN) as zipopen1:
1295 while True:
1296 read_data = zipopen1.read(256)
1297 if not read_data:
1298 break
1299 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001300
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001301 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001302 with zipfp.open("another.name") as zipopen2:
1303 while True:
1304 read_data = zipopen2.read(256)
1305 if not read_data:
1306 break
1307 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001308
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001309 testdata1 = b''.join(zipdata1)
1310 self.assertEqual(len(testdata1), len(self.data))
1311 self.assertEqual(testdata1, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001312
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001313 testdata2 = b''.join(zipdata2)
Ezio Melotti35386712009-12-31 13:22:41 +00001314 self.assertEqual(len(testdata2), len(self.data))
1315 self.assertEqual(testdata2, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001316 if not isinstance(f, str):
1317 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001318
Ezio Melottiafd0d112009-07-15 17:17:17 +00001319 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001320 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001321 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001322
Ezio Melotti975077a2011-05-19 22:03:22 +03001323 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001324 def test_open_deflated(self):
1325 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1326 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1327
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001328 @requires_bz2
1329 def test_open_bzip2(self):
1330 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1331 self.zip_open_test(f, zipfile.ZIP_BZIP2)
1332
Ezio Melottiafd0d112009-07-15 17:17:17 +00001333 def zip_random_open_test(self, f, compression):
1334 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001335
1336 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001337 with zipfile.ZipFile(f, "r", compression) as zipfp:
1338 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001339 with zipfp.open(TESTFN) as zipopen1:
1340 while True:
1341 read_data = zipopen1.read(randint(1, 1024))
1342 if not read_data:
1343 break
1344 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001345
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001346 testdata = b''.join(zipdata1)
1347 self.assertEqual(len(testdata), len(self.data))
1348 self.assertEqual(testdata, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001349 if not isinstance(f, str):
1350 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001351
Ezio Melottiafd0d112009-07-15 17:17:17 +00001352 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001353 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001354 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001355
Ezio Melotti975077a2011-05-19 22:03:22 +03001356 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001357 def test_random_open_deflated(self):
1358 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1359 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1360
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001361 @requires_bz2
1362 def test_random_open_bzip2(self):
1363 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1364 self.zip_random_open_test(f, zipfile.ZIP_BZIP2)
1365
Ezio Melotti76430242009-07-11 18:28:48 +00001366
Ezio Melotti975077a2011-05-19 22:03:22 +03001367@requires_zlib
Guido van Rossumd8faa362007-04-27 19:54:29 +00001368class TestsWithMultipleOpens(unittest.TestCase):
1369 def setUp(self):
1370 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001371 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1372 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1373 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001374
Ezio Melottiafd0d112009-07-15 17:17:17 +00001375 def test_same_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001376 # Verify that (when the ZipFile is in control of creating file objects)
1377 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001378 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001379 with zipf.open('ones') as zopen1, zipf.open('ones') as zopen2:
1380 data1 = zopen1.read(500)
1381 data2 = zopen2.read(500)
1382 data1 += zopen1.read(500)
1383 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001384 self.assertEqual(data1, data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001385
Ezio Melottiafd0d112009-07-15 17:17:17 +00001386 def test_different_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001387 # Verify that (when the ZipFile is in control of creating file objects)
1388 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001389 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001390 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1391 data1 = zopen1.read(500)
1392 data2 = zopen2.read(500)
1393 data1 += zopen1.read(500)
1394 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001395 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1396 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001397
Ezio Melottiafd0d112009-07-15 17:17:17 +00001398 def test_interleaved(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001399 # Verify that (when the ZipFile is in control of creating file objects)
1400 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001401 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001402 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1403 data1 = zopen1.read(500)
1404 data2 = zopen2.read(500)
1405 data1 += zopen1.read(500)
1406 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001407 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1408 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001409
1410 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001411 unlink(TESTFN2)
1412
Guido van Rossumd8faa362007-04-27 19:54:29 +00001413
Martin v. Löwis59e47792009-01-24 14:10:07 +00001414class TestWithDirectory(unittest.TestCase):
1415 def setUp(self):
1416 os.mkdir(TESTFN2)
1417
Ezio Melottiafd0d112009-07-15 17:17:17 +00001418 def test_extract_dir(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001419 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1420 zipf.extractall(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001421 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1422 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1423 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1424
Ezio Melottiafd0d112009-07-15 17:17:17 +00001425 def test_bug_6050(self):
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001426 # Extraction should succeed if directories already exist
1427 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottiafd0d112009-07-15 17:17:17 +00001428 self.test_extract_dir()
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001429
Ezio Melottiafd0d112009-07-15 17:17:17 +00001430 def test_store_dir(self):
Martin v. Löwis59e47792009-01-24 14:10:07 +00001431 os.mkdir(os.path.join(TESTFN2, "x"))
1432 zipf = zipfile.ZipFile(TESTFN, "w")
1433 zipf.write(os.path.join(TESTFN2, "x"), "x")
1434 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1435
1436 def tearDown(self):
1437 shutil.rmtree(TESTFN2)
1438 if os.path.exists(TESTFN):
Ezio Melotti76430242009-07-11 18:28:48 +00001439 unlink(TESTFN)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001440
Guido van Rossumd8faa362007-04-27 19:54:29 +00001441
1442class UniversalNewlineTests(unittest.TestCase):
1443 def setUp(self):
Guido van Rossum9c627722007-08-27 18:31:48 +00001444 self.line_gen = [bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001445 for i in range(FIXEDTEST_SIZE)]
Guido van Rossumd8faa362007-04-27 19:54:29 +00001446 self.seps = ('\r', '\r\n', '\n')
1447 self.arcdata, self.arcfiles = {}, {}
1448 for n, s in enumerate(self.seps):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001449 b = s.encode("ascii")
1450 self.arcdata[s] = b.join(self.line_gen) + b
Guido van Rossumd8faa362007-04-27 19:54:29 +00001451 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001452 f = open(self.arcfiles[s], "wb")
1453 try:
1454 f.write(self.arcdata[s])
1455 finally:
1456 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001457
Ezio Melottiafd0d112009-07-15 17:17:17 +00001458 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001459 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001460 with zipfile.ZipFile(f, "w", compression) as zipfp:
1461 for fn in self.arcfiles.values():
1462 zipfp.write(fn, fn)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001463
Ezio Melottiafd0d112009-07-15 17:17:17 +00001464 def read_test(self, f, compression):
1465 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001466
1467 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001468 with zipfile.ZipFile(f, "r") as zipfp:
1469 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001470 with zipfp.open(fn, "rU") as fp:
1471 zipdata = fp.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001472 self.assertEqual(self.arcdata[sep], zipdata)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001473 if not isinstance(f, str):
1474 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001475
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001476 def readline_read_test(self, f, compression):
1477 self.make_test_archive(f, compression)
1478
1479 # Read the ZIP archive
Brian Curtin8fb9b862010-11-18 02:15:28 +00001480 with zipfile.ZipFile(f, "r") as zipfp:
1481 for sep, fn in self.arcfiles.items():
1482 with zipfp.open(fn, "rU") as zipopen:
1483 data = b''
1484 while True:
1485 read = zipopen.readline()
1486 if not read:
1487 break
1488 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001489
Brian Curtin8fb9b862010-11-18 02:15:28 +00001490 read = zipopen.read(5)
1491 if not read:
1492 break
1493 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001494
1495 self.assertEqual(data, self.arcdata['\n'])
1496
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001497 if not isinstance(f, str):
1498 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001499
Ezio Melottiafd0d112009-07-15 17:17:17 +00001500 def readline_test(self, f, compression):
1501 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001502
1503 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001504 with zipfile.ZipFile(f, "r") as zipfp:
1505 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001506 with zipfp.open(fn, "rU") as zipopen:
1507 for line in self.line_gen:
1508 linedata = zipopen.readline()
1509 self.assertEqual(linedata, line + b'\n')
1510 if not isinstance(f, str):
1511 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001512
Ezio Melottiafd0d112009-07-15 17:17:17 +00001513 def readlines_test(self, f, compression):
1514 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001515
1516 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001517 with zipfile.ZipFile(f, "r") as zipfp:
1518 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001519 with zipfp.open(fn, "rU") as fp:
1520 ziplines = fp.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001521 for line, zipline in zip(self.line_gen, ziplines):
1522 self.assertEqual(zipline, line + b'\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001523 if not isinstance(f, str):
1524 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001525
Ezio Melottiafd0d112009-07-15 17:17:17 +00001526 def iterlines_test(self, f, compression):
1527 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001528
1529 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001530 with zipfile.ZipFile(f, "r") as zipfp:
1531 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001532 with zipfp.open(fn, "rU") as fp:
1533 for line, zipline in zip(self.line_gen, fp):
1534 self.assertEqual(zipline, line + b'\n')
1535 if not isinstance(f, str):
1536 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001537
Ezio Melottiafd0d112009-07-15 17:17:17 +00001538 def test_read_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001539 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001540 self.read_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001541
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001542 def test_readline_read_stored(self):
1543 # Issue #7610: calls to readline() interleaved with calls to read().
1544 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1545 self.readline_read_test(f, zipfile.ZIP_STORED)
1546
Ezio Melottiafd0d112009-07-15 17:17:17 +00001547 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001548 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001549 self.readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001550
Ezio Melottiafd0d112009-07-15 17:17:17 +00001551 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001552 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001553 self.readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001554
Ezio Melottiafd0d112009-07-15 17:17:17 +00001555 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001556 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001557 self.iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001558
Ezio Melotti975077a2011-05-19 22:03:22 +03001559 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001560 def test_read_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001561 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001562 self.read_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001563
Ezio Melotti975077a2011-05-19 22:03:22 +03001564 @requires_zlib
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001565 def test_readline_read_deflated(self):
1566 # Issue #7610: calls to readline() interleaved with calls to read().
1567 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1568 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1569
Ezio Melotti975077a2011-05-19 22:03:22 +03001570 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001571 def test_readline_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001572 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001573 self.readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001574
Ezio Melotti975077a2011-05-19 22:03:22 +03001575 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001576 def test_readlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001577 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001578 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001579
Ezio Melotti975077a2011-05-19 22:03:22 +03001580 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001581 def test_iterlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001582 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001583 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001584
Martin v. Löwisf6b16a42012-05-01 07:58:44 +02001585 @requires_bz2
1586 def test_read_bzip2(self):
1587 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1588 self.read_test(f, zipfile.ZIP_BZIP2)
1589
1590 @requires_bz2
1591 def test_readline_read_bzip2(self):
1592 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1593 self.readline_read_test(f, zipfile.ZIP_BZIP2)
1594
1595 @requires_bz2
1596 def test_readline_bzip2(self):
1597 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1598 self.readline_test(f, zipfile.ZIP_BZIP2)
1599
1600 @requires_bz2
1601 def test_readlines_bzip2(self):
1602 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1603 self.readlines_test(f, zipfile.ZIP_BZIP2)
1604
1605 @requires_bz2
1606 def test_iterlines_bzip2(self):
1607 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1608 self.iterlines_test(f, zipfile.ZIP_BZIP2)
1609
Guido van Rossumd8faa362007-04-27 19:54:29 +00001610 def tearDown(self):
1611 for sep, fn in self.arcfiles.items():
1612 os.remove(fn)
Ezio Melotti76430242009-07-11 18:28:48 +00001613 unlink(TESTFN)
1614 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001615
1616
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001617def test_main():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001618 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1619 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti76430242009-07-11 18:28:48 +00001620 TestWithDirectory, UniversalNewlineTests,
1621 TestsWithRandomBinaryFiles)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001622
1623if __name__ == "__main__":
1624 test_main()