blob: 96637159bfc5434e3236851a466f3bee0580ecd2 [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
Ezio Melotti975077a2011-05-19 22:03:22 +030016from test.support import TESTFN, run_unittest, findfile, unlink, requires_zlib
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
Ezio Melottiafd0d112009-07-15 17:17:17 +0000316 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000317 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
318 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000319
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000320 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
321 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000322
Ezio Melottiafd0d112009-07-15 17:17:17 +0000323 def test_append_to_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000324 """Test appending to an existing zipfile."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000325 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
326 zipfp.write(TESTFN, TESTFN)
327
328 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
329 zipfp.writestr("strfile", self.data)
330 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000331
Ezio Melottiafd0d112009-07-15 17:17:17 +0000332 def test_append_to_non_zip_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000333 """Test appending to an existing file that is not a zipfile."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000334 # NOTE: this test fails if len(d) < 22 because of the first
335 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti35386712009-12-31 13:22:41 +0000336 data = b'I am not a ZipFile!'*10
337 with open(TESTFN2, 'wb') as f:
338 f.write(data)
339
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000340 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
341 zipfp.write(TESTFN, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000342
Ezio Melotti35386712009-12-31 13:22:41 +0000343 with open(TESTFN2, 'rb') as f:
344 f.seek(len(data))
345 with zipfile.ZipFile(f, "r") as zipfp:
346 self.assertEqual(zipfp.namelist(), [TESTFN])
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000347
Ezio Melottiafd0d112009-07-15 17:17:17 +0000348 def test_write_default_name(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000349 """Check that calling ZipFile.write without arcname specified
350 produces the expected result."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000351 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
352 zipfp.write(TESTFN)
Brian Curtin8fb9b862010-11-18 02:15:28 +0000353 with open(TESTFN, "rb") as f:
354 self.assertEqual(zipfp.read(TESTFN), f.read())
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000355
Ezio Melotti975077a2011-05-19 22:03:22 +0300356 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000357 def test_per_file_compression(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000358 """Check that files within a Zip archive can have different
359 compression options."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000360 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
361 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
362 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
363 sinfo = zipfp.getinfo('storeme')
364 dinfo = zipfp.getinfo('deflateme')
365 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
366 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000367
Ezio Melottiafd0d112009-07-15 17:17:17 +0000368 def test_write_to_readonly(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000369 """Check that trying to call write() on a readonly ZipFile object
370 raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000371 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
372 zipfp.writestr("somefile.txt", "bogus")
373
374 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
375 self.assertRaises(RuntimeError, zipfp.write, TESTFN)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000376
Ezio Melottiafd0d112009-07-15 17:17:17 +0000377 def test_extract(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000378 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
379 for fpath, fdata in SMALL_TEST_DATA:
380 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000381
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000382 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
383 for fpath, fdata in SMALL_TEST_DATA:
384 writtenfile = zipfp.extract(fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000385
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000386 # make sure it was written to the right place
387 if os.path.isabs(fpath):
388 correctfile = os.path.join(os.getcwd(), fpath[1:])
389 else:
390 correctfile = os.path.join(os.getcwd(), fpath)
391 correctfile = os.path.normpath(correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000392
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000393 self.assertEqual(writtenfile, correctfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000394
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000395 # make sure correct data is in correct file
Brian Curtin8fb9b862010-11-18 02:15:28 +0000396 with open(writtenfile, "rb") as f:
397 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000398
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000399 os.remove(writtenfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000400
401 # remove the test file subdirectories
402 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
403
Ezio Melottiafd0d112009-07-15 17:17:17 +0000404 def test_extract_all(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000405 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
406 for fpath, fdata in SMALL_TEST_DATA:
407 zipfp.writestr(fpath, fdata)
Christian Heimes790c8232008-01-07 21:14:23 +0000408
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000409 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
410 zipfp.extractall()
411 for fpath, fdata in SMALL_TEST_DATA:
412 if os.path.isabs(fpath):
413 outfile = os.path.join(os.getcwd(), fpath[1:])
414 else:
415 outfile = os.path.join(os.getcwd(), fpath)
Christian Heimes790c8232008-01-07 21:14:23 +0000416
Brian Curtin8fb9b862010-11-18 02:15:28 +0000417 with open(outfile, "rb") as f:
418 self.assertEqual(fdata.encode(), f.read())
Christian Heimes790c8232008-01-07 21:14:23 +0000419
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000420 os.remove(outfile)
Christian Heimes790c8232008-01-07 21:14:23 +0000421
422 # remove the test file subdirectories
423 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
424
Ezio Melotti975077a2011-05-19 22:03:22 +0300425 def test_writestr_compression_stored(self):
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000426 zipfp = zipfile.ZipFile(TESTFN2, "w")
427 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000428 info = zipfp.getinfo('a.txt')
429 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
430
Ezio Melotti975077a2011-05-19 22:03:22 +0300431 @requires_zlib
432 def test_writestr_compression_deflated(self):
433 zipfp = zipfile.ZipFile(TESTFN2, "w")
434 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
435 info = zipfp.getinfo('b.txt')
436 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
Ronald Oussorenee5c8852010-02-07 20:24:02 +0000437
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000438 def zip_test_writestr_permissions(self, f, compression):
439 # Make sure that writestr creates files with mode 0600,
440 # when it is passed a name rather than a ZipInfo instance.
441
Ezio Melottiafd0d112009-07-15 17:17:17 +0000442 self.make_test_archive(f, compression)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000443 with zipfile.ZipFile(f, "r") as zipfp:
444 zinfo = zipfp.getinfo('strfile')
445 self.assertEqual(zinfo.external_attr, 0o600 << 16)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000446 if not isinstance(f, str):
447 f.close()
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000448
Ezio Melottiafd0d112009-07-15 17:17:17 +0000449 def test_writestr_permissions(self):
Antoine Pitrou6e1df8d2008-07-25 19:58:18 +0000450 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
451 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
452
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000453 def test_writestr_extended_local_header_issue1202(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000454 with zipfile.ZipFile(TESTFN2, 'w') as orig_zip:
455 for data in 'abcdefghijklmnop':
456 zinfo = zipfile.ZipInfo(data)
457 zinfo.flag_bits |= 0x08 # Include an extended local header.
458 orig_zip.writestr(zinfo, data)
459
460 def test_close(self):
461 """Check that the zipfile is closed after the 'with' block."""
462 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
463 for fpath, fdata in SMALL_TEST_DATA:
464 zipfp.writestr(fpath, fdata)
465 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
466 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
467
468 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
469 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
470 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
471
472 def test_close_on_exception(self):
473 """Check that the zipfile is closed if an exception is raised in the
474 'with' block."""
475 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
476 for fpath, fdata in SMALL_TEST_DATA:
477 zipfp.writestr(fpath, fdata)
478
479 try:
480 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
Georg Brandl4d540882010-10-28 06:42:33 +0000481 raise zipfile.BadZipFile()
482 except zipfile.BadZipFile:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000483 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
Gregory P. Smithb0d9ca92009-07-07 05:06:04 +0000484
Ezio Melotti975077a2011-05-19 22:03:22 +0300485 @requires_zlib
Georg Brandl5ba11de2011-01-01 10:09:32 +0000486 def test_unicode_filenames(self):
Georg Brandl04480a82011-01-01 10:42:31 +0000487 # bug #10801
488 fname = findfile('zip_cp437_header.zip')
Georg Brandl5ba11de2011-01-01 10:09:32 +0000489 with zipfile.ZipFile(fname) as zipfp:
Georg Brandl04480a82011-01-01 10:42:31 +0000490 for name in zipfp.namelist():
491 zipfp.open(name).close()
Georg Brandl5ba11de2011-01-01 10:09:32 +0000492
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000493 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000494 unlink(TESTFN)
495 unlink(TESTFN2)
496
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000497
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000498class TestZip64InSmallFiles(unittest.TestCase):
499 # These tests test the ZIP64 functionality without using large files,
500 # see test_zipfile64 for proper tests.
501
502 def setUp(self):
503 self._limit = zipfile.ZIP64_LIMIT
504 zipfile.ZIP64_LIMIT = 5
505
Guido van Rossum9c627722007-08-27 18:31:48 +0000506 line_gen = (bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000507 for i in range(0, FIXEDTEST_SIZE))
508 self.data = b'\n'.join(line_gen)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000509
510 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +0000511 with open(TESTFN, "wb") as fp:
512 fp.write(self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000513
Ezio Melottiafd0d112009-07-15 17:17:17 +0000514 def large_file_exception_test(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000515 with zipfile.ZipFile(f, "w", compression) as zipfp:
516 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000517 zipfp.write, TESTFN, "another.name")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000518
Ezio Melottiafd0d112009-07-15 17:17:17 +0000519 def large_file_exception_test2(self, f, compression):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000520 with zipfile.ZipFile(f, "w", compression) as zipfp:
521 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti35386712009-12-31 13:22:41 +0000522 zipfp.writestr, "another.name", self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000523 if not isinstance(f, str):
524 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000525
Ezio Melottiafd0d112009-07-15 17:17:17 +0000526 def test_large_file_exception(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000527 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000528 self.large_file_exception_test(f, zipfile.ZIP_STORED)
529 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000530
Ezio Melottiafd0d112009-07-15 17:17:17 +0000531 def zip_test(self, f, compression):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000532 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000533 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
534 zipfp.write(TESTFN, "another.name")
535 zipfp.write(TESTFN, TESTFN)
536 zipfp.writestr("strfile", self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000537
538 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000539 with zipfile.ZipFile(f, "r", compression) as zipfp:
540 self.assertEqual(zipfp.read(TESTFN), self.data)
541 self.assertEqual(zipfp.read("another.name"), self.data)
542 self.assertEqual(zipfp.read("strfile"), self.data)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000543
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000544 # Print the ZIP directory
545 fp = io.StringIO()
546 zipfp.printdir(fp)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000547
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000548 directory = fp.getvalue()
549 lines = directory.splitlines()
Ezio Melotti35386712009-12-31 13:22:41 +0000550 self.assertEqual(len(lines), 4) # Number of files + header
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000551
Benjamin Peterson577473f2010-01-19 00:09:57 +0000552 self.assertIn('File Name', lines[0])
553 self.assertIn('Modified', lines[0])
554 self.assertIn('Size', lines[0])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000555
Ezio Melotti35386712009-12-31 13:22:41 +0000556 fn, date, time_, size = lines[1].split()
557 self.assertEqual(fn, 'another.name')
558 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
559 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
560 self.assertEqual(size, str(len(self.data)))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000561
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000562 # Check the namelist
563 names = zipfp.namelist()
Ezio Melotti35386712009-12-31 13:22:41 +0000564 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000565 self.assertIn(TESTFN, names)
566 self.assertIn("another.name", names)
567 self.assertIn("strfile", names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000568
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000569 # Check infolist
570 infos = zipfp.infolist()
Ezio Melotti35386712009-12-31 13:22:41 +0000571 names = [i.filename for i in infos]
572 self.assertEqual(len(names), 3)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000573 self.assertIn(TESTFN, names)
574 self.assertIn("another.name", names)
575 self.assertIn("strfile", names)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000576 for i in infos:
Ezio Melotti35386712009-12-31 13:22:41 +0000577 self.assertEqual(i.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000578
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000579 # check getinfo
580 for nm in (TESTFN, "another.name", "strfile"):
581 info = zipfp.getinfo(nm)
Ezio Melotti35386712009-12-31 13:22:41 +0000582 self.assertEqual(info.filename, nm)
583 self.assertEqual(info.file_size, len(self.data))
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000584
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000585 # Check that testzip doesn't raise an exception
586 zipfp.testzip()
Benjamin Petersond285bdb2010-10-31 17:57:22 +0000587 if not isinstance(f, str):
588 f.close()
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000589
Ezio Melottiafd0d112009-07-15 17:17:17 +0000590 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000591 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000592 self.zip_test(f, zipfile.ZIP_STORED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000593
Ezio Melotti975077a2011-05-19 22:03:22 +0300594 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +0000595 def test_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +0000596 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000597 self.zip_test(f, zipfile.ZIP_DEFLATED)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000598
Ezio Melottiafd0d112009-07-15 17:17:17 +0000599 def test_absolute_arcnames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000600 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
601 allowZip64=True) as zipfp:
602 zipfp.write(TESTFN, "/absolute")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000603
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000604 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
605 self.assertEqual(zipfp.namelist(), ["absolute"])
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000606
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000607 def tearDown(self):
608 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti76430242009-07-11 18:28:48 +0000609 unlink(TESTFN)
610 unlink(TESTFN2)
611
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000612
613class PyZipFileTests(unittest.TestCase):
Ezio Melottiafd0d112009-07-15 17:17:17 +0000614 def test_write_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000615 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000616 fn = __file__
617 if fn.endswith('.pyc') or fn.endswith('.pyo'):
Barry Warsaw28a691b2010-04-17 00:19:56 +0000618 path_split = fn.split(os.sep)
619 if os.altsep is not None:
620 path_split.extend(fn.split(os.altsep))
621 if '__pycache__' in path_split:
622 fn = imp.source_from_cache(fn)
623 else:
624 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000625
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000626 zipfp.writepy(fn)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000627
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000628 bn = os.path.basename(fn)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000629 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000630 self.assertTrue(bn + 'o' in zipfp.namelist() or
631 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000632
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000633 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000634 fn = __file__
Ezio Melotti35386712009-12-31 13:22:41 +0000635 if fn.endswith(('.pyc', '.pyo')):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000636 fn = fn[:-1]
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000637
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000638 zipfp.writepy(fn, "testpackage")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000639
Ezio Melotti35386712009-12-31 13:22:41 +0000640 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Benjamin Peterson577473f2010-01-19 00:09:57 +0000641 self.assertNotIn(bn, zipfp.namelist())
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000642 self.assertTrue(bn + 'o' in zipfp.namelist() or
643 bn + 'c' in zipfp.namelist())
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000644
Ezio Melottiafd0d112009-07-15 17:17:17 +0000645 def test_write_python_package(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000646 import email
647 packagedir = os.path.dirname(email.__file__)
648
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000649 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000650 zipfp.writepy(packagedir)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000651
Ezio Melotti35386712009-12-31 13:22:41 +0000652 # Check for a couple of modules at different levels of the
653 # hierarchy
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000654 names = zipfp.namelist()
655 self.assertTrue('email/__init__.pyo' in names or
656 'email/__init__.pyc' in names)
657 self.assertTrue('email/mime/text.pyo' in names or
658 'email/mime/text.pyc' in names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000659
Georg Brandl8334fd92010-12-04 10:26:46 +0000660 def test_write_with_optimization(self):
661 import email
662 packagedir = os.path.dirname(email.__file__)
663 # use .pyc if running test in optimization mode,
664 # use .pyo if running test in debug mode
665 optlevel = 1 if __debug__ else 0
666 ext = '.pyo' if optlevel == 1 else '.pyc'
667
668 with TemporaryFile() as t, \
669 zipfile.PyZipFile(t, "w", optimize=optlevel) as zipfp:
670 zipfp.writepy(packagedir)
671
672 names = zipfp.namelist()
673 self.assertIn('email/__init__' + ext, names)
674 self.assertIn('email/mime/text' + ext, names)
675
Ezio Melottiafd0d112009-07-15 17:17:17 +0000676 def test_write_python_directory(self):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000677 os.mkdir(TESTFN2)
678 try:
Ezio Melotti35386712009-12-31 13:22:41 +0000679 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
680 fp.write("print(42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000681
Ezio Melotti35386712009-12-31 13:22:41 +0000682 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
683 fp.write("print(42 * 42)\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000684
Ezio Melotti35386712009-12-31 13:22:41 +0000685 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
686 fp.write("bla bla bla\n")
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000687
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000688 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
689 zipfp.writepy(TESTFN2)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000690
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000691 names = zipfp.namelist()
692 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
693 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
694 self.assertNotIn('mod2.txt', names)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000695
696 finally:
697 shutil.rmtree(TESTFN2)
698
Ezio Melottiafd0d112009-07-15 17:17:17 +0000699 def test_write_non_pyfile(self):
Łukasz Langaa9f054b2010-11-23 00:15:02 +0000700 with TemporaryFile() as t, zipfile.PyZipFile(t, "w") as zipfp:
Brian Curtin8fb9b862010-11-18 02:15:28 +0000701 with open(TESTFN, 'w') as f:
702 f.write('most definitely not a python file')
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000703 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
704 os.remove(TESTFN)
705
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000706
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000707class OtherTests(unittest.TestCase):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000708 zips_with_bad_crc = {
709 zipfile.ZIP_STORED: (
710 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
711 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
712 b'ilehello,AworldP'
713 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
714 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
715 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
716 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
717 b'\0\0/\0\0\0\0\0'),
718 zipfile.ZIP_DEFLATED: (
719 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
720 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
721 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
722 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
723 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
724 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
725 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
726 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
727 }
728
Ezio Melottiafd0d112009-07-15 17:17:17 +0000729 def test_unicode_filenames(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000730 with zipfile.ZipFile(TESTFN, "w") as zf:
731 zf.writestr("foo.txt", "Test for unicode filename")
732 zf.writestr("\xf6.txt", "Test for unicode filename")
Ezio Melottie9615932010-01-24 19:26:24 +0000733 self.assertIsInstance(zf.infolist()[0].filename, str)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000734
735 with zipfile.ZipFile(TESTFN, "r") as zf:
736 self.assertEqual(zf.filelist[0].filename, "foo.txt")
737 self.assertEqual(zf.filelist[1].filename, "\xf6.txt")
Martin v. Löwis8570f6a2008-05-05 17:44:38 +0000738
Ezio Melottiafd0d112009-07-15 17:17:17 +0000739 def test_create_non_existent_file_for_append(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +0000740 if os.path.exists(TESTFN):
741 os.unlink(TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000742
Thomas Wouterscf297e42007-02-23 15:07:44 +0000743 filename = 'testfile.txt'
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000744 content = b'hello, world. this is some content.'
Guido van Rossumd8faa362007-04-27 19:54:29 +0000745
Thomas Wouterscf297e42007-02-23 15:07:44 +0000746 try:
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000747 with zipfile.ZipFile(TESTFN, 'a') as zf:
748 zf.writestr(filename, content)
Thomas Wouterscf297e42007-02-23 15:07:44 +0000749 except IOError:
750 self.fail('Could not append data to a non-existent zip file.')
751
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000752 self.assertTrue(os.path.exists(TESTFN))
Thomas Wouterscf297e42007-02-23 15:07:44 +0000753
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000754 with zipfile.ZipFile(TESTFN, 'r') as zf:
755 self.assertEqual(zf.read(filename), content)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000756
Ezio Melottiafd0d112009-07-15 17:17:17 +0000757 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000758 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti35386712009-12-31 13:22:41 +0000759 # it opens if there's an error in the file. If it doesn't, the
760 # traceback holds a reference to the ZipFile object and, indirectly,
761 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000762 # On Windows, this causes the os.unlink() call to fail because the
763 # underlying file is still open. This is SF bug #412214.
764 #
Ezio Melotti35386712009-12-31 13:22:41 +0000765 with open(TESTFN, "w") as fp:
766 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000767 try:
768 zf = zipfile.ZipFile(TESTFN)
Georg Brandl4d540882010-10-28 06:42:33 +0000769 except zipfile.BadZipFile:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000770 pass
771
Ezio Melottiafd0d112009-07-15 17:17:17 +0000772 def test_is_zip_erroneous_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000773 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000774 # - passing a filename
775 with open(TESTFN, "w") as fp:
776 fp.write("this is not a legal zip file\n")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000777 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti35386712009-12-31 13:22:41 +0000778 self.assertFalse(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000779 # - passing a file object
780 with open(TESTFN, "rb") as fp:
781 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000782 self.assertTrue(not chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000783 # - passing a file-like object
784 fp = io.BytesIO()
785 fp.write(b"this is not a legal zip file\n")
786 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000787 self.assertTrue(not chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000788 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000789 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000790 self.assertTrue(not chk)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000791
Ezio Melottiafd0d112009-07-15 17:17:17 +0000792 def test_is_zip_valid_file(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000793 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000794 # - passing a filename
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000795 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
796 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
797
Guido van Rossumd8faa362007-04-27 19:54:29 +0000798 chk = zipfile.is_zipfile(TESTFN)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000799 self.assertTrue(chk)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000800 # - passing a file object
801 with open(TESTFN, "rb") as fp:
802 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000803 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000804 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000805 zip_contents = fp.read()
806 # - passing a file-like object
807 fp = io.BytesIO()
808 fp.write(zip_contents)
809 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000810 self.assertTrue(chk)
Ezio Melotti35386712009-12-31 13:22:41 +0000811 fp.seek(0, 0)
Antoine Pitroudb5fe662008-12-27 15:50:40 +0000812 chk = zipfile.is_zipfile(fp)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000813 self.assertTrue(chk)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000814
Ezio Melottiafd0d112009-07-15 17:17:17 +0000815 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000816 # make sure we don't raise an AttributeError when a partially-constructed
817 # ZipFile instance is finalized; this tests for regression on SF tracker
818 # bug #403871.
819
820 # The bug we're testing for caused an AttributeError to be raised
821 # when a ZipFile instance was created for a file that did not
822 # exist; the .fp member was not initialized but was needed by the
823 # __del__() method. Since the AttributeError is in the __del__(),
824 # it is ignored, but the user should be sufficiently annoyed by
825 # the message on the output that regression will be noticed
826 # quickly.
827 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
828
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000829 def test_empty_file_raises_BadZipFile(self):
830 f = open(TESTFN, 'w')
831 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +0000832 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000833
Ezio Melotti35386712009-12-31 13:22:41 +0000834 with open(TESTFN, 'w') as fp:
835 fp.write("short file")
Georg Brandl4d540882010-10-28 06:42:33 +0000836 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN)
Amaury Forgeot d'Arcbc347802009-07-28 22:18:57 +0000837
Ezio Melottiafd0d112009-07-15 17:17:17 +0000838 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000839 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Guido van Rossumd6ca5462007-05-22 01:29:33 +0000840 data = io.BytesIO()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000841 with zipfile.ZipFile(data, mode="w") as zipf:
842 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000843
844 # This is correct; calling .read on a closed ZipFile should throw
845 # a RuntimeError, and so should calling .testzip. An earlier
846 # version of .testzip would swallow this exception (and any other)
847 # and report that the first file in the archive was corrupt.
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000848 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
849 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000850 self.assertRaises(RuntimeError, zipf.testzip)
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000851 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Brian Curtin8fb9b862010-11-18 02:15:28 +0000852 with open(TESTFN, 'w') as f:
853 f.write('zipfile test data')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000854 self.assertRaises(RuntimeError, zipf.write, TESTFN)
855
Ezio Melottiafd0d112009-07-15 17:17:17 +0000856 def test_bad_constructor_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000857 """Check that bad modes passed to ZipFile constructor are caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000858 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
859
Ezio Melottiafd0d112009-07-15 17:17:17 +0000860 def test_bad_open_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000861 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000862 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
863 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
864
865 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000866 # read the data to make sure the file is there
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000867 zipf.read("foo.txt")
868 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000869
Ezio Melottiafd0d112009-07-15 17:17:17 +0000870 def test_read0(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000871 """Check that calling read(0) on a ZipExtFile object returns an empty
872 string and doesn't advance file pointer."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000873 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
874 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
875 # read the data to make sure the file is there
Brian Curtin8fb9b862010-11-18 02:15:28 +0000876 with zipf.open("foo.txt") as f:
877 for i in range(FIXEDTEST_SIZE):
878 self.assertEqual(f.read(0), b'')
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000879
Brian Curtin8fb9b862010-11-18 02:15:28 +0000880 self.assertEqual(f.read(), b"O, for a Muse of Fire!")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000881
Ezio Melottiafd0d112009-07-15 17:17:17 +0000882 def test_open_non_existent_item(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000883 """Check that attempting to call open() for an item that doesn't
884 exist in the archive raises a RuntimeError."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000885 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
886 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000887
Ezio Melottiafd0d112009-07-15 17:17:17 +0000888 def test_bad_compression_mode(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000889 """Check that bad compression methods passed to ZipFile.open are
890 caught."""
Guido van Rossumb5a755e2007-07-18 18:15:48 +0000891 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
892
Ezio Melottiafd0d112009-07-15 17:17:17 +0000893 def test_null_byte_in_filename(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000894 """Check that a filename containing a null byte is properly
895 terminated."""
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000896 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
897 zipf.writestr("foo.txt\x00qqq", b"O, for a Muse of Fire!")
898 self.assertEqual(zipf.namelist(), ['foo.txt'])
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000899
Ezio Melottiafd0d112009-07-15 17:17:17 +0000900 def test_struct_sizes(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000901 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000902 self.assertEqual(zipfile.sizeEndCentDir, 22)
903 self.assertEqual(zipfile.sizeCentralDir, 46)
904 self.assertEqual(zipfile.sizeEndCentDir64, 56)
905 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
906
Ezio Melottiafd0d112009-07-15 17:17:17 +0000907 def test_comments(self):
Ezio Melotti35386712009-12-31 13:22:41 +0000908 """Check that comments on the archive are handled properly."""
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000909
910 # check default comment is empty
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000911 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
912 self.assertEqual(zipf.comment, b'')
913 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
914
915 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
916 self.assertEqual(zipfr.comment, b'')
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000917
918 # check a simple short comment
919 comment = b'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000920 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
921 zipf.comment = comment
922 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
923 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
924 self.assertEqual(zipf.comment, comment)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000925
926 # check a comment of max length
927 comment2 = ''.join(['%d' % (i**3 % 10) for i in range((1 << 16)-1)])
928 comment2 = comment2.encode("ascii")
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000929 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
930 zipf.comment = comment2
931 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
932
933 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
934 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000935
936 # check a comment that is too long is truncated
Ezio Melottifaa6b7f2009-12-30 12:34:59 +0000937 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
938 zipf.comment = comment2 + b'oops'
939 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
940 with zipfile.ZipFile(TESTFN, mode="r") as zipfr:
941 self.assertEqual(zipfr.comment, comment2)
Martin v. Löwisb09b8442008-07-03 14:13:42 +0000942
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000943 def check_testzip_with_bad_crc(self, compression):
944 """Tests that files with bad CRCs return their name from testzip."""
945 zipdata = self.zips_with_bad_crc[compression]
946
947 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
948 # testzip returns the name of the first corrupt file, or None
949 self.assertEqual('afile', zipf.testzip())
950
951 def test_testzip_with_bad_crc_stored(self):
952 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
953
Ezio Melotti975077a2011-05-19 22:03:22 +0300954 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000955 def test_testzip_with_bad_crc_deflated(self):
956 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
957
958 def check_read_with_bad_crc(self, compression):
Georg Brandl4d540882010-10-28 06:42:33 +0000959 """Tests that files with bad CRCs raise a BadZipFile exception when read."""
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000960 zipdata = self.zips_with_bad_crc[compression]
961
962 # Using ZipFile.read()
963 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
Georg Brandl4d540882010-10-28 06:42:33 +0000964 self.assertRaises(zipfile.BadZipFile, zipf.read, 'afile')
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000965
966 # Using ZipExtFile.read()
967 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
968 with zipf.open('afile', 'r') as corrupt_file:
Georg Brandl4d540882010-10-28 06:42:33 +0000969 self.assertRaises(zipfile.BadZipFile, corrupt_file.read)
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000970
971 # Same with small reads (in order to exercise the buffering logic)
972 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
973 with zipf.open('afile', 'r') as corrupt_file:
974 corrupt_file.MIN_READ_SIZE = 2
Georg Brandl4d540882010-10-28 06:42:33 +0000975 with self.assertRaises(zipfile.BadZipFile):
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000976 while corrupt_file.read(2):
977 pass
978
979 def test_read_with_bad_crc_stored(self):
980 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
981
Ezio Melotti975077a2011-05-19 22:03:22 +0300982 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +0000983 def test_read_with_bad_crc_deflated(self):
984 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
985
Antoine Pitrou6464d5f2010-09-12 14:51:20 +0000986 def check_read_return_size(self, compression):
987 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
988 # than requested.
989 for test_size in (1, 4095, 4096, 4097, 16384):
990 file_size = test_size + 1
991 junk = b''.join(struct.pack('B', randint(0, 255))
992 for x in range(file_size))
993 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
994 zipf.writestr('foo', junk)
995 with zipf.open('foo', 'r') as fp:
996 buf = fp.read(test_size)
997 self.assertEqual(len(buf), test_size)
998
999 def test_read_return_size_stored(self):
1000 self.check_read_return_size(zipfile.ZIP_STORED)
1001
Ezio Melotti975077a2011-05-19 22:03:22 +03001002 @requires_zlib
Antoine Pitrou6464d5f2010-09-12 14:51:20 +00001003 def test_read_return_size_deflated(self):
1004 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1005
Georg Brandl268e4d42010-10-14 06:59:45 +00001006 def test_empty_zipfile(self):
1007 # Check that creating a file in 'w' or 'a' mode and closing without
1008 # adding any files to the archives creates a valid empty ZIP file
1009 zipf = zipfile.ZipFile(TESTFN, mode="w")
1010 zipf.close()
1011 try:
1012 zipf = zipfile.ZipFile(TESTFN, mode="r")
1013 except zipfile.BadZipFile:
1014 self.fail("Unable to create empty ZIP file in 'w' mode")
1015
1016 zipf = zipfile.ZipFile(TESTFN, mode="a")
1017 zipf.close()
1018 try:
1019 zipf = zipfile.ZipFile(TESTFN, mode="r")
1020 except:
1021 self.fail("Unable to create empty ZIP file in 'a' mode")
1022
1023 def test_open_empty_file(self):
1024 # Issue 1710703: Check that opening a file with less than 22 bytes
Georg Brandl4d540882010-10-28 06:42:33 +00001025 # raises a BadZipFile exception (rather than the previously unhelpful
Georg Brandl268e4d42010-10-14 06:59:45 +00001026 # IOError)
1027 f = open(TESTFN, 'w')
1028 f.close()
Georg Brandl4d540882010-10-28 06:42:33 +00001029 self.assertRaises(zipfile.BadZipFile, zipfile.ZipFile, TESTFN, 'r')
Georg Brandl268e4d42010-10-14 06:59:45 +00001030
Guido van Rossumd8faa362007-04-27 19:54:29 +00001031 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001032 unlink(TESTFN)
1033 unlink(TESTFN2)
1034
Thomas Wouterscf297e42007-02-23 15:07:44 +00001035
1036class DecryptionTests(unittest.TestCase):
Ezio Melotti35386712009-12-31 13:22:41 +00001037 """Check that ZIP decryption works. Since the library does not
1038 support encryption at the moment, we use a pre-generated encrypted
1039 ZIP file."""
Thomas Wouterscf297e42007-02-23 15:07:44 +00001040
1041 data = (
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001042 b'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1043 b'\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1044 b'\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1045 b'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1046 b'\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1047 b'\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1048 b'\x00\x00L\x00\x00\x00\x00\x00' )
Christian Heimesfdab48e2008-01-20 09:06:41 +00001049 data2 = (
1050 b'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1051 b'\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1052 b'\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1053 b'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1054 b'\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1055 b'\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1056 b'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1057 b'\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Thomas Wouterscf297e42007-02-23 15:07:44 +00001058
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001059 plain = b'zipfile.py encryption test'
Christian Heimesfdab48e2008-01-20 09:06:41 +00001060 plain2 = b'\x00'*512
Thomas Wouterscf297e42007-02-23 15:07:44 +00001061
1062 def setUp(self):
Ezio Melotti35386712009-12-31 13:22:41 +00001063 with open(TESTFN, "wb") as fp:
1064 fp.write(self.data)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001065 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti35386712009-12-31 13:22:41 +00001066 with open(TESTFN2, "wb") as fp:
1067 fp.write(self.data2)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001068 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001069
1070 def tearDown(self):
1071 self.zip.close()
1072 os.unlink(TESTFN)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001073 self.zip2.close()
1074 os.unlink(TESTFN2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001075
Ezio Melottiafd0d112009-07-15 17:17:17 +00001076 def test_no_password(self):
Thomas Wouterscf297e42007-02-23 15:07:44 +00001077 # Reading the encrypted file without password
1078 # must generate a RunTime exception
1079 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001080 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001081
Ezio Melottiafd0d112009-07-15 17:17:17 +00001082 def test_bad_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001083 self.zip.setpassword(b"perl")
Thomas Wouterscf297e42007-02-23 15:07:44 +00001084 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Christian Heimesfdab48e2008-01-20 09:06:41 +00001085 self.zip2.setpassword(b"perl")
1086 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Guido van Rossumd8faa362007-04-27 19:54:29 +00001087
Ezio Melotti975077a2011-05-19 22:03:22 +03001088 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001089 def test_good_password(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001090 self.zip.setpassword(b"python")
Ezio Melotti35386712009-12-31 13:22:41 +00001091 self.assertEqual(self.zip.read("test.txt"), self.plain)
Christian Heimesfdab48e2008-01-20 09:06:41 +00001092 self.zip2.setpassword(b"12345")
Ezio Melotti35386712009-12-31 13:22:41 +00001093 self.assertEqual(self.zip2.read("zero"), self.plain2)
Thomas Wouterscf297e42007-02-23 15:07:44 +00001094
R. David Murray8d855d82010-12-21 21:53:37 +00001095 def test_unicode_password(self):
1096 self.assertRaises(TypeError, self.zip.setpassword, "unicode")
1097 self.assertRaises(TypeError, self.zip.read, "test.txt", "python")
1098 self.assertRaises(TypeError, self.zip.open, "test.txt", pwd="python")
1099 self.assertRaises(TypeError, self.zip.extract, "test.txt", pwd="python")
1100
Guido van Rossumd8faa362007-04-27 19:54:29 +00001101
1102class TestsWithRandomBinaryFiles(unittest.TestCase):
1103 def setUp(self):
1104 datacount = randint(16, 64)*1024 + randint(1, 1024)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001105 self.data = b''.join(struct.pack('<f', random()*randint(-1000, 1000))
1106 for i in range(datacount))
Guido van Rossumd8faa362007-04-27 19:54:29 +00001107
1108 # Make a source file with some lines
Ezio Melotti35386712009-12-31 13:22:41 +00001109 with open(TESTFN, "wb") as fp:
1110 fp.write(self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001111
1112 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001113 unlink(TESTFN)
1114 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001115
Ezio Melottiafd0d112009-07-15 17:17:17 +00001116 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001117 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001118 with zipfile.ZipFile(f, "w", compression) as zipfp:
1119 zipfp.write(TESTFN, "another.name")
1120 zipfp.write(TESTFN, TESTFN)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001121
Ezio Melottiafd0d112009-07-15 17:17:17 +00001122 def zip_test(self, f, compression):
1123 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001124
1125 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001126 with zipfile.ZipFile(f, "r", compression) as zipfp:
1127 testdata = zipfp.read(TESTFN)
1128 self.assertEqual(len(testdata), len(self.data))
1129 self.assertEqual(testdata, self.data)
1130 self.assertEqual(zipfp.read("another.name"), self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001131 if not isinstance(f, str):
1132 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001133
Ezio Melottiafd0d112009-07-15 17:17:17 +00001134 def test_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001135 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001136 self.zip_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001137
Ezio Melotti975077a2011-05-19 22:03:22 +03001138 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001139 def test_deflated(self):
1140 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1141 self.zip_test(f, zipfile.ZIP_DEFLATED)
1142
Ezio Melottiafd0d112009-07-15 17:17:17 +00001143 def zip_open_test(self, f, compression):
1144 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001145
1146 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001147 with zipfile.ZipFile(f, "r", compression) as zipfp:
1148 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001149 with zipfp.open(TESTFN) as zipopen1:
1150 while True:
1151 read_data = zipopen1.read(256)
1152 if not read_data:
1153 break
1154 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001155
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001156 zipdata2 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001157 with zipfp.open("another.name") as zipopen2:
1158 while True:
1159 read_data = zipopen2.read(256)
1160 if not read_data:
1161 break
1162 zipdata2.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001163
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001164 testdata1 = b''.join(zipdata1)
1165 self.assertEqual(len(testdata1), len(self.data))
1166 self.assertEqual(testdata1, self.data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001167
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001168 testdata2 = b''.join(zipdata2)
Ezio Melotti35386712009-12-31 13:22:41 +00001169 self.assertEqual(len(testdata2), len(self.data))
1170 self.assertEqual(testdata2, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001171 if not isinstance(f, str):
1172 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001173
Ezio Melottiafd0d112009-07-15 17:17:17 +00001174 def test_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001175 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001176 self.zip_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001177
Ezio Melotti975077a2011-05-19 22:03:22 +03001178 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001179 def test_open_deflated(self):
1180 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1181 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1182
Ezio Melottiafd0d112009-07-15 17:17:17 +00001183 def zip_random_open_test(self, f, compression):
1184 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001185
1186 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001187 with zipfile.ZipFile(f, "r", compression) as zipfp:
1188 zipdata1 = []
Brian Curtin8fb9b862010-11-18 02:15:28 +00001189 with zipfp.open(TESTFN) as zipopen1:
1190 while True:
1191 read_data = zipopen1.read(randint(1, 1024))
1192 if not read_data:
1193 break
1194 zipdata1.append(read_data)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001195
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001196 testdata = b''.join(zipdata1)
1197 self.assertEqual(len(testdata), len(self.data))
1198 self.assertEqual(testdata, self.data)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001199 if not isinstance(f, str):
1200 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001201
Ezio Melottiafd0d112009-07-15 17:17:17 +00001202 def test_random_open_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001203 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001204 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001205
Ezio Melotti975077a2011-05-19 22:03:22 +03001206 @requires_zlib
Antoine Pitrou7c8bcb62010-08-12 15:11:50 +00001207 def test_random_open_deflated(self):
1208 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1209 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1210
Ezio Melotti76430242009-07-11 18:28:48 +00001211
Ezio Melotti975077a2011-05-19 22:03:22 +03001212@requires_zlib
Guido van Rossumd8faa362007-04-27 19:54:29 +00001213class TestsWithMultipleOpens(unittest.TestCase):
1214 def setUp(self):
1215 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001216 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1217 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1218 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001219
Ezio Melottiafd0d112009-07-15 17:17:17 +00001220 def test_same_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001221 # Verify that (when the ZipFile is in control of creating file objects)
1222 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001223 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001224 with zipf.open('ones') as zopen1, zipf.open('ones') as zopen2:
1225 data1 = zopen1.read(500)
1226 data2 = zopen2.read(500)
1227 data1 += zopen1.read(500)
1228 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001229 self.assertEqual(data1, data2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001230
Ezio Melottiafd0d112009-07-15 17:17:17 +00001231 def test_different_file(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001232 # Verify that (when the ZipFile is in control of creating file objects)
1233 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001234 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001235 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1236 data1 = zopen1.read(500)
1237 data2 = zopen2.read(500)
1238 data1 += zopen1.read(500)
1239 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001240 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1241 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001242
Ezio Melottiafd0d112009-07-15 17:17:17 +00001243 def test_interleaved(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001244 # Verify that (when the ZipFile is in control of creating file objects)
1245 # multiple open() calls can be made without interfering with each other.
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001246 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin8fb9b862010-11-18 02:15:28 +00001247 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1248 data1 = zopen1.read(500)
1249 data2 = zopen2.read(500)
1250 data1 += zopen1.read(500)
1251 data2 += zopen2.read(500)
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001252 self.assertEqual(data1, b'1'*FIXEDTEST_SIZE)
1253 self.assertEqual(data2, b'2'*FIXEDTEST_SIZE)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001254
1255 def tearDown(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001256 unlink(TESTFN2)
1257
Guido van Rossumd8faa362007-04-27 19:54:29 +00001258
Martin v. Löwis59e47792009-01-24 14:10:07 +00001259class TestWithDirectory(unittest.TestCase):
1260 def setUp(self):
1261 os.mkdir(TESTFN2)
1262
Ezio Melottiafd0d112009-07-15 17:17:17 +00001263 def test_extract_dir(self):
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001264 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1265 zipf.extractall(TESTFN2)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001266 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1267 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1268 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1269
Ezio Melottiafd0d112009-07-15 17:17:17 +00001270 def test_bug_6050(self):
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001271 # Extraction should succeed if directories already exist
1272 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottiafd0d112009-07-15 17:17:17 +00001273 self.test_extract_dir()
Martin v. Löwis70ccd162009-05-24 19:47:22 +00001274
Ezio Melottiafd0d112009-07-15 17:17:17 +00001275 def test_store_dir(self):
Martin v. Löwis59e47792009-01-24 14:10:07 +00001276 os.mkdir(os.path.join(TESTFN2, "x"))
1277 zipf = zipfile.ZipFile(TESTFN, "w")
1278 zipf.write(os.path.join(TESTFN2, "x"), "x")
1279 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1280
1281 def tearDown(self):
1282 shutil.rmtree(TESTFN2)
1283 if os.path.exists(TESTFN):
Ezio Melotti76430242009-07-11 18:28:48 +00001284 unlink(TESTFN)
Martin v. Löwis59e47792009-01-24 14:10:07 +00001285
Guido van Rossumd8faa362007-04-27 19:54:29 +00001286
1287class UniversalNewlineTests(unittest.TestCase):
1288 def setUp(self):
Guido van Rossum9c627722007-08-27 18:31:48 +00001289 self.line_gen = [bytes("Test of zipfile line %d." % i, "ascii")
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001290 for i in range(FIXEDTEST_SIZE)]
Guido van Rossumd8faa362007-04-27 19:54:29 +00001291 self.seps = ('\r', '\r\n', '\n')
1292 self.arcdata, self.arcfiles = {}, {}
1293 for n, s in enumerate(self.seps):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001294 b = s.encode("ascii")
1295 self.arcdata[s] = b.join(self.line_gen) + b
Guido van Rossumd8faa362007-04-27 19:54:29 +00001296 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001297 f = open(self.arcfiles[s], "wb")
1298 try:
1299 f.write(self.arcdata[s])
1300 finally:
1301 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001302
Ezio Melottiafd0d112009-07-15 17:17:17 +00001303 def make_test_archive(self, f, compression):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001304 # Create the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001305 with zipfile.ZipFile(f, "w", compression) as zipfp:
1306 for fn in self.arcfiles.values():
1307 zipfp.write(fn, fn)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001308
Ezio Melottiafd0d112009-07-15 17:17:17 +00001309 def read_test(self, f, compression):
1310 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001311
1312 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001313 with zipfile.ZipFile(f, "r") as zipfp:
1314 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001315 with zipfp.open(fn, "rU") as fp:
1316 zipdata = fp.read()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001317 self.assertEqual(self.arcdata[sep], zipdata)
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001318 if not isinstance(f, str):
1319 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001320
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001321 def readline_read_test(self, f, compression):
1322 self.make_test_archive(f, compression)
1323
1324 # Read the ZIP archive
Brian Curtin8fb9b862010-11-18 02:15:28 +00001325 with zipfile.ZipFile(f, "r") as zipfp:
1326 for sep, fn in self.arcfiles.items():
1327 with zipfp.open(fn, "rU") as zipopen:
1328 data = b''
1329 while True:
1330 read = zipopen.readline()
1331 if not read:
1332 break
1333 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001334
Brian Curtin8fb9b862010-11-18 02:15:28 +00001335 read = zipopen.read(5)
1336 if not read:
1337 break
1338 data += read
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001339
1340 self.assertEqual(data, self.arcdata['\n'])
1341
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001342 if not isinstance(f, str):
1343 f.close()
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001344
Ezio Melottiafd0d112009-07-15 17:17:17 +00001345 def readline_test(self, f, compression):
1346 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001347
1348 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001349 with zipfile.ZipFile(f, "r") as zipfp:
1350 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001351 with zipfp.open(fn, "rU") as zipopen:
1352 for line in self.line_gen:
1353 linedata = zipopen.readline()
1354 self.assertEqual(linedata, line + b'\n')
1355 if not isinstance(f, str):
1356 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001357
Ezio Melottiafd0d112009-07-15 17:17:17 +00001358 def readlines_test(self, f, compression):
1359 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001360
1361 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001362 with zipfile.ZipFile(f, "r") as zipfp:
1363 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001364 with zipfp.open(fn, "rU") as fp:
1365 ziplines = fp.readlines()
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001366 for line, zipline in zip(self.line_gen, ziplines):
1367 self.assertEqual(zipline, line + b'\n')
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001368 if not isinstance(f, str):
1369 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001370
Ezio Melottiafd0d112009-07-15 17:17:17 +00001371 def iterlines_test(self, f, compression):
1372 self.make_test_archive(f, compression)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001373
1374 # Read the ZIP archive
Ezio Melottifaa6b7f2009-12-30 12:34:59 +00001375 with zipfile.ZipFile(f, "r") as zipfp:
1376 for sep, fn in self.arcfiles.items():
Benjamin Petersond285bdb2010-10-31 17:57:22 +00001377 with zipfp.open(fn, "rU") as fp:
1378 for line, zipline in zip(self.line_gen, fp):
1379 self.assertEqual(zipline, line + b'\n')
1380 if not isinstance(f, str):
1381 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001382
Ezio Melottiafd0d112009-07-15 17:17:17 +00001383 def test_read_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001384 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001385 self.read_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001386
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001387 def test_readline_read_stored(self):
1388 # Issue #7610: calls to readline() interleaved with calls to read().
1389 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1390 self.readline_read_test(f, zipfile.ZIP_STORED)
1391
Ezio Melottiafd0d112009-07-15 17:17:17 +00001392 def test_readline_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001393 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001394 self.readline_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001395
Ezio Melottiafd0d112009-07-15 17:17:17 +00001396 def test_readlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001397 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001398 self.readlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001399
Ezio Melottiafd0d112009-07-15 17:17:17 +00001400 def test_iterlines_stored(self):
Guido van Rossumd6ca5462007-05-22 01:29:33 +00001401 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001402 self.iterlines_test(f, zipfile.ZIP_STORED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001403
Ezio Melotti975077a2011-05-19 22:03:22 +03001404 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001405 def test_read_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001406 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001407 self.read_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001408
Ezio Melotti975077a2011-05-19 22:03:22 +03001409 @requires_zlib
Antoine Pitroua32f9a22010-01-27 21:18:57 +00001410 def test_readline_read_deflated(self):
1411 # Issue #7610: calls to readline() interleaved with calls to read().
1412 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1413 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1414
Ezio Melotti975077a2011-05-19 22:03:22 +03001415 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001416 def test_readline_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001417 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001418 self.readline_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001419
Ezio Melotti975077a2011-05-19 22:03:22 +03001420 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001421 def test_readlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001422 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001423 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001424
Ezio Melotti975077a2011-05-19 22:03:22 +03001425 @requires_zlib
Ezio Melottiafd0d112009-07-15 17:17:17 +00001426 def test_iterlines_deflated(self):
Ezio Melotti76430242009-07-11 18:28:48 +00001427 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
Ezio Melottiafd0d112009-07-15 17:17:17 +00001428 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001429
1430 def tearDown(self):
1431 for sep, fn in self.arcfiles.items():
1432 os.remove(fn)
Ezio Melotti76430242009-07-11 18:28:48 +00001433 unlink(TESTFN)
1434 unlink(TESTFN2)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001435
1436
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001437def test_main():
Guido van Rossumd8faa362007-04-27 19:54:29 +00001438 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1439 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti76430242009-07-11 18:28:48 +00001440 TestWithDirectory, UniversalNewlineTests,
1441 TestsWithRandomBinaryFiles)
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001442
1443if __name__ == "__main__":
1444 test_main()