blob: a5ff90a7346bbe97b14df813ef82905da891adc3 [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'),
29 ('/ziptest2dir/ziptest3dir/_ziptest3', 'azsxdcfvgb'),
30 ('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
394 if os.path.isabs(fpath):
395 correctfile = os.path.join(os.getcwd(), fpath[1:])
396 else:
397 correctfile = os.path.join(os.getcwd(), fpath)
398 correctfile = os.path.normpath(correctfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000399
Ezio Melotti569e61f2009-12-30 06:14:51 +0000400 self.assertEqual(writtenfile, correctfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000401
Ezio Melotti569e61f2009-12-30 06:14:51 +0000402 # make sure correct data is in correct file
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000403 self.assertEqual(fdata, open(writtenfile, "rb").read())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000404 os.remove(writtenfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000405
406 # remove the test file subdirectories
407 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
408
Ezio Melottid5a23e32009-07-15 17:07:04 +0000409 def test_extract_all(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000410 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED) as zipfp:
411 for fpath, fdata in SMALL_TEST_DATA:
412 zipfp.writestr(fpath, fdata)
Georg Brandl62416bc2008-01-07 18:47:44 +0000413
Ezio Melotti569e61f2009-12-30 06:14:51 +0000414 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
415 zipfp.extractall()
416 for fpath, fdata in SMALL_TEST_DATA:
417 if os.path.isabs(fpath):
418 outfile = os.path.join(os.getcwd(), fpath[1:])
419 else:
420 outfile = os.path.join(os.getcwd(), fpath)
Georg Brandl62416bc2008-01-07 18:47:44 +0000421
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000422 self.assertEqual(fdata, open(outfile, "rb").read())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000423 os.remove(outfile)
Georg Brandl62416bc2008-01-07 18:47:44 +0000424
425 # remove the test file subdirectories
426 shutil.rmtree(os.path.join(os.getcwd(), 'ziptest2dir'))
427
Ronald Oussorendd25e862010-02-07 20:18:02 +0000428 def test_writestr_compression(self):
429 zipfp = zipfile.ZipFile(TESTFN2, "w")
430 zipfp.writestr("a.txt", "hello world", compress_type=zipfile.ZIP_STORED)
431 if zlib:
432 zipfp.writestr("b.txt", "hello world", compress_type=zipfile.ZIP_DEFLATED)
433
434 info = zipfp.getinfo('a.txt')
435 self.assertEqual(info.compress_type, zipfile.ZIP_STORED)
436
437 if zlib:
438 info = zipfp.getinfo('b.txt')
439 self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
440
441
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000442 def zip_test_writestr_permissions(self, f, compression):
443 # Make sure that writestr creates files with mode 0600,
444 # when it is passed a name rather than a ZipInfo instance.
445
Ezio Melottid5a23e32009-07-15 17:07:04 +0000446 self.make_test_archive(f, compression)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000447 with zipfile.ZipFile(f, "r") as zipfp:
448 zinfo = zipfp.getinfo('strfile')
449 self.assertEqual(zinfo.external_attr, 0600 << 16)
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000450
Ezio Melottid5a23e32009-07-15 17:07:04 +0000451 def test_writestr_permissions(self):
Antoine Pitrou5fdfa3e2008-07-25 19:42:26 +0000452 for f in (TESTFN2, TemporaryFile(), StringIO()):
453 self.zip_test_writestr_permissions(f, zipfile.ZIP_STORED)
454
Ezio Melotti569e61f2009-12-30 06:14:51 +0000455 def test_close(self):
456 """Check that the zipfile is closed after the 'with' block."""
457 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
458 for fpath, fdata in SMALL_TEST_DATA:
459 zipfp.writestr(fpath, fdata)
460 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
461 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
462
463 with zipfile.ZipFile(TESTFN2, "r") as zipfp:
464 self.assertTrue(zipfp.fp is not None, 'zipfp is not open')
465 self.assertTrue(zipfp.fp is None, 'zipfp is not closed')
466
467 def test_close_on_exception(self):
468 """Check that the zipfile is closed if an exception is raised in the
469 'with' block."""
470 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
471 for fpath, fdata in SMALL_TEST_DATA:
472 zipfp.writestr(fpath, fdata)
473
474 try:
475 with zipfile.ZipFile(TESTFN2, "r") as zipfp2:
476 raise zipfile.BadZipfile()
477 except zipfile.BadZipfile:
478 self.assertTrue(zipfp2.fp is None, 'zipfp is not closed')
479
Senthil Kumaranddd40312011-10-20 01:38:35 +0800480 def test_add_file_before_1980(self):
481 # Set atime and mtime to 1970-01-01
482 os.utime(TESTFN, (0, 0))
483 with zipfile.ZipFile(TESTFN2, "w") as zipfp:
484 self.assertRaises(ValueError, zipfp.write, TESTFN)
485
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000486 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000487 unlink(TESTFN)
488 unlink(TESTFN2)
489
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000490
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000491class TestZip64InSmallFiles(unittest.TestCase):
492 # These tests test the ZIP64 functionality without using large files,
493 # see test_zipfile64 for proper tests.
494
495 def setUp(self):
496 self._limit = zipfile.ZIP64_LIMIT
497 zipfile.ZIP64_LIMIT = 5
498
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000499 line_gen = ("Test of zipfile line %d." % i
500 for i in range(0, FIXEDTEST_SIZE))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000501 self.data = '\n'.join(line_gen)
502
503 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000504 with open(TESTFN, "wb") as fp:
505 fp.write(self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000506
Ezio Melottid5a23e32009-07-15 17:07:04 +0000507 def large_file_exception_test(self, f, compression):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000508 with zipfile.ZipFile(f, "w", compression) as zipfp:
509 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000510 zipfp.write, TESTFN, "another.name")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000511
Ezio Melottid5a23e32009-07-15 17:07:04 +0000512 def large_file_exception_test2(self, f, compression):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000513 with zipfile.ZipFile(f, "w", compression) as zipfp:
514 self.assertRaises(zipfile.LargeZipFile,
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000515 zipfp.writestr, "another.name", self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000516
Ezio Melottid5a23e32009-07-15 17:07:04 +0000517 def test_large_file_exception(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000518 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000519 self.large_file_exception_test(f, zipfile.ZIP_STORED)
520 self.large_file_exception_test2(f, zipfile.ZIP_STORED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000521
Ezio Melottid5a23e32009-07-15 17:07:04 +0000522 def zip_test(self, f, compression):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000523 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000524 with zipfile.ZipFile(f, "w", compression, allowZip64=True) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000525 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +0000526 zipfp.write(TESTFN, TESTFN)
527 zipfp.writestr("strfile", self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000528
529 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +0000530 with zipfile.ZipFile(f, "r", compression) as zipfp:
531 self.assertEqual(zipfp.read(TESTFN), self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000532 self.assertEqual(zipfp.read("another.name"), self.data)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000533 self.assertEqual(zipfp.read("strfile"), self.data)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000534
Ezio Melotti569e61f2009-12-30 06:14:51 +0000535 # Print the ZIP directory
536 fp = StringIO()
537 stdout = sys.stdout
538 try:
539 sys.stdout = fp
540 zipfp.printdir()
541 finally:
542 sys.stdout = stdout
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000543
Ezio Melotti569e61f2009-12-30 06:14:51 +0000544 directory = fp.getvalue()
545 lines = directory.splitlines()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000546 self.assertEqual(len(lines), 4) # Number of files + header
Tim Petersa608bb22006-06-15 18:06:29 +0000547
Ezio Melottiaa980582010-01-23 23:04:36 +0000548 self.assertIn('File Name', lines[0])
549 self.assertIn('Modified', lines[0])
550 self.assertIn('Size', lines[0])
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000551
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000552 fn, date, time_, size = lines[1].split()
553 self.assertEqual(fn, 'another.name')
554 self.assertTrue(time.strptime(date, '%Y-%m-%d'))
555 self.assertTrue(time.strptime(time_, '%H:%M:%S'))
556 self.assertEqual(size, str(len(self.data)))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000557
Ezio Melotti569e61f2009-12-30 06:14:51 +0000558 # Check the namelist
559 names = zipfp.namelist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000560 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000561 self.assertIn(TESTFN, names)
562 self.assertIn("another.name", names)
563 self.assertIn("strfile", names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000564
Ezio Melotti569e61f2009-12-30 06:14:51 +0000565 # Check infolist
566 infos = zipfp.infolist()
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000567 names = [i.filename for i in infos]
568 self.assertEqual(len(names), 3)
Ezio Melottiaa980582010-01-23 23:04:36 +0000569 self.assertIn(TESTFN, names)
570 self.assertIn("another.name", names)
571 self.assertIn("strfile", names)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000572 for i in infos:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000573 self.assertEqual(i.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000574
Ezio Melotti569e61f2009-12-30 06:14:51 +0000575 # check getinfo
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000576 for nm in (TESTFN, "another.name", "strfile"):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000577 info = zipfp.getinfo(nm)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000578 self.assertEqual(info.filename, nm)
579 self.assertEqual(info.file_size, len(self.data))
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000580
Ezio Melotti569e61f2009-12-30 06:14:51 +0000581 # Check that testzip doesn't raise an exception
582 zipfp.testzip()
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000583
Ezio Melottid5a23e32009-07-15 17:07:04 +0000584 def test_stored(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000585 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000586 self.zip_test(f, zipfile.ZIP_STORED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000587
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000588 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +0000589 def test_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000590 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000591 self.zip_test(f, zipfile.ZIP_DEFLATED)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000592
Ezio Melottid5a23e32009-07-15 17:07:04 +0000593 def test_absolute_arcnames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000594 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_STORED,
595 allowZip64=True) as zipfp:
596 zipfp.write(TESTFN, "/absolute")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000597
Ezio Melotti569e61f2009-12-30 06:14:51 +0000598 with zipfile.ZipFile(TESTFN2, "r", zipfile.ZIP_STORED) as zipfp:
599 self.assertEqual(zipfp.namelist(), ["absolute"])
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000600
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000601 def tearDown(self):
602 zipfile.ZIP64_LIMIT = self._limit
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000603 unlink(TESTFN)
604 unlink(TESTFN2)
605
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000606
607class PyZipFileTests(unittest.TestCase):
Ezio Melottid5a23e32009-07-15 17:07:04 +0000608 def test_write_pyfile(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000609 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
610 fn = __file__
611 if fn.endswith('.pyc') or fn.endswith('.pyo'):
612 fn = fn[:-1]
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000613
Ezio Melotti569e61f2009-12-30 06:14:51 +0000614 zipfp.writepy(fn)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000615
Ezio Melotti569e61f2009-12-30 06:14:51 +0000616 bn = os.path.basename(fn)
Ezio Melottiaa980582010-01-23 23:04:36 +0000617 self.assertNotIn(bn, zipfp.namelist())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000618 self.assertTrue(bn + 'o' in zipfp.namelist() or
619 bn + 'c' in zipfp.namelist())
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000620
Ezio Melotti569e61f2009-12-30 06:14:51 +0000621 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
622 fn = __file__
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000623 if fn.endswith(('.pyc', '.pyo')):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000624 fn = fn[:-1]
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000625
Ezio Melotti569e61f2009-12-30 06:14:51 +0000626 zipfp.writepy(fn, "testpackage")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000627
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000628 bn = "%s/%s" % ("testpackage", os.path.basename(fn))
Ezio Melottiaa980582010-01-23 23:04:36 +0000629 self.assertNotIn(bn, zipfp.namelist())
Ezio Melotti569e61f2009-12-30 06:14:51 +0000630 self.assertTrue(bn + 'o' in zipfp.namelist() or
631 bn + 'c' in zipfp.namelist())
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000632
Ezio Melottid5a23e32009-07-15 17:07:04 +0000633 def test_write_python_package(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000634 import email
635 packagedir = os.path.dirname(email.__file__)
636
Ezio Melotti569e61f2009-12-30 06:14:51 +0000637 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
638 zipfp.writepy(packagedir)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000639
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000640 # Check for a couple of modules at different levels of the
641 # hierarchy
Ezio Melotti569e61f2009-12-30 06:14:51 +0000642 names = zipfp.namelist()
643 self.assertTrue('email/__init__.pyo' in names or
644 'email/__init__.pyc' in names)
645 self.assertTrue('email/mime/text.pyo' in names or
646 'email/mime/text.pyc' in names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000647
Ezio Melottid5a23e32009-07-15 17:07:04 +0000648 def test_write_python_directory(self):
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000649 os.mkdir(TESTFN2)
650 try:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000651 with open(os.path.join(TESTFN2, "mod1.py"), "w") as fp:
Ezio Melotti763f1e82009-12-31 13:27:41 +0000652 fp.write("print(42)\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000653
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000654 with open(os.path.join(TESTFN2, "mod2.py"), "w") as fp:
Ezio Melotti763f1e82009-12-31 13:27:41 +0000655 fp.write("print(42 * 42)\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000656
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000657 with open(os.path.join(TESTFN2, "mod2.txt"), "w") as fp:
658 fp.write("bla bla bla\n")
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000659
660 zipfp = zipfile.PyZipFile(TemporaryFile(), "w")
661 zipfp.writepy(TESTFN2)
662
663 names = zipfp.namelist()
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000664 self.assertTrue('mod1.pyc' in names or 'mod1.pyo' in names)
665 self.assertTrue('mod2.pyc' in names or 'mod2.pyo' in names)
Ezio Melottiaa980582010-01-23 23:04:36 +0000666 self.assertNotIn('mod2.txt', names)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000667
668 finally:
669 shutil.rmtree(TESTFN2)
670
Ezio Melottid5a23e32009-07-15 17:07:04 +0000671 def test_write_non_pyfile(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000672 with zipfile.PyZipFile(TemporaryFile(), "w") as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000673 open(TESTFN, 'w').write('most definitely not a python file')
Ezio Melotti569e61f2009-12-30 06:14:51 +0000674 self.assertRaises(RuntimeError, zipfp.writepy, TESTFN)
675 os.remove(TESTFN)
Ronald Oussoren143cefb2006-06-15 08:14:18 +0000676
677
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000678class OtherTests(unittest.TestCase):
Antoine Pitroue1436d12010-08-12 15:25:51 +0000679 zips_with_bad_crc = {
680 zipfile.ZIP_STORED: (
681 b'PK\003\004\024\0\0\0\0\0 \213\212;:r'
682 b'\253\377\f\0\0\0\f\0\0\0\005\0\0\000af'
683 b'ilehello,AworldP'
684 b'K\001\002\024\003\024\0\0\0\0\0 \213\212;:'
685 b'r\253\377\f\0\0\0\f\0\0\0\005\0\0\0\0'
686 b'\0\0\0\0\0\0\0\200\001\0\0\0\000afi'
687 b'lePK\005\006\0\0\0\0\001\0\001\0003\000'
688 b'\0\0/\0\0\0\0\0'),
689 zipfile.ZIP_DEFLATED: (
690 b'PK\x03\x04\x14\x00\x00\x00\x08\x00n}\x0c=FA'
691 b'KE\x10\x00\x00\x00n\x00\x00\x00\x05\x00\x00\x00af'
692 b'ile\xcbH\xcd\xc9\xc9W(\xcf/\xcaI\xc9\xa0'
693 b'=\x13\x00PK\x01\x02\x14\x03\x14\x00\x00\x00\x08\x00n'
694 b'}\x0c=FAKE\x10\x00\x00\x00n\x00\x00\x00\x05'
695 b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x01\x00\x00\x00'
696 b'\x00afilePK\x05\x06\x00\x00\x00\x00\x01\x00'
697 b'\x01\x003\x00\x00\x003\x00\x00\x00\x00\x00'),
698 }
699
Ezio Melottid5a23e32009-07-15 17:07:04 +0000700 def test_unicode_filenames(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +0000701 with zipfile.ZipFile(TESTFN, "w") as zf:
702 zf.writestr(u"foo.txt", "Test for unicode filename")
703 zf.writestr(u"\xf6.txt", "Test for unicode filename")
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000704 self.assertIsInstance(zf.infolist()[0].filename, unicode)
Ezio Melotti569e61f2009-12-30 06:14:51 +0000705
706 with zipfile.ZipFile(TESTFN, "r") as zf:
707 self.assertEqual(zf.filelist[0].filename, "foo.txt")
708 self.assertEqual(zf.filelist[1].filename, u"\xf6.txt")
Martin v. Löwis471617d2008-05-05 17:16:58 +0000709
Ezio Melottid5a23e32009-07-15 17:07:04 +0000710 def test_create_non_existent_file_for_append(self):
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000711 if os.path.exists(TESTFN):
712 os.unlink(TESTFN)
Tim Petersea5962f2007-03-12 18:07:52 +0000713
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000714 filename = 'testfile.txt'
715 content = 'hello, world. this is some content.'
Tim Petersea5962f2007-03-12 18:07:52 +0000716
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000717 try:
Ezio Melotti569e61f2009-12-30 06:14:51 +0000718 with zipfile.ZipFile(TESTFN, 'a') as zf:
719 zf.writestr(filename, content)
Ezio Melotti6cbfc122009-07-10 20:25:56 +0000720 except IOError:
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000721 self.fail('Could not append data to a non-existent zip file.')
722
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000723 self.assertTrue(os.path.exists(TESTFN))
Martin v. Löwis84f6de92007-02-13 10:10:39 +0000724
Ezio Melotti569e61f2009-12-30 06:14:51 +0000725 with zipfile.ZipFile(TESTFN, 'r') as zf:
726 self.assertEqual(zf.read(filename), content)
Tim Petersea5962f2007-03-12 18:07:52 +0000727
Ezio Melottid5a23e32009-07-15 17:07:04 +0000728 def test_close_erroneous_file(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000729 # This test checks that the ZipFile constructor closes the file object
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000730 # it opens if there's an error in the file. If it doesn't, the
731 # traceback holds a reference to the ZipFile object and, indirectly,
732 # the file object.
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000733 # On Windows, this causes the os.unlink() call to fail because the
734 # underlying file is still open. This is SF bug #412214.
735 #
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000736 with open(TESTFN, "w") as fp:
737 fp.write("this is not a legal zip file\n")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000738 try:
739 zf = zipfile.ZipFile(TESTFN)
740 except zipfile.BadZipfile:
Collin Winter04a51ec2007-03-29 02:28:16 +0000741 pass
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000742
Ezio Melottid5a23e32009-07-15 17:07:04 +0000743 def test_is_zip_erroneous_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000744 """Check that is_zipfile() correctly identifies non-zip files."""
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000745 # - passing a filename
746 with open(TESTFN, "w") as fp:
747 fp.write("this is not a legal zip file\n")
Tim Petersea5962f2007-03-12 18:07:52 +0000748 chk = zipfile.is_zipfile(TESTFN)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000749 self.assertFalse(chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000750 # - passing a file object
751 with open(TESTFN, "rb") as fp:
752 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000753 self.assertTrue(not chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000754 # - passing a file-like object
755 fp = StringIO()
756 fp.write("this is not a legal zip file\n")
757 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000758 self.assertTrue(not chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000759 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000760 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000761 self.assertTrue(not chk)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000762
Serhiy Storchaka0be506a2013-01-31 15:26:55 +0200763 def test_damaged_zipfile(self):
764 """Check that zipfiles with missing bytes at the end raise BadZipFile."""
765 # - Create a valid zip file
766 fp = io.BytesIO()
767 with zipfile.ZipFile(fp, mode="w") as zipf:
768 zipf.writestr("foo.txt", b"O, for a Muse of Fire!")
769 zipfiledata = fp.getvalue()
770
771 # - Now create copies of it missing the last N bytes and make sure
772 # a BadZipFile exception is raised when we try to open it
773 for N in range(len(zipfiledata)):
774 fp = io.BytesIO(zipfiledata[:N])
775 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, fp)
776
Ezio Melottid5a23e32009-07-15 17:07:04 +0000777 def test_is_zip_valid_file(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000778 """Check that is_zipfile() correctly identifies zip files."""
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000779 # - passing a filename
Ezio Melotti569e61f2009-12-30 06:14:51 +0000780 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
781 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Tim Petersea5962f2007-03-12 18:07:52 +0000782 chk = zipfile.is_zipfile(TESTFN)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000783 self.assertTrue(chk)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000784 # - passing a file object
785 with open(TESTFN, "rb") as fp:
786 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000787 self.assertTrue(chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000788 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000789 zip_contents = fp.read()
790 # - passing a file-like object
791 fp = StringIO()
792 fp.write(zip_contents)
793 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000794 self.assertTrue(chk)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000795 fp.seek(0, 0)
Antoine Pitrou6f193e02008-12-27 15:43:12 +0000796 chk = zipfile.is_zipfile(fp)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000797 self.assertTrue(chk)
Martin v. Löwis3eb76482007-03-06 10:41:24 +0000798
Ezio Melottid5a23e32009-07-15 17:07:04 +0000799 def test_non_existent_file_raises_IOError(self):
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000800 # make sure we don't raise an AttributeError when a partially-constructed
801 # ZipFile instance is finalized; this tests for regression on SF tracker
802 # bug #403871.
803
804 # The bug we're testing for caused an AttributeError to be raised
805 # when a ZipFile instance was created for a file that did not
806 # exist; the .fp member was not initialized but was needed by the
807 # __del__() method. Since the AttributeError is in the __del__(),
808 # it is ignored, but the user should be sufficiently annoyed by
809 # the message on the output that regression will be noticed
810 # quickly.
811 self.assertRaises(IOError, zipfile.ZipFile, TESTFN)
812
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000813 def test_empty_file_raises_BadZipFile(self):
Brian Curtin0d654332011-04-19 21:15:55 -0500814 with open(TESTFN, 'w') as f:
815 pass
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000816 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN)
817
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000818 with open(TESTFN, 'w') as fp:
819 fp.write("short file")
Amaury Forgeot d'Arc3e5b0272009-07-28 22:15:30 +0000820 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN)
821
Ezio Melottid5a23e32009-07-15 17:07:04 +0000822 def test_closed_zip_raises_RuntimeError(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000823 """Verify that testzip() doesn't swallow inappropriate exceptions."""
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000824 data = StringIO()
Ezio Melotti569e61f2009-12-30 06:14:51 +0000825 with zipfile.ZipFile(data, mode="w") as zipf:
826 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000827
Andrew Svetlov4bb142b2012-12-18 21:27:37 +0200828 # This is correct; calling .read on a closed ZipFile should raise
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000829 # a RuntimeError, and so should calling .testzip. An earlier
830 # version of .testzip would swallow this exception (and any other)
831 # and report that the first file in the archive was corrupt.
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000832 self.assertRaises(RuntimeError, zipf.read, "foo.txt")
833 self.assertRaises(RuntimeError, zipf.open, "foo.txt")
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +0000834 self.assertRaises(RuntimeError, zipf.testzip)
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000835 self.assertRaises(RuntimeError, zipf.writestr, "bogus.txt", "bogus")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000836 open(TESTFN, 'w').write('zipfile test data')
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000837 self.assertRaises(RuntimeError, zipf.write, TESTFN)
838
Ezio Melottid5a23e32009-07-15 17:07:04 +0000839 def test_bad_constructor_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000840 """Check that bad modes passed to ZipFile constructor are caught."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000841 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "q")
842
Ezio Melottid5a23e32009-07-15 17:07:04 +0000843 def test_bad_open_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000844 """Check that bad modes passed to ZipFile.open are caught."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000845 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
846 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
847
848 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000849 # read the data to make sure the file is there
Ezio Melotti569e61f2009-12-30 06:14:51 +0000850 zipf.read("foo.txt")
851 self.assertRaises(RuntimeError, zipf.open, "foo.txt", "q")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000852
Ezio Melottid5a23e32009-07-15 17:07:04 +0000853 def test_read0(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000854 """Check that calling read(0) on a ZipExtFile object returns an empty
855 string and doesn't advance file pointer."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000856 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
857 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
858 # read the data to make sure the file is there
Brian Curtin0d654332011-04-19 21:15:55 -0500859 with zipf.open("foo.txt") as f:
860 for i in xrange(FIXEDTEST_SIZE):
861 self.assertEqual(f.read(0), '')
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000862
Brian Curtin0d654332011-04-19 21:15:55 -0500863 self.assertEqual(f.read(), "O, for a Muse of Fire!")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000864
Ezio Melottid5a23e32009-07-15 17:07:04 +0000865 def test_open_non_existent_item(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000866 """Check that attempting to call open() for an item that doesn't
867 exist in the archive raises a RuntimeError."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000868 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
869 self.assertRaises(KeyError, zipf.open, "foo.txt", "r")
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000870
Ezio Melottid5a23e32009-07-15 17:07:04 +0000871 def test_bad_compression_mode(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000872 """Check that bad compression methods passed to ZipFile.open are
873 caught."""
Georg Brandl4b3ab6f2007-07-12 09:59:22 +0000874 self.assertRaises(RuntimeError, zipfile.ZipFile, TESTFN, "w", -1)
875
Ezio Melotti9e949722012-11-18 13:18:06 +0200876 def test_unsupported_compression(self):
877 # data is declared as shrunk, but actually deflated
878 data = (b'PK\x03\x04.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00'
879 b'\x00\x02\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00x\x03\x00PK\x01'
880 b'\x02.\x03.\x00\x00\x00\x01\x00\xe4C\xa1@\x00\x00\x00\x00\x02\x00\x00'
881 b'\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
882 b'\x80\x01\x00\x00\x00\x00xPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x00'
883 b'/\x00\x00\x00!\x00\x00\x00\x00\x00')
884 with zipfile.ZipFile(io.BytesIO(data), 'r') as zipf:
885 self.assertRaises(NotImplementedError, zipf.open, 'x')
886
Ezio Melottid5a23e32009-07-15 17:07:04 +0000887 def test_null_byte_in_filename(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000888 """Check that a filename containing a null byte is properly
889 terminated."""
Ezio Melotti569e61f2009-12-30 06:14:51 +0000890 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
891 zipf.writestr("foo.txt\x00qqq", "O, for a Muse of Fire!")
892 self.assertEqual(zipf.namelist(), ['foo.txt'])
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000893
Ezio Melottid5a23e32009-07-15 17:07:04 +0000894 def test_struct_sizes(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000895 """Check that ZIP internal structure sizes are calculated correctly."""
Martin v. Löwis8c436412008-07-03 12:51:14 +0000896 self.assertEqual(zipfile.sizeEndCentDir, 22)
897 self.assertEqual(zipfile.sizeCentralDir, 46)
898 self.assertEqual(zipfile.sizeEndCentDir64, 56)
899 self.assertEqual(zipfile.sizeEndCentDir64Locator, 20)
900
Ezio Melottid5a23e32009-07-15 17:07:04 +0000901 def test_comments(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +0000902 """Check that comments on the archive are handled properly."""
Martin v. Löwis8c436412008-07-03 12:51:14 +0000903
904 # check default comment is empty
Ezio Melotti569e61f2009-12-30 06:14:51 +0000905 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
906 self.assertEqual(zipf.comment, '')
907 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
908
909 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
910 self.assertEqual(zipf.comment, '')
Martin v. Löwis8c436412008-07-03 12:51:14 +0000911
912 # check a simple short comment
913 comment = 'Bravely taking to his feet, he beat a very brave retreat.'
Ezio Melotti569e61f2009-12-30 06:14:51 +0000914 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
915 zipf.comment = comment
916 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
917 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
918 self.assertEqual(zipf.comment, comment)
Martin v. Löwis8c436412008-07-03 12:51:14 +0000919
920 # check a comment of max length
921 comment2 = ''.join(['%d' % (i**3 % 10) for i in xrange((1 << 16)-1)])
Ezio Melotti569e61f2009-12-30 06:14:51 +0000922 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
923 zipf.comment = comment2
924 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
925
926 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
927 self.assertEqual(zipf.comment, comment2)
Martin v. Löwis8c436412008-07-03 12:51:14 +0000928
929 # check a comment that is too long is truncated
Ezio Melotti569e61f2009-12-30 06:14:51 +0000930 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
931 zipf.comment = comment2 + 'oops'
932 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
933 with zipfile.ZipFile(TESTFN, mode="r") as zipf:
934 self.assertEqual(zipf.comment, comment2)
Martin v. Löwis8c436412008-07-03 12:51:14 +0000935
R David Murray3f4ccba2012-04-12 18:42:47 -0400936 def test_change_comment_in_empty_archive(self):
937 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
938 self.assertFalse(zipf.filelist)
939 zipf.comment = b"this is a comment"
940 with zipfile.ZipFile(TESTFN, "r") as zipf:
941 self.assertEqual(zipf.comment, b"this is a comment")
942
943 def test_change_comment_in_nonempty_archive(self):
944 with zipfile.ZipFile(TESTFN, "w", zipfile.ZIP_STORED) as zipf:
945 zipf.writestr("foo.txt", "O, for a Muse of Fire!")
946 with zipfile.ZipFile(TESTFN, "a", zipfile.ZIP_STORED) as zipf:
947 self.assertTrue(zipf.filelist)
948 zipf.comment = b"this is a comment"
949 with zipfile.ZipFile(TESTFN, "r") as zipf:
950 self.assertEqual(zipf.comment, b"this is a comment")
951
Antoine Pitroue1436d12010-08-12 15:25:51 +0000952 def check_testzip_with_bad_crc(self, compression):
953 """Tests that files with bad CRCs return their name from testzip."""
954 zipdata = self.zips_with_bad_crc[compression]
955
956 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
957 # testzip returns the name of the first corrupt file, or None
958 self.assertEqual('afile', zipf.testzip())
959
960 def test_testzip_with_bad_crc_stored(self):
961 self.check_testzip_with_bad_crc(zipfile.ZIP_STORED)
962
963 @skipUnless(zlib, "requires zlib")
964 def test_testzip_with_bad_crc_deflated(self):
965 self.check_testzip_with_bad_crc(zipfile.ZIP_DEFLATED)
966
967 def check_read_with_bad_crc(self, compression):
968 """Tests that files with bad CRCs raise a BadZipfile exception when read."""
969 zipdata = self.zips_with_bad_crc[compression]
970
971 # Using ZipFile.read()
972 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
973 self.assertRaises(zipfile.BadZipfile, zipf.read, 'afile')
974
975 # Using ZipExtFile.read()
976 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
977 with zipf.open('afile', 'r') as corrupt_file:
978 self.assertRaises(zipfile.BadZipfile, corrupt_file.read)
979
980 # Same with small reads (in order to exercise the buffering logic)
981 with zipfile.ZipFile(io.BytesIO(zipdata), mode="r") as zipf:
982 with zipf.open('afile', 'r') as corrupt_file:
983 corrupt_file.MIN_READ_SIZE = 2
984 with self.assertRaises(zipfile.BadZipfile):
985 while corrupt_file.read(2):
986 pass
987
988 def test_read_with_bad_crc_stored(self):
989 self.check_read_with_bad_crc(zipfile.ZIP_STORED)
990
991 @skipUnless(zlib, "requires zlib")
992 def test_read_with_bad_crc_deflated(self):
993 self.check_read_with_bad_crc(zipfile.ZIP_DEFLATED)
994
Antoine Pitroue4195e82010-09-12 14:56:27 +0000995 def check_read_return_size(self, compression):
996 # Issue #9837: ZipExtFile.read() shouldn't return more bytes
997 # than requested.
998 for test_size in (1, 4095, 4096, 4097, 16384):
999 file_size = test_size + 1
1000 junk = b''.join(struct.pack('B', randint(0, 255))
1001 for x in range(file_size))
1002 with zipfile.ZipFile(io.BytesIO(), "w", compression) as zipf:
1003 zipf.writestr('foo', junk)
1004 with zipf.open('foo', 'r') as fp:
1005 buf = fp.read(test_size)
1006 self.assertEqual(len(buf), test_size)
1007
1008 def test_read_return_size_stored(self):
1009 self.check_read_return_size(zipfile.ZIP_STORED)
1010
1011 @skipUnless(zlib, "requires zlib")
1012 def test_read_return_size_deflated(self):
1013 self.check_read_return_size(zipfile.ZIP_DEFLATED)
1014
Georg Brandl86e0c892010-11-26 07:22:28 +00001015 def test_empty_zipfile(self):
1016 # Check that creating a file in 'w' or 'a' mode and closing without
1017 # adding any files to the archives creates a valid empty ZIP file
Brian Curtin0d654332011-04-19 21:15:55 -05001018 with zipfile.ZipFile(TESTFN, mode="w") as zipf:
1019 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001020 try:
1021 zipf = zipfile.ZipFile(TESTFN, mode="r")
Éric Araujo67843b32011-02-02 17:03:38 +00001022 except zipfile.BadZipfile:
Georg Brandl86e0c892010-11-26 07:22:28 +00001023 self.fail("Unable to create empty ZIP file in 'w' mode")
1024
Brian Curtin0d654332011-04-19 21:15:55 -05001025 with zipfile.ZipFile(TESTFN, mode="a") as zipf:
1026 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001027 try:
1028 zipf = zipfile.ZipFile(TESTFN, mode="r")
1029 except:
1030 self.fail("Unable to create empty ZIP file in 'a' mode")
1031
1032 def test_open_empty_file(self):
1033 # Issue 1710703: Check that opening a file with less than 22 bytes
1034 # raises a BadZipfile exception (rather than the previously unhelpful
1035 # IOError)
Brian Curtin0d654332011-04-19 21:15:55 -05001036 with open(TESTFN, 'w') as f:
1037 pass
Georg Brandl86e0c892010-11-26 07:22:28 +00001038 self.assertRaises(zipfile.BadZipfile, zipfile.ZipFile, TESTFN, 'r')
1039
Senthil Kumaranddd40312011-10-20 01:38:35 +08001040 def test_create_zipinfo_before_1980(self):
1041 self.assertRaises(ValueError,
1042 zipfile.ZipInfo, 'seventies', (1979, 1, 1, 0, 0, 0))
1043
Collin Winter04a51ec2007-03-29 02:28:16 +00001044 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001045 unlink(TESTFN)
1046 unlink(TESTFN2)
1047
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001048
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001049class DecryptionTests(unittest.TestCase):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001050 """Check that ZIP decryption works. Since the library does not
1051 support encryption at the moment, we use a pre-generated encrypted
1052 ZIP file."""
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001053
1054 data = (
1055 'PK\x03\x04\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00\x1a\x00'
1056 '\x00\x00\x08\x00\x00\x00test.txt\xfa\x10\xa0gly|\xfa-\xc5\xc0=\xf9y'
1057 '\x18\xe0\xa8r\xb3Z}Lg\xbc\xae\xf9|\x9b\x19\xe4\x8b\xba\xbb)\x8c\xb0\xdbl'
1058 'PK\x01\x02\x14\x00\x14\x00\x01\x00\x00\x00n\x92i.#y\xef?&\x00\x00\x00'
1059 '\x1a\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x01\x00 \x00\xb6\x81'
1060 '\x00\x00\x00\x00test.txtPK\x05\x06\x00\x00\x00\x00\x01\x00\x01\x006\x00'
1061 '\x00\x00L\x00\x00\x00\x00\x00' )
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001062 data2 = (
1063 'PK\x03\x04\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02'
1064 '\x00\x00\x04\x00\x15\x00zeroUT\t\x00\x03\xd6\x8b\x92G\xda\x8b\x92GUx\x04'
1065 '\x00\xe8\x03\xe8\x03\xc7<M\xb5a\xceX\xa3Y&\x8b{oE\xd7\x9d\x8c\x98\x02\xc0'
1066 'PK\x07\x08xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00PK\x01\x02\x17\x03'
1067 '\x14\x00\t\x00\x08\x00\xcf}38xu\xaa\xb2\x14\x00\x00\x00\x00\x02\x00\x00'
1068 '\x04\x00\r\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa4\x81\x00\x00\x00\x00ze'
1069 'roUT\x05\x00\x03\xd6\x8b\x92GUx\x00\x00PK\x05\x06\x00\x00\x00\x00\x01'
1070 '\x00\x01\x00?\x00\x00\x00[\x00\x00\x00\x00\x00' )
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001071
1072 plain = 'zipfile.py encryption test'
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001073 plain2 = '\x00'*512
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001074
1075 def setUp(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001076 with open(TESTFN, "wb") as fp:
1077 fp.write(self.data)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001078 self.zip = zipfile.ZipFile(TESTFN, "r")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001079 with open(TESTFN2, "wb") as fp:
1080 fp.write(self.data2)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001081 self.zip2 = zipfile.ZipFile(TESTFN2, "r")
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001082
1083 def tearDown(self):
1084 self.zip.close()
1085 os.unlink(TESTFN)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001086 self.zip2.close()
1087 os.unlink(TESTFN2)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001088
Ezio Melottid5a23e32009-07-15 17:07:04 +00001089 def test_no_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001090 # Reading the encrypted file without password
1091 # must generate a RunTime exception
1092 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001093 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001094
Ezio Melottid5a23e32009-07-15 17:07:04 +00001095 def test_bad_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001096 self.zip.setpassword("perl")
1097 self.assertRaises(RuntimeError, self.zip.read, "test.txt")
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001098 self.zip2.setpassword("perl")
1099 self.assertRaises(RuntimeError, self.zip2.read, "zero")
Tim Petersea5962f2007-03-12 18:07:52 +00001100
Ezio Melotti1036a7f2009-09-12 14:43:43 +00001101 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001102 def test_good_password(self):
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001103 self.zip.setpassword("python")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001104 self.assertEqual(self.zip.read("test.txt"), self.plain)
Gregory P. Smith0c63fc22008-01-20 01:21:03 +00001105 self.zip2.setpassword("12345")
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001106 self.assertEqual(self.zip2.read("zero"), self.plain2)
Martin v. Löwisc6d626e2007-02-13 09:49:38 +00001107
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001108
1109class TestsWithRandomBinaryFiles(unittest.TestCase):
1110 def setUp(self):
1111 datacount = randint(16, 64)*1024 + randint(1, 1024)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001112 self.data = ''.join(struct.pack('<f', random()*randint(-1000, 1000))
Ezio Melotti763f1e82009-12-31 13:27:41 +00001113 for i in xrange(datacount))
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001114
1115 # Make a source file with some lines
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001116 with open(TESTFN, "wb") as fp:
1117 fp.write(self.data)
Neal Norwitz0d4c06e2007-04-25 06:30:05 +00001118
Collin Winter04a51ec2007-03-29 02:28:16 +00001119 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001120 unlink(TESTFN)
1121 unlink(TESTFN2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001122
Ezio Melottid5a23e32009-07-15 17:07:04 +00001123 def make_test_archive(self, f, compression):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001124 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001125 with zipfile.ZipFile(f, "w", compression) as zipfp:
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001126 zipfp.write(TESTFN, "another.name")
Ezio Melotti569e61f2009-12-30 06:14:51 +00001127 zipfp.write(TESTFN, TESTFN)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001128
Ezio Melottid5a23e32009-07-15 17:07:04 +00001129 def zip_test(self, f, compression):
1130 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001131
1132 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001133 with zipfile.ZipFile(f, "r", compression) as zipfp:
1134 testdata = zipfp.read(TESTFN)
1135 self.assertEqual(len(testdata), len(self.data))
1136 self.assertEqual(testdata, self.data)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001137 self.assertEqual(zipfp.read("another.name"), self.data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001138
Ezio Melottid5a23e32009-07-15 17:07:04 +00001139 def test_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001140 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001141 self.zip_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001142
Antoine Pitroue1436d12010-08-12 15:25:51 +00001143 @skipUnless(zlib, "requires zlib")
1144 def test_deflated(self):
1145 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1146 self.zip_test(f, zipfile.ZIP_DEFLATED)
1147
Ezio Melottid5a23e32009-07-15 17:07:04 +00001148 def zip_open_test(self, f, compression):
1149 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001150
1151 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001152 with zipfile.ZipFile(f, "r", compression) as zipfp:
1153 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001154 with zipfp.open(TESTFN) as zipopen1:
1155 while True:
1156 read_data = zipopen1.read(256)
1157 if not read_data:
1158 break
1159 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001160
Ezio Melotti569e61f2009-12-30 06:14:51 +00001161 zipdata2 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001162 with zipfp.open("another.name") as zipopen2:
1163 while True:
1164 read_data = zipopen2.read(256)
1165 if not read_data:
1166 break
1167 zipdata2.append(read_data)
Tim Petersea5962f2007-03-12 18:07:52 +00001168
Ezio Melotti569e61f2009-12-30 06:14:51 +00001169 testdata1 = ''.join(zipdata1)
1170 self.assertEqual(len(testdata1), len(self.data))
1171 self.assertEqual(testdata1, self.data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001172
Ezio Melotti569e61f2009-12-30 06:14:51 +00001173 testdata2 = ''.join(zipdata2)
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001174 self.assertEqual(len(testdata2), len(self.data))
1175 self.assertEqual(testdata2, self.data)
Tim Petersea5962f2007-03-12 18:07:52 +00001176
Ezio Melottid5a23e32009-07-15 17:07:04 +00001177 def test_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001178 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001179 self.zip_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001180
Antoine Pitroue1436d12010-08-12 15:25:51 +00001181 @skipUnless(zlib, "requires zlib")
1182 def test_open_deflated(self):
1183 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1184 self.zip_open_test(f, zipfile.ZIP_DEFLATED)
1185
Ezio Melottid5a23e32009-07-15 17:07:04 +00001186 def zip_random_open_test(self, f, compression):
1187 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001188
1189 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001190 with zipfile.ZipFile(f, "r", compression) as zipfp:
1191 zipdata1 = []
Brian Curtin0d654332011-04-19 21:15:55 -05001192 with zipfp.open(TESTFN) as zipopen1:
1193 while True:
1194 read_data = zipopen1.read(randint(1, 1024))
1195 if not read_data:
1196 break
1197 zipdata1.append(read_data)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001198
Ezio Melotti569e61f2009-12-30 06:14:51 +00001199 testdata = ''.join(zipdata1)
1200 self.assertEqual(len(testdata), len(self.data))
1201 self.assertEqual(testdata, self.data)
Tim Petersea5962f2007-03-12 18:07:52 +00001202
Ezio Melottid5a23e32009-07-15 17:07:04 +00001203 def test_random_open_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001204 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001205 self.zip_random_open_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001206
Antoine Pitroue1436d12010-08-12 15:25:51 +00001207 @skipUnless(zlib, "requires zlib")
1208 def test_random_open_deflated(self):
1209 for f in (TESTFN2, TemporaryFile(), io.BytesIO()):
1210 self.zip_random_open_test(f, zipfile.ZIP_DEFLATED)
1211
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001212
Ezio Melotti1036a7f2009-09-12 14:43:43 +00001213@skipUnless(zlib, "requires zlib")
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001214class TestsWithMultipleOpens(unittest.TestCase):
1215 def setUp(self):
1216 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001217 with zipfile.ZipFile(TESTFN2, "w", zipfile.ZIP_DEFLATED) as zipfp:
1218 zipfp.writestr('ones', '1'*FIXEDTEST_SIZE)
1219 zipfp.writestr('twos', '2'*FIXEDTEST_SIZE)
Tim Petersea5962f2007-03-12 18:07:52 +00001220
Ezio Melottid5a23e32009-07-15 17:07:04 +00001221 def test_same_file(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001222 # Verify that (when the ZipFile is in control of creating file objects)
1223 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001224 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
1225 zopen1 = zipf.open('ones')
1226 zopen2 = zipf.open('ones')
1227 data1 = zopen1.read(500)
1228 data2 = zopen2.read(500)
1229 data1 += zopen1.read(500)
1230 data2 += zopen2.read(500)
1231 self.assertEqual(data1, data2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001232
Ezio Melottid5a23e32009-07-15 17:07:04 +00001233 def test_different_file(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001234 # Verify that (when the ZipFile is in control of creating file objects)
1235 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001236 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin0d654332011-04-19 21:15:55 -05001237 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1238 data1 = zopen1.read(500)
1239 data2 = zopen2.read(500)
1240 data1 += zopen1.read(500)
1241 data2 += zopen2.read(500)
Ezio Melotti569e61f2009-12-30 06:14:51 +00001242 self.assertEqual(data1, '1'*FIXEDTEST_SIZE)
1243 self.assertEqual(data2, '2'*FIXEDTEST_SIZE)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001244
Ezio Melottid5a23e32009-07-15 17:07:04 +00001245 def test_interleaved(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001246 # Verify that (when the ZipFile is in control of creating file objects)
1247 # multiple open() calls can be made without interfering with each other.
Ezio Melotti569e61f2009-12-30 06:14:51 +00001248 with zipfile.ZipFile(TESTFN2, mode="r") as zipf:
Brian Curtin0d654332011-04-19 21:15:55 -05001249 with zipf.open('ones') as zopen1, zipf.open('twos') as zopen2:
1250 data1 = zopen1.read(500)
1251 data2 = zopen2.read(500)
1252 data1 += zopen1.read(500)
1253 data2 += zopen2.read(500)
Ezio Melotti569e61f2009-12-30 06:14:51 +00001254 self.assertEqual(data1, '1'*FIXEDTEST_SIZE)
1255 self.assertEqual(data2, '2'*FIXEDTEST_SIZE)
Tim Petersea5962f2007-03-12 18:07:52 +00001256
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001257 def tearDown(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001258 unlink(TESTFN2)
1259
Tim Petersea5962f2007-03-12 18:07:52 +00001260
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001261class TestWithDirectory(unittest.TestCase):
1262 def setUp(self):
1263 os.mkdir(TESTFN2)
1264
Ezio Melottid5a23e32009-07-15 17:07:04 +00001265 def test_extract_dir(self):
Ezio Melotti569e61f2009-12-30 06:14:51 +00001266 with zipfile.ZipFile(findfile("zipdir.zip")) as zipf:
1267 zipf.extractall(TESTFN2)
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001268 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a")))
1269 self.assertTrue(os.path.isdir(os.path.join(TESTFN2, "a", "b")))
1270 self.assertTrue(os.path.exists(os.path.join(TESTFN2, "a", "b", "c")))
1271
Ezio Melottid5a23e32009-07-15 17:07:04 +00001272 def test_bug_6050(self):
Martin v. Löwis0b09c422009-05-24 19:30:52 +00001273 # Extraction should succeed if directories already exist
1274 os.mkdir(os.path.join(TESTFN2, "a"))
Ezio Melottid5a23e32009-07-15 17:07:04 +00001275 self.test_extract_dir()
Martin v. Löwis0b09c422009-05-24 19:30:52 +00001276
Ezio Melottid5a23e32009-07-15 17:07:04 +00001277 def test_store_dir(self):
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001278 os.mkdir(os.path.join(TESTFN2, "x"))
1279 zipf = zipfile.ZipFile(TESTFN, "w")
1280 zipf.write(os.path.join(TESTFN2, "x"), "x")
1281 self.assertTrue(zipf.filelist[0].filename.endswith("x/"))
1282
1283 def tearDown(self):
1284 shutil.rmtree(TESTFN2)
1285 if os.path.exists(TESTFN):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001286 unlink(TESTFN)
Martin v. Löwis0dfcfc82009-01-24 14:00:33 +00001287
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001288
1289class UniversalNewlineTests(unittest.TestCase):
1290 def setUp(self):
Ezio Melotti6d6b53c2009-12-31 13:00:43 +00001291 self.line_gen = ["Test of zipfile line %d." % i
1292 for i in xrange(FIXEDTEST_SIZE)]
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001293 self.seps = ('\r', '\r\n', '\n')
1294 self.arcdata, self.arcfiles = {}, {}
1295 for n, s in enumerate(self.seps):
1296 self.arcdata[s] = s.join(self.line_gen) + s
1297 self.arcfiles[s] = '%s-%d' % (TESTFN, n)
Brett Cannon6cef0762007-05-25 20:17:15 +00001298 open(self.arcfiles[s], "wb").write(self.arcdata[s])
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001299
Ezio Melottid5a23e32009-07-15 17:07:04 +00001300 def make_test_archive(self, f, compression):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001301 # Create the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001302 with zipfile.ZipFile(f, "w", compression) as zipfp:
1303 for fn in self.arcfiles.values():
1304 zipfp.write(fn, fn)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001305
Ezio Melottid5a23e32009-07-15 17:07:04 +00001306 def read_test(self, f, compression):
1307 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001308
1309 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001310 with zipfile.ZipFile(f, "r") as zipfp:
1311 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001312 with zipfp.open(fn, "rU") as fp:
1313 zipdata = fp.read()
Ezio Melotti569e61f2009-12-30 06:14:51 +00001314 self.assertEqual(self.arcdata[sep], zipdata)
Tim Petersea5962f2007-03-12 18:07:52 +00001315
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001316 def readline_read_test(self, f, compression):
1317 self.make_test_archive(f, compression)
1318
1319 # Read the ZIP archive
1320 zipfp = zipfile.ZipFile(f, "r")
1321 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001322 with zipfp.open(fn, "rU") as zipopen:
1323 data = ''
1324 while True:
1325 read = zipopen.readline()
1326 if not read:
1327 break
1328 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001329
Brian Curtin0d654332011-04-19 21:15:55 -05001330 read = zipopen.read(5)
1331 if not read:
1332 break
1333 data += read
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001334
1335 self.assertEqual(data, self.arcdata['\n'])
1336
1337 zipfp.close()
1338
Ezio Melottid5a23e32009-07-15 17:07:04 +00001339 def readline_test(self, f, compression):
1340 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001341
1342 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001343 with zipfile.ZipFile(f, "r") as zipfp:
1344 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001345 with zipfp.open(fn, "rU") as zipopen:
1346 for line in self.line_gen:
1347 linedata = zipopen.readline()
1348 self.assertEqual(linedata, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001349
Ezio Melottid5a23e32009-07-15 17:07:04 +00001350 def readlines_test(self, f, compression):
1351 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001352
1353 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001354 with zipfile.ZipFile(f, "r") as zipfp:
1355 for sep, fn in self.arcfiles.items():
Brian Curtin0d654332011-04-19 21:15:55 -05001356 with zipfp.open(fn, "rU") as fp:
1357 ziplines = fp.readlines()
Ezio Melotti569e61f2009-12-30 06:14:51 +00001358 for line, zipline in zip(self.line_gen, ziplines):
1359 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001360
Ezio Melottid5a23e32009-07-15 17:07:04 +00001361 def iterlines_test(self, f, compression):
1362 self.make_test_archive(f, compression)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001363
1364 # Read the ZIP archive
Ezio Melotti569e61f2009-12-30 06:14:51 +00001365 with zipfile.ZipFile(f, "r") as zipfp:
1366 for sep, fn in self.arcfiles.items():
1367 for line, zipline in zip(self.line_gen, zipfp.open(fn, "rU")):
1368 self.assertEqual(zipline, line + '\n')
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001369
Ezio Melottid5a23e32009-07-15 17:07:04 +00001370 def test_read_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001371 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001372 self.read_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001373
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001374 def test_readline_read_stored(self):
1375 # Issue #7610: calls to readline() interleaved with calls to read().
1376 for f in (TESTFN2, TemporaryFile(), StringIO()):
1377 self.readline_read_test(f, zipfile.ZIP_STORED)
1378
Ezio Melottid5a23e32009-07-15 17:07:04 +00001379 def test_readline_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001380 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001381 self.readline_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001382
Ezio Melottid5a23e32009-07-15 17:07:04 +00001383 def test_readlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001384 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001385 self.readlines_test(f, zipfile.ZIP_STORED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001386
Ezio Melottid5a23e32009-07-15 17:07:04 +00001387 def test_iterlines_stored(self):
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001388 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001389 self.iterlines_test(f, zipfile.ZIP_STORED)
Tim Petersea5962f2007-03-12 18:07:52 +00001390
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001391 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001392 def test_read_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001393 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001394 self.read_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001395
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001396 @skipUnless(zlib, "requires zlib")
Antoine Pitrou94c33eb2010-01-27 20:59:50 +00001397 def test_readline_read_deflated(self):
1398 # Issue #7610: calls to readline() interleaved with calls to read().
1399 for f in (TESTFN2, TemporaryFile(), StringIO()):
1400 self.readline_read_test(f, zipfile.ZIP_DEFLATED)
1401
1402 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001403 def test_readline_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001404 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001405 self.readline_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001406
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001407 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001408 def test_readlines_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001409 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001410 self.readlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001411
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001412 @skipUnless(zlib, "requires zlib")
Ezio Melottid5a23e32009-07-15 17:07:04 +00001413 def test_iterlines_deflated(self):
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001414 for f in (TESTFN2, TemporaryFile(), StringIO()):
Ezio Melottid5a23e32009-07-15 17:07:04 +00001415 self.iterlines_test(f, zipfile.ZIP_DEFLATED)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001416
1417 def tearDown(self):
1418 for sep, fn in self.arcfiles.items():
1419 os.remove(fn)
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001420 unlink(TESTFN)
1421 unlink(TESTFN2)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001422
1423
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001424def test_main():
Tim Petersea5962f2007-03-12 18:07:52 +00001425 run_unittest(TestsWithSourceFile, TestZip64InSmallFiles, OtherTests,
1426 PyZipFileTests, DecryptionTests, TestsWithMultipleOpens,
Ezio Melotti6cbfc122009-07-10 20:25:56 +00001427 TestWithDirectory, UniversalNewlineTests,
1428 TestsWithRandomBinaryFiles)
Martin v. Löwis3eb76482007-03-06 10:41:24 +00001429
Johannes Gijsbers3caf9c12004-08-19 15:11:50 +00001430if __name__ == "__main__":
1431 test_main()