• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1from test import test_support as support
2from test.test_support import TESTFN, _4G, bigmemtest, import_module, findfile
3
4import unittest
5from cStringIO import StringIO
6import os
7import subprocess
8import sys
9
10try:
11    import threading
12except ImportError:
13    threading = None
14
15bz2 = import_module('bz2')
16from bz2 import BZ2File, BZ2Compressor, BZ2Decompressor
17
18has_cmdline_bunzip2 = sys.platform not in ("win32", "os2emx", "riscos")
19
20class BaseTest(unittest.TestCase):
21    "Base for other testcases."
22    TEXT = 'root:x:0:0:root:/root:/bin/bash\nbin:x:1:1:bin:/bin:\ndaemon:x:2:2:daemon:/sbin:\nadm:x:3:4:adm:/var/adm:\nlp:x:4:7:lp:/var/spool/lpd:\nsync:x:5:0:sync:/sbin:/bin/sync\nshutdown:x:6:0:shutdown:/sbin:/sbin/shutdown\nhalt:x:7:0:halt:/sbin:/sbin/halt\nmail:x:8:12:mail:/var/spool/mail:\nnews:x:9:13:news:/var/spool/news:\nuucp:x:10:14:uucp:/var/spool/uucp:\noperator:x:11:0:operator:/root:\ngames:x:12:100:games:/usr/games:\ngopher:x:13:30:gopher:/usr/lib/gopher-data:\nftp:x:14:50:FTP User:/var/ftp:/bin/bash\nnobody:x:65534:65534:Nobody:/home:\npostfix:x:100:101:postfix:/var/spool/postfix:\nniemeyer:x:500:500::/home/niemeyer:/bin/bash\npostgres:x:101:102:PostgreSQL Server:/var/lib/pgsql:/bin/bash\nmysql:x:102:103:MySQL server:/var/lib/mysql:/bin/bash\nwww:x:103:104::/var/www:/bin/false\n'
23    DATA = 'BZh91AY&SY.\xc8N\x18\x00\x01>_\x80\x00\x10@\x02\xff\xf0\x01\x07n\x00?\xe7\xff\xe00\x01\x99\xaa\x00\xc0\x03F\x86\x8c#&\x83F\x9a\x03\x06\xa6\xd0\xa6\x93M\x0fQ\xa7\xa8\x06\x804hh\x12$\x11\xa4i4\xf14S\xd2<Q\xb5\x0fH\xd3\xd4\xdd\xd5\x87\xbb\xf8\x94\r\x8f\xafI\x12\xe1\xc9\xf8/E\x00pu\x89\x12]\xc9\xbbDL\nQ\x0e\t1\x12\xdf\xa0\xc0\x97\xac2O9\x89\x13\x94\x0e\x1c7\x0ed\x95I\x0c\xaaJ\xa4\x18L\x10\x05#\x9c\xaf\xba\xbc/\x97\x8a#C\xc8\xe1\x8cW\xf9\xe2\xd0\xd6M\xa7\x8bXa<e\x84t\xcbL\xb3\xa7\xd9\xcd\xd1\xcb\x84.\xaf\xb3\xab\xab\xad`n}\xa0lh\tE,\x8eZ\x15\x17VH>\x88\xe5\xcd9gd6\x0b\n\xe9\x9b\xd5\x8a\x99\xf7\x08.K\x8ev\xfb\xf7xw\xbb\xdf\xa1\x92\xf1\xdd|/";\xa2\xba\x9f\xd5\xb1#A\xb6\xf6\xb3o\xc9\xc5y\\\xebO\xe7\x85\x9a\xbc\xb6f8\x952\xd5\xd7"%\x89>V,\xf7\xa6z\xe2\x9f\xa3\xdf\x11\x11"\xd6E)I\xa9\x13^\xca\xf3r\xd0\x03U\x922\xf26\xec\xb6\xed\x8b\xc3U\x13\x9d\xc5\x170\xa4\xfa^\x92\xacDF\x8a\x97\xd6\x19\xfe\xdd\xb8\xbd\x1a\x9a\x19\xa3\x80ankR\x8b\xe5\xd83]\xa9\xc6\x08\x82f\xf6\xb9"6l$\xb8j@\xc0\x8a\xb0l1..\xbak\x83ls\x15\xbc\xf4\xc1\x13\xbe\xf8E\xb8\x9d\r\xa8\x9dk\x84\xd3n\xfa\xacQ\x07\xb1%y\xaav\xb4\x08\xe0z\x1b\x16\xf5\x04\xe9\xcc\xb9\x08z\x1en7.G\xfc]\xc9\x14\xe1B@\xbb!8`'
24    DATA_CRLF = 'BZh91AY&SY\xaez\xbbN\x00\x01H\xdf\x80\x00\x12@\x02\xff\xf0\x01\x07n\x00?\xe7\xff\xe0@\x01\xbc\xc6`\x86*\x8d=M\xa9\x9a\x86\xd0L@\x0fI\xa6!\xa1\x13\xc8\x88jdi\x8d@\x03@\x1a\x1a\x0c\x0c\x83 \x00\xc4h2\x19\x01\x82D\x84e\t\xe8\x99\x89\x19\x1ah\x00\r\x1a\x11\xaf\x9b\x0fG\xf5(\x1b\x1f?\t\x12\xcf\xb5\xfc\x95E\x00ps\x89\x12^\xa4\xdd\xa2&\x05(\x87\x04\x98\x89u\xe40%\xb6\x19\'\x8c\xc4\x89\xca\x07\x0e\x1b!\x91UIFU%C\x994!DI\xd2\xfa\xf0\xf1N8W\xde\x13A\xf5\x9cr%?\x9f3;I45A\xd1\x8bT\xb1<l\xba\xcb_\xc00xY\x17r\x17\x88\x08\x08@\xa0\ry@\x10\x04$)`\xf2\xce\x89z\xb0s\xec\x9b.iW\x9d\x81\xb5-+t\x9f\x1a\'\x97dB\xf5x\xb5\xbe.[.\xd7\x0e\x81\xe7\x08\x1cN`\x88\x10\xca\x87\xc3!"\x80\x92R\xa1/\xd1\xc0\xe6mf\xac\xbd\x99\xcca\xb3\x8780>\xa4\xc7\x8d\x1a\\"\xad\xa1\xabyBg\x15\xb9l\x88\x88\x91k"\x94\xa4\xd4\x89\xae*\xa6\x0b\x10\x0c\xd6\xd4m\xe86\xec\xb5j\x8a\x86j\';\xca.\x01I\xf2\xaaJ\xe8\x88\x8cU+t3\xfb\x0c\n\xa33\x13r2\r\x16\xe0\xb3(\xbf\x1d\x83r\xe7M\xf0D\x1365\xd8\x88\xd3\xa4\x92\xcb2\x06\x04\\\xc1\xb0\xea//\xbek&\xd8\xe6+t\xe5\xa1\x13\xada\x16\xder5"w]\xa2i\xb7[\x97R \xe2IT\xcd;Z\x04dk4\xad\x8a\t\xd3\x81z\x10\xf1:^`\xab\x1f\xc5\xdc\x91N\x14$+\x9e\xae\xd3\x80'
25    EMPTY_DATA = 'BZh9\x17rE8P\x90\x00\x00\x00\x00'
26
27    if has_cmdline_bunzip2:
28        def decompress(self, data):
29            pop = subprocess.Popen("bunzip2", shell=True,
30                                   stdin=subprocess.PIPE,
31                                   stdout=subprocess.PIPE,
32                                   stderr=subprocess.STDOUT)
33            pop.stdin.write(data)
34            pop.stdin.close()
35            ret = pop.stdout.read()
36            pop.stdout.close()
37            if pop.wait() != 0:
38                ret = bz2.decompress(data)
39            return ret
40
41    else:
42        # bunzip2 isn't available to run on Windows.
43        def decompress(self, data):
44            return bz2.decompress(data)
45
46
47class BZ2FileTest(BaseTest):
48    "Test BZ2File type miscellaneous methods."
49
50    def setUp(self):
51        self.filename = TESTFN
52
53    def tearDown(self):
54        if os.path.isfile(self.filename):
55            os.unlink(self.filename)
56
57    def createTempFile(self, crlf=0):
58        with open(self.filename, "wb") as f:
59            if crlf:
60                data = self.DATA_CRLF
61            else:
62                data = self.DATA
63            f.write(data)
64
65    def testRead(self):
66        # "Test BZ2File.read()"
67        self.createTempFile()
68        with BZ2File(self.filename) as bz2f:
69            self.assertRaises(TypeError, bz2f.read, None)
70            self.assertEqual(bz2f.read(), self.TEXT)
71
72    def testRead0(self):
73        # Test BBZ2File.read(0)"
74        self.createTempFile()
75        with BZ2File(self.filename) as bz2f:
76            self.assertRaises(TypeError, bz2f.read, None)
77            self.assertEqual(bz2f.read(0), "")
78
79    def testReadChunk10(self):
80        # "Test BZ2File.read() in chunks of 10 bytes"
81        self.createTempFile()
82        with BZ2File(self.filename) as bz2f:
83            text = ''
84            while 1:
85                str = bz2f.read(10)
86                if not str:
87                    break
88                text += str
89            self.assertEqual(text, self.TEXT)
90
91    def testRead100(self):
92        # "Test BZ2File.read(100)"
93        self.createTempFile()
94        with BZ2File(self.filename) as bz2f:
95            self.assertEqual(bz2f.read(100), self.TEXT[:100])
96
97    def testReadLine(self):
98        # "Test BZ2File.readline()"
99        self.createTempFile()
100        with BZ2File(self.filename) as bz2f:
101            self.assertRaises(TypeError, bz2f.readline, None)
102            sio = StringIO(self.TEXT)
103            for line in sio.readlines():
104                self.assertEqual(bz2f.readline(), line)
105
106    def testReadLines(self):
107        # "Test BZ2File.readlines()"
108        self.createTempFile()
109        with BZ2File(self.filename) as bz2f:
110            self.assertRaises(TypeError, bz2f.readlines, None)
111            sio = StringIO(self.TEXT)
112            self.assertEqual(bz2f.readlines(), sio.readlines())
113
114    def testIterator(self):
115        # "Test iter(BZ2File)"
116        self.createTempFile()
117        with BZ2File(self.filename) as bz2f:
118            sio = StringIO(self.TEXT)
119            self.assertEqual(list(iter(bz2f)), sio.readlines())
120
121    def testClosedIteratorDeadlock(self):
122        # "Test that iteration on a closed bz2file releases the lock."
123        # http://bugs.python.org/issue3309
124        self.createTempFile()
125        bz2f = BZ2File(self.filename)
126        bz2f.close()
127        self.assertRaises(ValueError, bz2f.next)
128        # This call will deadlock of the above .next call failed to
129        # release the lock.
130        self.assertRaises(ValueError, bz2f.readlines)
131
132    def testXReadLines(self):
133        # "Test BZ2File.xreadlines()"
134        self.createTempFile()
135        bz2f = BZ2File(self.filename)
136        sio = StringIO(self.TEXT)
137        self.assertEqual(list(bz2f.xreadlines()), sio.readlines())
138        bz2f.close()
139
140    def testUniversalNewlinesLF(self):
141        # "Test BZ2File.read() with universal newlines (\\n)"
142        self.createTempFile()
143        bz2f = BZ2File(self.filename, "rU")
144        self.assertEqual(bz2f.read(), self.TEXT)
145        self.assertEqual(bz2f.newlines, "\n")
146        bz2f.close()
147
148    def testUniversalNewlinesCRLF(self):
149        # "Test BZ2File.read() with universal newlines (\\r\\n)"
150        self.createTempFile(crlf=1)
151        bz2f = BZ2File(self.filename, "rU")
152        self.assertEqual(bz2f.read(), self.TEXT)
153        self.assertEqual(bz2f.newlines, "\r\n")
154        bz2f.close()
155
156    def testWrite(self):
157        # "Test BZ2File.write()"
158        with BZ2File(self.filename, "w") as bz2f:
159            self.assertRaises(TypeError, bz2f.write)
160            bz2f.write(self.TEXT)
161        with open(self.filename, 'rb') as f:
162            self.assertEqual(self.decompress(f.read()), self.TEXT)
163
164    def testWriteChunks10(self):
165        # "Test BZ2File.write() with chunks of 10 bytes"
166        with BZ2File(self.filename, "w") as bz2f:
167            n = 0
168            while 1:
169                str = self.TEXT[n*10:(n+1)*10]
170                if not str:
171                    break
172                bz2f.write(str)
173                n += 1
174        with open(self.filename, 'rb') as f:
175            self.assertEqual(self.decompress(f.read()), self.TEXT)
176
177    def testWriteLines(self):
178        # "Test BZ2File.writelines()"
179        with BZ2File(self.filename, "w") as bz2f:
180            self.assertRaises(TypeError, bz2f.writelines)
181            sio = StringIO(self.TEXT)
182            bz2f.writelines(sio.readlines())
183        # patch #1535500
184        self.assertRaises(ValueError, bz2f.writelines, ["a"])
185        with open(self.filename, 'rb') as f:
186            self.assertEqual(self.decompress(f.read()), self.TEXT)
187
188    def testWriteMethodsOnReadOnlyFile(self):
189        with BZ2File(self.filename, "w") as bz2f:
190            bz2f.write("abc")
191
192        with BZ2File(self.filename, "r") as bz2f:
193            self.assertRaises(IOError, bz2f.write, "a")
194            self.assertRaises(IOError, bz2f.writelines, ["a"])
195
196    def testSeekForward(self):
197        # "Test BZ2File.seek(150, 0)"
198        self.createTempFile()
199        with BZ2File(self.filename) as bz2f:
200            self.assertRaises(TypeError, bz2f.seek)
201            bz2f.seek(150)
202            self.assertEqual(bz2f.read(), self.TEXT[150:])
203
204    def testSeekBackwards(self):
205        # "Test BZ2File.seek(-150, 1)"
206        self.createTempFile()
207        with BZ2File(self.filename) as bz2f:
208            bz2f.read(500)
209            bz2f.seek(-150, 1)
210            self.assertEqual(bz2f.read(), self.TEXT[500-150:])
211
212    def testSeekBackwardsFromEnd(self):
213        # "Test BZ2File.seek(-150, 2)"
214        self.createTempFile()
215        with BZ2File(self.filename) as bz2f:
216            bz2f.seek(-150, 2)
217            self.assertEqual(bz2f.read(), self.TEXT[len(self.TEXT)-150:])
218
219    def testSeekPostEnd(self):
220        # "Test BZ2File.seek(150000)"
221        self.createTempFile()
222        with BZ2File(self.filename) as bz2f:
223            bz2f.seek(150000)
224            self.assertEqual(bz2f.tell(), len(self.TEXT))
225            self.assertEqual(bz2f.read(), "")
226
227    def testSeekPostEndTwice(self):
228        # "Test BZ2File.seek(150000) twice"
229        self.createTempFile()
230        with BZ2File(self.filename) as bz2f:
231            bz2f.seek(150000)
232            bz2f.seek(150000)
233            self.assertEqual(bz2f.tell(), len(self.TEXT))
234            self.assertEqual(bz2f.read(), "")
235
236    def testSeekPreStart(self):
237        # "Test BZ2File.seek(-150, 0)"
238        self.createTempFile()
239        with BZ2File(self.filename) as bz2f:
240            bz2f.seek(-150)
241            self.assertEqual(bz2f.tell(), 0)
242            self.assertEqual(bz2f.read(), self.TEXT)
243
244    def testOpenDel(self):
245        # "Test opening and deleting a file many times"
246        self.createTempFile()
247        for i in xrange(10000):
248            o = BZ2File(self.filename)
249            del o
250
251    def testOpenNonexistent(self):
252        # "Test opening a nonexistent file"
253        self.assertRaises(IOError, BZ2File, "/non/existent")
254
255    def testModeU(self):
256        # Bug #1194181: bz2.BZ2File opened for write with mode "U"
257        self.createTempFile()
258        bz2f = BZ2File(self.filename, "U")
259        bz2f.close()
260        f = file(self.filename)
261        f.seek(0, 2)
262        self.assertEqual(f.tell(), len(self.DATA))
263        f.close()
264
265    def testBug1191043(self):
266        # readlines() for files containing no newline
267        data = 'BZh91AY&SY\xd9b\x89]\x00\x00\x00\x03\x80\x04\x00\x02\x00\x0c\x00 \x00!\x9ah3M\x13<]\xc9\x14\xe1BCe\x8a%t'
268        with open(self.filename, "wb") as f:
269            f.write(data)
270        with BZ2File(self.filename) as bz2f:
271            lines = bz2f.readlines()
272        self.assertEqual(lines, ['Test'])
273        with BZ2File(self.filename) as bz2f:
274            xlines = list(bz2f.readlines())
275        self.assertEqual(xlines, ['Test'])
276
277    def testContextProtocol(self):
278        # BZ2File supports the context management protocol
279        f = None
280        with BZ2File(self.filename, "wb") as f:
281            f.write(b"xxx")
282        f = BZ2File(self.filename, "rb")
283        f.close()
284        try:
285            with f:
286                pass
287        except ValueError:
288            pass
289        else:
290            self.fail("__enter__ on a closed file didn't raise an exception")
291        try:
292            with BZ2File(self.filename, "wb") as f:
293                1 // 0
294        except ZeroDivisionError:
295            pass
296        else:
297            self.fail("1 // 0 didn't raise an exception")
298
299    @unittest.skipUnless(threading, 'Threading required for this test.')
300    def testThreading(self):
301        # Using a BZ2File from several threads doesn't deadlock (issue #7205).
302        data = "1" * 2**20
303        nthreads = 10
304        with bz2.BZ2File(self.filename, 'wb') as f:
305            def comp():
306                for i in range(5):
307                    f.write(data)
308            threads = [threading.Thread(target=comp) for i in range(nthreads)]
309            with support.start_threads(threads):
310                pass
311
312    def testMixedIterationReads(self):
313        # Issue #8397: mixed iteration and reads should be forbidden.
314        with bz2.BZ2File(self.filename, 'wb') as f:
315            # The internal buffer size is hard-wired to 8192 bytes, we must
316            # write out more than that for the test to stop half through
317            # the buffer.
318            f.write(self.TEXT * 100)
319        with bz2.BZ2File(self.filename, 'rb') as f:
320            next(f)
321            self.assertRaises(ValueError, f.read)
322            self.assertRaises(ValueError, f.readline)
323            self.assertRaises(ValueError, f.readlines)
324
325    @unittest.skipIf(sys.platform == 'win32',
326                     'test depends on being able to delete a still-open file,'
327                     ' which is not possible on Windows')
328    def testInitNonExistentFile(self):
329        # Issue #19878: Should not segfault when __init__ with non-existent
330        # file for the second time.
331        self.createTempFile()
332        # Test close():
333        with BZ2File(self.filename, "wb") as f:
334            self.assertRaises(IOError, f.__init__, "non-existent-file")
335        # Test object deallocation without call to close():
336        f = bz2.BZ2File(self.filename)
337        self.assertRaises(IOError, f.__init__, "non-existent-file")
338        del f
339
340class BZ2CompressorTest(BaseTest):
341    def testCompress(self):
342        # "Test BZ2Compressor.compress()/flush()"
343        bz2c = BZ2Compressor()
344        self.assertRaises(TypeError, bz2c.compress)
345        data = bz2c.compress(self.TEXT)
346        data += bz2c.flush()
347        self.assertEqual(self.decompress(data), self.TEXT)
348
349    def testCompressEmptyString(self):
350        # "Test BZ2Compressor.compress()/flush() of empty string"
351        bz2c = BZ2Compressor()
352        data = bz2c.compress('')
353        data += bz2c.flush()
354        self.assertEqual(data, self.EMPTY_DATA)
355
356    def testCompressChunks10(self):
357        # "Test BZ2Compressor.compress()/flush() with chunks of 10 bytes"
358        bz2c = BZ2Compressor()
359        n = 0
360        data = ''
361        while 1:
362            str = self.TEXT[n*10:(n+1)*10]
363            if not str:
364                break
365            data += bz2c.compress(str)
366            n += 1
367        data += bz2c.flush()
368        self.assertEqual(self.decompress(data), self.TEXT)
369
370    @bigmemtest(_4G, memuse=1.25)
371    def testBigmem(self, size):
372        text = "a" * size
373        bz2c = bz2.BZ2Compressor()
374        data = bz2c.compress(text) + bz2c.flush()
375        del text
376        text = self.decompress(data)
377        self.assertEqual(len(text), size)
378        self.assertEqual(text.strip("a"), "")
379
380
381class BZ2DecompressorTest(BaseTest):
382    def test_Constructor(self):
383        self.assertRaises(TypeError, BZ2Decompressor, 42)
384
385    def testDecompress(self):
386        # "Test BZ2Decompressor.decompress()"
387        bz2d = BZ2Decompressor()
388        self.assertRaises(TypeError, bz2d.decompress)
389        text = bz2d.decompress(self.DATA)
390        self.assertEqual(text, self.TEXT)
391
392    def testDecompressChunks10(self):
393        # "Test BZ2Decompressor.decompress() with chunks of 10 bytes"
394        bz2d = BZ2Decompressor()
395        text = ''
396        n = 0
397        while 1:
398            str = self.DATA[n*10:(n+1)*10]
399            if not str:
400                break
401            text += bz2d.decompress(str)
402            n += 1
403        self.assertEqual(text, self.TEXT)
404
405    def testDecompressUnusedData(self):
406        # "Test BZ2Decompressor.decompress() with unused data"
407        bz2d = BZ2Decompressor()
408        unused_data = "this is unused data"
409        text = bz2d.decompress(self.DATA+unused_data)
410        self.assertEqual(text, self.TEXT)
411        self.assertEqual(bz2d.unused_data, unused_data)
412
413    def testEOFError(self):
414        # "Calling BZ2Decompressor.decompress() after EOS must raise EOFError"
415        bz2d = BZ2Decompressor()
416        text = bz2d.decompress(self.DATA)
417        self.assertRaises(EOFError, bz2d.decompress, "anything")
418        self.assertRaises(EOFError, bz2d.decompress, "")
419
420    @bigmemtest(_4G, memuse=1.25)
421    def testBigmem(self, size):
422        # Issue #14398: decompression fails when output data is >=2GB.
423        if size < _4G:
424            self.skipTest("Test needs 5GB of memory to run.")
425        compressed = bz2.compress("a" * _4G)
426        text = bz2.BZ2Decompressor().decompress(compressed)
427        self.assertEqual(len(text), _4G)
428        self.assertEqual(text.strip("a"), "")
429
430
431class FuncTest(BaseTest):
432    "Test module functions"
433
434    def testCompress(self):
435        # "Test compress() function"
436        data = bz2.compress(self.TEXT)
437        self.assertEqual(self.decompress(data), self.TEXT)
438
439    def testCompressEmptyString(self):
440        # "Test compress() of empty string"
441        text = bz2.compress('')
442        self.assertEqual(text, self.EMPTY_DATA)
443
444    def testDecompress(self):
445        # "Test decompress() function"
446        text = bz2.decompress(self.DATA)
447        self.assertEqual(text, self.TEXT)
448
449    def testDecompressEmpty(self):
450        # "Test decompress() function with empty string"
451        text = bz2.decompress("")
452        self.assertEqual(text, "")
453
454    def testDecompressToEmptyString(self):
455        # "Test decompress() of minimal bz2 data to empty string"
456        text = bz2.decompress(self.EMPTY_DATA)
457        self.assertEqual(text, '')
458
459    def testDecompressIncomplete(self):
460        # "Test decompress() function with incomplete data"
461        self.assertRaises(ValueError, bz2.decompress, self.DATA[:-10])
462
463    @bigmemtest(_4G, memuse=1.25)
464    def testCompressBigmem(self, size):
465        text = "a" * size
466        data = bz2.compress(text)
467        del text
468        text = self.decompress(data)
469        self.assertEqual(len(text), size)
470        self.assertEqual(text.strip("a"), "")
471
472    @bigmemtest(_4G, memuse=1.25)
473    def testDecompressBigmem(self, size):
474        # Issue #14398: decompression fails when output data is >=2GB.
475        if size < _4G:
476            self.skipTest("Test needs 5GB of memory to run.")
477        compressed = bz2.compress("a" * _4G)
478        text = bz2.decompress(compressed)
479        self.assertEqual(len(text), _4G)
480        self.assertEqual(text.strip("a"), "")
481
482def test_main():
483    support.run_unittest(
484        BZ2FileTest,
485        BZ2CompressorTest,
486        BZ2DecompressorTest,
487        FuncTest
488    )
489    support.reap_children()
490
491if __name__ == '__main__':
492    test_main()
493
494# vim:ts=4:sw=4
495