blob: f535e56e9b9690675c6cb0834bea5e0d8f4ee7cd [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'),
Gregory P. Smith608cc452013-02-01 11:40:18 -0800437 ]
438 if os.path.sep == '\\':
439 hacknames.extend([
440 (r'..\foo\bar', 'foo/bar'),
441 (r'..\/foo\/bar', 'foo/bar'),
442 (r'foo/\..\/bar', 'foo/bar'),
443 (r'foo\/../\bar', 'foo/bar'),
444 (r'C:foo/bar', 'foo/bar'),
445 (r'C:/foo/bar', 'foo/bar'),
446 (r'C://foo/bar', 'foo/bar'),
447 (r'C:\foo\bar', 'foo/bar'),
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200448 (r'//conky/mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
449 (r'\\conky\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
Gregory P. Smith608cc452013-02-01 11:40:18 -0800450 (r'///conky/mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
451 (r'\\\conky\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
452 (r'//conky//mountpoint/foo/bar', 'conky/mountpoint/foo/bar'),
453 (r'\\conky\\mountpoint\foo\bar', 'conky/mountpoint/foo/bar'),
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200454 (r'//?/C:/foo/bar', '_/C_/foo/bar'),
455 (r'\\?\C:\foo\bar', '_/C_/foo/bar'),
Gregory P. Smith608cc452013-02-01 11:40:18 -0800456 (r'C:/../C:/foo/bar', 'C_/foo/bar'),
457 (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 +0200458 ('../../foo../../ba..r', 'foo/ba..r'),
459 ])
460 else: # Unix
461 hacknames.extend([
462 ('//foo/bar', 'foo/bar'),
463 ('../../foo../../ba..r', 'foo../ba..r'),
Gregory P. Smith608cc452013-02-01 11:40:18 -0800464 ])
465
466 for arcname, fixedname in hacknames:
467 content = b'foobar' + arcname.encode()
468 with zipfile.ZipFile(TESTFN2, 'w', zipfile.ZIP_STORED) as zipfp:
469 zipfp.writestr(arcname, content)
470
471 targetpath = os.path.join('target', 'subdir', 'subsub')
472 correctfile = os.path.join(targetpath, *fixedname.split('/'))
473
474 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
475 writtenfile = zipfp.extract(arcname, targetpath)
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200476 self.assertEqual(writtenfile, correctfile,
477 msg="extract %r" % arcname)
Gregory P. Smith608cc452013-02-01 11:40:18 -0800478 self.check_file(correctfile, content)
479 shutil.rmtree('target')
480
481 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
482 zipfp.extractall(targetpath)
483 self.check_file(correctfile, content)
484 shutil.rmtree('target')
485
486 correctfile = os.path.join(os.getcwd(), *fixedname.split('/'))
487
488 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
489 writtenfile = zipfp.extract(arcname)
Serhiy Storchaka13e56c72013-02-02 17:46:33 +0200490 self.assertEqual(writtenfile, correctfile,
491 msg="extract %r" % arcname)
Gregory P. Smith608cc452013-02-01 11:40:18 -0800492 self.check_file(correctfile, content)
493 shutil.rmtree(fixedname.split('/')[0])
494
495 with zipfile.ZipFile(TESTFN2, 'r') as zipfp:
496 zipfp.extractall()
497 self.check_file(correctfile, content)
498 shutil.rmtree(fixedname.split('/')[0])
499
500 os.remove(TESTFN2)
501
Ronald Oussorendd25e862010-02-07 20:18:02 +0000502 def test_writestr_compression(self):
503 zipfp = zipfile.ZipFile(TESTFN2, "w")
504 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
505 if zlib:
506 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
507
508 info = zipfp.getinfo('a.txt')
509 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
510
511 if zlib:
512 info = zipfp.getinfo('b.txt')
513 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
514
515
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000516 def zip_test_writestr_permissions(self, f, compression):
517 # Make sure that writestr creates files with mode 0600,
518 # when it is passed a name rather than a ZipInfo instance.
519
Ezio Melottid5a23e32009-07-15 17:07:04 +0000520 self.make_test_archive(f, compression)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000521 with zipfile.ZipFile(f, "r") as zipfp:
522 zinfo = zipfp.getinfo('strfile')
523 self.assertEqual(zinfo.external_attr, 0600 << 16)
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000524
Ezio Melottid5a23e32009-07-15 17:07:04 +0000525 def test_writestr_permissions(self):
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000526 for f in (TESTFN2, TemporaryFile(), StringIO()):
527 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
528
Ezio Melotti569e61f2009-12-30 06:14:51 +0000529 def test_close(self):
530 """Check that the zipfile is closed after the 'with' block."""
531 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
532 for fpath, fdata in SMALL_TEST_DATA:
533 zipfp.writestr(fpath, fdata)
534 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
535 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
536
537 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
538 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
539 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
540
541 def test_close_on_exception(self):
542 """Check that the zipfile is closed if an exception is raised in the
543 'with' block."""
544 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
545 for fpath, fdata in SMALL_TEST_DATA:
546 zipfp.writestr(fpath, fdata)
547
548 try:
549 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
550 raise zipfile.BadZipfile()
551 except zipfile.BadZipfile:
552 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
553
Senthil Kumaranddd40312011-10-20 01:38:35 +0800554 def test_add_file_before_1980(self):
555 # Set atime and mtime to 1970-01-01
556 os.utime(TESTFN, (0, 0))
557 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
558 self.assertRaises(ValueError, zipfp.write, TESTFN)
559
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000560 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000561 unlink(TESTFN)
562 unlink(TESTFN2)
563
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000564
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000565class TestZip64InSmallFiles(unittest.TestCase):
566 # These tests test the ZIP64 functionality without using large files,
567 # see test_zipfile64 for proper tests.
568
569 def setUp(self):
570 self._limit = zipfile.ZIP64_LIMIT
571 zipfile.ZIP64_LIMIT = 5
572
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000573 line_gen = ("Test of zipfile line %d." % i
574 for i in range(0, FIXEDTEST_SIZE))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000575 self.data = '\n'.join(line_gen)
576
577 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000578 with open(TESTFN, "wb") as fp:
579 fp.write(self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000580
Ezio Melottid5a23e32009-07-15 17:07:04 +0000581 def large_file_exception_test(self, f, compression):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000582 with zipfile.ZipFile(f, "w", compression) as zipfp:
583 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000584 zipfp.write, TESTFN, "another.name")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000585
Ezio Melottid5a23e32009-07-15 17:07:04 +0000586 def large_file_exception_test2(self, f, compression):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000587 with zipfile.ZipFile(f, "w", compression) as zipfp:
588 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000589 zipfp.writestr, "another.name", self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000590
Ezio Melottid5a23e32009-07-15 17:07:04 +0000591 def test_large_file_exception(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000592 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000593 self.large_file_exception_test(f, zipfile.ZIP_STORED)
594 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000595
Ezio Melottid5a23e32009-07-15 17:07:04 +0000596 def zip_test(self, f, compression):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000597 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000598 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000599 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +0000600 zipfp.write(TESTFN, TESTFN)
601 zipfp.writestr("strfile", self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000602
603 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000604 with zipfile.ZipFile(f, "r", compression) as zipfp:
605 self.assertEqual(zipfp.read(TESTFN), self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000606 self.assertEqual(zipfp.read("another.name"), self.data)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000607 self.assertEqual(zipfp.read("strfile"), self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000608
Ezio Melotti569e61f2009-12-30 06:14:51 +0000609 # Print the ZIP directory
610 fp = StringIO()
611 stdout = sys.stdout
612 try:
613 sys.stdout = fp
614 zipfp.printdir()
615 finally:
616 sys.stdout = stdout
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000617
Ezio Melotti569e61f2009-12-30 06:14:51 +0000618 directory = fp.getvalue()
619 lines = directory.splitlines()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000620 self.assertEqual(len(lines), 4) # Number of files + header
Tim Petersa608bb22006-06-15 18:06:29 +0000621
Ezio Melottiaa980582010-01-23 23:04:36 +0000622 self.assertIn('File Name', lines[0])
623 self.assertIn('Modified', lines[0])
624 self.assertIn('Size', lines[0])
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000625
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000626 fn, date, time_, size = lines[1].split()
627 self.assertEqual(fn, 'another.name')
628 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
629 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
630 self.assertEqual(size, str(len(self.data)))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000631
Ezio Melotti569e61f2009-12-30 06:14:51 +0000632 # Check the namelist
633 names = zipfp.namelist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000634 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000635 self.assertIn(TESTFN, names)
636 self.assertIn("another.name", names)
637 self.assertIn("strfile", names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000638
Ezio Melotti569e61f2009-12-30 06:14:51 +0000639 # Check infolist
640 infos = zipfp.infolist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000641 names = [i.filename for i in infos]
642 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000643 self.assertIn(TESTFN, names)
644 self.assertIn("another.name", names)
645 self.assertIn("strfile", names)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000646 for i in infos:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000647 self.assertEqual(i.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000648
Ezio Melotti569e61f2009-12-30 06:14:51 +0000649 # check getinfo
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000650 for nm in (TESTFN, "another.name", "strfile"):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000651 info = zipfp.getinfo(nm)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000652 self.assertEqual(info.filename, nm)
653 self.assertEqual(info.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000654
Ezio Melotti569e61f2009-12-30 06:14:51 +0000655 # Check that testzip doesn't raise an exception
656 zipfp.testzip()
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000657
Ezio Melottid5a23e32009-07-15 17:07:04 +0000658 def test_stored(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000659 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000660 self.zip_test(f, zipfile.ZIP_STORED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000661
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000662 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000663 def test_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000664 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000665 self.zip_test(f, zipfile.ZIP_DEFLATED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000666
Ezio Melottid5a23e32009-07-15 17:07:04 +0000667 def test_absolute_arcnames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000668 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
669 allowZip64=True) as zipfp:
670 zipfp.write(TESTFN, "/absolute")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000671
Ezio Melotti569e61f2009-12-30 06:14:51 +0000672 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
673 self.assertEqual(zipfp.namelist(), ["absolute"])
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000674
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000675 def tearDown(self):
676 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000677 unlink(TESTFN)
678 unlink(TESTFN2)
679
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000680
681class PyZipFileTests(unittest.TestCase):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000682 def test_write_pyfile(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000683 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
684 fn = __file__
685 if fn.endswith('.pyc') or fn.endswith('.pyo'):
686 fn = fn[:-1]
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000687
Ezio Melotti569e61f2009-12-30 06:14:51 +0000688 zipfp.writepy(fn)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000689
Ezio Melotti569e61f2009-12-30 06:14:51 +0000690 bn = os.path.basename(fn)
Ezio Melottiaa980582010-01-23 23:04:36 +0000691 self.assertNotIn(bn, zipfp.namelist())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000692 self.assertTrue(bn + 'o' in zipfp.namelist() or
693 bn + 'c' in zipfp.namelist())
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000694
Ezio Melotti569e61f2009-12-30 06:14:51 +0000695 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
696 fn = __file__
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000697 if fn.endswith(('.pyc', '.pyo')):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000698 fn = fn[:-1]
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000699
Ezio Melotti569e61f2009-12-30 06:14:51 +0000700 zipfp.writepy(fn, "testpackage")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000701
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000702 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Ezio Melottiaa980582010-01-23 23:04:36 +0000703 self.assertNotIn(bn, zipfp.namelist())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000704 self.assertTrue(bn + 'o' in zipfp.namelist() or
705 bn + 'c' in zipfp.namelist())
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000706
Ezio Melottid5a23e32009-07-15 17:07:04 +0000707 def test_write_python_package(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000708 import email
709 packagedir = os.path.dirname(email.__file__)
710
Ezio Melotti569e61f2009-12-30 06:14:51 +0000711 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
712 zipfp.writepy(packagedir)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000713
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000714 # Check for a couple of modules at different levels of the
715 # hierarchy
Ezio Melotti569e61f2009-12-30 06:14:51 +0000716 names = zipfp.namelist()
717 self.assertTrue('email/__init__.pyo' in names or
718 'email/__init__.pyc' in names)
719 self.assertTrue('email/mime/text.pyo' in names or
720 'email/mime/text.pyc' in names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000721
Ezio Melottid5a23e32009-07-15 17:07:04 +0000722 def test_write_python_directory(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000723 os.mkdir(TESTFN2)
724 try:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000725 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
Ezio Melotti763f1e82009-12-31 13:27:41 +0000726 fp.write("print(42)\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000727
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000728 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
Ezio Melotti763f1e82009-12-31 13:27:41 +0000729 fp.write("print(42 * 42)\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000730
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000731 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
732 fp.write("bla bla bla\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000733
734 zipfp = zipfile.PyZipFile(TemporaryFile(), "w")
735 zipfp.writepy(TESTFN2)
736
737 names = zipfp.namelist()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000738 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
739 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
Ezio Melottiaa980582010-01-23 23:04:36 +0000740 self.assertNotIn('mod2.txt', names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000741
742 finally:
743 shutil.rmtree(TESTFN2)
744
Ezio Melottid5a23e32009-07-15 17:07:04 +0000745 def test_write_non_pyfile(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000746 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000747 open(TESTFN, 'w').write('most definitely not a python file')
Ezio Melotti569e61f2009-12-30 06:14:51 +0000748 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
749 os.remove(TESTFN)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000750
751
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000752class OtherTests(unittest.TestCase):
Antoine Pitroue1436d12010-08-12 15:25:51 +0000753 zips_with_bad_crc = {
754 zipfile.ZIP_STORED: (
755 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
756 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
757 b'ilehello,AworldP'
758 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
759 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
760 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
761 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
762 b'\0\0/\0\0\0\0\0'),
763 zipfile.ZIP_DEFLATED: (
764 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
765 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
766 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
767 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
768 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
769 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
770 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
771 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
772 }
773
Ezio Melottid5a23e32009-07-15 17:07:04 +0000774 def test_unicode_filenames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000775 with zipfile.ZipFile(TESTFN, "w") as zf:
776 zf.writestr(u"foo.txt", "Test for unicode filename")
777 zf.writestr(u"\xf6.txt", "Test for unicode filename")
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000778 self.assertIsInstance(zf.infolist()[0].filename, unicode)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000779
780 with zipfile.ZipFile(TESTFN, "r") as zf:
781 self.assertEqual(zf.filelist[0].filename, "foo.txt")
782 self.assertEqual(zf.filelist[1].filename, u"\xf6.txt")
Martin v. Löwis471617d2008-05-05 17:16:58 +0000783
Ezio Melottid5a23e32009-07-15 17:07:04 +0000784 def test_create_non_existent_file_for_append(self):
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000785 if os.path.exists(TESTFN):
786 os.unlink(TESTFN)
Tim Petersea5962f2007-03-12 18:07:52 +0000787
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000788 filename = 'testfile.txt'
789 content = 'hello, world. this is some content.'
Tim Petersea5962f2007-03-12 18:07:52 +0000790
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000791 try:
Ezio Melotti569e61f2009-12-30 06:14:51 +0000792 with zipfile.ZipFile(TESTFN, 'a') as zf:
793 zf.writestr(filename, content)
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000794 except IOError:
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000795 self.fail('Could not append data to a non-existent zip file.')
796
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000797 self.assertTrue(os.path.exists(TESTFN))
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000798
Ezio Melotti569e61f2009-12-30 06:14:51 +0000799 with zipfile.ZipFile(TESTFN, 'r') as zf:
800 self.assertEqual(zf.read(filename), content)
Tim Petersea5962f2007-03-12 18:07:52 +0000801
Ezio Melottid5a23e32009-07-15 17:07:04 +0000802 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000803 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000804 # it opens if there's an error in the file. If it doesn't, the
805 # traceback holds a reference to the ZipFile object and, indirectly,
806 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000807 # On Windows, this causes the os.unlink() call to fail because the
808 # underlying file is still open. This is SF bug #412214.
809 #
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000810 with open(TESTFN, "w") as fp:
811 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000812 try:
813 zf = zipfile.ZipFile(TESTFN)
814 except zipfile.BadZipfile:
Collin Winter04a51ec2007-03-29 02:28:16 +0000815 pass
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000816
Ezio Melottid5a23e32009-07-15 17:07:04 +0000817 def test_is_zip_erroneous_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000818 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000819 # - passing a filename
820 with open(TESTFN, "w") as fp:
821 fp.write("this is not a legal zip file\n")
Tim Petersea5962f2007-03-12 18:07:52 +0000822 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000823 self.assertFalse(chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000824 # - passing a file object
825 with open(TESTFN, "rb") as fp:
826 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000827 self.assertTrue(not chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000828 # - passing a file-like object
829 fp = StringIO()
830 fp.write("this is not a legal zip file\n")
831 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000832 self.assertTrue(not chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000833 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000834 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000835 self.assertTrue(not chk)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000836
Serhiy Storchaka0be506a2013-01-31 15:26:55 +0200837 def test_damaged_zipfile(self):
838 """Check that zipfiles with missing bytes at the end raise BadZipFile."""
839 # - Create a valid zip file
840 fp = io.BytesIO()
841 with zipfile.ZipFile(fp, mode="w") as zipf:
842 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
843 zipfiledata = fp.getvalue()
844
845 # - Now create copies of it missing the last N bytes and make sure
846 # a BadZipFile exception is raised when we try to open it
847 for N in range(len(zipfiledata)):
848 fp = io.BytesIO(zipfiledata[:N])
849 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, fp)
850
Ezio Melottid5a23e32009-07-15 17:07:04 +0000851 def test_is_zip_valid_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000852 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000853 # - passing a filename
Ezio Melotti569e61f2009-12-30 06:14:51 +0000854 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
855 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Tim Petersea5962f2007-03-12 18:07:52 +0000856 chk = zipfile.is_zipfile(TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000857 self.assertTrue(chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000858 # - passing a file object
859 with open(TESTFN, "rb") as fp:
860 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000861 self.assertTrue(chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000862 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000863 zip_contents = fp.read()
864 # - passing a file-like object
865 fp = StringIO()
866 fp.write(zip_contents)
867 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000868 self.assertTrue(chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000869 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000870 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000871 self.assertTrue(chk)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000872
Ezio Melottid5a23e32009-07-15 17:07:04 +0000873 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000874 # make sure we don't raise an AttributeError when a partially-constructed
875 # ZipFile instance is finalized; this tests for regression on SF tracker
876 # bug #403871.
877
878 # The bug we're testing for caused an AttributeError to be raised
879 # when a ZipFile instance was created for a file that did not
880 # exist; the .fp member was not initialized but was needed by the
881 # __del__() method. Since the AttributeError is in the __del__(),
882 # it is ignored, but the user should be sufficiently annoyed by
883 # the message on the output that regression will be noticed
884 # quickly.
885 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
886
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000887 def test_empty_file_raises_BadZipFile(self):
Brian Curtin0d654332011-04-19 21:15:55 -0500888 with open(TESTFN, 'w') as f:
889 pass
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000890 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN)
891
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000892 with open(TESTFN, 'w') as fp:
893 fp.write("short file")
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000894 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN)
895
Ezio Melottid5a23e32009-07-15 17:07:04 +0000896 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000897 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000898 data = StringIO()
Ezio Melotti569e61f2009-12-30 06:14:51 +0000899 with zipfile.ZipFile(data, mode="w") as zipf:
900 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000901
Andrew Svetlov4bb142b2012-12-18 21:27:37 +0200902 # This is correct; calling .read on a closed ZipFile should raise
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000903 # a RuntimeError, and so should calling .testzip. An earlier
904 # version of .testzip would swallow this exception (and any other)
905 # and report that the first file in the archive was corrupt.
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000906 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
907 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000908 self.assertRaises(RuntimeError, zipf.testzip)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000909 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000910 open(TESTFN, 'w').write('zipfile test data')
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000911 self.assertRaises(RuntimeError, zipf.write, TESTFN)
912
Ezio Melottid5a23e32009-07-15 17:07:04 +0000913 def test_bad_constructor_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000914 """Check that bad modes passed to ZipFile constructor are caught."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000915 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
916
Ezio Melottid5a23e32009-07-15 17:07:04 +0000917 def test_bad_open_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000918 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000919 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
920 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
921
922 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000923 # read the data to make sure the file is there
Ezio Melotti569e61f2009-12-30 06:14:51 +0000924 zipf.read("foo.txt")
925 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000926
Ezio Melottid5a23e32009-07-15 17:07:04 +0000927 def test_read0(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000928 """Check that calling read(0) on a ZipExtFile object returns an empty
929 string and doesn't advance file pointer."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000930 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
931 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
932 # read the data to make sure the file is there
Brian Curtin0d654332011-04-19 21:15:55 -0500933 with zipf.open("foo.txt") as f:
934 for i in xrange(FIXEDTEST_SIZE):
935 self.assertEqual(f.read(0), '')
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000936
Brian Curtin0d654332011-04-19 21:15:55 -0500937 self.assertEqual(f.read(), "O, for a Muse of Fire!")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000938
Ezio Melottid5a23e32009-07-15 17:07:04 +0000939 def test_open_non_existent_item(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000940 """Check that attempting to call open() for an item that doesn't
941 exist in the archive raises a RuntimeError."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000942 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
943 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000944
Ezio Melottid5a23e32009-07-15 17:07:04 +0000945 def test_bad_compression_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000946 """Check that bad compression methods passed to ZipFile.open are
947 caught."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000948 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
949
Ezio Melotti9e949722012-11-18 13:18:06 +0200950 def test_unsupported_compression(self):
951 # data is declared as shrunk, but actually deflated
952 data = (b'PK\x03\x04.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00'
953 b'\x00\x02\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00x\x03\x00PK\x01'
954 b'\x02.\x03.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00\x00\x02\x00\x00'
955 b'\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
956 b'\x80\x01\x00\x00\x00\x00xPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00'
957 b'/\x00\x00\x00!\x00\x00\x00\x00\x00')
958 with zipfile.ZipFile(io.BytesIO(data), 'r') as zipf:
959 self.assertRaises(NotImplementedError, zipf.open, 'x')
960
Ezio Melottid5a23e32009-07-15 17:07:04 +0000961 def test_null_byte_in_filename(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000962 """Check that a filename containing a null byte is properly
963 terminated."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000964 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
965 zipf.writestr("foo.txt\x00qqq", "O, for a Muse of Fire!")
966 self.assertEqual(zipf.namelist(), ['foo.txt'])
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000967
Ezio Melottid5a23e32009-07-15 17:07:04 +0000968 def test_struct_sizes(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000969 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwis8c436412008-07-03 12:51:14 +0000970 self.assertEqual(zipfile.sizeEndCentDir, 22)
971 self.assertEqual(zipfile.sizeCentralDir, 46)
972 self.assertEqual(zipfile.sizeEndCentDir64, 56)
973 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
974
Ezio Melottid5a23e32009-07-15 17:07:04 +0000975 def test_comments(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000976 """Check that comments on the archive are handled properly."""
Martin v. Löwis8c436412008-07-03 12:51:14 +0000977
978 # check default comment is empty
Ezio Melotti569e61f2009-12-30 06:14:51 +0000979 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
980 self.assertEqual(zipf.comment, '')
981 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
982
983 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
984 self.assertEqual(zipf.comment, '')
Martin v. Löwis8c436412008-07-03 12:51:14 +0000985
986 # check a simple short comment
987 comment = 'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melotti569e61f2009-12-30 06:14:51 +0000988 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
989 zipf.comment = comment
990 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
991 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
992 self.assertEqual(zipf.comment, comment)
Martin v. Löwis8c436412008-07-03 12:51:14 +0000993
994 # check a comment of max length
995 comment2 = ''.join(['%d' % (i**3 % 10) for i in xrange((1 << 16)-1)])
Ezio Melotti569e61f2009-12-30 06:14:51 +0000996 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
997 zipf.comment = comment2
998 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
999
1000 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
1001 self.assertEqual(zipf.comment, comment2)
Martin v. Löwis8c436412008-07-03 12:51:14 +00001002
1003 # check a comment that is too long is truncated
Ezio Melotti569e61f2009-12-30 06:14:51 +00001004 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1005 zipf.comment = comment2 + 'oops'
1006 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1007 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
1008 self.assertEqual(zipf.comment, comment2)
Martin v. Löwis8c436412008-07-03 12:51:14 +00001009
R David Murray3f4ccba2012-04-12 18:42:47 -04001010 def test_change_comment_in_empty_archive(self):
1011 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1012 self.assertFalse(zipf.filelist)
1013 zipf.comment = b"this is a comment"
1014 with zipfile.ZipFile(TESTFN, "r") as zipf:
1015 self.assertEqual(zipf.comment, b"this is a comment")
1016
1017 def test_change_comment_in_nonempty_archive(self):
1018 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
1019 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
1020 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
1021 self.assertTrue(zipf.filelist)
1022 zipf.comment = b"this is a comment"
1023 with zipfile.ZipFile(TESTFN, "r") as zipf:
1024 self.assertEqual(zipf.comment, b"this is a comment")
1025
Antoine Pitroue1436d12010-08-12 15:25:51 +00001026 def check_testzip_with_bad_crc(self, compression):
1027 """Tests that files with bad CRCs return their name from testzip."""
1028 zipdata = self.zips_with_bad_crc[compression]
1029
1030 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1031 # testzip returns the name of the first corrupt file, or None
1032 self.assertEqual('afile', zipf.testzip())
1033
1034 def test_testzip_with_bad_crc_stored(self):
1035 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
1036
1037 @skipUnless(zlib, "requires zlib")
1038 def test_testzip_with_bad_crc_deflated(self):
1039 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
1040
1041 def check_read_with_bad_crc(self, compression):
1042 """Tests that files with bad CRCs raise a BadZipfile exception when read."""
1043 zipdata = self.zips_with_bad_crc[compression]
1044
1045 # Using ZipFile.read()
1046 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1047 self.assertRaises(zipfile.BadZipfile, zipf.read, 'afile')
1048
1049 # Using ZipExtFile.read()
1050 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1051 with zipf.open('afile', 'r') as corrupt_file:
1052 self.assertRaises(zipfile.BadZipfile, corrupt_file.read)
1053
1054 # Same with small reads (in order to exercise the buffering logic)
1055 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
1056 with zipf.open('afile', 'r') as corrupt_file:
1057 corrupt_file.MIN_READ_SIZE = 2
1058 with self.assertRaises(zipfile.BadZipfile):
1059 while corrupt_file.read(2):
1060 pass
1061
1062 def test_read_with_bad_crc_stored(self):
1063 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
1064
1065 @skipUnless(zlib, "requires zlib")
1066 def test_read_with_bad_crc_deflated(self):
1067 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
1068
Antoine Pitroue4195e82010-09-12 14:56:27 +00001069 def check_read_return_size(self, compression):
1070 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
1071 # than requested.
1072 for test_size in (1, 4095, 4096, 4097, 16384):
1073 file_size = test_size + 1
1074 junk = b''.join(struct.pack('B', randint(0, 255))
1075 for x in range(file_size))
1076 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
1077 zipf.writestr('foo', junk)
1078 with zipf.open('foo', 'r') as fp:
1079 buf = fp.read(test_size)
1080 self.assertEqual(len(buf), test_size)
1081
1082 def test_read_return_size_stored(self):
1083 self.check_read_return_size(zipfile.ZIP_STORED)
1084
1085 @skipUnless(zlib, "requires zlib")
1086 def test_read_return_size_deflated(self):
1087 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1088
Georg Brandl86e0c892010-11-26 07:22:28 +00001089 def test_empty_zipfile(self):
1090 # Check that creating a file in 'w' or 'a' mode and closing without
1091 # adding any files to the archives creates a valid empty ZIP file
Brian Curtin0d654332011-04-19 21:15:55 -05001092 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1093 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001094 try:
1095 zipf = zipfile.ZipFile(TESTFN, mode="r")
Éric Araujo67843b32011-02-02 17:03:38 +00001096 except zipfile.BadZipfile:
Georg Brandl86e0c892010-11-26 07:22:28 +00001097 self.fail("Unable to create empty ZIP file in 'w' mode")
1098
Brian Curtin0d654332011-04-19 21:15:55 -05001099 with zipfile.ZipFile(TESTFN, mode="a") as zipf:
1100 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001101 try:
1102 zipf = zipfile.ZipFile(TESTFN, mode="r")
1103 except:
1104 self.fail("Unable to create empty ZIP file in 'a' mode")
1105
1106 def test_open_empty_file(self):
1107 # Issue 1710703: Check that opening a file with less than 22 bytes
1108 # raises a BadZipfile exception (rather than the previously unhelpful
1109 # IOError)
Brian Curtin0d654332011-04-19 21:15:55 -05001110 with open(TESTFN, 'w') as f:
1111 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001112 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN, 'r')
1113
Senthil Kumaranddd40312011-10-20 01:38:35 +08001114 def test_create_zipinfo_before_1980(self):
1115 self.assertRaises(ValueError,
1116 zipfile.ZipInfo, 'seventies', (1979, 1, 1, 0, 0, 0))
1117
Collin Winter04a51ec2007-03-29 02:28:16 +00001118 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001119 unlink(TESTFN)
1120 unlink(TESTFN2)
1121
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001122
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001123class DecryptionTests(unittest.TestCase):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001124 """Check that ZIP decryption works. Since the library does not
1125 support encryption at the moment, we use a pre-generated encrypted
1126 ZIP file."""
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001127
1128 data = (
1129 'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1130 '\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1131 '\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1132 'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1133 '\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1134 '\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1135 '\x00\x00L\x00\x00\x00\x00\x00' )
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001136 data2 = (
1137 'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1138 '\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1139 '\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1140 'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1141 '\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1142 '\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1143 'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1144 '\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001145
1146 plain = 'zipfile.py encryption test'
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001147 plain2 = '\x00'*512
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001148
1149 def setUp(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001150 with open(TESTFN, "wb") as fp:
1151 fp.write(self.data)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001152 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001153 with open(TESTFN2, "wb") as fp:
1154 fp.write(self.data2)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001155 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001156
1157 def tearDown(self):
1158 self.zip.close()
1159 os.unlink(TESTFN)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001160 self.zip2.close()
1161 os.unlink(TESTFN2)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001162
Ezio Melottid5a23e32009-07-15 17:07:04 +00001163 def test_no_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001164 # Reading the encrypted file without password
1165 # must generate a RunTime exception
1166 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001167 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001168
Ezio Melottid5a23e32009-07-15 17:07:04 +00001169 def test_bad_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001170 self.zip.setpassword("perl")
1171 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001172 self.zip2.setpassword("perl")
1173 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Tim Petersea5962f2007-03-12 18:07:52 +00001174
Ezio Melotti1036a7f2009-09-12 14:43:43 +00001175 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001176 def test_good_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001177 self.zip.setpassword("python")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001178 self.assertEqual(self.zip.read("test.txt"), self.plain)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001179 self.zip2.setpassword("12345")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001180 self.assertEqual(self.zip2.read("zero"), self.plain2)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001181
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001182
1183class TestsWithRandomBinaryFiles(unittest.TestCase):
1184 def setUp(self):
1185 datacount = randint(16, 64)*1024 + randint(1, 1024)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001186 self.data = ''.join(struct.pack('<f', random()*randint(-1000, 1000))
Ezio Melotti763f1e82009-12-31 13:27:41 +00001187 for i in xrange(datacount))
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001188
1189 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001190 with open(TESTFN, "wb") as fp:
1191 fp.write(self.data)
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00001192
Collin Winter04a51ec2007-03-29 02:28:16 +00001193 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001194 unlink(TESTFN)
1195 unlink(TESTFN2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001196
Ezio Melottid5a23e32009-07-15 17:07:04 +00001197 def make_test_archive(self, f, compression):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001198 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001199 with zipfile.ZipFile(f, "w", compression) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001200 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +00001201 zipfp.write(TESTFN, TESTFN)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001202
Ezio Melottid5a23e32009-07-15 17:07:04 +00001203 def zip_test(self, f, compression):
1204 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001205
1206 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001207 with zipfile.ZipFile(f, "r", compression) as zipfp:
1208 testdata = zipfp.read(TESTFN)
1209 self.assertEqual(len(testdata), len(self.data))
1210 self.assertEqual(testdata, self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001211 self.assertEqual(zipfp.read("another.name"), self.data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001212
Ezio Melottid5a23e32009-07-15 17:07:04 +00001213 def test_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001214 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001215 self.zip_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001216
Antoine Pitroue1436d12010-08-12 15:25:51 +00001217 @skipUnless(zlib, "requires zlib")
1218 def test_deflated(self):
1219 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1220 self.zip_test(f, zipfile.ZIP_DEFLATED)
1221
Ezio Melottid5a23e32009-07-15 17:07:04 +00001222 def zip_open_test(self, f, compression):
1223 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001224
1225 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001226 with zipfile.ZipFile(f, "r", compression) as zipfp:
1227 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001228 with zipfp.open(TESTFN) as zipopen1:
1229 while True:
1230 read_data = zipopen1.read(256)
1231 if not read_data:
1232 break
1233 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001234
Ezio Melotti569e61f2009-12-30 06:14:51 +00001235 zipdata2 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001236 with zipfp.open("another.name") as zipopen2:
1237 while True:
1238 read_data = zipopen2.read(256)
1239 if not read_data:
1240 break
1241 zipdata2.append(read_data)
Tim Petersea5962f2007-03-12 18:07:52 +00001242
Ezio Melotti569e61f2009-12-30 06:14:51 +00001243 testdata1 = ''.join(zipdata1)
1244 self.assertEqual(len(testdata1), len(self.data))
1245 self.assertEqual(testdata1, self.data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001246
Ezio Melotti569e61f2009-12-30 06:14:51 +00001247 testdata2 = ''.join(zipdata2)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001248 self.assertEqual(len(testdata2), len(self.data))
1249 self.assertEqual(testdata2, self.data)
Tim Petersea5962f2007-03-12 18:07:52 +00001250
Ezio Melottid5a23e32009-07-15 17:07:04 +00001251 def test_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001252 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001253 self.zip_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001254
Antoine Pitroue1436d12010-08-12 15:25:51 +00001255 @skipUnless(zlib, "requires zlib")
1256 def test_open_deflated(self):
1257 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1258 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1259
Ezio Melottid5a23e32009-07-15 17:07:04 +00001260 def zip_random_open_test(self, f, compression):
1261 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001262
1263 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001264 with zipfile.ZipFile(f, "r", compression) as zipfp:
1265 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001266 with zipfp.open(TESTFN) as zipopen1:
1267 while True:
1268 read_data = zipopen1.read(randint(1, 1024))
1269 if not read_data:
1270 break
1271 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001272
Ezio Melotti569e61f2009-12-30 06:14:51 +00001273 testdata = ''.join(zipdata1)
1274 self.assertEqual(len(testdata), len(self.data))
1275 self.assertEqual(testdata, self.data)
Tim Petersea5962f2007-03-12 18:07:52 +00001276
Ezio Melottid5a23e32009-07-15 17:07:04 +00001277 def test_random_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001278 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001279 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001280
Antoine Pitroue1436d12010-08-12 15:25:51 +00001281 @skipUnless(zlib, "requires zlib")
1282 def test_random_open_deflated(self):
1283 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1284 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1285
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001286
Ezio Melotti1036a7f2009-09-12 14:43:43 +00001287@skipUnless(zlib, "requires zlib")
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001288class TestsWithMultipleOpens(unittest.TestCase):
1289 def setUp(self):
1290 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001291 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1292 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1293 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Tim Petersea5962f2007-03-12 18:07:52 +00001294
Ezio Melottid5a23e32009-07-15 17:07:04 +00001295 def test_same_file(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001296 # Verify that (when the ZipFile is in control of creating file objects)
1297 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001298 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
1299 zopen1 = zipf.open('ones')
1300 zopen2 = zipf.open('ones')
1301 data1 = zopen1.read(500)
1302 data2 = zopen2.read(500)
1303 data1 += zopen1.read(500)
1304 data2 += zopen2.read(500)
1305 self.assertEqual(data1, data2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001306
Ezio Melottid5a23e32009-07-15 17:07:04 +00001307 def test_different_file(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001308 # Verify that (when the ZipFile is in control of creating file objects)
1309 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001310 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin0d654332011-04-19 21:15:55 -05001311 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1312 data1 = zopen1.read(500)
1313 data2 = zopen2.read(500)
1314 data1 += zopen1.read(500)
1315 data2 += zopen2.read(500)
Ezio Melotti569e61f2009-12-30 06:14:51 +00001316 self.assertEqual(data1, '1'*FIXEDTEST_SIZE)
1317 self.assertEqual(data2, '2'*FIXEDTEST_SIZE)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001318
Ezio Melottid5a23e32009-07-15 17:07:04 +00001319 def test_interleaved(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001320 # Verify that (when the ZipFile is in control of creating file objects)
1321 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001322 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin0d654332011-04-19 21:15:55 -05001323 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1324 data1 = zopen1.read(500)
1325 data2 = zopen2.read(500)
1326 data1 += zopen1.read(500)
1327 data2 += zopen2.read(500)
Ezio Melotti569e61f2009-12-30 06:14:51 +00001328 self.assertEqual(data1, '1'*FIXEDTEST_SIZE)
1329 self.assertEqual(data2, '2'*FIXEDTEST_SIZE)
Tim Petersea5962f2007-03-12 18:07:52 +00001330
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001331 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001332 unlink(TESTFN2)
1333
Tim Petersea5962f2007-03-12 18:07:52 +00001334
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001335class TestWithDirectory(unittest.TestCase):
1336 def setUp(self):
1337 os.mkdir(TESTFN2)
1338
Ezio Melottid5a23e32009-07-15 17:07:04 +00001339 def test_extract_dir(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +00001340 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1341 zipf.extractall(TESTFN2)
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001342 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1343 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1344 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1345
Ezio Melottid5a23e32009-07-15 17:07:04 +00001346 def test_bug_6050(self):
Martin v. Löwis0b09c422009-05-24 19:30:52 +00001347 # Extraction should succeed if directories already exist
1348 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottid5a23e32009-07-15 17:07:04 +00001349 self.test_extract_dir()
Martin v. Löwis0b09c422009-05-24 19:30:52 +00001350
Ezio Melottid5a23e32009-07-15 17:07:04 +00001351 def test_store_dir(self):
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001352 os.mkdir(os.path.join(TESTFN2, "x"))
1353 zipf = zipfile.ZipFile(TESTFN, "w")
1354 zipf.write(os.path.join(TESTFN2, "x"), "x")
1355 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1356
1357 def tearDown(self):
1358 shutil.rmtree(TESTFN2)
1359 if os.path.exists(TESTFN):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001360 unlink(TESTFN)
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001361
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001362
1363class UniversalNewlineTests(unittest.TestCase):
1364 def setUp(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001365 self.line_gen = ["Test of zipfile line %d." % i
1366 for i in xrange(FIXEDTEST_SIZE)]
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001367 self.seps = ('\r', '\r\n', '\n')
1368 self.arcdata, self.arcfiles = {}, {}
1369 for n, s in enumerate(self.seps):
1370 self.arcdata[s] = s.join(self.line_gen) + s
1371 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Brett Cannon6cef0762007-05-25 20:17:15 +00001372 open(self.arcfiles[s], "wb").write(self.arcdata[s])
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001373
Ezio Melottid5a23e32009-07-15 17:07:04 +00001374 def make_test_archive(self, f, compression):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001375 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001376 with zipfile.ZipFile(f, "w", compression) as zipfp:
1377 for fn in self.arcfiles.values():
1378 zipfp.write(fn, fn)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001379
Ezio Melottid5a23e32009-07-15 17:07:04 +00001380 def read_test(self, f, compression):
1381 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001382
1383 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001384 with zipfile.ZipFile(f, "r") as zipfp:
1385 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001386 with zipfp.open(fn, "rU") as fp:
1387 zipdata = fp.read()
Ezio Melotti569e61f2009-12-30 06:14:51 +00001388 self.assertEqual(self.arcdata[sep], zipdata)
Tim Petersea5962f2007-03-12 18:07:52 +00001389
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001390 def readline_read_test(self, f, compression):
1391 self.make_test_archive(f, compression)
1392
1393 # Read the ZIP archive
1394 zipfp = zipfile.ZipFile(f, "r")
1395 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001396 with zipfp.open(fn, "rU") as zipopen:
1397 data = ''
1398 while True:
1399 read = zipopen.readline()
1400 if not read:
1401 break
1402 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001403
Brian Curtin0d654332011-04-19 21:15:55 -05001404 read = zipopen.read(5)
1405 if not read:
1406 break
1407 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001408
1409 self.assertEqual(data, self.arcdata['\n'])
1410
1411 zipfp.close()
1412
Ezio Melottid5a23e32009-07-15 17:07:04 +00001413 def readline_test(self, f, compression):
1414 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001415
1416 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001417 with zipfile.ZipFile(f, "r") as zipfp:
1418 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001419 with zipfp.open(fn, "rU") as zipopen:
1420 for line in self.line_gen:
1421 linedata = zipopen.readline()
1422 self.assertEqual(linedata, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001423
Ezio Melottid5a23e32009-07-15 17:07:04 +00001424 def readlines_test(self, f, compression):
1425 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001426
1427 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001428 with zipfile.ZipFile(f, "r") as zipfp:
1429 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001430 with zipfp.open(fn, "rU") as fp:
1431 ziplines = fp.readlines()
Ezio Melotti569e61f2009-12-30 06:14:51 +00001432 for line, zipline in zip(self.line_gen, ziplines):
1433 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001434
Ezio Melottid5a23e32009-07-15 17:07:04 +00001435 def iterlines_test(self, f, compression):
1436 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001437
1438 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001439 with zipfile.ZipFile(f, "r") as zipfp:
1440 for sep, fn in self.arcfiles.items():
1441 for line, zipline in zip(self.line_gen, zipfp.open(fn, "rU")):
1442 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001443
Ezio Melottid5a23e32009-07-15 17:07:04 +00001444 def test_read_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001445 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001446 self.read_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001447
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001448 def test_readline_read_stored(self):
1449 # Issue #7610: calls to readline() interleaved with calls to read().
1450 for f in (TESTFN2, TemporaryFile(), StringIO()):
1451 self.readline_read_test(f, zipfile.ZIP_STORED)
1452
Ezio Melottid5a23e32009-07-15 17:07:04 +00001453 def test_readline_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001454 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001455 self.readline_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001456
Ezio Melottid5a23e32009-07-15 17:07:04 +00001457 def test_readlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001458 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001459 self.readlines_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001460
Ezio Melottid5a23e32009-07-15 17:07:04 +00001461 def test_iterlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001462 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001463 self.iterlines_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001464
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001465 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001466 def test_read_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001467 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001468 self.read_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001469
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001470 @skipUnless(zlib, "requires zlib")
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001471 def test_readline_read_deflated(self):
1472 # Issue #7610: calls to readline() interleaved with calls to read().
1473 for f in (TESTFN2, TemporaryFile(), StringIO()):
1474 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1475
1476 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001477 def test_readline_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001478 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001479 self.readline_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001480
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001481 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001482 def test_readlines_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001483 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001484 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001485
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001486 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001487 def test_iterlines_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001488 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001489 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001490
1491 def tearDown(self):
1492 for sep, fn in self.arcfiles.items():
1493 os.remove(fn)
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001494 unlink(TESTFN)
1495 unlink(TESTFN2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001496
1497
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001498def test_main():
Tim Petersea5962f2007-03-12 18:07:52 +00001499 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1500 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001501 TestWithDirectory, UniversalNewlineTests,
1502 TestsWithRandomBinaryFiles)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001503
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001504if __name__ == "__main__":
1505 test_main()