blob: 58d3c4883a26916aa64f79a44fe787b20847def2 [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
Ezio Melotti6cbfc122009-07-10 20:25:56 +000021from test.test_support import TESTFN, run_unittest, findfile, unlink
Guido van Rossum368f04a2000-04-10 13:23:04 +000022
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000023TESTFN2 = TESTFN + "2"
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +000024TESTFNDIR = TESTFN + "d"
Georg Brandl4b3ab6f2007-07-12 09:59:22 +000025FIXEDTEST_SIZE = 1000
Guido van Rossum368f04a2000-04-10 13:23:04 +000026
Georg Brandl62416bc2008-01-07 18:47:44 +000027SMALL_TEST_DATA = [('_ziptest1', '1q2w3e4r5t'),
28 ('ziptest2dir/_ziptest2', 'qawsedrftg'),
Gregory P. Smith608cc452013-02-01 11:40:18 -080029 ('ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
Georg Brandl62416bc2008-01-07 18:47:44 +000030 ('ziptest2dir/ziptest3dir/ziptest4dir/_ziptest3', '6y7u8i9o0p')]
31
Ezio Melotti6cbfc122009-07-10 20:25:56 +000032
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000033class TestsWithSourceFile(unittest.TestCase):
34 def setUp(self):
Georg Brandl4b3ab6f2007-07-12 09:59:22 +000035 self.line_gen = ["Zipfile test line %d. random float: %f" % (i, random())
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000036 for i in xrange(FIXEDTEST_SIZE)]
Martin v. Löwis3eb76482007-03-06 10:41:24 +000037 self.data = '\n'.join(self.line_gen) + '\n'
Fred Drake6e7e4852001-02-28 05:34:16 +000038
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000039 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000040 with open(TESTFN, "wb") as fp:
41 fp.write(self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000042
Ezio Melottid5a23e32009-07-15 17:07:04 +000043 def make_test_archive(self, f, compression):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000044 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +000045 with zipfile.ZipFile(f, "w", compression) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000046 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +000047 zipfp.write(TESTFN, TESTFN)
48 zipfp.writestr("strfile", self.data)
Tim Peters7d3bad62001-04-04 18:56:49 +000049
Ezio Melottid5a23e32009-07-15 17:07:04 +000050 def zip_test(self, f, compression):
51 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +000052
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +000053 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +000054 with zipfile.ZipFile(f, "r", compression) as zipfp:
55 self.assertEqual(zipfp.read(TESTFN), self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000056 self.assertEqual(zipfp.read("another.name"), self.data)
Ezio Melotti569e61f2009-12-30 06:14:51 +000057 self.assertEqual(zipfp.read("strfile"), self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +000058
Ezio Melotti569e61f2009-12-30 06:14:51 +000059 # Print the ZIP directory
60 fp = StringIO()
61 stdout = sys.stdout
62 try:
63 sys.stdout = fp
64 zipfp.printdir()
65 finally:
66 sys.stdout = stdout
Tim Petersa608bb22006-06-15 18:06:29 +000067
Ezio Melotti569e61f2009-12-30 06:14:51 +000068 directory = fp.getvalue()
69 lines = directory.splitlines()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000070 self.assertEqual(len(lines), 4) # Number of files + header
Ronald Oussoren143cefb2006-06-15 08:14:18 +000071
Ezio Melottiaa980582010-01-23 23:04:36 +000072 self.assertIn('File Name', lines[0])
73 self.assertIn('Modified', lines[0])
74 self.assertIn('Size', lines[0])
Ronald Oussoren143cefb2006-06-15 08:14:18 +000075
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000076 fn, date, time_, size = lines[1].split()
77 self.assertEqual(fn, 'another.name')
78 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
79 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
80 self.assertEqual(size, str(len(self.data)))
Ronald Oussoren143cefb2006-06-15 08:14:18 +000081
Ezio Melotti569e61f2009-12-30 06:14:51 +000082 # Check the namelist
83 names = zipfp.namelist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000084 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +000085 self.assertIn(TESTFN, names)
86 self.assertIn("another.name", names)
87 self.assertIn("strfile", names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +000088
Ezio Melotti569e61f2009-12-30 06:14:51 +000089 # Check infolist
90 infos = zipfp.infolist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000091 names = [i.filename for i in infos]
92 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +000093 self.assertIn(TESTFN, names)
94 self.assertIn("another.name", names)
95 self.assertIn("strfile", names)
Ezio Melotti569e61f2009-12-30 06:14:51 +000096 for i in infos:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +000097 self.assertEqual(i.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +000098
Ezio Melotti569e61f2009-12-30 06:14:51 +000099 # check getinfo
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000100 for nm in (TESTFN, "another.name", "strfile"):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000101 info = zipfp.getinfo(nm)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000102 self.assertEqual(info.filename, nm)
103 self.assertEqual(info.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000104
Ezio Melotti569e61f2009-12-30 06:14:51 +0000105 # Check that testzip doesn't raise an exception
106 zipfp.testzip()
Tim Peters7d3bad62001-04-04 18:56:49 +0000107
Ezio Melottid5a23e32009-07-15 17:07:04 +0000108 def test_stored(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000109 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000110 self.zip_test(f, zipfile.ZIP_STORED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000111
Ezio Melottid5a23e32009-07-15 17:07:04 +0000112 def zip_open_test(self, f, compression):
113 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000114
115 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000116 with zipfile.ZipFile(f, "r", compression) as zipfp:
117 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -0500118 with zipfp.open(TESTFN) as zipopen1:
119 while True:
120 read_data = zipopen1.read(256)
121 if not read_data:
122 break
123 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000124
Ezio Melotti569e61f2009-12-30 06:14:51 +0000125 zipdata2 = []
Brian Curtin0d654332011-04-19 21:15:55 -0500126 with zipfp.open("another.name") as zipopen2:
127 while True:
128 read_data = zipopen2.read(256)
129 if not read_data:
130 break
131 zipdata2.append(read_data)
Tim Petersea5962f2007-03-12 18:07:52 +0000132
Ezio Melotti569e61f2009-12-30 06:14:51 +0000133 self.assertEqual(''.join(zipdata1), self.data)
134 self.assertEqual(''.join(zipdata2), self.data)
Tim Petersea5962f2007-03-12 18:07:52 +0000135
Ezio Melottid5a23e32009-07-15 17:07:04 +0000136 def test_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000137 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000138 self.zip_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000139
Ezio Melottid5a23e32009-07-15 17:07:04 +0000140 def test_open_via_zip_info(self):
Georg Brandl112aa502008-05-20 08:25:48 +0000141 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000142 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
143 zipfp.writestr("name", "foo")
144 zipfp.writestr("name", "bar")
Georg Brandl112aa502008-05-20 08:25:48 +0000145
Ezio Melotti569e61f2009-12-30 06:14:51 +0000146 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
147 infos = zipfp.infolist()
148 data = ""
149 for info in infos:
Brian Curtin0d654332011-04-19 21:15:55 -0500150 with zipfp.open(info) as f:
151 data += f.read()
Ezio Melotti569e61f2009-12-30 06:14:51 +0000152 self.assertTrue(data == "foobar" or data == "barfoo")
153 data = ""
154 for info in infos:
155 data += zipfp.read(info)
156 self.assertTrue(data == "foobar" or data == "barfoo")
Georg Brandl112aa502008-05-20 08:25:48 +0000157
Ezio Melottid5a23e32009-07-15 17:07:04 +0000158 def zip_random_open_test(self, f, compression):
159 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000160
161 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000162 with zipfile.ZipFile(f, "r", compression) as zipfp:
163 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -0500164 with zipfp.open(TESTFN) as zipopen1:
165 while True:
166 read_data = zipopen1.read(randint(1, 1024))
167 if not read_data:
168 break
169 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000170
Ezio Melotti569e61f2009-12-30 06:14:51 +0000171 self.assertEqual(''.join(zipdata1), self.data)
Tim Petersea5962f2007-03-12 18:07:52 +0000172
Ezio Melottid5a23e32009-07-15 17:07:04 +0000173 def test_random_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000174 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000175 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +0000176
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000177 def test_univeral_readaheads(self):
178 f = StringIO()
179
180 data = 'a\r\n' * 16 * 1024
Brian Curtin0d654332011-04-19 21:15:55 -0500181 with zipfile.ZipFile(f, 'w', zipfile.ZIP_STORED) as zipfp:
182 zipfp.writestr(TESTFN, data)
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000183
184 data2 = ''
Brian Curtin0d654332011-04-19 21:15:55 -0500185 with zipfile.ZipFile(f, 'r') as zipfp:
186 with zipfp.open(TESTFN, 'rU') as zipopen:
187 for line in zipopen:
188 data2 += line
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000189
190 self.assertEqual(data, data2.replace('\n', '\r\n'))
191
192 def zip_readline_read_test(self, f, compression):
193 self.make_test_archive(f, compression)
194
195 # Read the ZIP archive
Brian Curtin0d654332011-04-19 21:15:55 -0500196 with zipfile.ZipFile(f, "r") as zipfp:
197 with zipfp.open(TESTFN) as zipopen:
198 data = ''
199 while True:
200 read = zipopen.readline()
201 if not read:
202 break
203 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000204
Brian Curtin0d654332011-04-19 21:15:55 -0500205 read = zipopen.read(100)
206 if not read:
207 break
208 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000209
210 self.assertEqual(data, self.data)
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000211
Ezio Melottid5a23e32009-07-15 17:07:04 +0000212 def zip_readline_test(self, f, compression):
213 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000214
215 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000216 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin0d654332011-04-19 21:15:55 -0500217 with zipfp.open(TESTFN) as zipopen:
218 for line in self.line_gen:
219 linedata = zipopen.readline()
220 self.assertEqual(linedata, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000221
Ezio Melottid5a23e32009-07-15 17:07:04 +0000222 def zip_readlines_test(self, f, compression):
223 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000224
225 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000226 with zipfile.ZipFile(f, "r") as zipfp:
Brian Curtin0d654332011-04-19 21:15:55 -0500227 with zipfp.open(TESTFN) as zo:
228 ziplines = zo.readlines()
229 for line, zipline in zip(self.line_gen, ziplines):
230 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000231
Ezio Melottid5a23e32009-07-15 17:07:04 +0000232 def zip_iterlines_test(self, f, compression):
233 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000234
235 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000236 with zipfile.ZipFile(f, "r") as zipfp:
237 for line, zipline in zip(self.line_gen, zipfp.open(TESTFN)):
238 self.assertEqual(zipline, line + '\n')
Tim Petersea5962f2007-03-12 18:07:52 +0000239
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000240 def test_readline_read_stored(self):
241 # Issue #7610: calls to readline() interleaved with calls to read().
242 for f in (TESTFN2, TemporaryFile(), StringIO()):
243 self.zip_readline_read_test(f, zipfile.ZIP_STORED)
244
Ezio Melottid5a23e32009-07-15 17:07:04 +0000245 def test_readline_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000246 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000247 self.zip_readline_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000248
Ezio Melottid5a23e32009-07-15 17:07:04 +0000249 def test_readlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000250 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000251 self.zip_readlines_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000252
Ezio Melottid5a23e32009-07-15 17:07:04 +0000253 def test_iterlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000254 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000255 self.zip_iterlines_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000256
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000257 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000258 def test_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000259 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000260 self.zip_test(f, zipfile.ZIP_DEFLATED)
Raymond Hettingerc0fac962003-06-27 22:25:03 +0000261
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000262 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000263 def test_open_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000264 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000265 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000266
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000267 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000268 def test_random_open_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000269 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000270 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000271
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000272 @skipUnless(zlib, "requires zlib")
Antoine Pitrou94c33eb2010-01-27 20:59:50 +0000273 def test_readline_read_deflated(self):
274 # Issue #7610: calls to readline() interleaved with calls to read().
275 for f in (TESTFN2, TemporaryFile(), StringIO()):
276 self.zip_readline_read_test(f, zipfile.ZIP_DEFLATED)
277
278 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000279 def test_readline_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000280 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000281 self.zip_readline_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000282
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000283 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000284 def test_readlines_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000285 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000286 self.zip_readlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000287
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000288 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000289 def test_iterlines_deflated(self):
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000290 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000291 self.zip_iterlines_test(f, zipfile.ZIP_DEFLATED)
Tim Petersea5962f2007-03-12 18:07:52 +0000292
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000293 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000294 def test_low_compression(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000295 """Check for cases where compressed data is larger than original."""
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000296 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000297 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
298 zipfp.writestr("strfile", '12')
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000299
Ezio Melottie7a0cc22009-07-04 14:58:27 +0000300 # Get an open object for strfile
Ezio Melotti569e61f2009-12-30 06:14:51 +0000301 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_DEFLATED) as zipfp:
Brian Curtin0d654332011-04-19 21:15:55 -0500302 with zipfp.open("strfile") as openobj:
303 self.assertEqual(openobj.read(1), '1')
304 self.assertEqual(openobj.read(1), '2')
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000305
Ezio Melottid5a23e32009-07-15 17:07:04 +0000306 def test_absolute_arcnames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000307 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
308 zipfp.write(TESTFN, "/absolute")
Georg Brandl8f7c54e2006-02-20 08:40:38 +0000309
Ezio Melotti569e61f2009-12-30 06:14:51 +0000310 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
311 self.assertEqual(zipfp.namelist(), ["absolute"])
Tim Peters32cbc962006-02-20 21:42:18 +0000312
Ezio Melottid5a23e32009-07-15 17:07:04 +0000313 def test_append_to_zip_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000314 """Test appending to an existing zipfile."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000315 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
316 zipfp.write(TESTFN, TESTFN)
317
318 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
319 zipfp.writestr("strfile", self.data)
320 self.assertEqual(zipfp.namelist(), [TESTFN, "strfile"])
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000321
Ezio Melottid5a23e32009-07-15 17:07:04 +0000322 def test_append_to_non_zip_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000323 """Test appending to an existing file that is not a zipfile."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000324 # NOTE: this test fails if len(d) < 22 because of the first
325 # line "fpin.seek(-22, 2)" in _EndRecData
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000326 data = 'I am not a ZipFile!'*10
327 with open(TESTFN2, 'wb') as f:
328 f.write(data)
329
Ezio Melotti569e61f2009-12-30 06:14:51 +0000330 with zipfile.ZipFile(TESTFN2, "a", zipfile.ZIP_STORED) as zipfp:
331 zipfp.write(TESTFN, TESTFN)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000332
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000333 with open(TESTFN2, 'rb') as f:
334 f.seek(len(data))
335 with zipfile.ZipFile(f, "r") as zipfp:
336 self.assertEqual(zipfp.namelist(), [TESTFN])
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000337
R David Murray873c5832011-06-09 16:01:09 -0400338 def test_ignores_newline_at_end(self):
339 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
340 zipfp.write(TESTFN, TESTFN)
341 with open(TESTFN2, 'a') as f:
342 f.write("\r\n\00\00\00")
343 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
344 self.assertIsInstance(zipfp, zipfile.ZipFile)
345
346 def test_ignores_stuff_appended_past_comments(self):
347 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
348 zipfp.comment = b"this is a comment"
349 zipfp.write(TESTFN, TESTFN)
350 with open(TESTFN2, 'a') as f:
351 f.write("abcdef\r\n")
352 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
353 self.assertIsInstance(zipfp, zipfile.ZipFile)
354 self.assertEqual(zipfp.comment, b"this is a comment")
355
Ezio Melottid5a23e32009-07-15 17:07:04 +0000356 def test_write_default_name(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000357 """Check that calling ZipFile.write without arcname specified
358 produces the expected result."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000359 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
360 zipfp.write(TESTFN)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000361 self.assertEqual(zipfp.read(TESTFN), open(TESTFN).read())
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000362
Ezio Melotti1036a7f2009-09-12 14:43:43 +0000363 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000364 def test_per_file_compression(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000365 """Check that files within a Zip archive can have different
366 compression options."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000367 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
368 zipfp.write(TESTFN, 'storeme', zipfile.ZIP_STORED)
369 zipfp.write(TESTFN, 'deflateme', zipfile.ZIP_DEFLATED)
370 sinfo = zipfp.getinfo('storeme')
371 dinfo = zipfp.getinfo('deflateme')
372 self.assertEqual(sinfo.compress_type, zipfile.ZIP_STORED)
373 self.assertEqual(dinfo.compress_type, zipfile.ZIP_DEFLATED)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000374
Ezio Melottid5a23e32009-07-15 17:07:04 +0000375 def test_write_to_readonly(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000376 """Check that trying to call write() on a readonly ZipFile object
377 raises a RuntimeError."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000378 with zipfile.ZipFile(TESTFN2, mode="w") as zipfp:
379 zipfp.writestr("somefile.txt", "bogus")
380
381 with zipfile.ZipFile(TESTFN2, mode="r") as zipfp:
382 self.assertRaises(RuntimeError, zipfp.write, TESTFN)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000383
Ezio Melottid5a23e32009-07-15 17:07:04 +0000384 def test_extract(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000385 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
386 for fpath, fdata in SMALL_TEST_DATA:
387 zipfp.writestr(fpath, fdata)
Georg Brandl62416bc2008-01-07 18:47:44 +0000388
Ezio Melotti569e61f2009-12-30 06:14:51 +0000389 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
390 for fpath, fdata in SMALL_TEST_DATA:
391 writtenfile = zipfp.extract(fpath)
Georg Brandl62416bc2008-01-07 18:47:44 +0000392
Ezio Melotti569e61f2009-12-30 06:14:51 +0000393 # make sure it was written to the right place
Gregory P. Smith608cc452013-02-01 11:40:18 -0800394 correctfile = os.path.join(os.getcwd(), fpath)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000395 correctfile = os.path.normpath(correctfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000396
Ezio Melotti569e61f2009-12-30 06:14:51 +0000397 self.assertEqual(writtenfile, correctfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000398
Ezio Melotti569e61f2009-12-30 06:14:51 +0000399 # make sure correct data is in correct file
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000400 self.assertEqual(fdata, open(writtenfile, "rb").read())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000401 os.remove(writtenfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000402
403 # remove the test file subdirectories
404 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
405
Ezio Melottid5a23e32009-07-15 17:07:04 +0000406 def test_extract_all(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000407 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
408 for fpath, fdata in SMALL_TEST_DATA:
409 zipfp.writestr(fpath, fdata)
Georg Brandl62416bc2008-01-07 18:47:44 +0000410
Ezio Melotti569e61f2009-12-30 06:14:51 +0000411 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
412 zipfp.extractall()
413 for fpath, fdata in SMALL_TEST_DATA:
Gregory P. Smith608cc452013-02-01 11:40:18 -0800414 outfile = os.path.join(os.getcwd(), fpath)
Georg Brandl62416bc2008-01-07 18:47:44 +0000415
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000416 self.assertEqual(fdata, open(outfile, "rb").read())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000417 os.remove(outfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000418
419 # remove the test file subdirectories
420 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
421
Gregory P. Smith608cc452013-02-01 11:40:18 -0800422 def check_file(self, filename, content):
423 self.assertTrue(os.path.isfile(filename))
424 with open(filename, 'rb') as f:
425 self.assertEqual(f.read(), content)
426
427 def test_extract_hackers_arcnames(self):
428 hacknames = [
429 ('../foo/bar', 'foo/bar'),
430 ('foo/../bar', 'foo/bar'),
431 ('foo/../../bar', 'foo/bar'),
432 ('foo/bar/..', 'foo/bar'),
433 ('./../foo/bar', 'foo/bar'),
434 ('/foo/bar', 'foo/bar'),
435 ('/foo/../bar', 'foo/bar'),
436 ('/foo/../../bar', 'foo/bar'),
437 ('//foo/bar', 'foo/bar'),
438 ('../../foo../../ba..r', 'foo../ba..r'),
439 ]
440 if os.path.sep == '\\':
441 hacknames.extend([
442 (r'..\foo\bar', 'foo/bar'),
443 (r'..\/foo\/bar', 'foo/bar'),
444 (r'foo/\..\/bar', 'foo/bar'),
445 (r'foo\/../\bar', 'foo/bar'),
446 (r'C:foo/bar', 'foo/bar'),
447 (r'C:/foo/bar', 'foo/bar'),
448 (r'C://foo/bar', 'foo/bar'),
449 (r'C:\foo\bar', 'foo/bar'),
450 (r'//conky/mountpoint/foo/bar', 'foo/bar'),
451 (r'\\conky\mountpoint\foo\bar', 'foo/bar'),
452 (r'///conky/mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
453 (r'\\\conky\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
454 (r'//conky//mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
455 (r'\\conky\\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
456 (r'//?/C:/foo/bar', 'foo/bar'),
457 (r'\\?\C:\foo\bar', 'foo/bar'),
458 (r'C:/../C:/foo/bar', 'C_/foo/bar'),
459 (r'a:b\c<d>e|f"g?h*i', 'b/c_d_e_f_g_h_i'),
460 ])
461
462 for arcname, fixedname in hacknames:
463 content = b'foobar' + arcname.encode()
464 with zipfile.ZipFile(TESTFN2, 'w', zipfile.ZIP_STORED) as zipfp:
465 zipfp.writestr(arcname, content)
466
467 targetpath = os.path.join('target', 'subdir', 'subsub')
468 correctfile = os.path.join(targetpath, *fixedname.split('/'))
469
470 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
471 writtenfile = zipfp.extract(arcname, targetpath)
472 self.assertEqual(writtenfile, correctfile)
473 self.check_file(correctfile, content)
474 shutil.rmtree('target')
475
476 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
477 zipfp.extractall(targetpath)
478 self.check_file(correctfile, content)
479 shutil.rmtree('target')
480
481 correctfile = os.path.join(os.getcwd(), *fixedname.split('/'))
482
483 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
484 writtenfile = zipfp.extract(arcname)
485 self.assertEqual(writtenfile, correctfile)
486 self.check_file(correctfile, content)
487 shutil.rmtree(fixedname.split('/')[0])
488
489 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
490 zipfp.extractall()
491 self.check_file(correctfile, content)
492 shutil.rmtree(fixedname.split('/')[0])
493
494 os.remove(TESTFN2)
495
Ronald Oussorendd25e862010-02-07 20:18:02 +0000496 def test_writestr_compression(self):
497 zipfp = zipfile.ZipFile(TESTFN2, "w")
498 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
499 if zlib:
500 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
501
502 info = zipfp.getinfo('a.txt')
503 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
504
505 if zlib:
506 info = zipfp.getinfo('b.txt')
507 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
508
509
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000510 def zip_test_writestr_permissions(self, f, compression):
511 # Make sure that writestr creates files with mode 0600,
512 # when it is passed a name rather than a ZipInfo instance.
513
Ezio Melottid5a23e32009-07-15 17:07:04 +0000514 self.make_test_archive(f, compression)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000515 with zipfile.ZipFile(f, "r") as zipfp:
516 zinfo = zipfp.getinfo('strfile')
517 self.assertEqual(zinfo.external_attr, 0600 << 16)
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000518
Ezio Melottid5a23e32009-07-15 17:07:04 +0000519 def test_writestr_permissions(self):
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000520 for f in (TESTFN2, TemporaryFile(), StringIO()):
521 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
522
Ezio Melotti569e61f2009-12-30 06:14:51 +0000523 def test_close(self):
524 """Check that the zipfile is closed after the 'with' block."""
525 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
526 for fpath, fdata in SMALL_TEST_DATA:
527 zipfp.writestr(fpath, fdata)
528 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
529 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
530
531 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
532 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
533 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
534
535 def test_close_on_exception(self):
536 """Check that the zipfile is closed if an exception is raised in the
537 'with' block."""
538 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
539 for fpath, fdata in SMALL_TEST_DATA:
540 zipfp.writestr(fpath, fdata)
541
542 try:
543 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
544 raise zipfile.BadZipfile()
545 except zipfile.BadZipfile:
546 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
547
Senthil Kumaranddd40312011-10-20 01:38:35 +0800548 def test_add_file_before_1980(self):
549 # Set atime and mtime to 1970-01-01
550 os.utime(TESTFN, (0, 0))
551 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
552 self.assertRaises(ValueError, zipfp.write, TESTFN)
553
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000554 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000555 unlink(TESTFN)
556 unlink(TESTFN2)
557
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000558
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000559class TestZip64InSmallFiles(unittest.TestCase):
560 # These tests test the ZIP64 functionality without using large files,
561 # see test_zipfile64 for proper tests.
562
563 def setUp(self):
564 self._limit = zipfile.ZIP64_LIMIT
565 zipfile.ZIP64_LIMIT = 5
566
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000567 line_gen = ("Test of zipfile line %d." % i
568 for i in range(0, FIXEDTEST_SIZE))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000569 self.data = '\n'.join(line_gen)
570
571 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000572 with open(TESTFN, "wb") as fp:
573 fp.write(self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000574
Ezio Melottid5a23e32009-07-15 17:07:04 +0000575 def large_file_exception_test(self, f, compression):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000576 with zipfile.ZipFile(f, "w", compression) as zipfp:
577 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000578 zipfp.write, TESTFN, "another.name")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000579
Ezio Melottid5a23e32009-07-15 17:07:04 +0000580 def large_file_exception_test2(self, f, compression):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000581 with zipfile.ZipFile(f, "w", compression) as zipfp:
582 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000583 zipfp.writestr, "another.name", self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000584
Ezio Melottid5a23e32009-07-15 17:07:04 +0000585 def test_large_file_exception(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000586 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000587 self.large_file_exception_test(f, zipfile.ZIP_STORED)
588 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000589
Ezio Melottid5a23e32009-07-15 17:07:04 +0000590 def zip_test(self, f, compression):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000591 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000592 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000593 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +0000594 zipfp.write(TESTFN, TESTFN)
595 zipfp.writestr("strfile", self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000596
597 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000598 with zipfile.ZipFile(f, "r", compression) as zipfp:
599 self.assertEqual(zipfp.read(TESTFN), self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000600 self.assertEqual(zipfp.read("another.name"), self.data)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000601 self.assertEqual(zipfp.read("strfile"), self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000602
Ezio Melotti569e61f2009-12-30 06:14:51 +0000603 # Print the ZIP directory
604 fp = StringIO()
605 stdout = sys.stdout
606 try:
607 sys.stdout = fp
608 zipfp.printdir()
609 finally:
610 sys.stdout = stdout
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000611
Ezio Melotti569e61f2009-12-30 06:14:51 +0000612 directory = fp.getvalue()
613 lines = directory.splitlines()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000614 self.assertEqual(len(lines), 4) # Number of files + header
Tim Petersa608bb22006-06-15 18:06:29 +0000615
Ezio Melottiaa980582010-01-23 23:04:36 +0000616 self.assertIn('File Name', lines[0])
617 self.assertIn('Modified', lines[0])
618 self.assertIn('Size', lines[0])
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000619
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000620 fn, date, time_, size = lines[1].split()
621 self.assertEqual(fn, 'another.name')
622 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
623 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
624 self.assertEqual(size, str(len(self.data)))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000625
Ezio Melotti569e61f2009-12-30 06:14:51 +0000626 # Check the namelist
627 names = zipfp.namelist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000628 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000629 self.assertIn(TESTFN, names)
630 self.assertIn("another.name", names)
631 self.assertIn("strfile", names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000632
Ezio Melotti569e61f2009-12-30 06:14:51 +0000633 # Check infolist
634 infos = zipfp.infolist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000635 names = [i.filename for i in infos]
636 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000637 self.assertIn(TESTFN, names)
638 self.assertIn("another.name", names)
639 self.assertIn("strfile", names)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000640 for i in infos:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000641 self.assertEqual(i.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000642
Ezio Melotti569e61f2009-12-30 06:14:51 +0000643 # check getinfo
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000644 for nm in (TESTFN, "another.name", "strfile"):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000645 info = zipfp.getinfo(nm)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000646 self.assertEqual(info.filename, nm)
647 self.assertEqual(info.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000648
Ezio Melotti569e61f2009-12-30 06:14:51 +0000649 # Check that testzip doesn't raise an exception
650 zipfp.testzip()
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000651
Ezio Melottid5a23e32009-07-15 17:07:04 +0000652 def test_stored(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000653 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000654 self.zip_test(f, zipfile.ZIP_STORED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000655
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000656 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000657 def test_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000658 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000659 self.zip_test(f, zipfile.ZIP_DEFLATED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000660
Ezio Melottid5a23e32009-07-15 17:07:04 +0000661 def test_absolute_arcnames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000662 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
663 allowZip64=True) as zipfp:
664 zipfp.write(TESTFN, "/absolute")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000665
Ezio Melotti569e61f2009-12-30 06:14:51 +0000666 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
667 self.assertEqual(zipfp.namelist(), ["absolute"])
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000668
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000669 def tearDown(self):
670 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000671 unlink(TESTFN)
672 unlink(TESTFN2)
673
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000674
675class PyZipFileTests(unittest.TestCase):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000676 def test_write_pyfile(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000677 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
678 fn = __file__
679 if fn.endswith('.pyc') or fn.endswith('.pyo'):
680 fn = fn[:-1]
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000681
Ezio Melotti569e61f2009-12-30 06:14:51 +0000682 zipfp.writepy(fn)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000683
Ezio Melotti569e61f2009-12-30 06:14:51 +0000684 bn = os.path.basename(fn)
Ezio Melottiaa980582010-01-23 23:04:36 +0000685 self.assertNotIn(bn, zipfp.namelist())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000686 self.assertTrue(bn + 'o' in zipfp.namelist() or
687 bn + 'c' in zipfp.namelist())
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000688
Ezio Melotti569e61f2009-12-30 06:14:51 +0000689 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
690 fn = __file__
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000691 if fn.endswith(('.pyc', '.pyo')):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000692 fn = fn[:-1]
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000693
Ezio Melotti569e61f2009-12-30 06:14:51 +0000694 zipfp.writepy(fn, "testpackage")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000695
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000696 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Ezio Melottiaa980582010-01-23 23:04:36 +0000697 self.assertNotIn(bn, zipfp.namelist())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000698 self.assertTrue(bn + 'o' in zipfp.namelist() or
699 bn + 'c' in zipfp.namelist())
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000700
Ezio Melottid5a23e32009-07-15 17:07:04 +0000701 def test_write_python_package(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000702 import email
703 packagedir = os.path.dirname(email.__file__)
704
Ezio Melotti569e61f2009-12-30 06:14:51 +0000705 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
706 zipfp.writepy(packagedir)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000707
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000708 # Check for a couple of modules at different levels of the
709 # hierarchy
Ezio Melotti569e61f2009-12-30 06:14:51 +0000710 names = zipfp.namelist()
711 self.assertTrue('email/__init__.pyo' in names or
712 'email/__init__.pyc' in names)
713 self.assertTrue('email/mime/text.pyo' in names or
714 'email/mime/text.pyc' in names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000715
Ezio Melottid5a23e32009-07-15 17:07:04 +0000716 def test_write_python_directory(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000717 os.mkdir(TESTFN2)
718 try:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000719 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
Ezio Melotti763f1e82009-12-31 13:27:41 +0000720 fp.write("print(42)\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000721
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000722 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
Ezio Melotti763f1e82009-12-31 13:27:41 +0000723 fp.write("print(42 * 42)\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000724
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000725 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
726 fp.write("bla bla bla\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000727
728 zipfp = zipfile.PyZipFile(TemporaryFile(), "w")
729 zipfp.writepy(TESTFN2)
730
731 names = zipfp.namelist()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000732 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
733 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
Ezio Melottiaa980582010-01-23 23:04:36 +0000734 self.assertNotIn('mod2.txt', names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000735
736 finally:
737 shutil.rmtree(TESTFN2)
738
Ezio Melottid5a23e32009-07-15 17:07:04 +0000739 def test_write_non_pyfile(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000740 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000741 open(TESTFN, 'w').write('most definitely not a python file')
Ezio Melotti569e61f2009-12-30 06:14:51 +0000742 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
743 os.remove(TESTFN)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000744
745
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000746class OtherTests(unittest.TestCase):
Antoine Pitroue1436d12010-08-12 15:25:51 +0000747 zips_with_bad_crc = {
748 zipfile.ZIP_STORED: (
749 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
750 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
751 b'ilehello,AworldP'
752 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
753 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
754 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
755 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
756 b'\0\0/\0\0\0\0\0'),
757 zipfile.ZIP_DEFLATED: (
758 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
759 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
760 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
761 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
762 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
763 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
764 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
765 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
766 }
767
Ezio Melottid5a23e32009-07-15 17:07:04 +0000768 def test_unicode_filenames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000769 with zipfile.ZipFile(TESTFN, "w") as zf:
770 zf.writestr(u"foo.txt", "Test for unicode filename")
771 zf.writestr(u"\xf6.txt", "Test for unicode filename")
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000772 self.assertIsInstance(zf.infolist()[0].filename, unicode)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000773
774 with zipfile.ZipFile(TESTFN, "r") as zf:
775 self.assertEqual(zf.filelist[0].filename, "foo.txt")
776 self.assertEqual(zf.filelist[1].filename, u"\xf6.txt")
Martin v. Löwis471617d2008-05-05 17:16:58 +0000777
Ezio Melottid5a23e32009-07-15 17:07:04 +0000778 def test_create_non_existent_file_for_append(self):
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000779 if os.path.exists(TESTFN):
780 os.unlink(TESTFN)
Tim Petersea5962f2007-03-12 18:07:52 +0000781
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000782 filename = 'testfile.txt'
783 content = 'hello, world. this is some content.'
Tim Petersea5962f2007-03-12 18:07:52 +0000784
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000785 try:
Ezio Melotti569e61f2009-12-30 06:14:51 +0000786 with zipfile.ZipFile(TESTFN, 'a') as zf:
787 zf.writestr(filename, content)
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000788 except IOError:
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000789 self.fail('Could not append data to a non-existent zip file.')
790
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000791 self.assertTrue(os.path.exists(TESTFN))
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000792
Ezio Melotti569e61f2009-12-30 06:14:51 +0000793 with zipfile.ZipFile(TESTFN, 'r') as zf:
794 self.assertEqual(zf.read(filename), content)
Tim Petersea5962f2007-03-12 18:07:52 +0000795
Ezio Melottid5a23e32009-07-15 17:07:04 +0000796 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000797 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000798 # it opens if there's an error in the file. If it doesn't, the
799 # traceback holds a reference to the ZipFile object and, indirectly,
800 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000801 # On Windows, this causes the os.unlink() call to fail because the
802 # underlying file is still open. This is SF bug #412214.
803 #
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000804 with open(TESTFN, "w") as fp:
805 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000806 try:
807 zf = zipfile.ZipFile(TESTFN)
808 except zipfile.BadZipfile:
Collin Winter04a51ec2007-03-29 02:28:16 +0000809 pass
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000810
Ezio Melottid5a23e32009-07-15 17:07:04 +0000811 def test_is_zip_erroneous_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000812 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000813 # - passing a filename
814 with open(TESTFN, "w") as fp:
815 fp.write("this is not a legal zip file\n")
Tim Petersea5962f2007-03-12 18:07:52 +0000816 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000817 self.assertFalse(chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000818 # - passing a file object
819 with open(TESTFN, "rb") as fp:
820 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000821 self.assertTrue(not chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000822 # - passing a file-like object
823 fp = StringIO()
824 fp.write("this is not a legal zip file\n")
825 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000826 self.assertTrue(not chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000827 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000828 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000829 self.assertTrue(not chk)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000830
Serhiy Storchaka0be506a2013-01-31 15:26:55 +0200831 def test_damaged_zipfile(self):
832 """Check that zipfiles with missing bytes at the end raise BadZipFile."""
833 # - Create a valid zip file
834 fp = io.BytesIO()
835 with zipfile.ZipFile(fp, mode="w") as zipf:
836 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
837 zipfiledata = fp.getvalue()
838
839 # - Now create copies of it missing the last N bytes and make sure
840 # a BadZipFile exception is raised when we try to open it
841 for N in range(len(zipfiledata)):
842 fp = io.BytesIO(zipfiledata[:N])
843 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, fp)
844
Ezio Melottid5a23e32009-07-15 17:07:04 +0000845 def test_is_zip_valid_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000846 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000847 # - passing a filename
Ezio Melotti569e61f2009-12-30 06:14:51 +0000848 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
849 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Tim Petersea5962f2007-03-12 18:07:52 +0000850 chk = zipfile.is_zipfile(TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000851 self.assertTrue(chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000852 # - passing a file object
853 with open(TESTFN, "rb") as fp:
854 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000855 self.assertTrue(chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000856 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000857 zip_contents = fp.read()
858 # - passing a file-like object
859 fp = StringIO()
860 fp.write(zip_contents)
861 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000862 self.assertTrue(chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000863 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000864 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000865 self.assertTrue(chk)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000866
Ezio Melottid5a23e32009-07-15 17:07:04 +0000867 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000868 # make sure we don't raise an AttributeError when a partially-constructed
869 # ZipFile instance is finalized; this tests for regression on SF tracker
870 # bug #403871.
871
872 # The bug we're testing for caused an AttributeError to be raised
873 # when a ZipFile instance was created for a file that did not
874 # exist; the .fp member was not initialized but was needed by the
875 # __del__() method. Since the AttributeError is in the __del__(),
876 # it is ignored, but the user should be sufficiently annoyed by
877 # the message on the output that regression will be noticed
878 # quickly.
879 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
880
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000881 def test_empty_file_raises_BadZipFile(self):
Brian Curtin0d654332011-04-19 21:15:55 -0500882 with open(TESTFN, 'w') as f:
883 pass
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000884 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN)
885
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000886 with open(TESTFN, 'w') as fp:
887 fp.write("short file")
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000888 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN)
889
Ezio Melottid5a23e32009-07-15 17:07:04 +0000890 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000891 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000892 data = StringIO()
Ezio Melotti569e61f2009-12-30 06:14:51 +0000893 with zipfile.ZipFile(data, mode="w") as zipf:
894 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000895
Andrew Svetlov4bb142b2012-12-18 21:27:37 +0200896 # This is correct; calling .read on a closed ZipFile should raise
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000897 # a RuntimeError, and so should calling .testzip. An earlier
898 # version of .testzip would swallow this exception (and any other)
899 # and report that the first file in the archive was corrupt.
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000900 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
901 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000902 self.assertRaises(RuntimeError, zipf.testzip)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000903 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000904 open(TESTFN, 'w').write('zipfile test data')
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000905 self.assertRaises(RuntimeError, zipf.write, TESTFN)
906
Ezio Melottid5a23e32009-07-15 17:07:04 +0000907 def test_bad_constructor_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000908 """Check that bad modes passed to ZipFile constructor are caught."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000909 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
910
Ezio Melottid5a23e32009-07-15 17:07:04 +0000911 def test_bad_open_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000912 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000913 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
914 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
915
916 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000917 # read the data to make sure the file is there
Ezio Melotti569e61f2009-12-30 06:14:51 +0000918 zipf.read("foo.txt")
919 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000920
Ezio Melottid5a23e32009-07-15 17:07:04 +0000921 def test_read0(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000922 """Check that calling read(0) on a ZipExtFile object returns an empty
923 string and doesn't advance file pointer."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000924 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
925 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
926 # read the data to make sure the file is there
Brian Curtin0d654332011-04-19 21:15:55 -0500927 with zipf.open("foo.txt") as f:
928 for i in xrange(FIXEDTEST_SIZE):
929 self.assertEqual(f.read(0), '')
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000930
Brian Curtin0d654332011-04-19 21:15:55 -0500931 self.assertEqual(f.read(), "O, for a Muse of Fire!")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000932
Ezio Melottid5a23e32009-07-15 17:07:04 +0000933 def test_open_non_existent_item(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000934 """Check that attempting to call open() for an item that doesn't
935 exist in the archive raises a RuntimeError."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000936 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
937 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000938
Ezio Melottid5a23e32009-07-15 17:07:04 +0000939 def test_bad_compression_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000940 """Check that bad compression methods passed to ZipFile.open are
941 caught."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000942 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
943
Ezio Melotti9e949722012-11-18 13:18:06 +0200944 def test_unsupported_compression(self):
945 # data is declared as shrunk, but actually deflated
946 data = (b'PK\x03\x04.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00'
947 b'\x00\x02\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00x\x03\x00PK\x01'
948 b'\x02.\x03.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00\x00\x02\x00\x00'
949 b'\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
950 b'\x80\x01\x00\x00\x00\x00xPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00'
951 b'/\x00\x00\x00!\x00\x00\x00\x00\x00')
952 with zipfile.ZipFile(io.BytesIO(data), 'r') as zipf:
953 self.assertRaises(NotImplementedError, zipf.open, 'x')
954
Ezio Melottid5a23e32009-07-15 17:07:04 +0000955 def test_null_byte_in_filename(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000956 """Check that a filename containing a null byte is properly
957 terminated."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000958 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
959 zipf.writestr("foo.txt\x00qqq", "O, for a Muse of Fire!")
960 self.assertEqual(zipf.namelist(), ['foo.txt'])
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000961
Ezio Melottid5a23e32009-07-15 17:07:04 +0000962 def test_struct_sizes(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000963 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwis8c436412008-07-03 12:51:14 +0000964 self.assertEqual(zipfile.sizeEndCentDir, 22)
965 self.assertEqual(zipfile.sizeCentralDir, 46)
966 self.assertEqual(zipfile.sizeEndCentDir64, 56)
967 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
968
Ezio Melottid5a23e32009-07-15 17:07:04 +0000969 def test_comments(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000970 """Check that comments on the archive are handled properly."""
Martin v. Löwis8c436412008-07-03 12:51:14 +0000971
972 # check default comment is empty
Ezio Melotti569e61f2009-12-30 06:14:51 +0000973 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
974 self.assertEqual(zipf.comment, '')
975 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
976
977 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
978 self.assertEqual(zipf.comment, '')
Martin v. Löwis8c436412008-07-03 12:51:14 +0000979
980 # check a simple short comment
981 comment = 'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melotti569e61f2009-12-30 06:14:51 +0000982 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
983 zipf.comment = comment
984 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
985 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
986 self.assertEqual(zipf.comment, comment)
Martin v. Löwis8c436412008-07-03 12:51:14 +0000987
988 # check a comment of max length
989 comment2 = ''.join(['%d' % (i**3 % 10) for i in xrange((1 << 16)-1)])
Ezio Melotti569e61f2009-12-30 06:14:51 +0000990 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
991 zipf.comment = comment2
992 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
993
994 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
995 self.assertEqual(zipf.comment, comment2)
Martin v. Löwis8c436412008-07-03 12:51:14 +0000996
997 # check a comment that is too long is truncated
Ezio Melotti569e61f2009-12-30 06:14:51 +0000998 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
999 zipf.comment = comment2 + 'oops'
1000 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1001 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
1002 self.assertEqual(zipf.comment, comment2)
Martin v. Löwis8c436412008-07-03 12:51:14 +00001003
R David Murray3f4ccba2012-04-12 18:42:47 -04001004 def test_change_comment_in_empty_archive(self):
1005 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1006 self.assertFalse(zipf.filelist)
1007 zipf.comment = b"this is a comment"
1008 with zipfile.ZipFile(TESTFN, "r") as zipf:
1009 self.assertEqual(zipf.comment, b"this is a comment")
1010
1011 def test_change_comment_in_nonempty_archive(self):
1012 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1013 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1014 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1015 self.assertTrue(zipf.filelist)
1016 zipf.comment = b"this is a comment"
1017 with zipfile.ZipFile(TESTFN, "r") as zipf:
1018 self.assertEqual(zipf.comment, b"this is a comment")
1019
Antoine Pitroue1436d12010-08-12 15:25:51 +00001020 def check_testzip_with_bad_crc(self, compression):
1021 """Tests that files with bad CRCs return their name from testzip."""
1022 zipdata = self.zips_with_bad_crc[compression]
1023
1024 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1025 # testzip returns the name of the first corrupt file, or None
1026 self.assertEqual('afile', zipf.testzip())
1027
1028 def test_testzip_with_bad_crc_stored(self):
1029 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
1030
1031 @skipUnless(zlib, "requires zlib")
1032 def test_testzip_with_bad_crc_deflated(self):
1033 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
1034
1035 def check_read_with_bad_crc(self, compression):
1036 """Tests that files with bad CRCs raise a BadZipfile exception when read."""
1037 zipdata = self.zips_with_bad_crc[compression]
1038
1039 # Using ZipFile.read()
1040 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1041 self.assertRaises(zipfile.BadZipfile, zipf.read, 'afile')
1042
1043 # Using ZipExtFile.read()
1044 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1045 with zipf.open('afile', 'r') as corrupt_file:
1046 self.assertRaises(zipfile.BadZipfile, corrupt_file.read)
1047
1048 # Same with small reads (in order to exercise the buffering logic)
1049 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1050 with zipf.open('afile', 'r') as corrupt_file:
1051 corrupt_file.MIN_READ_SIZE = 2
1052 with self.assertRaises(zipfile.BadZipfile):
1053 while corrupt_file.read(2):
1054 pass
1055
1056 def test_read_with_bad_crc_stored(self):
1057 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
1058
1059 @skipUnless(zlib, "requires zlib")
1060 def test_read_with_bad_crc_deflated(self):
1061 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
1062
Antoine Pitroue4195e82010-09-12 14:56:27 +00001063 def check_read_return_size(self, compression):
1064 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
1065 # than requested.
1066 for test_size in (1, 4095, 4096, 4097, 16384):
1067 file_size = test_size + 1
1068 junk = b''.join(struct.pack('B', randint(0, 255))
1069 for x in range(file_size))
1070 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
1071 zipf.writestr('foo', junk)
1072 with zipf.open('foo', 'r') as fp:
1073 buf = fp.read(test_size)
1074 self.assertEqual(len(buf), test_size)
1075
1076 def test_read_return_size_stored(self):
1077 self.check_read_return_size(zipfile.ZIP_STORED)
1078
1079 @skipUnless(zlib, "requires zlib")
1080 def test_read_return_size_deflated(self):
1081 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1082
Georg Brandl86e0c892010-11-26 07:22:28 +00001083 def test_empty_zipfile(self):
1084 # Check that creating a file in 'w' or 'a' mode and closing without
1085 # adding any files to the archives creates a valid empty ZIP file
Brian Curtin0d654332011-04-19 21:15:55 -05001086 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1087 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001088 try:
1089 zipf = zipfile.ZipFile(TESTFN, mode="r")
Éric Araujo67843b32011-02-02 17:03:38 +00001090 except zipfile.BadZipfile:
Georg Brandl86e0c892010-11-26 07:22:28 +00001091 self.fail("Unable to create empty ZIP file in 'w' mode")
1092
Brian Curtin0d654332011-04-19 21:15:55 -05001093 with zipfile.ZipFile(TESTFN, mode="a") as zipf:
1094 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001095 try:
1096 zipf = zipfile.ZipFile(TESTFN, mode="r")
1097 except:
1098 self.fail("Unable to create empty ZIP file in 'a' mode")
1099
1100 def test_open_empty_file(self):
1101 # Issue 1710703: Check that opening a file with less than 22 bytes
1102 # raises a BadZipfile exception (rather than the previously unhelpful
1103 # IOError)
Brian Curtin0d654332011-04-19 21:15:55 -05001104 with open(TESTFN, 'w') as f:
1105 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001106 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN, 'r')
1107
Senthil Kumaranddd40312011-10-20 01:38:35 +08001108 def test_create_zipinfo_before_1980(self):
1109 self.assertRaises(ValueError,
1110 zipfile.ZipInfo, 'seventies', (1979, 1, 1, 0, 0, 0))
1111
Collin Winter04a51ec2007-03-29 02:28:16 +00001112 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001113 unlink(TESTFN)
1114 unlink(TESTFN2)
1115
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001116
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001117class DecryptionTests(unittest.TestCase):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001118 """Check that ZIP decryption works. Since the library does not
1119 support encryption at the moment, we use a pre-generated encrypted
1120 ZIP file."""
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001121
1122 data = (
1123 'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1124 '\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1125 '\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1126 'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1127 '\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1128 '\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1129 '\x00\x00L\x00\x00\x00\x00\x00' )
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001130 data2 = (
1131 'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1132 '\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1133 '\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1134 'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1135 '\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1136 '\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1137 'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1138 '\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001139
1140 plain = 'zipfile.py encryption test'
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001141 plain2 = '\x00'*512
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001142
1143 def setUp(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001144 with open(TESTFN, "wb") as fp:
1145 fp.write(self.data)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001146 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001147 with open(TESTFN2, "wb") as fp:
1148 fp.write(self.data2)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001149 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001150
1151 def tearDown(self):
1152 self.zip.close()
1153 os.unlink(TESTFN)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001154 self.zip2.close()
1155 os.unlink(TESTFN2)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001156
Ezio Melottid5a23e32009-07-15 17:07:04 +00001157 def test_no_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001158 # Reading the encrypted file without password
1159 # must generate a RunTime exception
1160 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001161 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001162
Ezio Melottid5a23e32009-07-15 17:07:04 +00001163 def test_bad_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001164 self.zip.setpassword("perl")
1165 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001166 self.zip2.setpassword("perl")
1167 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Tim Petersea5962f2007-03-12 18:07:52 +00001168
Ezio Melotti1036a7f2009-09-12 14:43:43 +00001169 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001170 def test_good_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001171 self.zip.setpassword("python")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001172 self.assertEqual(self.zip.read("test.txt"), self.plain)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001173 self.zip2.setpassword("12345")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001174 self.assertEqual(self.zip2.read("zero"), self.plain2)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001175
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001176
1177class TestsWithRandomBinaryFiles(unittest.TestCase):
1178 def setUp(self):
1179 datacount = randint(16, 64)*1024 + randint(1, 1024)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001180 self.data = ''.join(struct.pack('<f', random()*randint(-1000, 1000))
Ezio Melotti763f1e82009-12-31 13:27:41 +00001181 for i in xrange(datacount))
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001182
1183 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001184 with open(TESTFN, "wb") as fp:
1185 fp.write(self.data)
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00001186
Collin Winter04a51ec2007-03-29 02:28:16 +00001187 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001188 unlink(TESTFN)
1189 unlink(TESTFN2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001190
Ezio Melottid5a23e32009-07-15 17:07:04 +00001191 def make_test_archive(self, f, compression):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001192 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001193 with zipfile.ZipFile(f, "w", compression) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001194 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +00001195 zipfp.write(TESTFN, TESTFN)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001196
Ezio Melottid5a23e32009-07-15 17:07:04 +00001197 def zip_test(self, f, compression):
1198 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001199
1200 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001201 with zipfile.ZipFile(f, "r", compression) as zipfp:
1202 testdata = zipfp.read(TESTFN)
1203 self.assertEqual(len(testdata), len(self.data))
1204 self.assertEqual(testdata, self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001205 self.assertEqual(zipfp.read("another.name"), self.data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001206
Ezio Melottid5a23e32009-07-15 17:07:04 +00001207 def test_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001208 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001209 self.zip_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001210
Antoine Pitroue1436d12010-08-12 15:25:51 +00001211 @skipUnless(zlib, "requires zlib")
1212 def test_deflated(self):
1213 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1214 self.zip_test(f, zipfile.ZIP_DEFLATED)
1215
Ezio Melottid5a23e32009-07-15 17:07:04 +00001216 def zip_open_test(self, f, compression):
1217 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001218
1219 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001220 with zipfile.ZipFile(f, "r", compression) as zipfp:
1221 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001222 with zipfp.open(TESTFN) as zipopen1:
1223 while True:
1224 read_data = zipopen1.read(256)
1225 if not read_data:
1226 break
1227 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001228
Ezio Melotti569e61f2009-12-30 06:14:51 +00001229 zipdata2 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001230 with zipfp.open("another.name") as zipopen2:
1231 while True:
1232 read_data = zipopen2.read(256)
1233 if not read_data:
1234 break
1235 zipdata2.append(read_data)
Tim Petersea5962f2007-03-12 18:07:52 +00001236
Ezio Melotti569e61f2009-12-30 06:14:51 +00001237 testdata1 = ''.join(zipdata1)
1238 self.assertEqual(len(testdata1), len(self.data))
1239 self.assertEqual(testdata1, self.data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001240
Ezio Melotti569e61f2009-12-30 06:14:51 +00001241 testdata2 = ''.join(zipdata2)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001242 self.assertEqual(len(testdata2), len(self.data))
1243 self.assertEqual(testdata2, self.data)
Tim Petersea5962f2007-03-12 18:07:52 +00001244
Ezio Melottid5a23e32009-07-15 17:07:04 +00001245 def test_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001246 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001247 self.zip_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001248
Antoine Pitroue1436d12010-08-12 15:25:51 +00001249 @skipUnless(zlib, "requires zlib")
1250 def test_open_deflated(self):
1251 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1252 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1253
Ezio Melottid5a23e32009-07-15 17:07:04 +00001254 def zip_random_open_test(self, f, compression):
1255 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001256
1257 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001258 with zipfile.ZipFile(f, "r", compression) as zipfp:
1259 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001260 with zipfp.open(TESTFN) as zipopen1:
1261 while True:
1262 read_data = zipopen1.read(randint(1, 1024))
1263 if not read_data:
1264 break
1265 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001266
Ezio Melotti569e61f2009-12-30 06:14:51 +00001267 testdata = ''.join(zipdata1)
1268 self.assertEqual(len(testdata), len(self.data))
1269 self.assertEqual(testdata, self.data)
Tim Petersea5962f2007-03-12 18:07:52 +00001270
Ezio Melottid5a23e32009-07-15 17:07:04 +00001271 def test_random_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001272 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001273 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001274
Antoine Pitroue1436d12010-08-12 15:25:51 +00001275 @skipUnless(zlib, "requires zlib")
1276 def test_random_open_deflated(self):
1277 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1278 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1279
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001280
Ezio Melotti1036a7f2009-09-12 14:43:43 +00001281@skipUnless(zlib, "requires zlib")
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001282class TestsWithMultipleOpens(unittest.TestCase):
1283 def setUp(self):
1284 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001285 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1286 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1287 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Tim Petersea5962f2007-03-12 18:07:52 +00001288
Ezio Melottid5a23e32009-07-15 17:07:04 +00001289 def test_same_file(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001290 # Verify that (when the ZipFile is in control of creating file objects)
1291 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001292 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
1293 zopen1 = zipf.open('ones')
1294 zopen2 = zipf.open('ones')
1295 data1 = zopen1.read(500)
1296 data2 = zopen2.read(500)
1297 data1 += zopen1.read(500)
1298 data2 += zopen2.read(500)
1299 self.assertEqual(data1, data2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001300
Ezio Melottid5a23e32009-07-15 17:07:04 +00001301 def test_different_file(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001302 # Verify that (when the ZipFile is in control of creating file objects)
1303 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001304 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin0d654332011-04-19 21:15:55 -05001305 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1306 data1 = zopen1.read(500)
1307 data2 = zopen2.read(500)
1308 data1 += zopen1.read(500)
1309 data2 += zopen2.read(500)
Ezio Melotti569e61f2009-12-30 06:14:51 +00001310 self.assertEqual(data1, '1'*FIXEDTEST_SIZE)
1311 self.assertEqual(data2, '2'*FIXEDTEST_SIZE)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001312
Ezio Melottid5a23e32009-07-15 17:07:04 +00001313 def test_interleaved(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001314 # Verify that (when the ZipFile is in control of creating file objects)
1315 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001316 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin0d654332011-04-19 21:15:55 -05001317 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1318 data1 = zopen1.read(500)
1319 data2 = zopen2.read(500)
1320 data1 += zopen1.read(500)
1321 data2 += zopen2.read(500)
Ezio Melotti569e61f2009-12-30 06:14:51 +00001322 self.assertEqual(data1, '1'*FIXEDTEST_SIZE)
1323 self.assertEqual(data2, '2'*FIXEDTEST_SIZE)
Tim Petersea5962f2007-03-12 18:07:52 +00001324
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001325 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001326 unlink(TESTFN2)
1327
Tim Petersea5962f2007-03-12 18:07:52 +00001328
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001329class TestWithDirectory(unittest.TestCase):
1330 def setUp(self):
1331 os.mkdir(TESTFN2)
1332
Ezio Melottid5a23e32009-07-15 17:07:04 +00001333 def test_extract_dir(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +00001334 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1335 zipf.extractall(TESTFN2)
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001336 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1337 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1338 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1339
Ezio Melottid5a23e32009-07-15 17:07:04 +00001340 def test_bug_6050(self):
Martin v. Löwis0b09c422009-05-24 19:30:52 +00001341 # Extraction should succeed if directories already exist
1342 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottid5a23e32009-07-15 17:07:04 +00001343 self.test_extract_dir()
Martin v. Löwis0b09c422009-05-24 19:30:52 +00001344
Ezio Melottid5a23e32009-07-15 17:07:04 +00001345 def test_store_dir(self):
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001346 os.mkdir(os.path.join(TESTFN2, "x"))
1347 zipf = zipfile.ZipFile(TESTFN, "w")
1348 zipf.write(os.path.join(TESTFN2, "x"), "x")
1349 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1350
1351 def tearDown(self):
1352 shutil.rmtree(TESTFN2)
1353 if os.path.exists(TESTFN):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001354 unlink(TESTFN)
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001355
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001356
1357class UniversalNewlineTests(unittest.TestCase):
1358 def setUp(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001359 self.line_gen = ["Test of zipfile line %d." % i
1360 for i in xrange(FIXEDTEST_SIZE)]
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001361 self.seps = ('\r', '\r\n', '\n')
1362 self.arcdata, self.arcfiles = {}, {}
1363 for n, s in enumerate(self.seps):
1364 self.arcdata[s] = s.join(self.line_gen) + s
1365 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Brett Cannon6cef0762007-05-25 20:17:15 +00001366 open(self.arcfiles[s], "wb").write(self.arcdata[s])
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001367
Ezio Melottid5a23e32009-07-15 17:07:04 +00001368 def make_test_archive(self, f, compression):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001369 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001370 with zipfile.ZipFile(f, "w", compression) as zipfp:
1371 for fn in self.arcfiles.values():
1372 zipfp.write(fn, fn)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001373
Ezio Melottid5a23e32009-07-15 17:07:04 +00001374 def read_test(self, f, compression):
1375 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001376
1377 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001378 with zipfile.ZipFile(f, "r") as zipfp:
1379 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001380 with zipfp.open(fn, "rU") as fp:
1381 zipdata = fp.read()
Ezio Melotti569e61f2009-12-30 06:14:51 +00001382 self.assertEqual(self.arcdata[sep], zipdata)
Tim Petersea5962f2007-03-12 18:07:52 +00001383
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001384 def readline_read_test(self, f, compression):
1385 self.make_test_archive(f, compression)
1386
1387 # Read the ZIP archive
1388 zipfp = zipfile.ZipFile(f, "r")
1389 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001390 with zipfp.open(fn, "rU") as zipopen:
1391 data = ''
1392 while True:
1393 read = zipopen.readline()
1394 if not read:
1395 break
1396 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001397
Brian Curtin0d654332011-04-19 21:15:55 -05001398 read = zipopen.read(5)
1399 if not read:
1400 break
1401 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001402
1403 self.assertEqual(data, self.arcdata['\n'])
1404
1405 zipfp.close()
1406
Ezio Melottid5a23e32009-07-15 17:07:04 +00001407 def readline_test(self, f, compression):
1408 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001409
1410 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001411 with zipfile.ZipFile(f, "r") as zipfp:
1412 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001413 with zipfp.open(fn, "rU") as zipopen:
1414 for line in self.line_gen:
1415 linedata = zipopen.readline()
1416 self.assertEqual(linedata, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001417
Ezio Melottid5a23e32009-07-15 17:07:04 +00001418 def readlines_test(self, f, compression):
1419 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001420
1421 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001422 with zipfile.ZipFile(f, "r") as zipfp:
1423 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001424 with zipfp.open(fn, "rU") as fp:
1425 ziplines = fp.readlines()
Ezio Melotti569e61f2009-12-30 06:14:51 +00001426 for line, zipline in zip(self.line_gen, ziplines):
1427 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001428
Ezio Melottid5a23e32009-07-15 17:07:04 +00001429 def iterlines_test(self, f, compression):
1430 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001431
1432 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001433 with zipfile.ZipFile(f, "r") as zipfp:
1434 for sep, fn in self.arcfiles.items():
1435 for line, zipline in zip(self.line_gen, zipfp.open(fn, "rU")):
1436 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001437
Ezio Melottid5a23e32009-07-15 17:07:04 +00001438 def test_read_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001439 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001440 self.read_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001441
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001442 def test_readline_read_stored(self):
1443 # Issue #7610: calls to readline() interleaved with calls to read().
1444 for f in (TESTFN2, TemporaryFile(), StringIO()):
1445 self.readline_read_test(f, zipfile.ZIP_STORED)
1446
Ezio Melottid5a23e32009-07-15 17:07:04 +00001447 def test_readline_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001448 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001449 self.readline_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001450
Ezio Melottid5a23e32009-07-15 17:07:04 +00001451 def test_readlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001452 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001453 self.readlines_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001454
Ezio Melottid5a23e32009-07-15 17:07:04 +00001455 def test_iterlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001456 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001457 self.iterlines_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001458
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001459 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001460 def test_read_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001461 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001462 self.read_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001463
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001464 @skipUnless(zlib, "requires zlib")
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001465 def test_readline_read_deflated(self):
1466 # Issue #7610: calls to readline() interleaved with calls to read().
1467 for f in (TESTFN2, TemporaryFile(), StringIO()):
1468 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1469
1470 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001471 def test_readline_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001472 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001473 self.readline_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001474
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001475 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001476 def test_readlines_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001477 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001478 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001479
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001480 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001481 def test_iterlines_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001482 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001483 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001484
1485 def tearDown(self):
1486 for sep, fn in self.arcfiles.items():
1487 os.remove(fn)
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001488 unlink(TESTFN)
1489 unlink(TESTFN2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001490
1491
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001492def test_main():
Tim Petersea5962f2007-03-12 18:07:52 +00001493 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1494 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001495 TestWithDirectory, UniversalNewlineTests,
1496 TestsWithRandomBinaryFiles)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001497
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001498if __name__ == "__main__":
1499 test_main()