| # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, |
| # 2011, 2012, 2013, 2014, 2015, 2016, 2017 Python Software Foundation; All |
| # Rights Reserved |
| # |
| # This is a backport from python 3.4 into python 2.7. Text and exclusive mode |
| # support are removed as they're unsupported in 2.7. This backport patches a |
| # streaming bug that exists in python 2.7. |
| |
| """Test script for the gzip module. |
| """ |
| |
| import six |
| from six.moves import range |
| |
| import unittest |
| import os |
| import io |
| import struct |
| from apitools.base.py import gzip |
| from io import open |
| |
| data1 = b""" int length=DEFAULTALLOC, err = Z_OK; |
| PyObject *RetVal; |
| int flushmode = Z_FINISH; |
| unsigned long start_total_out; |
| |
| """ |
| |
| data2 = b"""/* zlibmodule.c -- gzip-compatible data compression */ |
| /* See http://www.gzip.org/zlib/ |
| /* See http://www.winimage.com/zLibDll for Windows */ |
| """ |
| |
| |
| def unlink(filename): |
| try: |
| os.unlink(filename) |
| except: |
| pass |
| |
| |
| class UnseekableIO(io.BytesIO): |
| def seekable(self): |
| return False |
| |
| def tell(self): |
| raise io.UnsupportedOperation |
| |
| def seek(self, *args): |
| raise io.UnsupportedOperation |
| |
| |
| class BaseTest(unittest.TestCase): |
| filename = "@test" |
| |
| def setUp(self): |
| unlink(self.filename) |
| |
| def tearDown(self): |
| unlink(self.filename) |
| |
| |
| class TestGzip(BaseTest): |
| def write_and_read_back(self, data, mode='b'): |
| b_data = bytes(data) |
| with gzip.GzipFile(self.filename, 'w' + mode) as f: |
| l = f.write(data) |
| self.assertEqual(l, len(b_data)) |
| with gzip.GzipFile(self.filename, 'r' + mode) as f: |
| self.assertEqual(f.read(), b_data) |
| |
| def test_write(self): |
| with gzip.GzipFile(self.filename, 'wb') as f: |
| f.write(data1 * 50) |
| |
| # Try flush and fileno. |
| f.flush() |
| f.fileno() |
| if hasattr(os, 'fsync'): |
| os.fsync(f.fileno()) |
| f.close() |
| |
| # Test multiple close() calls. |
| f.close() |
| |
| # The following test_write_xy methods test that write accepts |
| # the corresponding bytes-like object type as input |
| # and that the data written equals bytes(xy) in all cases. |
| def test_write_memoryview(self): |
| data = memoryview(data1 * 50) |
| self.write_and_read_back(data.tobytes()) |
| data = memoryview(bytes(range(256))) |
| self.write_and_read_back(data.tobytes()) |
| |
| def test_write_incompatible_type(self): |
| # Test that non-bytes-like types raise TypeError. |
| # Issue #21560: attempts to write incompatible types |
| # should not affect the state of the fileobject |
| with gzip.GzipFile(self.filename, 'wb') as f: |
| if six.PY2: |
| with self.assertRaises(UnicodeEncodeError): |
| f.write(u'\xff') |
| elif six.PY3: |
| with self.assertRaises(TypeError): |
| f.write(u'\xff') |
| with self.assertRaises(TypeError): |
| f.write([1]) |
| f.write(data1) |
| with gzip.GzipFile(self.filename, 'rb') as f: |
| self.assertEqual(f.read(), data1) |
| |
| def test_read(self): |
| self.test_write() |
| # Try reading. |
| with gzip.GzipFile(self.filename, 'r') as f: |
| d = f.read() |
| self.assertEqual(d, data1 * 50) |
| |
| def test_read1(self): |
| self.test_write() |
| blocks = [] |
| nread = 0 |
| with gzip.GzipFile(self.filename, 'r') as f: |
| while True: |
| d = f.read1() |
| if not d: |
| break |
| blocks.append(d) |
| nread += len(d) |
| # Check that position was updated correctly (see issue10791). |
| self.assertEqual(f.tell(), nread) |
| self.assertEqual(b''.join(blocks), data1 * 50) |
| |
| def test_io_on_closed_object(self): |
| # Test that I/O operations on closed GzipFile objects raise a |
| # ValueError, just like the corresponding functions on file objects. |
| |
| # Write to a file, open it for reading, then close it. |
| self.test_write() |
| f = gzip.GzipFile(self.filename, 'r') |
| f.close() |
| with self.assertRaises(ValueError): |
| f.read(1) |
| with self.assertRaises(ValueError): |
| f.seek(0) |
| with self.assertRaises(ValueError): |
| f.tell() |
| # Open the file for writing, then close it. |
| f = gzip.GzipFile(self.filename, 'w') |
| f.close() |
| with self.assertRaises(ValueError): |
| f.write(b'') |
| with self.assertRaises(ValueError): |
| f.flush() |
| |
| def test_append(self): |
| self.test_write() |
| # Append to the previous file |
| with gzip.GzipFile(self.filename, 'ab') as f: |
| f.write(data2 * 15) |
| |
| with gzip.GzipFile(self.filename, 'rb') as f: |
| d = f.read() |
| self.assertEqual(d, (data1 * 50) + (data2 * 15)) |
| |
| def test_many_append(self): |
| # Bug #1074261 was triggered when reading a file that contained |
| # many, many members. Create such a file and verify that reading it |
| # works. |
| with gzip.GzipFile(self.filename, 'wb', 9) as f: |
| f.write(b'a') |
| for i in range(0, 200): |
| with gzip.GzipFile(self.filename, "ab", 9) as f: # append |
| f.write(b'a') |
| |
| # Try reading the file |
| with gzip.GzipFile(self.filename, "rb") as zgfile: |
| contents = b"" |
| while 1: |
| ztxt = zgfile.read(8192) |
| contents += ztxt |
| if not ztxt: |
| break |
| self.assertEqual(contents, b'a' * 201) |
| |
| def test_buffered_reader(self): |
| # Issue #7471: a GzipFile can be wrapped in a BufferedReader for |
| # performance. |
| self.test_write() |
| |
| with gzip.GzipFile(self.filename, 'rb') as f: |
| with io.BufferedReader(f) as r: |
| lines = [line for line in r] |
| |
| self.assertEqual(lines, 50 * data1.splitlines(True)) |
| |
| def test_readline(self): |
| self.test_write() |
| # Try .readline() with varying line lengths |
| |
| with gzip.GzipFile(self.filename, 'rb') as f: |
| line_length = 0 |
| while 1: |
| L = f.readline(line_length) |
| if not L and line_length != 0: |
| break |
| self.assertTrue(len(L) <= line_length) |
| line_length = (line_length + 1) % 50 |
| |
| def test_readlines(self): |
| self.test_write() |
| # Try .readlines() |
| |
| with gzip.GzipFile(self.filename, 'rb') as f: |
| L = f.readlines() |
| |
| with gzip.GzipFile(self.filename, 'rb') as f: |
| while 1: |
| L = f.readlines(150) |
| if L == []: |
| break |
| |
| def test_seek_read(self): |
| self.test_write() |
| # Try seek, read test |
| |
| with gzip.GzipFile(self.filename) as f: |
| while 1: |
| oldpos = f.tell() |
| line1 = f.readline() |
| if not line1: |
| break |
| newpos = f.tell() |
| f.seek(oldpos) # negative seek |
| if len(line1) > 10: |
| amount = 10 |
| else: |
| amount = len(line1) |
| line2 = f.read(amount) |
| self.assertEqual(line1[:amount], line2) |
| f.seek(newpos) # positive seek |
| |
| def test_seek_whence(self): |
| self.test_write() |
| # Try seek(whence=1), read test |
| |
| with gzip.GzipFile(self.filename) as f: |
| f.read(10) |
| f.seek(10, whence=1) |
| y = f.read(10) |
| self.assertEqual(y, data1[20:30]) |
| |
| def test_seek_write(self): |
| # Try seek, write test |
| with gzip.GzipFile(self.filename, 'w') as f: |
| for pos in range(0, 256, 16): |
| f.seek(pos) |
| f.write(b'GZ\n') |
| |
| def test_mode(self): |
| self.test_write() |
| with gzip.GzipFile(self.filename, 'r') as f: |
| self.assertEqual(f.myfileobj.mode, 'rb') |
| |
| def test_1647484(self): |
| for mode in ('wb', 'rb'): |
| with gzip.GzipFile(self.filename, mode) as f: |
| self.assertTrue(hasattr(f, "name")) |
| self.assertEqual(f.name, self.filename) |
| |
| def test_paddedfile_getattr(self): |
| self.test_write() |
| with gzip.GzipFile(self.filename, 'rb') as f: |
| self.assertTrue(hasattr(f.fileobj, "name")) |
| self.assertEqual(f.fileobj.name, self.filename) |
| |
| def test_mtime(self): |
| mtime = 123456789 |
| with gzip.GzipFile(self.filename, 'w', mtime=mtime) as fWrite: |
| fWrite.write(data1) |
| with gzip.GzipFile(self.filename) as fRead: |
| dataRead = fRead.read() |
| self.assertEqual(dataRead, data1) |
| self.assertTrue(hasattr(fRead, 'mtime')) |
| self.assertEqual(fRead.mtime, mtime) |
| |
| def test_metadata(self): |
| mtime = 123456789 |
| |
| with gzip.GzipFile(self.filename, 'w', mtime=mtime) as fWrite: |
| fWrite.write(data1) |
| |
| with open(self.filename, 'rb') as fRead: |
| # see RFC 1952: http://www.faqs.org/rfcs/rfc1952.html |
| |
| idBytes = fRead.read(2) |
| self.assertEqual(idBytes, b'\x1f\x8b') # gzip ID |
| |
| cmByte = fRead.read(1) |
| self.assertEqual(cmByte, b'\x08') # deflate |
| |
| flagsByte = fRead.read(1) |
| self.assertEqual(flagsByte, b'\x08') # only the FNAME flag is set |
| |
| mtimeBytes = fRead.read(4) |
| self.assertEqual(mtimeBytes, struct.pack( |
| '<i', mtime)) # little-endian |
| |
| xflByte = fRead.read(1) |
| self.assertEqual(xflByte, b'\x02') # maximum compression |
| |
| osByte = fRead.read(1) |
| self.assertEqual(osByte, b'\xff') # OS "unknown" (OS-independent) |
| |
| # Since the FNAME flag is set, the zero-terminated filename |
| # follows. RFC 1952 specifies that this is the name of the input |
| # file, if any. However, the gzip module defaults to storing the |
| # name of the output file in this field. |
| expected = self.filename.encode('Latin-1') + b'\x00' |
| nameBytes = fRead.read(len(expected)) |
| self.assertEqual(nameBytes, expected) |
| |
| # Since no other flags were set, the header ends here. Rather than |
| # process the compressed data, let's seek to the trailer. |
| fRead.seek(os.stat(self.filename).st_size - 8) |
| |
| crc32Bytes = fRead.read(4) # CRC32 of uncompressed data [data1] |
| self.assertEqual(crc32Bytes, b'\xaf\xd7d\x83') |
| |
| isizeBytes = fRead.read(4) |
| self.assertEqual(isizeBytes, struct.pack('<i', len(data1))) |
| |
| def test_with_open(self): |
| # GzipFile supports the context management protocol |
| with gzip.GzipFile(self.filename, "wb") as f: |
| f.write(b"xxx") |
| f = gzip.GzipFile(self.filename, "rb") |
| f.close() |
| try: |
| with f: |
| pass |
| except ValueError: |
| pass |
| else: |
| self.fail("__enter__ on a closed file didn't raise an exception") |
| try: |
| with gzip.GzipFile(self.filename, "wb") as f: |
| 1 / 0 |
| except ZeroDivisionError: |
| pass |
| else: |
| self.fail("1/0 didn't raise an exception") |
| |
| def test_zero_padded_file(self): |
| with gzip.GzipFile(self.filename, "wb") as f: |
| f.write(data1 * 50) |
| |
| # Pad the file with zeroes |
| with open(self.filename, "ab") as f: |
| f.write(b"\x00" * 50) |
| |
| with gzip.GzipFile(self.filename, "rb") as f: |
| d = f.read() |
| self.assertEqual(d, data1 * 50, "Incorrect data in file") |
| |
| def test_non_seekable_file(self): |
| uncompressed = data1 * 50 |
| buf = UnseekableIO() |
| with gzip.GzipFile(fileobj=buf, mode="wb") as f: |
| f.write(uncompressed) |
| compressed = buf.getvalue() |
| buf = UnseekableIO(compressed) |
| with gzip.GzipFile(fileobj=buf, mode="rb") as f: |
| self.assertEqual(f.read(), uncompressed) |
| |
| def test_peek(self): |
| uncompressed = data1 * 200 |
| with gzip.GzipFile(self.filename, "wb") as f: |
| f.write(uncompressed) |
| |
| def sizes(): |
| while True: |
| for n in range(5, 50, 10): |
| yield n |
| |
| with gzip.GzipFile(self.filename, "rb") as f: |
| f.max_read_chunk = 33 |
| nread = 0 |
| for n in sizes(): |
| s = f.peek(n) |
| if s == b'': |
| break |
| self.assertEqual(f.read(len(s)), s) |
| nread += len(s) |
| self.assertEqual(f.read(100), b'') |
| self.assertEqual(nread, len(uncompressed)) |
| |
| def test_textio_readlines(self): |
| # Issue #10791: TextIOWrapper.readlines() fails when wrapping GzipFile. |
| lines = (data1 * 50).decode("ascii").splitlines(True) |
| self.test_write() |
| with gzip.GzipFile(self.filename, 'r') as f: |
| with io.TextIOWrapper(f, encoding="ascii") as t: |
| self.assertEqual(t.readlines(), lines) |
| |
| def test_fileobj_from_fdopen(self): |
| # Issue #13781: Opening a GzipFile for writing fails when using a |
| # fileobj created with os.fdopen(). |
| fd = os.open(self.filename, os.O_WRONLY | os.O_CREAT) |
| with os.fdopen(fd, "wb") as f: |
| with gzip.GzipFile(fileobj=f, mode="w") as g: |
| pass |
| |
| def test_bytes_filename(self): |
| str_filename = self.filename |
| try: |
| bytes_filename = str_filename.encode("ascii") |
| except UnicodeEncodeError: |
| self.skipTest("Temporary file name needs to be ASCII") |
| with gzip.GzipFile(bytes_filename, "wb") as f: |
| f.write(data1 * 50) |
| with gzip.GzipFile(bytes_filename, "rb") as f: |
| self.assertEqual(f.read(), data1 * 50) |
| # Sanity check that we are actually operating on the right file. |
| with gzip.GzipFile(str_filename, "rb") as f: |
| self.assertEqual(f.read(), data1 * 50) |
| |
| # Testing compress/decompress shortcut functions |
| |
| def test_compress(self): |
| for data in [data1, data2]: |
| for args in [(), (1,), (6,), (9,)]: |
| datac = gzip.compress(data, *args) |
| self.assertEqual(type(datac), bytes) |
| with gzip.GzipFile(fileobj=io.BytesIO(datac), mode="rb") as f: |
| self.assertEqual(f.read(), data) |
| |
| def test_decompress(self): |
| for data in (data1, data2): |
| buf = io.BytesIO() |
| with gzip.GzipFile(fileobj=buf, mode="wb") as f: |
| f.write(data) |
| self.assertEqual(gzip.decompress(buf.getvalue()), data) |
| # Roundtrip with compress |
| datac = gzip.compress(data) |
| self.assertEqual(gzip.decompress(datac), data) |
| |
| def test_read_truncated(self): |
| data = data1 * 50 |
| # Drop the CRC (4 bytes) and file size (4 bytes). |
| truncated = gzip.compress(data)[:-8] |
| with gzip.GzipFile(fileobj=io.BytesIO(truncated)) as f: |
| self.assertRaises(EOFError, f.read) |
| with gzip.GzipFile(fileobj=io.BytesIO(truncated)) as f: |
| self.assertEqual(f.read(len(data)), data) |
| self.assertRaises(EOFError, f.read, 1) |
| # Incomplete 10-byte header. |
| for i in range(2, 10): |
| with gzip.GzipFile(fileobj=io.BytesIO(truncated[:i])) as f: |
| self.assertRaises(EOFError, f.read, 1) |
| |
| def test_read_with_extra(self): |
| # Gzip data with an extra field |
| gzdata = (b'\x1f\x8b\x08\x04\xb2\x17cQ\x02\xff' |
| b'\x05\x00Extra' |
| b'\x0bI-.\x01\x002\xd1Mx\x04\x00\x00\x00') |
| with gzip.GzipFile(fileobj=io.BytesIO(gzdata)) as f: |
| self.assertEqual(f.read(), b'Test') |
| |
| def test_prepend_error(self): |
| # See issue #20875 |
| with gzip.open(self.filename, "wb") as f: |
| f.write(data1) |
| with gzip.open(self.filename, "rb") as f: |
| f.fileobj.prepend() |
| |
| |
| class TestOpen(BaseTest): |
| def test_binary_modes(self): |
| uncompressed = data1 * 50 |
| |
| with gzip.open(self.filename, "wb") as f: |
| f.write(uncompressed) |
| with open(self.filename, "rb") as f: |
| file_data = gzip.decompress(f.read()) |
| self.assertEqual(file_data, uncompressed) |
| |
| with gzip.open(self.filename, "rb") as f: |
| self.assertEqual(f.read(), uncompressed) |
| |
| with gzip.open(self.filename, "ab") as f: |
| f.write(uncompressed) |
| with open(self.filename, "rb") as f: |
| file_data = gzip.decompress(f.read()) |
| self.assertEqual(file_data, uncompressed * 2) |
| |
| def test_implicit_binary_modes(self): |
| # Test implicit binary modes (no "b" or "t" in mode string). |
| uncompressed = data1 * 50 |
| |
| with gzip.open(self.filename, "w") as f: |
| f.write(uncompressed) |
| with open(self.filename, "rb") as f: |
| file_data = gzip.decompress(f.read()) |
| self.assertEqual(file_data, uncompressed) |
| |
| with gzip.open(self.filename, "r") as f: |
| self.assertEqual(f.read(), uncompressed) |
| |
| with gzip.open(self.filename, "a") as f: |
| f.write(uncompressed) |
| with open(self.filename, "rb") as f: |
| file_data = gzip.decompress(f.read()) |
| self.assertEqual(file_data, uncompressed * 2) |
