blob: 97a71e6439353fe6cd3a655cf4a3c98f2ff93a01 [file] [log] [blame]
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001# We can test part of the module without zlib.
Guido van Rossum368f04a2000-04-10 13:23:04 +00002try:
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00003 import zlib
4except ImportError:
5 zlib = None
Tim Petersa45cacf2004-08-20 03:47:14 +00006
Ezio Melottie7a0cc22009-07-04 14:58:27 +00007import os
Antoine Pitroue1436d12010-08-12 15:25:51 +00008import io
Ezio Melottie7a0cc22009-07-04 14:58:27 +00009import sys
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000010import time
Ezio Melottie7a0cc22009-07-04 14:58:27 +000011import shutil
12import struct
13import zipfile
14import unittest
Tim Petersa19a1682001-03-29 04:36:09 +000015
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000016from StringIO import StringIO
17from tempfile import TemporaryFile
Martin v. Löwis3eb76482007-03-06 10:41:24 +000018from random import randint, random
Ezio Melottie7a0cc22009-07-04 14:58:27 +000019from unittest import skipUnless
Tim Petersa19a1682001-03-29 04:36:09 +000020
Serhiy Storchakadb03e6b2013-05-08 21:52:31 +030021from test.test_support import TESTFN, TESTFN_UNICODE, TESTFN_ENCODING, \
Serhiy Storchaka49259352014-01-20 21:57:09 +020022 run_unittest, findfile, unlink, check_warnings
Serhiy Storchakadb03e6b2013-05-08 21:52:31 +030023try:
24 TESTFN_UNICODE.encode(TESTFN_ENCODING)
25except (UnicodeError, TypeError):
26 # Either the file system encoding is None, or the file name
27 # cannot be encoded in the file system encoding.
28 TESTFN_UNICODE = None
Guido van Rossum368f04a2000-04-10 13:23:04 +000029
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000030TESTFN2 = TESTFN + "2"
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +000031TESTFNDIR = TESTFN + "d"
Georg Brandl4b3ab6f2007-07-12 09:59:22 +000032FIXEDTEST_SIZE = 1000
Guido van Rossum368f04a2000-04-10 13:23:04 +000033
Georg Brandl62416bc2008-01-07 18:47:44 +000034SMALL_TEST_DATA = [('_ziptest1', '1q2w3e4r5t'),
35 ('ziptest2dir/_ziptest2', 'qawsedrftg'),
Gregory P. Smith608cc452013-02-01 11:40:18 -080036 ('ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
Georg Brandl62416bc2008-01-07 18:47:44 +000037 ('ziptest2dir/ziptest3dir/ziptest4dir/_ziptest3', '6y7u8i9o0p')]
38
Ezio Melotti6cbfc122009-07-10 20:25:56 +000039
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000040class TestsWithSourceFile(unittest.TestCase):
41 def setUp(self):
Georg Brandl4b3ab6f2007-07-12 09:59:22 +000042 self.line_gen = ["Zipfile test line %d. random float: %f" % (i, random())
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000043 for i in xrange(FIXEDTEST_SIZE)]
Martin v. Löwis3eb76482007-03-06 10:41:24 +000044 self.data = '\n'.join(self.line_gen) + '\n'
Fred Drake6e7e4852001-02-28 05:34:16 +000045
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000046 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000047 with open(TESTFN, "wb") as fp:
48 fp.write(self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000049
Ezio Melottid5a23e32009-07-15 17:07:04 +000050 def make_test_archive(self, f, compression):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000051 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +000052 with zipfile.ZipFile(f, "w", compression) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000053 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +000054 zipfp.write(TESTFN, TESTFN)
55 zipfp.writestr("strfile", self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000056
Ezio Melottid5a23e32009-07-15 17:07:04 +000057 def zip_test(self, f, compression):
58 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +000059
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000060 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +000061 with zipfile.ZipFile(f, "r", compression) as zipfp:
62 self.assertEqual(zipfp.read(TESTFN), self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000063 self.assertEqual(zipfp.read("another.name"), self.data)
Ezio Melotti569e61f2009-12-30 06:14:51 +000064 self.assertEqual(zipfp.read("strfile"), self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +000065
Ezio Melotti569e61f2009-12-30 06:14:51 +000066 # Print the ZIP directory
67 fp = StringIO()
68 stdout = sys.stdout
69 try:
70 sys.stdout = fp
71 zipfp.printdir()
72 finally:
73 sys.stdout = stdout
Tim Petersa608bb22006-06-15 18:06:29 +000074
Ezio Melotti569e61f2009-12-30 06:14:51 +000075 directory = fp.getvalue()
76 lines = directory.splitlines()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000077 self.assertEqual(len(lines), 4) # Number of files + header
Ronald Oussoren143cefb2006-06-15 08:14:18 +000078
Ezio Melottiaa980582010-01-23 23:04:36 +000079 self.assertIn('File Name', lines[0])
80 self.assertIn('Modified', lines[0])
81 self.assertIn('Size', lines[0])
Ronald Oussoren143cefb2006-06-15 08:14:18 +000082
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000083 fn, date, time_, size = lines[1].split()
84 self.assertEqual(fn, 'another.name')
85 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
86 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
87 self.assertEqual(size, str(len(self.data)))
Ronald Oussoren143cefb2006-06-15 08:14:18 +000088
Ezio Melotti569e61f2009-12-30 06:14:51 +000089 # Check the namelist
90 names = zipfp.namelist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000091 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +000092 self.assertIn(TESTFN, names)
93 self.assertIn("another.name", names)
94 self.assertIn("strfile", names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +000095
Ezio Melotti569e61f2009-12-30 06:14:51 +000096 # Check infolist
97 infos = zipfp.infolist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000098 names = [i.filename for i in infos]
99 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000100 self.assertIn(TESTFN, names)
101 self.assertIn("another.name", names)
102 self.assertIn("strfile", names)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000103 for i in infos:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000104 self.assertEqual(i.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000105
Ezio Melotti569e61f2009-12-30 06:14:51 +0000106 # check getinfo
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000107 for nm in (TESTFN, "another.name", "strfile"):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000108 info = zipfp.getinfo(nm)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000109 self.assertEqual(info.filename, nm)
110 self.assertEqual(info.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000111
Ezio Melotti569e61f2009-12-30 06:14:51 +0000112 # Check that testzip doesn't raise an exception
113 zipfp.testzip()
Tim Peters7d3bad62001-04-04 18:56:49 +0000114
Ezio Melottid5a23e32009-07-15 17:07:04 +0000115 def test_stored(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000116 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000117 self.zip_test(f, zipfile.ZIP_STORED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000118
Ezio Melottid5a23e32009-07-15 17:07:04 +0000119 def zip_open_test(self, f, compression):
120 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000121
122 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000123 with zipfile.ZipFile(f, "r", compression) as zipfp:
124 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -0500125 with zipfp.open(TESTFN) as zipopen1:
126 while True:
127 read_data = zipopen1.read(256)
128 if not read_data:
129 break
130 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000131
Ezio Melotti569e61f2009-12-30 06:14:51 +0000132 zipdata2 = []
Brian Curtin0d654332011-04-19 21:15:55 -0500133 with zipfp.open("another.name") as zipopen2:
134 while True:
135 read_data = zipopen2.read(256)
136 if not read_data:
137 break
138 zipdata2.append(read_data)
Tim Petersea5962f2007-03-12 18:07:52 +0000139
Ezio Melotti569e61f2009-12-30 06:14:51 +0000140 self.assertEqual(''.join(zipdata1), self.data)
141 self.assertEqual(''.join(zipdata2), self.data)
Tim Petersea5962f2007-03-12 18:07:52 +0000142
Ezio Melottid5a23e32009-07-15 17:07:04 +0000143 def test_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000144 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000145 self.zip_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000146
Ezio Melottid5a23e32009-07-15 17:07:04 +0000147 def test_open_via_zip_info(self):
Georg Brandl112aa502008-05-20 08:25:48 +0000148 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000149 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
150 zipfp.writestr("name", "foo")
Serhiy Storchaka49259352014-01-20 21:57:09 +0200151 with check_warnings(('', UserWarning)):
152 zipfp.writestr("name", "bar")
153 self.assertEqual(zipfp.namelist(), ["name"] * 2)
Georg Brandl112aa502008-05-20 08:25:48 +0000154
Ezio Melotti569e61f2009-12-30 06:14:51 +0000155 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
156 infos = zipfp.infolist()
157 data = ""
158 for info in infos:
Brian Curtin0d654332011-04-19 21:15:55 -0500159 with zipfp.open(info) as f:
160 data += f.read()
Ezio Melotti569e61f2009-12-30 06:14:51 +0000161 self.assertTrue(data == "foobar" or data == "barfoo")
162 data = ""
163 for info in infos:
164 data += zipfp.read(info)
165 self.assertTrue(data == "foobar" or data == "barfoo")
Georg Brandl112aa502008-05-20 08:25:48 +0000166
Ezio Melottid5a23e32009-07-15 17:07:04 +0000167 def zip_random_open_test(self, f, compression):
168 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000169
170 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000171 with zipfile.ZipFile(f, "r", compression) as zipfp:
172 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -0500173 with zipfp.open(TESTFN) as zipopen1:
174 while True:
175 read_data = zipopen1.read(randint(1, 1024))
176 if not read_data:
177 break
178 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000179
Ezio Melotti569e61f2009-12-30 06:14:51 +0000180 self.assertEqual(''.join(zipdata1), self.data)
Tim Petersea5962f2007-03-12 18:07:52 +0000181
Ezio Melottid5a23e32009-07-15 17:07:04 +0000182 def test_random_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000183 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000184 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +0000185
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000186 def test_univeral_readaheads(self):
187 f = StringIO()
188
189 data = 'a\r\n' * 16 * 1024
Brian Curtin0d654332011-04-19 21:15:55 -0500190 with zipfile.ZipFile(f, 'w', zipfile.ZIP_STORED) as zipfp:
191 zipfp.writestr(TESTFN, data)
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000192
193 data2 = ''
Brian Curtin0d654332011-04-19 21:15:55 -0500194 with zipfile.ZipFile(f, 'r') as zipfp:
195 with zipfp.open(TESTFN, 'rU') as zipopen:
196 for line in zipopen:
197 data2 += line
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000198
199 self.assertEqual(data, data2.replace('\n', '\r\n'))
200
201 def zip_readline_read_test(self, f, compression):
202 self.make_test_archive(f, compression)
203
204 # Read the ZIP archive
Brian Curtin0d654332011-04-19 21:15:55 -0500205 with zipfile.ZipFile(f, "r") as zipfp:
206 with zipfp.open(TESTFN) as zipopen:
207 data = ''
208 while True:
209 read = zipopen.readline()
210 if not read:
211 break
212 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000213
Brian Curtin0d654332011-04-19 21:15:55 -0500214 read = zipopen.read(100)
215 if not read:
216 break
217 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000218
219 self.assertEqual(data, self.data)
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000220
Ezio Melottid5a23e32009-07-15 17:07:04 +0000221 def zip_readline_test(self, f, compression):
222 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000223
224 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000225 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin0d654332011-04-19 21:15:55 -0500226 with zipfp.open(TESTFN) as zipopen:
227 for line in self.line_gen:
228 linedata = zipopen.readline()
229 self.assertEqual(linedata, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000230
Ezio Melottid5a23e32009-07-15 17:07:04 +0000231 def zip_readlines_test(self, f, compression):
232 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000233
234 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000235 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin0d654332011-04-19 21:15:55 -0500236 with zipfp.open(TESTFN) as zo:
237 ziplines = zo.readlines()
238 for line, zipline in zip(self.line_gen, ziplines):
239 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000240
Ezio Melottid5a23e32009-07-15 17:07:04 +0000241 def zip_iterlines_test(self, f, compression):
242 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000243
244 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000245 with zipfile.ZipFile(f, "r") as zipfp:
246 for line, zipline in zip(self.line_gen, zipfp.open(TESTFN)):
247 self.assertEqual(zipline, line + '\n')
Tim Petersea5962f2007-03-12 18:07:52 +0000248
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000249 def test_readline_read_stored(self):
250 # Issue #7610: calls to readline() interleaved with calls to read().
251 for f in (TESTFN2, TemporaryFile(), StringIO()):
252 self.zip_readline_read_test(f, zipfile.ZIP_STORED)
253
Ezio Melottid5a23e32009-07-15 17:07:04 +0000254 def test_readline_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000255 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000256 self.zip_readline_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000257
Ezio Melottid5a23e32009-07-15 17:07:04 +0000258 def test_readlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000259 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000260 self.zip_readlines_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000261
Ezio Melottid5a23e32009-07-15 17:07:04 +0000262 def test_iterlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000263 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000264 self.zip_iterlines_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000265
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000266 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000267 def test_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000268 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000269 self.zip_test(f, zipfile.ZIP_DEFLATED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000270
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000271 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000272 def test_open_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000273 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000274 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000275
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000276 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000277 def test_random_open_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000278 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000279 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000280
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000281 @skipUnless(zlib, "requires zlib")
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000282 def test_readline_read_deflated(self):
283 # Issue #7610: calls to readline() interleaved with calls to read().
284 for f in (TESTFN2, TemporaryFile(), StringIO()):
285 self.zip_readline_read_test(f, zipfile.ZIP_DEFLATED)
286
287 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000288 def test_readline_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000289 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000290 self.zip_readline_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000291
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000292 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000293 def test_readlines_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000294 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000295 self.zip_readlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000296
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000297 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000298 def test_iterlines_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000299 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000300 self.zip_iterlines_test(f, zipfile.ZIP_DEFLATED)
Tim Petersea5962f2007-03-12 18:07:52 +0000301
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000302 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000303 def test_low_compression(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000304 """Check for cases where compressed data is larger than original."""
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000305 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000306 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
307 zipfp.writestr("strfile", '12')
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000308
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000309 # Get an open object for strfile
Ezio Melotti569e61f2009-12-30 06:14:51 +0000310 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_DEFLATED) as zipfp:
Brian Curtin0d654332011-04-19 21:15:55 -0500311 with zipfp.open("strfile") as openobj:
312 self.assertEqual(openobj.read(1), '1')
313 self.assertEqual(openobj.read(1), '2')
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000314
Ezio Melottid5a23e32009-07-15 17:07:04 +0000315 def test_absolute_arcnames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000316 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
317 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000318
Ezio Melotti569e61f2009-12-30 06:14:51 +0000319 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
320 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000321
Ezio Melottid5a23e32009-07-15 17:07:04 +0000322 def test_append_to_zip_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000323 """Test appending to an existing zipfile."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000324 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
325 zipfp.write(TESTFN, TESTFN)
326
327 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
328 zipfp.writestr("strfile", self.data)
329 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000330
Ezio Melottid5a23e32009-07-15 17:07:04 +0000331 def test_append_to_non_zip_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000332 """Test appending to an existing file that is not a zipfile."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000333 # NOTE: this test fails if len(d) < 22 because of the first
334 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000335 data = 'I am not a ZipFile!'*10
336 with open(TESTFN2, 'wb') as f:
337 f.write(data)
338
Ezio Melotti569e61f2009-12-30 06:14:51 +0000339 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
340 zipfp.write(TESTFN, TESTFN)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000341
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000342 with open(TESTFN2, 'rb') as f:
343 f.seek(len(data))
344 with zipfile.ZipFile(f, "r") as zipfp:
345 self.assertEqual(zipfp.namelist(), [TESTFN])
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000346
R David Murray873c5832011-06-09 16:01:09 -0400347 def test_ignores_newline_at_end(self):
348 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
349 zipfp.write(TESTFN, TESTFN)
350 with open(TESTFN2, 'a') as f:
351 f.write("\r\n\00\00\00")
352 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
353 self.assertIsInstance(zipfp, zipfile.ZipFile)
354
355 def test_ignores_stuff_appended_past_comments(self):
356 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
357 zipfp.comment = b"this is a comment"
358 zipfp.write(TESTFN, TESTFN)
359 with open(TESTFN2, 'a') as f:
360 f.write("abcdef\r\n")
361 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
362 self.assertIsInstance(zipfp, zipfile.ZipFile)
363 self.assertEqual(zipfp.comment, b"this is a comment")
364
Ezio Melottid5a23e32009-07-15 17:07:04 +0000365 def test_write_default_name(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000366 """Check that calling ZipFile.write without arcname specified
367 produces the expected result."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000368 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
369 zipfp.write(TESTFN)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000370 self.assertEqual(zipfp.read(TESTFN), open(TESTFN).read())
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000371
Ezio Melotti1036a7f2009-09-12 14:43:43 +0000372 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000373 def test_per_file_compression(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000374 """Check that files within a Zip archive can have different
375 compression options."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000376 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
377 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
378 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
379 sinfo = zipfp.getinfo('storeme')
380 dinfo = zipfp.getinfo('deflateme')
381 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
382 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000383
Ezio Melottid5a23e32009-07-15 17:07:04 +0000384 def test_write_to_readonly(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000385 """Check that trying to call write() on a readonly ZipFile object
386 raises a RuntimeError."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000387 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
388 zipfp.writestr("somefile.txt", "bogus")
389
390 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
391 self.assertRaises(RuntimeError, zipfp.write, TESTFN)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000392
Ezio Melottid5a23e32009-07-15 17:07:04 +0000393 def test_extract(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000394 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
395 for fpath, fdata in SMALL_TEST_DATA:
396 zipfp.writestr(fpath, fdata)
Georg Brandl62416bc2008-01-07 18:47:44 +0000397
Ezio Melotti569e61f2009-12-30 06:14:51 +0000398 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
399 for fpath, fdata in SMALL_TEST_DATA:
400 writtenfile = zipfp.extract(fpath)
Georg Brandl62416bc2008-01-07 18:47:44 +0000401
Ezio Melotti569e61f2009-12-30 06:14:51 +0000402 # make sure it was written to the right place
Gregory P. Smith608cc452013-02-01 11:40:18 -0800403 correctfile = os.path.join(os.getcwd(), fpath)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000404 correctfile = os.path.normpath(correctfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000405
Ezio Melotti569e61f2009-12-30 06:14:51 +0000406 self.assertEqual(writtenfile, correctfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000407
Ezio Melotti569e61f2009-12-30 06:14:51 +0000408 # make sure correct data is in correct file
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000409 self.assertEqual(fdata, open(writtenfile, "rb").read())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000410 os.remove(writtenfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000411
412 # remove the test file subdirectories
413 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
414
Ezio Melottid5a23e32009-07-15 17:07:04 +0000415 def test_extract_all(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000416 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
417 for fpath, fdata in SMALL_TEST_DATA:
418 zipfp.writestr(fpath, fdata)
Georg Brandl62416bc2008-01-07 18:47:44 +0000419
Ezio Melotti569e61f2009-12-30 06:14:51 +0000420 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
421 zipfp.extractall()
422 for fpath, fdata in SMALL_TEST_DATA:
Gregory P. Smith608cc452013-02-01 11:40:18 -0800423 outfile = os.path.join(os.getcwd(), fpath)
Georg Brandl62416bc2008-01-07 18:47:44 +0000424
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000425 self.assertEqual(fdata, open(outfile, "rb").read())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000426 os.remove(outfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000427
428 # remove the test file subdirectories
429 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
430
Gregory P. Smith608cc452013-02-01 11:40:18 -0800431 def check_file(self, filename, content):
432 self.assertTrue(os.path.isfile(filename))
433 with open(filename, 'rb') as f:
434 self.assertEqual(f.read(), content)
435
Serhiy Storchakadb03e6b2013-05-08 21:52:31 +0300436 @skipUnless(TESTFN_UNICODE, "No Unicode filesystem semantics on this platform.")
Serhiy Storchaka6fa83f92013-04-13 12:28:17 +0300437 def test_extract_unicode_filenames(self):
438 fnames = [u'foo.txt', os.path.basename(TESTFN_UNICODE)]
439 content = 'Test for unicode filename'
440 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
441 for fname in fnames:
442 zipfp.writestr(fname, content)
443
444 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
445 for fname in fnames:
446 writtenfile = zipfp.extract(fname)
447
448 # make sure it was written to the right place
449 correctfile = os.path.join(os.getcwd(), fname)
450 correctfile = os.path.normpath(correctfile)
451 self.assertEqual(writtenfile, correctfile)
452
453 self.check_file(writtenfile, content)
454 os.remove(writtenfile)
455
Gregory P. Smith608cc452013-02-01 11:40:18 -0800456 def test_extract_hackers_arcnames(self):
457 hacknames = [
458 ('../foo/bar', 'foo/bar'),
459 ('foo/../bar', 'foo/bar'),
460 ('foo/../../bar', 'foo/bar'),
461 ('foo/bar/..', 'foo/bar'),
462 ('./../foo/bar', 'foo/bar'),
463 ('/foo/bar', 'foo/bar'),
464 ('/foo/../bar', 'foo/bar'),
465 ('/foo/../../bar', 'foo/bar'),
Gregory P. Smith608cc452013-02-01 11:40:18 -0800466 ]
467 if os.path.sep == '\\':
468 hacknames.extend([
469 (r'..\foo\bar', 'foo/bar'),
470 (r'..\/foo\/bar', 'foo/bar'),
471 (r'foo/\..\/bar', 'foo/bar'),
472 (r'foo\/../\bar', 'foo/bar'),
473 (r'C:foo/bar', 'foo/bar'),
474 (r'C:/foo/bar', 'foo/bar'),
475 (r'C://foo/bar', 'foo/bar'),
476 (r'C:\foo\bar', 'foo/bar'),
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200477 (r'//conky/mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
478 (r'\\conky\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
Gregory P. Smith608cc452013-02-01 11:40:18 -0800479 (r'///conky/mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
480 (r'\\\conky\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
481 (r'//conky//mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
482 (r'\\conky\\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200483 (r'//?/C:/foo/bar', '_/C_/foo/bar'),
484 (r'\\?\C:\foo\bar', '_/C_/foo/bar'),
Gregory P. Smith608cc452013-02-01 11:40:18 -0800485 (r'C:/../C:/foo/bar', 'C_/foo/bar'),
486 (r'a:b\c<d>e|f"g?h*i', 'b/c_d_e_f_g_h_i'),
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200487 ('../../foo../../ba..r', 'foo/ba..r'),
488 ])
489 else: # Unix
490 hacknames.extend([
491 ('//foo/bar', 'foo/bar'),
492 ('../../foo../../ba..r', 'foo../ba..r'),
Serhiy Storchaka05fd7442013-02-02 18:34:57 +0200493 (r'foo/..\bar', r'foo/..\bar'),
Gregory P. Smith608cc452013-02-01 11:40:18 -0800494 ])
495
496 for arcname, fixedname in hacknames:
497 content = b'foobar' + arcname.encode()
498 with zipfile.ZipFile(TESTFN2, 'w', zipfile.ZIP_STORED) as zipfp:
Serhiy Storchaka05fd7442013-02-02 18:34:57 +0200499 zinfo = zipfile.ZipInfo()
500 # preserve backslashes
501 zinfo.filename = arcname
502 zinfo.external_attr = 0o600 << 16
503 zipfp.writestr(zinfo, content)
Gregory P. Smith608cc452013-02-01 11:40:18 -0800504
Serhiy Storchaka2a051fa2013-02-02 19:25:57 +0200505 arcname = arcname.replace(os.sep, "/")
Gregory P. Smith608cc452013-02-01 11:40:18 -0800506 targetpath = os.path.join('target', 'subdir', 'subsub')
507 correctfile = os.path.join(targetpath, *fixedname.split('/'))
508
509 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
510 writtenfile = zipfp.extract(arcname, targetpath)
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200511 self.assertEqual(writtenfile, correctfile,
512 msg="extract %r" % arcname)
Gregory P. Smith608cc452013-02-01 11:40:18 -0800513 self.check_file(correctfile, content)
514 shutil.rmtree('target')
515
516 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
517 zipfp.extractall(targetpath)
518 self.check_file(correctfile, content)
519 shutil.rmtree('target')
520
521 correctfile = os.path.join(os.getcwd(), *fixedname.split('/'))
522
523 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
524 writtenfile = zipfp.extract(arcname)
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200525 self.assertEqual(writtenfile, correctfile,
526 msg="extract %r" % arcname)
Gregory P. Smith608cc452013-02-01 11:40:18 -0800527 self.check_file(correctfile, content)
528 shutil.rmtree(fixedname.split('/')[0])
529
530 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
531 zipfp.extractall()
532 self.check_file(correctfile, content)
533 shutil.rmtree(fixedname.split('/')[0])
534
535 os.remove(TESTFN2)
536
Ronald Oussorendd25e862010-02-07 20:18:02 +0000537 def test_writestr_compression(self):
538 zipfp = zipfile.ZipFile(TESTFN2, "w")
539 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
540 if zlib:
541 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
542
543 info = zipfp.getinfo('a.txt')
544 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
545
546 if zlib:
547 info = zipfp.getinfo('b.txt')
548 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
549
550
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000551 def zip_test_writestr_permissions(self, f, compression):
552 # Make sure that writestr creates files with mode 0600,
553 # when it is passed a name rather than a ZipInfo instance.
554
Ezio Melottid5a23e32009-07-15 17:07:04 +0000555 self.make_test_archive(f, compression)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000556 with zipfile.ZipFile(f, "r") as zipfp:
557 zinfo = zipfp.getinfo('strfile')
558 self.assertEqual(zinfo.external_attr, 0600 << 16)
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000559
Ezio Melottid5a23e32009-07-15 17:07:04 +0000560 def test_writestr_permissions(self):
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000561 for f in (TESTFN2, TemporaryFile(), StringIO()):
562 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
563
Ezio Melotti569e61f2009-12-30 06:14:51 +0000564 def test_close(self):
565 """Check that the zipfile is closed after the 'with' block."""
566 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
567 for fpath, fdata in SMALL_TEST_DATA:
568 zipfp.writestr(fpath, fdata)
569 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
570 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
571
572 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
573 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
574 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
575
576 def test_close_on_exception(self):
577 """Check that the zipfile is closed if an exception is raised in the
578 'with' block."""
579 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
580 for fpath, fdata in SMALL_TEST_DATA:
581 zipfp.writestr(fpath, fdata)
582
583 try:
584 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
585 raise zipfile.BadZipfile()
586 except zipfile.BadZipfile:
587 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
588
Senthil Kumaranddd40312011-10-20 01:38:35 +0800589 def test_add_file_before_1980(self):
590 # Set atime and mtime to 1970-01-01
591 os.utime(TESTFN, (0, 0))
592 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
593 self.assertRaises(ValueError, zipfp.write, TESTFN)
594
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000595 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000596 unlink(TESTFN)
597 unlink(TESTFN2)
598
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000599
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000600class TestZip64InSmallFiles(unittest.TestCase):
601 # These tests test the ZIP64 functionality without using large files,
602 # see test_zipfile64 for proper tests.
603
604 def setUp(self):
605 self._limit = zipfile.ZIP64_LIMIT
606 zipfile.ZIP64_LIMIT = 5
607
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000608 line_gen = ("Test of zipfile line %d." % i
609 for i in range(0, FIXEDTEST_SIZE))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000610 self.data = '\n'.join(line_gen)
611
612 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000613 with open(TESTFN, "wb") as fp:
614 fp.write(self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000615
Ezio Melottid5a23e32009-07-15 17:07:04 +0000616 def large_file_exception_test(self, f, compression):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000617 with zipfile.ZipFile(f, "w", compression) as zipfp:
618 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000619 zipfp.write, TESTFN, "another.name")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000620
Ezio Melottid5a23e32009-07-15 17:07:04 +0000621 def large_file_exception_test2(self, f, compression):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000622 with zipfile.ZipFile(f, "w", compression) as zipfp:
623 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000624 zipfp.writestr, "another.name", self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000625
Ezio Melottid5a23e32009-07-15 17:07:04 +0000626 def test_large_file_exception(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000627 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000628 self.large_file_exception_test(f, zipfile.ZIP_STORED)
629 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000630
Ezio Melottid5a23e32009-07-15 17:07:04 +0000631 def zip_test(self, f, compression):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000632 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000633 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000634 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +0000635 zipfp.write(TESTFN, TESTFN)
636 zipfp.writestr("strfile", self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000637
638 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000639 with zipfile.ZipFile(f, "r", compression) as zipfp:
640 self.assertEqual(zipfp.read(TESTFN), self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000641 self.assertEqual(zipfp.read("another.name"), self.data)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000642 self.assertEqual(zipfp.read("strfile"), self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000643
Ezio Melotti569e61f2009-12-30 06:14:51 +0000644 # Print the ZIP directory
645 fp = StringIO()
646 stdout = sys.stdout
647 try:
648 sys.stdout = fp
649 zipfp.printdir()
650 finally:
651 sys.stdout = stdout
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000652
Ezio Melotti569e61f2009-12-30 06:14:51 +0000653 directory = fp.getvalue()
654 lines = directory.splitlines()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000655 self.assertEqual(len(lines), 4) # Number of files + header
Tim Petersa608bb22006-06-15 18:06:29 +0000656
Ezio Melottiaa980582010-01-23 23:04:36 +0000657 self.assertIn('File Name', lines[0])
658 self.assertIn('Modified', lines[0])
659 self.assertIn('Size', lines[0])
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000660
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000661 fn, date, time_, size = lines[1].split()
662 self.assertEqual(fn, 'another.name')
663 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
664 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
665 self.assertEqual(size, str(len(self.data)))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000666
Ezio Melotti569e61f2009-12-30 06:14:51 +0000667 # Check the namelist
668 names = zipfp.namelist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000669 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000670 self.assertIn(TESTFN, names)
671 self.assertIn("another.name", names)
672 self.assertIn("strfile", names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000673
Ezio Melotti569e61f2009-12-30 06:14:51 +0000674 # Check infolist
675 infos = zipfp.infolist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000676 names = [i.filename for i in infos]
677 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000678 self.assertIn(TESTFN, names)
679 self.assertIn("another.name", names)
680 self.assertIn("strfile", names)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000681 for i in infos:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000682 self.assertEqual(i.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000683
Ezio Melotti569e61f2009-12-30 06:14:51 +0000684 # check getinfo
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000685 for nm in (TESTFN, "another.name", "strfile"):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000686 info = zipfp.getinfo(nm)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000687 self.assertEqual(info.filename, nm)
688 self.assertEqual(info.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000689
Ezio Melotti569e61f2009-12-30 06:14:51 +0000690 # Check that testzip doesn't raise an exception
691 zipfp.testzip()
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000692
Ezio Melottid5a23e32009-07-15 17:07:04 +0000693 def test_stored(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000694 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000695 self.zip_test(f, zipfile.ZIP_STORED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000696
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000697 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000698 def test_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000699 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000700 self.zip_test(f, zipfile.ZIP_DEFLATED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000701
Ezio Melottid5a23e32009-07-15 17:07:04 +0000702 def test_absolute_arcnames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000703 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
704 allowZip64=True) as zipfp:
705 zipfp.write(TESTFN, "/absolute")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000706
Ezio Melotti569e61f2009-12-30 06:14:51 +0000707 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
708 self.assertEqual(zipfp.namelist(), ["absolute"])
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000709
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000710 def tearDown(self):
711 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000712 unlink(TESTFN)
713 unlink(TESTFN2)
714
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000715
716class PyZipFileTests(unittest.TestCase):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000717 def test_write_pyfile(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000718 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
719 fn = __file__
720 if fn.endswith('.pyc') or fn.endswith('.pyo'):
721 fn = fn[:-1]
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000722
Ezio Melotti569e61f2009-12-30 06:14:51 +0000723 zipfp.writepy(fn)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000724
Ezio Melotti569e61f2009-12-30 06:14:51 +0000725 bn = os.path.basename(fn)
Ezio Melottiaa980582010-01-23 23:04:36 +0000726 self.assertNotIn(bn, zipfp.namelist())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000727 self.assertTrue(bn + 'o' in zipfp.namelist() or
728 bn + 'c' in zipfp.namelist())
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000729
Ezio Melotti569e61f2009-12-30 06:14:51 +0000730 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
731 fn = __file__
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000732 if fn.endswith(('.pyc', '.pyo')):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000733 fn = fn[:-1]
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000734
Ezio Melotti569e61f2009-12-30 06:14:51 +0000735 zipfp.writepy(fn, "testpackage")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000736
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000737 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Ezio Melottiaa980582010-01-23 23:04:36 +0000738 self.assertNotIn(bn, zipfp.namelist())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000739 self.assertTrue(bn + 'o' in zipfp.namelist() or
740 bn + 'c' in zipfp.namelist())
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000741
Ezio Melottid5a23e32009-07-15 17:07:04 +0000742 def test_write_python_package(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000743 import email
744 packagedir = os.path.dirname(email.__file__)
745
Ezio Melotti569e61f2009-12-30 06:14:51 +0000746 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
747 zipfp.writepy(packagedir)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000748
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000749 # Check for a couple of modules at different levels of the
750 # hierarchy
Ezio Melotti569e61f2009-12-30 06:14:51 +0000751 names = zipfp.namelist()
752 self.assertTrue('email/__init__.pyo' in names or
753 'email/__init__.pyc' in names)
754 self.assertTrue('email/mime/text.pyo' in names or
755 'email/mime/text.pyc' in names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000756
Ezio Melottid5a23e32009-07-15 17:07:04 +0000757 def test_write_python_directory(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000758 os.mkdir(TESTFN2)
759 try:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000760 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
Ezio Melotti763f1e82009-12-31 13:27:41 +0000761 fp.write("print(42)\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000762
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000763 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
Ezio Melotti763f1e82009-12-31 13:27:41 +0000764 fp.write("print(42 * 42)\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000765
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000766 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
767 fp.write("bla bla bla\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000768
769 zipfp = zipfile.PyZipFile(TemporaryFile(), "w")
770 zipfp.writepy(TESTFN2)
771
772 names = zipfp.namelist()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000773 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
774 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
Ezio Melottiaa980582010-01-23 23:04:36 +0000775 self.assertNotIn('mod2.txt', names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000776
777 finally:
778 shutil.rmtree(TESTFN2)
779
Ezio Melottid5a23e32009-07-15 17:07:04 +0000780 def test_write_non_pyfile(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000781 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000782 open(TESTFN, 'w').write('most definitely not a python file')
Ezio Melotti569e61f2009-12-30 06:14:51 +0000783 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
784 os.remove(TESTFN)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000785
786
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000787class OtherTests(unittest.TestCase):
Antoine Pitroue1436d12010-08-12 15:25:51 +0000788 zips_with_bad_crc = {
789 zipfile.ZIP_STORED: (
790 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
791 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
792 b'ilehello,AworldP'
793 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
794 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
795 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
796 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
797 b'\0\0/\0\0\0\0\0'),
798 zipfile.ZIP_DEFLATED: (
799 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
800 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
801 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
802 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
803 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
804 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
805 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
806 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
807 }
808
Ezio Melottid5a23e32009-07-15 17:07:04 +0000809 def test_unicode_filenames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000810 with zipfile.ZipFile(TESTFN, "w") as zf:
811 zf.writestr(u"foo.txt", "Test for unicode filename")
812 zf.writestr(u"\xf6.txt", "Test for unicode filename")
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000813 self.assertIsInstance(zf.infolist()[0].filename, unicode)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000814
815 with zipfile.ZipFile(TESTFN, "r") as zf:
816 self.assertEqual(zf.filelist[0].filename, "foo.txt")
817 self.assertEqual(zf.filelist[1].filename, u"\xf6.txt")
Martin v. Löwis471617d2008-05-05 17:16:58 +0000818
Ezio Melottid5a23e32009-07-15 17:07:04 +0000819 def test_create_non_existent_file_for_append(self):
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000820 if os.path.exists(TESTFN):
821 os.unlink(TESTFN)
Tim Petersea5962f2007-03-12 18:07:52 +0000822
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000823 filename = 'testfile.txt'
824 content = 'hello, world. this is some content.'
Tim Petersea5962f2007-03-12 18:07:52 +0000825
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000826 try:
Ezio Melotti569e61f2009-12-30 06:14:51 +0000827 with zipfile.ZipFile(TESTFN, 'a') as zf:
828 zf.writestr(filename, content)
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000829 except IOError:
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000830 self.fail('Could not append data to a non-existent zip file.')
831
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000832 self.assertTrue(os.path.exists(TESTFN))
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000833
Ezio Melotti569e61f2009-12-30 06:14:51 +0000834 with zipfile.ZipFile(TESTFN, 'r') as zf:
835 self.assertEqual(zf.read(filename), content)
Tim Petersea5962f2007-03-12 18:07:52 +0000836
Ezio Melottid5a23e32009-07-15 17:07:04 +0000837 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000838 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000839 # it opens if there's an error in the file. If it doesn't, the
840 # traceback holds a reference to the ZipFile object and, indirectly,
841 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000842 # On Windows, this causes the os.unlink() call to fail because the
843 # underlying file is still open. This is SF bug #412214.
844 #
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000845 with open(TESTFN, "w") as fp:
846 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000847 try:
848 zf = zipfile.ZipFile(TESTFN)
849 except zipfile.BadZipfile:
Collin Winter04a51ec2007-03-29 02:28:16 +0000850 pass
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000851
Ezio Melottid5a23e32009-07-15 17:07:04 +0000852 def test_is_zip_erroneous_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000853 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000854 # - passing a filename
855 with open(TESTFN, "w") as fp:
856 fp.write("this is not a legal zip file\n")
Tim Petersea5962f2007-03-12 18:07:52 +0000857 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000858 self.assertFalse(chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000859 # - passing a file object
860 with open(TESTFN, "rb") as fp:
861 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000862 self.assertTrue(not chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000863 # - passing a file-like object
864 fp = StringIO()
865 fp.write("this is not a legal zip file\n")
866 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000867 self.assertTrue(not chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000868 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000869 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000870 self.assertTrue(not chk)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000871
Serhiy Storchaka0be506a2013-01-31 15:26:55 +0200872 def test_damaged_zipfile(self):
873 """Check that zipfiles with missing bytes at the end raise BadZipFile."""
874 # - Create a valid zip file
875 fp = io.BytesIO()
876 with zipfile.ZipFile(fp, mode="w") as zipf:
877 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
878 zipfiledata = fp.getvalue()
879
880 # - Now create copies of it missing the last N bytes and make sure
881 # a BadZipFile exception is raised when we try to open it
882 for N in range(len(zipfiledata)):
883 fp = io.BytesIO(zipfiledata[:N])
884 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, fp)
885
Ezio Melottid5a23e32009-07-15 17:07:04 +0000886 def test_is_zip_valid_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000887 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000888 # - passing a filename
Ezio Melotti569e61f2009-12-30 06:14:51 +0000889 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
890 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Tim Petersea5962f2007-03-12 18:07:52 +0000891 chk = zipfile.is_zipfile(TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000892 self.assertTrue(chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000893 # - passing a file object
894 with open(TESTFN, "rb") as fp:
895 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000896 self.assertTrue(chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000897 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000898 zip_contents = fp.read()
899 # - passing a file-like object
900 fp = StringIO()
901 fp.write(zip_contents)
902 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000903 self.assertTrue(chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000904 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000905 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000906 self.assertTrue(chk)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000907
Ezio Melottid5a23e32009-07-15 17:07:04 +0000908 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000909 # make sure we don't raise an AttributeError when a partially-constructed
910 # ZipFile instance is finalized; this tests for regression on SF tracker
911 # bug #403871.
912
913 # The bug we're testing for caused an AttributeError to be raised
914 # when a ZipFile instance was created for a file that did not
915 # exist; the .fp member was not initialized but was needed by the
916 # __del__() method. Since the AttributeError is in the __del__(),
917 # it is ignored, but the user should be sufficiently annoyed by
918 # the message on the output that regression will be noticed
919 # quickly.
920 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
921
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000922 def test_empty_file_raises_BadZipFile(self):
Brian Curtin0d654332011-04-19 21:15:55 -0500923 with open(TESTFN, 'w') as f:
924 pass
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000925 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN)
926
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000927 with open(TESTFN, 'w') as fp:
928 fp.write("short file")
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000929 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN)
930
Ezio Melottid5a23e32009-07-15 17:07:04 +0000931 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000932 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000933 data = StringIO()
Ezio Melotti569e61f2009-12-30 06:14:51 +0000934 with zipfile.ZipFile(data, mode="w") as zipf:
935 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000936
Andrew Svetlov4bb142b2012-12-18 21:27:37 +0200937 # This is correct; calling .read on a closed ZipFile should raise
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000938 # a RuntimeError, and so should calling .testzip. An earlier
939 # version of .testzip would swallow this exception (and any other)
940 # and report that the first file in the archive was corrupt.
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000941 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
942 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000943 self.assertRaises(RuntimeError, zipf.testzip)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000944 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000945 open(TESTFN, 'w').write('zipfile test data')
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000946 self.assertRaises(RuntimeError, zipf.write, TESTFN)
947
Ezio Melottid5a23e32009-07-15 17:07:04 +0000948 def test_bad_constructor_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000949 """Check that bad modes passed to ZipFile constructor are caught."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000950 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
951
Ezio Melottid5a23e32009-07-15 17:07:04 +0000952 def test_bad_open_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000953 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000954 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
955 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
956
957 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000958 # read the data to make sure the file is there
Ezio Melotti569e61f2009-12-30 06:14:51 +0000959 zipf.read("foo.txt")
960 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000961
Ezio Melottid5a23e32009-07-15 17:07:04 +0000962 def test_read0(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000963 """Check that calling read(0) on a ZipExtFile object returns an empty
964 string and doesn't advance file pointer."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000965 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
966 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
967 # read the data to make sure the file is there
Brian Curtin0d654332011-04-19 21:15:55 -0500968 with zipf.open("foo.txt") as f:
969 for i in xrange(FIXEDTEST_SIZE):
970 self.assertEqual(f.read(0), '')
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000971
Brian Curtin0d654332011-04-19 21:15:55 -0500972 self.assertEqual(f.read(), "O, for a Muse of Fire!")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000973
Ezio Melottid5a23e32009-07-15 17:07:04 +0000974 def test_open_non_existent_item(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000975 """Check that attempting to call open() for an item that doesn't
976 exist in the archive raises a RuntimeError."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000977 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
978 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000979
Ezio Melottid5a23e32009-07-15 17:07:04 +0000980 def test_bad_compression_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000981 """Check that bad compression methods passed to ZipFile.open are
982 caught."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000983 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
984
Ezio Melotti9e949722012-11-18 13:18:06 +0200985 def test_unsupported_compression(self):
986 # data is declared as shrunk, but actually deflated
987 data = (b'PK\x03\x04.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00'
988 b'\x00\x02\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00x\x03\x00PK\x01'
989 b'\x02.\x03.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00\x00\x02\x00\x00'
990 b'\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
991 b'\x80\x01\x00\x00\x00\x00xPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00'
992 b'/\x00\x00\x00!\x00\x00\x00\x00\x00')
993 with zipfile.ZipFile(io.BytesIO(data), 'r') as zipf:
994 self.assertRaises(NotImplementedError, zipf.open, 'x')
995
Ezio Melottid5a23e32009-07-15 17:07:04 +0000996 def test_null_byte_in_filename(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000997 """Check that a filename containing a null byte is properly
998 terminated."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000999 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1000 zipf.writestr("foo.txt\x00qqq", "O, for a Muse of Fire!")
1001 self.assertEqual(zipf.namelist(), ['foo.txt'])
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00001002
Ezio Melottid5a23e32009-07-15 17:07:04 +00001003 def test_struct_sizes(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001004 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwis8c436412008-07-03 12:51:14 +00001005 self.assertEqual(zipfile.sizeEndCentDir, 22)
1006 self.assertEqual(zipfile.sizeCentralDir, 46)
1007 self.assertEqual(zipfile.sizeEndCentDir64, 56)
1008 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
1009
Ezio Melottid5a23e32009-07-15 17:07:04 +00001010 def test_comments(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001011 """Check that comments on the archive are handled properly."""
Martin v. Löwis8c436412008-07-03 12:51:14 +00001012
1013 # check default comment is empty
Ezio Melotti569e61f2009-12-30 06:14:51 +00001014 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1015 self.assertEqual(zipf.comment, '')
1016 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1017
1018 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
1019 self.assertEqual(zipf.comment, '')
Martin v. Löwis8c436412008-07-03 12:51:14 +00001020
1021 # check a simple short comment
1022 comment = 'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melotti569e61f2009-12-30 06:14:51 +00001023 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1024 zipf.comment = comment
1025 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1026 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
1027 self.assertEqual(zipf.comment, comment)
Martin v. Löwis8c436412008-07-03 12:51:14 +00001028
1029 # check a comment of max length
1030 comment2 = ''.join(['%d' % (i**3 % 10) for i in xrange((1 << 16)-1)])
Ezio Melotti569e61f2009-12-30 06:14:51 +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 zipf:
1036 self.assertEqual(zipf.comment, comment2)
Martin v. Löwis8c436412008-07-03 12:51:14 +00001037
1038 # check a comment that is too long is truncated
Ezio Melotti569e61f2009-12-30 06:14:51 +00001039 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
Serhiy Storchaka49259352014-01-20 21:57:09 +02001040 with check_warnings(('', UserWarning)):
1041 zipf.comment = comment2 + 'oops'
Ezio Melotti569e61f2009-12-30 06:14:51 +00001042 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1043 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
1044 self.assertEqual(zipf.comment, comment2)
Martin v. Löwis8c436412008-07-03 12:51:14 +00001045
R David Murray3f4ccba2012-04-12 18:42:47 -04001046 def test_change_comment_in_empty_archive(self):
1047 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1048 self.assertFalse(zipf.filelist)
1049 zipf.comment = b"this is a comment"
1050 with zipfile.ZipFile(TESTFN, "r") as zipf:
1051 self.assertEqual(zipf.comment, b"this is a comment")
1052
1053 def test_change_comment_in_nonempty_archive(self):
1054 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1055 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1056 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1057 self.assertTrue(zipf.filelist)
1058 zipf.comment = b"this is a comment"
1059 with zipfile.ZipFile(TESTFN, "r") as zipf:
1060 self.assertEqual(zipf.comment, b"this is a comment")
1061
Antoine Pitroue1436d12010-08-12 15:25:51 +00001062 def check_testzip_with_bad_crc(self, compression):
1063 """Tests that files with bad CRCs return their name from testzip."""
1064 zipdata = self.zips_with_bad_crc[compression]
1065
1066 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1067 # testzip returns the name of the first corrupt file, or None
1068 self.assertEqual('afile', zipf.testzip())
1069
1070 def test_testzip_with_bad_crc_stored(self):
1071 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
1072
1073 @skipUnless(zlib, "requires zlib")
1074 def test_testzip_with_bad_crc_deflated(self):
1075 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
1076
1077 def check_read_with_bad_crc(self, compression):
1078 """Tests that files with bad CRCs raise a BadZipfile exception when read."""
1079 zipdata = self.zips_with_bad_crc[compression]
1080
1081 # Using ZipFile.read()
1082 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1083 self.assertRaises(zipfile.BadZipfile, zipf.read, 'afile')
1084
1085 # Using ZipExtFile.read()
1086 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1087 with zipf.open('afile', 'r') as corrupt_file:
1088 self.assertRaises(zipfile.BadZipfile, corrupt_file.read)
1089
1090 # Same with small reads (in order to exercise the buffering logic)
1091 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1092 with zipf.open('afile', 'r') as corrupt_file:
1093 corrupt_file.MIN_READ_SIZE = 2
1094 with self.assertRaises(zipfile.BadZipfile):
1095 while corrupt_file.read(2):
1096 pass
1097
1098 def test_read_with_bad_crc_stored(self):
1099 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
1100
1101 @skipUnless(zlib, "requires zlib")
1102 def test_read_with_bad_crc_deflated(self):
1103 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
1104
Antoine Pitroue4195e82010-09-12 14:56:27 +00001105 def check_read_return_size(self, compression):
1106 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
1107 # than requested.
1108 for test_size in (1, 4095, 4096, 4097, 16384):
1109 file_size = test_size + 1
1110 junk = b''.join(struct.pack('B', randint(0, 255))
1111 for x in range(file_size))
1112 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
1113 zipf.writestr('foo', junk)
1114 with zipf.open('foo', 'r') as fp:
1115 buf = fp.read(test_size)
1116 self.assertEqual(len(buf), test_size)
1117
1118 def test_read_return_size_stored(self):
1119 self.check_read_return_size(zipfile.ZIP_STORED)
1120
1121 @skipUnless(zlib, "requires zlib")
1122 def test_read_return_size_deflated(self):
1123 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1124
Georg Brandl86e0c892010-11-26 07:22:28 +00001125 def test_empty_zipfile(self):
1126 # Check that creating a file in 'w' or 'a' mode and closing without
1127 # adding any files to the archives creates a valid empty ZIP file
Brian Curtin0d654332011-04-19 21:15:55 -05001128 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1129 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001130 try:
1131 zipf = zipfile.ZipFile(TESTFN, mode="r")
Éric Araujo67843b32011-02-02 17:03:38 +00001132 except zipfile.BadZipfile:
Georg Brandl86e0c892010-11-26 07:22:28 +00001133 self.fail("Unable to create empty ZIP file in 'w' mode")
1134
Brian Curtin0d654332011-04-19 21:15:55 -05001135 with zipfile.ZipFile(TESTFN, mode="a") as zipf:
1136 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001137 try:
1138 zipf = zipfile.ZipFile(TESTFN, mode="r")
1139 except:
1140 self.fail("Unable to create empty ZIP file in 'a' mode")
1141
1142 def test_open_empty_file(self):
1143 # Issue 1710703: Check that opening a file with less than 22 bytes
1144 # raises a BadZipfile exception (rather than the previously unhelpful
1145 # IOError)
Brian Curtin0d654332011-04-19 21:15:55 -05001146 with open(TESTFN, 'w') as f:
1147 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001148 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN, 'r')
1149
Senthil Kumaranddd40312011-10-20 01:38:35 +08001150 def test_create_zipinfo_before_1980(self):
1151 self.assertRaises(ValueError,
1152 zipfile.ZipInfo, 'seventies', (1979, 1, 1, 0, 0, 0))
1153
Collin Winter04a51ec2007-03-29 02:28:16 +00001154 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001155 unlink(TESTFN)
1156 unlink(TESTFN2)
1157
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001158
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001159class DecryptionTests(unittest.TestCase):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001160 """Check that ZIP decryption works. Since the library does not
1161 support encryption at the moment, we use a pre-generated encrypted
1162 ZIP file."""
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001163
1164 data = (
1165 'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1166 '\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1167 '\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1168 'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1169 '\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1170 '\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1171 '\x00\x00L\x00\x00\x00\x00\x00' )
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001172 data2 = (
1173 'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1174 '\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1175 '\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1176 'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1177 '\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1178 '\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1179 'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1180 '\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001181
1182 plain = 'zipfile.py encryption test'
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001183 plain2 = '\x00'*512
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001184
1185 def setUp(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001186 with open(TESTFN, "wb") as fp:
1187 fp.write(self.data)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001188 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001189 with open(TESTFN2, "wb") as fp:
1190 fp.write(self.data2)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001191 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001192
1193 def tearDown(self):
1194 self.zip.close()
1195 os.unlink(TESTFN)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001196 self.zip2.close()
1197 os.unlink(TESTFN2)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001198
Ezio Melottid5a23e32009-07-15 17:07:04 +00001199 def test_no_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001200 # Reading the encrypted file without password
1201 # must generate a RunTime exception
1202 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001203 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001204
Ezio Melottid5a23e32009-07-15 17:07:04 +00001205 def test_bad_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001206 self.zip.setpassword("perl")
1207 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001208 self.zip2.setpassword("perl")
1209 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Tim Petersea5962f2007-03-12 18:07:52 +00001210
Ezio Melotti1036a7f2009-09-12 14:43:43 +00001211 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001212 def test_good_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001213 self.zip.setpassword("python")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001214 self.assertEqual(self.zip.read("test.txt"), self.plain)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001215 self.zip2.setpassword("12345")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001216 self.assertEqual(self.zip2.read("zero"), self.plain2)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001217
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001218
1219class TestsWithRandomBinaryFiles(unittest.TestCase):
1220 def setUp(self):
1221 datacount = randint(16, 64)*1024 + randint(1, 1024)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001222 self.data = ''.join(struct.pack('<f', random()*randint(-1000, 1000))
Ezio Melotti763f1e82009-12-31 13:27:41 +00001223 for i in xrange(datacount))
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001224
1225 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001226 with open(TESTFN, "wb") as fp:
1227 fp.write(self.data)
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00001228
Collin Winter04a51ec2007-03-29 02:28:16 +00001229 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001230 unlink(TESTFN)
1231 unlink(TESTFN2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001232
Ezio Melottid5a23e32009-07-15 17:07:04 +00001233 def make_test_archive(self, f, compression):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001234 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001235 with zipfile.ZipFile(f, "w", compression) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001236 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +00001237 zipfp.write(TESTFN, TESTFN)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001238
Ezio Melottid5a23e32009-07-15 17:07:04 +00001239 def zip_test(self, f, compression):
1240 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001241
1242 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001243 with zipfile.ZipFile(f, "r", compression) as zipfp:
1244 testdata = zipfp.read(TESTFN)
1245 self.assertEqual(len(testdata), len(self.data))
1246 self.assertEqual(testdata, self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001247 self.assertEqual(zipfp.read("another.name"), self.data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001248
Ezio Melottid5a23e32009-07-15 17:07:04 +00001249 def test_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001250 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001251 self.zip_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001252
Antoine Pitroue1436d12010-08-12 15:25:51 +00001253 @skipUnless(zlib, "requires zlib")
1254 def test_deflated(self):
1255 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1256 self.zip_test(f, zipfile.ZIP_DEFLATED)
1257
Ezio Melottid5a23e32009-07-15 17:07:04 +00001258 def zip_open_test(self, f, compression):
1259 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001260
1261 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001262 with zipfile.ZipFile(f, "r", compression) as zipfp:
1263 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001264 with zipfp.open(TESTFN) as zipopen1:
1265 while True:
1266 read_data = zipopen1.read(256)
1267 if not read_data:
1268 break
1269 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001270
Ezio Melotti569e61f2009-12-30 06:14:51 +00001271 zipdata2 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001272 with zipfp.open("another.name") as zipopen2:
1273 while True:
1274 read_data = zipopen2.read(256)
1275 if not read_data:
1276 break
1277 zipdata2.append(read_data)
Tim Petersea5962f2007-03-12 18:07:52 +00001278
Ezio Melotti569e61f2009-12-30 06:14:51 +00001279 testdata1 = ''.join(zipdata1)
1280 self.assertEqual(len(testdata1), len(self.data))
1281 self.assertEqual(testdata1, self.data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001282
Ezio Melotti569e61f2009-12-30 06:14:51 +00001283 testdata2 = ''.join(zipdata2)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001284 self.assertEqual(len(testdata2), len(self.data))
1285 self.assertEqual(testdata2, self.data)
Tim Petersea5962f2007-03-12 18:07:52 +00001286
Ezio Melottid5a23e32009-07-15 17:07:04 +00001287 def test_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001288 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001289 self.zip_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001290
Antoine Pitroue1436d12010-08-12 15:25:51 +00001291 @skipUnless(zlib, "requires zlib")
1292 def test_open_deflated(self):
1293 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1294 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1295
Ezio Melottid5a23e32009-07-15 17:07:04 +00001296 def zip_random_open_test(self, f, compression):
1297 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001298
1299 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001300 with zipfile.ZipFile(f, "r", compression) as zipfp:
1301 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001302 with zipfp.open(TESTFN) as zipopen1:
1303 while True:
1304 read_data = zipopen1.read(randint(1, 1024))
1305 if not read_data:
1306 break
1307 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001308
Ezio Melotti569e61f2009-12-30 06:14:51 +00001309 testdata = ''.join(zipdata1)
1310 self.assertEqual(len(testdata), len(self.data))
1311 self.assertEqual(testdata, self.data)
Tim Petersea5962f2007-03-12 18:07:52 +00001312
Ezio Melottid5a23e32009-07-15 17:07:04 +00001313 def test_random_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001314 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001315 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001316
Antoine Pitroue1436d12010-08-12 15:25:51 +00001317 @skipUnless(zlib, "requires zlib")
1318 def test_random_open_deflated(self):
1319 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1320 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1321
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001322
Ezio Melotti1036a7f2009-09-12 14:43:43 +00001323@skipUnless(zlib, "requires zlib")
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001324class TestsWithMultipleOpens(unittest.TestCase):
1325 def setUp(self):
1326 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001327 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1328 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1329 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Tim Petersea5962f2007-03-12 18:07:52 +00001330
Ezio Melottid5a23e32009-07-15 17:07:04 +00001331 def test_same_file(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001332 # Verify that (when the ZipFile is in control of creating file objects)
1333 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001334 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
1335 zopen1 = zipf.open('ones')
1336 zopen2 = zipf.open('ones')
1337 data1 = zopen1.read(500)
1338 data2 = zopen2.read(500)
1339 data1 += zopen1.read(500)
1340 data2 += zopen2.read(500)
1341 self.assertEqual(data1, data2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001342
Ezio Melottid5a23e32009-07-15 17:07:04 +00001343 def test_different_file(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001344 # Verify that (when the ZipFile is in control of creating file objects)
1345 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001346 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin0d654332011-04-19 21:15:55 -05001347 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1348 data1 = zopen1.read(500)
1349 data2 = zopen2.read(500)
1350 data1 += zopen1.read(500)
1351 data2 += zopen2.read(500)
Ezio Melotti569e61f2009-12-30 06:14:51 +00001352 self.assertEqual(data1, '1'*FIXEDTEST_SIZE)
1353 self.assertEqual(data2, '2'*FIXEDTEST_SIZE)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001354
Ezio Melottid5a23e32009-07-15 17:07:04 +00001355 def test_interleaved(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001356 # Verify that (when the ZipFile is in control of creating file objects)
1357 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001358 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin0d654332011-04-19 21:15:55 -05001359 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1360 data1 = zopen1.read(500)
1361 data2 = zopen2.read(500)
1362 data1 += zopen1.read(500)
1363 data2 += zopen2.read(500)
Ezio Melotti569e61f2009-12-30 06:14:51 +00001364 self.assertEqual(data1, '1'*FIXEDTEST_SIZE)
1365 self.assertEqual(data2, '2'*FIXEDTEST_SIZE)
Tim Petersea5962f2007-03-12 18:07:52 +00001366
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001367 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001368 unlink(TESTFN2)
1369
Tim Petersea5962f2007-03-12 18:07:52 +00001370
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001371class TestWithDirectory(unittest.TestCase):
1372 def setUp(self):
1373 os.mkdir(TESTFN2)
1374
Ezio Melottid5a23e32009-07-15 17:07:04 +00001375 def test_extract_dir(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +00001376 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1377 zipf.extractall(TESTFN2)
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001378 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1379 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1380 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1381
Ezio Melottid5a23e32009-07-15 17:07:04 +00001382 def test_bug_6050(self):
Martin v. Löwis0b09c422009-05-24 19:30:52 +00001383 # Extraction should succeed if directories already exist
1384 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottid5a23e32009-07-15 17:07:04 +00001385 self.test_extract_dir()
Martin v. Löwis0b09c422009-05-24 19:30:52 +00001386
Ezio Melottid5a23e32009-07-15 17:07:04 +00001387 def test_store_dir(self):
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001388 os.mkdir(os.path.join(TESTFN2, "x"))
1389 zipf = zipfile.ZipFile(TESTFN, "w")
1390 zipf.write(os.path.join(TESTFN2, "x"), "x")
1391 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1392
1393 def tearDown(self):
1394 shutil.rmtree(TESTFN2)
1395 if os.path.exists(TESTFN):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001396 unlink(TESTFN)
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001397
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001398
1399class UniversalNewlineTests(unittest.TestCase):
1400 def setUp(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001401 self.line_gen = ["Test of zipfile line %d." % i
1402 for i in xrange(FIXEDTEST_SIZE)]
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001403 self.seps = ('\r', '\r\n', '\n')
1404 self.arcdata, self.arcfiles = {}, {}
1405 for n, s in enumerate(self.seps):
1406 self.arcdata[s] = s.join(self.line_gen) + s
1407 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Brett Cannon6cef0762007-05-25 20:17:15 +00001408 open(self.arcfiles[s], "wb").write(self.arcdata[s])
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001409
Ezio Melottid5a23e32009-07-15 17:07:04 +00001410 def make_test_archive(self, f, compression):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001411 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001412 with zipfile.ZipFile(f, "w", compression) as zipfp:
1413 for fn in self.arcfiles.values():
1414 zipfp.write(fn, fn)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001415
Ezio Melottid5a23e32009-07-15 17:07:04 +00001416 def read_test(self, f, compression):
1417 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001418
1419 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001420 with zipfile.ZipFile(f, "r") as zipfp:
1421 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001422 with zipfp.open(fn, "rU") as fp:
1423 zipdata = fp.read()
Ezio Melotti569e61f2009-12-30 06:14:51 +00001424 self.assertEqual(self.arcdata[sep], zipdata)
Tim Petersea5962f2007-03-12 18:07:52 +00001425
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001426 def readline_read_test(self, f, compression):
1427 self.make_test_archive(f, compression)
1428
1429 # Read the ZIP archive
1430 zipfp = zipfile.ZipFile(f, "r")
1431 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001432 with zipfp.open(fn, "rU") as zipopen:
1433 data = ''
1434 while True:
1435 read = zipopen.readline()
1436 if not read:
1437 break
1438 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001439
Brian Curtin0d654332011-04-19 21:15:55 -05001440 read = zipopen.read(5)
1441 if not read:
1442 break
1443 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001444
1445 self.assertEqual(data, self.arcdata['\n'])
1446
1447 zipfp.close()
1448
Ezio Melottid5a23e32009-07-15 17:07:04 +00001449 def readline_test(self, f, compression):
1450 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001451
1452 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001453 with zipfile.ZipFile(f, "r") as zipfp:
1454 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001455 with zipfp.open(fn, "rU") as zipopen:
1456 for line in self.line_gen:
1457 linedata = zipopen.readline()
1458 self.assertEqual(linedata, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001459
Ezio Melottid5a23e32009-07-15 17:07:04 +00001460 def readlines_test(self, f, compression):
1461 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001462
1463 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001464 with zipfile.ZipFile(f, "r") as zipfp:
1465 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001466 with zipfp.open(fn, "rU") as fp:
1467 ziplines = fp.readlines()
Ezio Melotti569e61f2009-12-30 06:14:51 +00001468 for line, zipline in zip(self.line_gen, ziplines):
1469 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001470
Ezio Melottid5a23e32009-07-15 17:07:04 +00001471 def iterlines_test(self, f, compression):
1472 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001473
1474 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001475 with zipfile.ZipFile(f, "r") as zipfp:
1476 for sep, fn in self.arcfiles.items():
1477 for line, zipline in zip(self.line_gen, zipfp.open(fn, "rU")):
1478 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001479
Ezio Melottid5a23e32009-07-15 17:07:04 +00001480 def test_read_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001481 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001482 self.read_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001483
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001484 def test_readline_read_stored(self):
1485 # Issue #7610: calls to readline() interleaved with calls to read().
1486 for f in (TESTFN2, TemporaryFile(), StringIO()):
1487 self.readline_read_test(f, zipfile.ZIP_STORED)
1488
Ezio Melottid5a23e32009-07-15 17:07:04 +00001489 def test_readline_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001490 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001491 self.readline_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001492
Ezio Melottid5a23e32009-07-15 17:07:04 +00001493 def test_readlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001494 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001495 self.readlines_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001496
Ezio Melottid5a23e32009-07-15 17:07:04 +00001497 def test_iterlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001498 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001499 self.iterlines_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001500
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001501 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001502 def test_read_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001503 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001504 self.read_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001505
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001506 @skipUnless(zlib, "requires zlib")
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001507 def test_readline_read_deflated(self):
1508 # Issue #7610: calls to readline() interleaved with calls to read().
1509 for f in (TESTFN2, TemporaryFile(), StringIO()):
1510 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1511
1512 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001513 def test_readline_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001514 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001515 self.readline_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001516
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001517 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001518 def test_readlines_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001519 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001520 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001521
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001522 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001523 def test_iterlines_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001524 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001525 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001526
1527 def tearDown(self):
1528 for sep, fn in self.arcfiles.items():
1529 os.remove(fn)
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001530 unlink(TESTFN)
1531 unlink(TESTFN2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001532
1533
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001534def test_main():
Tim Petersea5962f2007-03-12 18:07:52 +00001535 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1536 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001537 TestWithDirectory, UniversalNewlineTests,
1538 TestsWithRandomBinaryFiles)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001539
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001540if __name__ == "__main__":
1541 test_main()