Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1 | # -*- coding: iso-8859-15 -*- |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 2 | |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 3 | import sys |
| 4 | import os |
| 5 | import shutil |
Georg Brandl | 38c6a22 | 2006-05-10 16:26:03 +0000 | [diff] [blame] | 6 | import StringIO |
Brett Cannon | 7eec217 | 2007-05-30 22:24:28 +0000 | [diff] [blame] | 7 | from hashlib import md5 |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 8 | import errno |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 9 | |
| 10 | import unittest |
| 11 | import tarfile |
| 12 | |
| 13 | from test import test_support |
| 14 | |
| 15 | # Check for our compression modules. |
| 16 | try: |
| 17 | import gzip |
Neal Norwitz | ae32319 | 2003-04-14 01:18:32 +0000 | [diff] [blame] | 18 | gzip.GzipFile |
| 19 | except (ImportError, AttributeError): |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 20 | gzip = None |
| 21 | try: |
| 22 | import bz2 |
| 23 | except ImportError: |
| 24 | bz2 = None |
| 25 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 26 | def md5sum(data): |
Brett Cannon | 7eec217 | 2007-05-30 22:24:28 +0000 | [diff] [blame] | 27 | return md5(data).hexdigest() |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 28 | |
Antoine Pitrou | 310c9fe | 2009-11-11 20:55:07 +0000 | [diff] [blame] | 29 | TEMPDIR = os.path.abspath(test_support.TESTFN) |
| 30 | tarname = test_support.findfile("testtar.tar") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 31 | gzipname = os.path.join(TEMPDIR, "testtar.tar.gz") |
| 32 | bz2name = os.path.join(TEMPDIR, "testtar.tar.bz2") |
| 33 | tmpname = os.path.join(TEMPDIR, "tmp.tar") |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 34 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 35 | md5_regtype = "65f477c818ad9e15f7feab0c6d37742f" |
| 36 | md5_sparse = "a54fbc4ca4f4399a90e1b27164012fc6" |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 37 | |
| 38 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 39 | class ReadTest(unittest.TestCase): |
| 40 | |
| 41 | tarname = tarname |
| 42 | mode = "r:" |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 43 | |
| 44 | def setUp(self): |
Lars Gustäbel | a36cde4 | 2007-03-13 15:47:07 +0000 | [diff] [blame] | 45 | self.tar = tarfile.open(self.tarname, mode=self.mode, encoding="iso8859-1") |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 46 | |
| 47 | def tearDown(self): |
| 48 | self.tar.close() |
| 49 | |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 50 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 51 | class UstarReadTest(ReadTest): |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 52 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 53 | def test_fileobj_regular_file(self): |
| 54 | tarinfo = self.tar.getmember("ustar/regtype") |
| 55 | fobj = self.tar.extractfile(tarinfo) |
| 56 | data = fobj.read() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 57 | self.assertTrue((len(data), md5sum(data)) == (tarinfo.size, md5_regtype), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 58 | "regular file extraction failed") |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 59 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 60 | def test_fileobj_readlines(self): |
| 61 | self.tar.extract("ustar/regtype", TEMPDIR) |
| 62 | tarinfo = self.tar.getmember("ustar/regtype") |
| 63 | fobj1 = open(os.path.join(TEMPDIR, "ustar/regtype"), "rU") |
| 64 | fobj2 = self.tar.extractfile(tarinfo) |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 65 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 66 | lines1 = fobj1.readlines() |
| 67 | lines2 = fobj2.readlines() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 68 | self.assertTrue(lines1 == lines2, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 69 | "fileobj.readlines() failed") |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 70 | self.assertTrue(len(lines2) == 114, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 71 | "fileobj.readlines() failed") |
Florent Xicluna | fc5f6a7 | 2010-03-20 22:26:42 +0000 | [diff] [blame] | 72 | self.assertTrue(lines2[83] == |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 73 | "I will gladly admit that Python is not the fastest running scripting language.\n", |
| 74 | "fileobj.readlines() failed") |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 75 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 76 | def test_fileobj_iter(self): |
| 77 | self.tar.extract("ustar/regtype", TEMPDIR) |
| 78 | tarinfo = self.tar.getmember("ustar/regtype") |
| 79 | fobj1 = open(os.path.join(TEMPDIR, "ustar/regtype"), "rU") |
| 80 | fobj2 = self.tar.extractfile(tarinfo) |
| 81 | lines1 = fobj1.readlines() |
| 82 | lines2 = [line for line in fobj2] |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 83 | self.assertTrue(lines1 == lines2, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 84 | "fileobj.__iter__() failed") |
Martin v. Löwis | df24153 | 2005-03-03 08:17:42 +0000 | [diff] [blame] | 85 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 86 | def test_fileobj_seek(self): |
| 87 | self.tar.extract("ustar/regtype", TEMPDIR) |
| 88 | fobj = open(os.path.join(TEMPDIR, "ustar/regtype"), "rb") |
| 89 | data = fobj.read() |
Neal Norwitz | f339654 | 2005-10-28 05:52:22 +0000 | [diff] [blame] | 90 | fobj.close() |
| 91 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 92 | tarinfo = self.tar.getmember("ustar/regtype") |
| 93 | fobj = self.tar.extractfile(tarinfo) |
| 94 | |
| 95 | text = fobj.read() |
| 96 | fobj.seek(0) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 97 | self.assertTrue(0 == fobj.tell(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 98 | "seek() to file's start failed") |
| 99 | fobj.seek(2048, 0) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 100 | self.assertTrue(2048 == fobj.tell(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 101 | "seek() to absolute position failed") |
| 102 | fobj.seek(-1024, 1) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 103 | self.assertTrue(1024 == fobj.tell(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 104 | "seek() to negative relative position failed") |
| 105 | fobj.seek(1024, 1) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 106 | self.assertTrue(2048 == fobj.tell(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 107 | "seek() to positive relative position failed") |
| 108 | s = fobj.read(10) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 109 | self.assertTrue(s == data[2048:2058], |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 110 | "read() after seek failed") |
| 111 | fobj.seek(0, 2) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 112 | self.assertTrue(tarinfo.size == fobj.tell(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 113 | "seek() to file's end failed") |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 114 | self.assertTrue(fobj.read() == "", |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 115 | "read() at file's end did not return empty string") |
| 116 | fobj.seek(-tarinfo.size, 2) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 117 | self.assertTrue(0 == fobj.tell(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 118 | "relative seek() to file's start failed") |
| 119 | fobj.seek(512) |
| 120 | s1 = fobj.readlines() |
| 121 | fobj.seek(512) |
| 122 | s2 = fobj.readlines() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 123 | self.assertTrue(s1 == s2, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 124 | "readlines() after seek failed") |
| 125 | fobj.seek(0) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 126 | self.assertTrue(len(fobj.readline()) == fobj.tell(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 127 | "tell() after readline() failed") |
| 128 | fobj.seek(512) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 129 | self.assertTrue(len(fobj.readline()) + 512 == fobj.tell(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 130 | "tell() after seek() and readline() failed") |
| 131 | fobj.seek(0) |
| 132 | line = fobj.readline() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 133 | self.assertTrue(fobj.read() == data[len(line):], |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 134 | "read() after readline() failed") |
| 135 | fobj.close() |
| 136 | |
| 137 | |
Lars Gustäbel | dd866d5 | 2009-11-22 18:30:53 +0000 | [diff] [blame] | 138 | class CommonReadTest(ReadTest): |
| 139 | |
| 140 | def test_empty_tarfile(self): |
| 141 | # Test for issue6123: Allow opening empty archives. |
| 142 | # This test checks if tarfile.open() is able to open an empty tar |
| 143 | # archive successfully. Note that an empty tar archive is not the |
| 144 | # same as an empty file! |
| 145 | tarfile.open(tmpname, self.mode.replace("r", "w")).close() |
| 146 | try: |
| 147 | tar = tarfile.open(tmpname, self.mode) |
| 148 | tar.getnames() |
| 149 | except tarfile.ReadError: |
| 150 | self.fail("tarfile.open() failed on empty archive") |
| 151 | self.assertListEqual(tar.getmembers(), []) |
| 152 | |
| 153 | def test_null_tarfile(self): |
| 154 | # Test for issue6123: Allow opening empty archives. |
| 155 | # This test guarantees that tarfile.open() does not treat an empty |
| 156 | # file as an empty tar archive. |
| 157 | open(tmpname, "wb").close() |
| 158 | self.assertRaises(tarfile.ReadError, tarfile.open, tmpname, self.mode) |
| 159 | self.assertRaises(tarfile.ReadError, tarfile.open, tmpname) |
| 160 | |
| 161 | def test_ignore_zeros(self): |
| 162 | # Test TarFile's ignore_zeros option. |
| 163 | if self.mode.endswith(":gz"): |
| 164 | _open = gzip.GzipFile |
| 165 | elif self.mode.endswith(":bz2"): |
| 166 | _open = bz2.BZ2File |
| 167 | else: |
| 168 | _open = open |
| 169 | |
| 170 | for char in ('\0', 'a'): |
| 171 | # Test if EOFHeaderError ('\0') and InvalidHeaderError ('a') |
| 172 | # are ignored correctly. |
| 173 | fobj = _open(tmpname, "wb") |
| 174 | fobj.write(char * 1024) |
| 175 | fobj.write(tarfile.TarInfo("foo").tobuf()) |
| 176 | fobj.close() |
| 177 | |
| 178 | tar = tarfile.open(tmpname, mode="r", ignore_zeros=True) |
| 179 | self.assertListEqual(tar.getnames(), ["foo"], |
| 180 | "ignore_zeros=True should have skipped the %r-blocks" % char) |
| 181 | tar.close() |
| 182 | |
| 183 | |
| 184 | class MiscReadTest(CommonReadTest): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 185 | |
Lars Gustäbel | 0f4a14b | 2007-08-28 12:31:09 +0000 | [diff] [blame] | 186 | def test_no_name_argument(self): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 187 | fobj = open(self.tarname, "rb") |
| 188 | tar = tarfile.open(fileobj=fobj, mode=self.mode) |
| 189 | self.assertEqual(tar.name, os.path.abspath(fobj.name)) |
| 190 | |
Lars Gustäbel | 0f4a14b | 2007-08-28 12:31:09 +0000 | [diff] [blame] | 191 | def test_no_name_attribute(self): |
| 192 | data = open(self.tarname, "rb").read() |
| 193 | fobj = StringIO.StringIO(data) |
| 194 | self.assertRaises(AttributeError, getattr, fobj, "name") |
| 195 | tar = tarfile.open(fileobj=fobj, mode=self.mode) |
| 196 | self.assertEqual(tar.name, None) |
| 197 | |
| 198 | def test_empty_name_attribute(self): |
| 199 | data = open(self.tarname, "rb").read() |
| 200 | fobj = StringIO.StringIO(data) |
| 201 | fobj.name = "" |
| 202 | tar = tarfile.open(fileobj=fobj, mode=self.mode) |
| 203 | self.assertEqual(tar.name, None) |
| 204 | |
Lars Gustäbel | 77b2d63 | 2007-12-01 21:02:12 +0000 | [diff] [blame] | 205 | def test_fileobj_with_offset(self): |
| 206 | # Skip the first member and store values from the second member |
| 207 | # of the testtar. |
| 208 | tar = tarfile.open(self.tarname, mode=self.mode) |
| 209 | tar.next() |
| 210 | t = tar.next() |
| 211 | name = t.name |
| 212 | offset = t.offset |
| 213 | data = tar.extractfile(t).read() |
| 214 | tar.close() |
| 215 | |
| 216 | # Open the testtar and seek to the offset of the second member. |
| 217 | if self.mode.endswith(":gz"): |
| 218 | _open = gzip.GzipFile |
| 219 | elif self.mode.endswith(":bz2"): |
| 220 | _open = bz2.BZ2File |
| 221 | else: |
| 222 | _open = open |
| 223 | fobj = _open(self.tarname, "rb") |
| 224 | fobj.seek(offset) |
| 225 | |
| 226 | # Test if the tarfile starts with the second member. |
| 227 | tar = tar.open(self.tarname, mode="r:", fileobj=fobj) |
| 228 | t = tar.next() |
| 229 | self.assertEqual(t.name, name) |
| 230 | # Read to the end of fileobj and test if seeking back to the |
| 231 | # beginning works. |
| 232 | tar.getmembers() |
| 233 | self.assertEqual(tar.extractfile(t).read(), data, |
| 234 | "seek back did not work") |
| 235 | tar.close() |
| 236 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 237 | def test_fail_comp(self): |
| 238 | # For Gzip and Bz2 Tests: fail with a ReadError on an uncompressed file. |
| 239 | if self.mode == "r:": |
| 240 | return |
| 241 | self.assertRaises(tarfile.ReadError, tarfile.open, tarname, self.mode) |
| 242 | fobj = open(tarname, "rb") |
| 243 | self.assertRaises(tarfile.ReadError, tarfile.open, fileobj=fobj, mode=self.mode) |
| 244 | |
| 245 | def test_v7_dirtype(self): |
| 246 | # Test old style dirtype member (bug #1336623): |
| 247 | # Old V7 tars create directory members using an AREGTYPE |
| 248 | # header with a "/" appended to the filename field. |
| 249 | tarinfo = self.tar.getmember("misc/dirtype-old-v7") |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 250 | self.assertTrue(tarinfo.type == tarfile.DIRTYPE, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 251 | "v7 dirtype failed") |
| 252 | |
Lars Gustäbel | 6bf51da | 2008-02-11 19:17:10 +0000 | [diff] [blame] | 253 | def test_xstar_type(self): |
| 254 | # The xstar format stores extra atime and ctime fields inside the |
| 255 | # space reserved for the prefix field. The prefix field must be |
| 256 | # ignored in this case, otherwise it will mess up the name. |
| 257 | try: |
| 258 | self.tar.getmember("misc/regtype-xstar") |
| 259 | except KeyError: |
| 260 | self.fail("failed to find misc/regtype-xstar (mangled prefix?)") |
| 261 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 262 | def test_check_members(self): |
| 263 | for tarinfo in self.tar: |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 264 | self.assertTrue(int(tarinfo.mtime) == 07606136617, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 265 | "wrong mtime for %s" % tarinfo.name) |
| 266 | if not tarinfo.name.startswith("ustar/"): |
| 267 | continue |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 268 | self.assertTrue(tarinfo.uname == "tarfile", |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 269 | "wrong uname for %s" % tarinfo.name) |
| 270 | |
| 271 | def test_find_members(self): |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 272 | self.assertTrue(self.tar.getmembers()[-1].name == "misc/eof", |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 273 | "could not find all members") |
| 274 | |
| 275 | def test_extract_hardlink(self): |
| 276 | # Test hardlink extraction (e.g. bug #857297). |
Lars Gustäbel | a36cde4 | 2007-03-13 15:47:07 +0000 | [diff] [blame] | 277 | tar = tarfile.open(tarname, errorlevel=1, encoding="iso8859-1") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 278 | |
| 279 | tar.extract("ustar/regtype", TEMPDIR) |
Neal Norwitz | f339654 | 2005-10-28 05:52:22 +0000 | [diff] [blame] | 280 | try: |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 281 | tar.extract("ustar/lnktype", TEMPDIR) |
| 282 | except EnvironmentError, e: |
| 283 | if e.errno == errno.ENOENT: |
| 284 | self.fail("hardlink not extracted properly") |
Neal Norwitz | f339654 | 2005-10-28 05:52:22 +0000 | [diff] [blame] | 285 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 286 | data = open(os.path.join(TEMPDIR, "ustar/lnktype"), "rb").read() |
| 287 | self.assertEqual(md5sum(data), md5_regtype) |
Neal Norwitz | f339654 | 2005-10-28 05:52:22 +0000 | [diff] [blame] | 288 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 289 | try: |
| 290 | tar.extract("ustar/symtype", TEMPDIR) |
| 291 | except EnvironmentError, e: |
| 292 | if e.errno == errno.ENOENT: |
| 293 | self.fail("symlink not extracted properly") |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 294 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 295 | data = open(os.path.join(TEMPDIR, "ustar/symtype"), "rb").read() |
| 296 | self.assertEqual(md5sum(data), md5_regtype) |
| 297 | |
Lars Gustäbel | 2ee1c76 | 2008-01-04 14:00:33 +0000 | [diff] [blame] | 298 | def test_extractall(self): |
| 299 | # Test if extractall() correctly restores directory permissions |
| 300 | # and times (see issue1735). |
Lars Gustäbel | 2ee1c76 | 2008-01-04 14:00:33 +0000 | [diff] [blame] | 301 | tar = tarfile.open(tarname, encoding="iso8859-1") |
| 302 | directories = [t for t in tar if t.isdir()] |
| 303 | tar.extractall(TEMPDIR, directories) |
| 304 | for tarinfo in directories: |
| 305 | path = os.path.join(TEMPDIR, tarinfo.name) |
Lars Gustäbel | 3b02742 | 2008-12-12 13:58:03 +0000 | [diff] [blame] | 306 | if sys.platform != "win32": |
| 307 | # Win32 has no support for fine grained permissions. |
| 308 | self.assertEqual(tarinfo.mode & 0777, os.stat(path).st_mode & 0777) |
Lars Gustäbel | 2ee1c76 | 2008-01-04 14:00:33 +0000 | [diff] [blame] | 309 | self.assertEqual(tarinfo.mtime, os.path.getmtime(path)) |
| 310 | tar.close() |
| 311 | |
Lars Gustäbel | 12adc65 | 2009-11-23 15:46:19 +0000 | [diff] [blame] | 312 | def test_init_close_fobj(self): |
| 313 | # Issue #7341: Close the internal file object in the TarFile |
| 314 | # constructor in case of an error. For the test we rely on |
| 315 | # the fact that opening an empty file raises a ReadError. |
| 316 | empty = os.path.join(TEMPDIR, "empty") |
| 317 | open(empty, "wb").write("") |
| 318 | |
| 319 | try: |
| 320 | tar = object.__new__(tarfile.TarFile) |
| 321 | try: |
| 322 | tar.__init__(empty) |
| 323 | except tarfile.ReadError: |
| 324 | self.assertTrue(tar.fileobj.closed) |
| 325 | else: |
| 326 | self.fail("ReadError not raised") |
| 327 | finally: |
| 328 | os.remove(empty) |
| 329 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 330 | |
Lars Gustäbel | dd866d5 | 2009-11-22 18:30:53 +0000 | [diff] [blame] | 331 | class StreamReadTest(CommonReadTest): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 332 | |
| 333 | mode="r|" |
| 334 | |
| 335 | def test_fileobj_regular_file(self): |
| 336 | tarinfo = self.tar.next() # get "regtype" (can't use getmember) |
| 337 | fobj = self.tar.extractfile(tarinfo) |
| 338 | data = fobj.read() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 339 | self.assertTrue((len(data), md5sum(data)) == (tarinfo.size, md5_regtype), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 340 | "regular file extraction failed") |
| 341 | |
| 342 | def test_provoke_stream_error(self): |
| 343 | tarinfos = self.tar.getmembers() |
| 344 | f = self.tar.extractfile(tarinfos[0]) # read the first member |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 345 | self.assertRaises(tarfile.StreamError, f.read) |
| 346 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 347 | def test_compare_members(self): |
Lars Gustäbel | a36cde4 | 2007-03-13 15:47:07 +0000 | [diff] [blame] | 348 | tar1 = tarfile.open(tarname, encoding="iso8859-1") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 349 | tar2 = self.tar |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 350 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 351 | while True: |
| 352 | t1 = tar1.next() |
| 353 | t2 = tar2.next() |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 354 | if t1 is None: |
| 355 | break |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 356 | self.assertTrue(t2 is not None, "stream.next() failed.") |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 357 | |
| 358 | if t2.islnk() or t2.issym(): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 359 | self.assertRaises(tarfile.StreamError, tar2.extractfile, t2) |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 360 | continue |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 361 | |
| 362 | v1 = tar1.extractfile(t1) |
| 363 | v2 = tar2.extractfile(t2) |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 364 | if v1 is None: |
| 365 | continue |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 366 | self.assertTrue(v2 is not None, "stream.extractfile() failed") |
| 367 | self.assertTrue(v1.read() == v2.read(), "stream extraction failed") |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 368 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 369 | tar1.close() |
Lars Gustäbel | a4b2381 | 2006-12-23 17:57:23 +0000 | [diff] [blame] | 370 | |
Georg Brandl | a32e0a0 | 2006-10-24 16:54:16 +0000 | [diff] [blame] | 371 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 372 | class DetectReadTest(unittest.TestCase): |
Lars Gustäbel | 3f8aca1 | 2007-02-06 18:38:13 +0000 | [diff] [blame] | 373 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 374 | def _testfunc_file(self, name, mode): |
| 375 | try: |
| 376 | tarfile.open(name, mode) |
| 377 | except tarfile.ReadError: |
| 378 | self.fail() |
Lars Gustäbel | 3f8aca1 | 2007-02-06 18:38:13 +0000 | [diff] [blame] | 379 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 380 | def _testfunc_fileobj(self, name, mode): |
| 381 | try: |
| 382 | tarfile.open(name, mode, fileobj=open(name, "rb")) |
| 383 | except tarfile.ReadError: |
| 384 | self.fail() |
| 385 | |
| 386 | def _test_modes(self, testfunc): |
| 387 | testfunc(tarname, "r") |
| 388 | testfunc(tarname, "r:") |
| 389 | testfunc(tarname, "r:*") |
| 390 | testfunc(tarname, "r|") |
| 391 | testfunc(tarname, "r|*") |
| 392 | |
| 393 | if gzip: |
| 394 | self.assertRaises(tarfile.ReadError, tarfile.open, tarname, mode="r:gz") |
| 395 | self.assertRaises(tarfile.ReadError, tarfile.open, tarname, mode="r|gz") |
| 396 | self.assertRaises(tarfile.ReadError, tarfile.open, gzipname, mode="r:") |
| 397 | self.assertRaises(tarfile.ReadError, tarfile.open, gzipname, mode="r|") |
| 398 | |
| 399 | testfunc(gzipname, "r") |
| 400 | testfunc(gzipname, "r:*") |
| 401 | testfunc(gzipname, "r:gz") |
| 402 | testfunc(gzipname, "r|*") |
| 403 | testfunc(gzipname, "r|gz") |
| 404 | |
| 405 | if bz2: |
| 406 | self.assertRaises(tarfile.ReadError, tarfile.open, tarname, mode="r:bz2") |
| 407 | self.assertRaises(tarfile.ReadError, tarfile.open, tarname, mode="r|bz2") |
| 408 | self.assertRaises(tarfile.ReadError, tarfile.open, bz2name, mode="r:") |
| 409 | self.assertRaises(tarfile.ReadError, tarfile.open, bz2name, mode="r|") |
| 410 | |
| 411 | testfunc(bz2name, "r") |
| 412 | testfunc(bz2name, "r:*") |
| 413 | testfunc(bz2name, "r:bz2") |
| 414 | testfunc(bz2name, "r|*") |
| 415 | testfunc(bz2name, "r|bz2") |
| 416 | |
| 417 | def test_detect_file(self): |
| 418 | self._test_modes(self._testfunc_file) |
| 419 | |
| 420 | def test_detect_fileobj(self): |
| 421 | self._test_modes(self._testfunc_fileobj) |
| 422 | |
| 423 | |
| 424 | class MemberReadTest(ReadTest): |
| 425 | |
| 426 | def _test_member(self, tarinfo, chksum=None, **kwargs): |
| 427 | if chksum is not None: |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 428 | self.assertTrue(md5sum(self.tar.extractfile(tarinfo).read()) == chksum, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 429 | "wrong md5sum for %s" % tarinfo.name) |
| 430 | |
| 431 | kwargs["mtime"] = 07606136617 |
| 432 | kwargs["uid"] = 1000 |
| 433 | kwargs["gid"] = 100 |
| 434 | if "old-v7" not in tarinfo.name: |
| 435 | # V7 tar can't handle alphabetic owners. |
| 436 | kwargs["uname"] = "tarfile" |
| 437 | kwargs["gname"] = "tarfile" |
| 438 | for k, v in kwargs.iteritems(): |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 439 | self.assertTrue(getattr(tarinfo, k) == v, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 440 | "wrong value in %s field of %s" % (k, tarinfo.name)) |
| 441 | |
| 442 | def test_find_regtype(self): |
| 443 | tarinfo = self.tar.getmember("ustar/regtype") |
| 444 | self._test_member(tarinfo, size=7011, chksum=md5_regtype) |
| 445 | |
| 446 | def test_find_conttype(self): |
| 447 | tarinfo = self.tar.getmember("ustar/conttype") |
| 448 | self._test_member(tarinfo, size=7011, chksum=md5_regtype) |
| 449 | |
| 450 | def test_find_dirtype(self): |
| 451 | tarinfo = self.tar.getmember("ustar/dirtype") |
| 452 | self._test_member(tarinfo, size=0) |
| 453 | |
| 454 | def test_find_dirtype_with_size(self): |
| 455 | tarinfo = self.tar.getmember("ustar/dirtype-with-size") |
| 456 | self._test_member(tarinfo, size=255) |
| 457 | |
| 458 | def test_find_lnktype(self): |
| 459 | tarinfo = self.tar.getmember("ustar/lnktype") |
| 460 | self._test_member(tarinfo, size=0, linkname="ustar/regtype") |
| 461 | |
| 462 | def test_find_symtype(self): |
| 463 | tarinfo = self.tar.getmember("ustar/symtype") |
| 464 | self._test_member(tarinfo, size=0, linkname="regtype") |
| 465 | |
| 466 | def test_find_blktype(self): |
| 467 | tarinfo = self.tar.getmember("ustar/blktype") |
| 468 | self._test_member(tarinfo, size=0, devmajor=3, devminor=0) |
| 469 | |
| 470 | def test_find_chrtype(self): |
| 471 | tarinfo = self.tar.getmember("ustar/chrtype") |
| 472 | self._test_member(tarinfo, size=0, devmajor=1, devminor=3) |
| 473 | |
| 474 | def test_find_fifotype(self): |
| 475 | tarinfo = self.tar.getmember("ustar/fifotype") |
| 476 | self._test_member(tarinfo, size=0) |
| 477 | |
| 478 | def test_find_sparse(self): |
| 479 | tarinfo = self.tar.getmember("ustar/sparse") |
| 480 | self._test_member(tarinfo, size=86016, chksum=md5_sparse) |
| 481 | |
| 482 | def test_find_umlauts(self): |
| 483 | tarinfo = self.tar.getmember("ustar/umlauts-ÄÖÜäöüß") |
| 484 | self._test_member(tarinfo, size=7011, chksum=md5_regtype) |
| 485 | |
| 486 | def test_find_ustar_longname(self): |
| 487 | name = "ustar/" + "12345/" * 39 + "1234567/longname" |
Ezio Melotti | aa98058 | 2010-01-23 23:04:36 +0000 | [diff] [blame] | 488 | self.assertIn(name, self.tar.getnames()) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 489 | |
| 490 | def test_find_regtype_oldv7(self): |
| 491 | tarinfo = self.tar.getmember("misc/regtype-old-v7") |
| 492 | self._test_member(tarinfo, size=7011, chksum=md5_regtype) |
| 493 | |
| 494 | def test_find_pax_umlauts(self): |
Lars Gustäbel | a36cde4 | 2007-03-13 15:47:07 +0000 | [diff] [blame] | 495 | self.tar = tarfile.open(self.tarname, mode=self.mode, encoding="iso8859-1") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 496 | tarinfo = self.tar.getmember("pax/umlauts-ÄÖÜäöüß") |
| 497 | self._test_member(tarinfo, size=7011, chksum=md5_regtype) |
| 498 | |
| 499 | |
| 500 | class LongnameTest(ReadTest): |
| 501 | |
| 502 | def test_read_longname(self): |
| 503 | # Test reading of longname (bug #1471427). |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 504 | longname = self.subdir + "/" + "123/" * 125 + "longname" |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 505 | try: |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 506 | tarinfo = self.tar.getmember(longname) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 507 | except KeyError: |
| 508 | self.fail("longname not found") |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 509 | self.assertTrue(tarinfo.type != tarfile.DIRTYPE, "read longname as dirtype") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 510 | |
| 511 | def test_read_longlink(self): |
| 512 | longname = self.subdir + "/" + "123/" * 125 + "longname" |
| 513 | longlink = self.subdir + "/" + "123/" * 125 + "longlink" |
| 514 | try: |
| 515 | tarinfo = self.tar.getmember(longlink) |
| 516 | except KeyError: |
| 517 | self.fail("longlink not found") |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 518 | self.assertTrue(tarinfo.linkname == longname, "linkname wrong") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 519 | |
| 520 | def test_truncated_longname(self): |
| 521 | longname = self.subdir + "/" + "123/" * 125 + "longname" |
| 522 | tarinfo = self.tar.getmember(longname) |
| 523 | offset = tarinfo.offset |
| 524 | self.tar.fileobj.seek(offset) |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 525 | fobj = StringIO.StringIO(self.tar.fileobj.read(3 * 512)) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 526 | self.assertRaises(tarfile.ReadError, tarfile.open, name="foo.tar", fileobj=fobj) |
| 527 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 528 | def test_header_offset(self): |
| 529 | # Test if the start offset of the TarInfo object includes |
| 530 | # the preceding extended header. |
| 531 | longname = self.subdir + "/" + "123/" * 125 + "longname" |
| 532 | offset = self.tar.getmember(longname).offset |
| 533 | fobj = open(tarname) |
| 534 | fobj.seek(offset) |
| 535 | tarinfo = tarfile.TarInfo.frombuf(fobj.read(512)) |
| 536 | self.assertEqual(tarinfo.type, self.longnametype) |
| 537 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 538 | |
| 539 | class GNUReadTest(LongnameTest): |
| 540 | |
| 541 | subdir = "gnu" |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 542 | longnametype = tarfile.GNUTYPE_LONGNAME |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 543 | |
| 544 | def test_sparse_file(self): |
| 545 | tarinfo1 = self.tar.getmember("ustar/sparse") |
| 546 | fobj1 = self.tar.extractfile(tarinfo1) |
| 547 | tarinfo2 = self.tar.getmember("gnu/sparse") |
| 548 | fobj2 = self.tar.extractfile(tarinfo2) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 549 | self.assertTrue(fobj1.read() == fobj2.read(), |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 550 | "sparse file extraction failed") |
| 551 | |
| 552 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 553 | class PaxReadTest(LongnameTest): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 554 | |
| 555 | subdir = "pax" |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 556 | longnametype = tarfile.XHDTYPE |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 557 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 558 | def test_pax_global_headers(self): |
Lars Gustäbel | a36cde4 | 2007-03-13 15:47:07 +0000 | [diff] [blame] | 559 | tar = tarfile.open(tarname, encoding="iso8859-1") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 560 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 561 | tarinfo = tar.getmember("pax/regtype1") |
| 562 | self.assertEqual(tarinfo.uname, "foo") |
| 563 | self.assertEqual(tarinfo.gname, "bar") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 564 | self.assertEqual(tarinfo.pax_headers.get("VENDOR.umlauts"), u"ÄÖÜäöüß") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 565 | |
| 566 | tarinfo = tar.getmember("pax/regtype2") |
| 567 | self.assertEqual(tarinfo.uname, "") |
| 568 | self.assertEqual(tarinfo.gname, "bar") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 569 | self.assertEqual(tarinfo.pax_headers.get("VENDOR.umlauts"), u"ÄÖÜäöüß") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 570 | |
| 571 | tarinfo = tar.getmember("pax/regtype3") |
| 572 | self.assertEqual(tarinfo.uname, "tarfile") |
| 573 | self.assertEqual(tarinfo.gname, "tarfile") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 574 | self.assertEqual(tarinfo.pax_headers.get("VENDOR.umlauts"), u"ÄÖÜäöüß") |
| 575 | |
| 576 | def test_pax_number_fields(self): |
| 577 | # All following number fields are read from the pax header. |
| 578 | tar = tarfile.open(tarname, encoding="iso8859-1") |
| 579 | tarinfo = tar.getmember("pax/regtype4") |
| 580 | self.assertEqual(tarinfo.size, 7011) |
| 581 | self.assertEqual(tarinfo.uid, 123) |
| 582 | self.assertEqual(tarinfo.gid, 123) |
| 583 | self.assertEqual(tarinfo.mtime, 1041808783.0) |
| 584 | self.assertEqual(type(tarinfo.mtime), float) |
| 585 | self.assertEqual(float(tarinfo.pax_headers["atime"]), 1041808783.0) |
| 586 | self.assertEqual(float(tarinfo.pax_headers["ctime"]), 1041808783.0) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 587 | |
| 588 | |
Lars Gustäbel | b1a54a3 | 2008-05-27 12:39:23 +0000 | [diff] [blame] | 589 | class WriteTestBase(unittest.TestCase): |
| 590 | # Put all write tests in here that are supposed to be tested |
| 591 | # in all possible mode combinations. |
| 592 | |
| 593 | def test_fileobj_no_close(self): |
| 594 | fobj = StringIO.StringIO() |
| 595 | tar = tarfile.open(fileobj=fobj, mode=self.mode) |
| 596 | tar.addfile(tarfile.TarInfo("foo")) |
| 597 | tar.close() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 598 | self.assertTrue(fobj.closed is False, "external fileobjs must never closed") |
Lars Gustäbel | b1a54a3 | 2008-05-27 12:39:23 +0000 | [diff] [blame] | 599 | |
| 600 | |
| 601 | class WriteTest(WriteTestBase): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 602 | |
| 603 | mode = "w:" |
| 604 | |
| 605 | def test_100_char_name(self): |
| 606 | # The name field in a tar header stores strings of at most 100 chars. |
| 607 | # If a string is shorter than 100 chars it has to be padded with '\0', |
| 608 | # which implies that a string of exactly 100 chars is stored without |
| 609 | # a trailing '\0'. |
| 610 | name = "0123456789" * 10 |
| 611 | tar = tarfile.open(tmpname, self.mode) |
| 612 | t = tarfile.TarInfo(name) |
| 613 | tar.addfile(t) |
Lars Gustäbel | 3f8aca1 | 2007-02-06 18:38:13 +0000 | [diff] [blame] | 614 | tar.close() |
| 615 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 616 | tar = tarfile.open(tmpname) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 617 | self.assertTrue(tar.getnames()[0] == name, |
Georg Brandl | a32e0a0 | 2006-10-24 16:54:16 +0000 | [diff] [blame] | 618 | "failed to store 100 char filename") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 619 | tar.close() |
Georg Brandl | a32e0a0 | 2006-10-24 16:54:16 +0000 | [diff] [blame] | 620 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 621 | def test_tar_size(self): |
| 622 | # Test for bug #1013882. |
| 623 | tar = tarfile.open(tmpname, self.mode) |
| 624 | path = os.path.join(TEMPDIR, "file") |
| 625 | fobj = open(path, "wb") |
| 626 | fobj.write("aaa") |
| 627 | fobj.close() |
| 628 | tar.add(path) |
| 629 | tar.close() |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 630 | self.assertTrue(os.path.getsize(tmpname) > 0, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 631 | "tarfile is empty") |
Georg Brandl | a32e0a0 | 2006-10-24 16:54:16 +0000 | [diff] [blame] | 632 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 633 | # The test_*_size tests test for bug #1167128. |
| 634 | def test_file_size(self): |
| 635 | tar = tarfile.open(tmpname, self.mode) |
Martin v. Löwis | 5dbdc59 | 2005-08-27 10:07:56 +0000 | [diff] [blame] | 636 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 637 | path = os.path.join(TEMPDIR, "file") |
| 638 | fobj = open(path, "wb") |
| 639 | fobj.close() |
| 640 | tarinfo = tar.gettarinfo(path) |
Martin v. Löwis | 5dbdc59 | 2005-08-27 10:07:56 +0000 | [diff] [blame] | 641 | self.assertEqual(tarinfo.size, 0) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 642 | |
| 643 | fobj = open(path, "wb") |
| 644 | fobj.write("aaa") |
| 645 | fobj.close() |
| 646 | tarinfo = tar.gettarinfo(path) |
Martin v. Löwis | 5dbdc59 | 2005-08-27 10:07:56 +0000 | [diff] [blame] | 647 | self.assertEqual(tarinfo.size, 3) |
| 648 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 649 | tar.close() |
| 650 | |
| 651 | def test_directory_size(self): |
| 652 | path = os.path.join(TEMPDIR, "directory") |
Martin v. Löwis | 5dbdc59 | 2005-08-27 10:07:56 +0000 | [diff] [blame] | 653 | os.mkdir(path) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 654 | try: |
| 655 | tar = tarfile.open(tmpname, self.mode) |
| 656 | tarinfo = tar.gettarinfo(path) |
Martin v. Löwis | 5dbdc59 | 2005-08-27 10:07:56 +0000 | [diff] [blame] | 657 | self.assertEqual(tarinfo.size, 0) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 658 | finally: |
| 659 | os.rmdir(path) |
| 660 | |
| 661 | def test_link_size(self): |
| 662 | if hasattr(os, "link"): |
| 663 | link = os.path.join(TEMPDIR, "link") |
| 664 | target = os.path.join(TEMPDIR, "link_target") |
| 665 | open(target, "wb").close() |
| 666 | os.link(target, link) |
| 667 | try: |
| 668 | tar = tarfile.open(tmpname, self.mode) |
| 669 | tarinfo = tar.gettarinfo(link) |
| 670 | self.assertEqual(tarinfo.size, 0) |
| 671 | finally: |
| 672 | os.remove(target) |
| 673 | os.remove(link) |
| 674 | |
| 675 | def test_symlink_size(self): |
| 676 | if hasattr(os, "symlink"): |
| 677 | path = os.path.join(TEMPDIR, "symlink") |
| 678 | os.symlink("link_target", path) |
| 679 | try: |
| 680 | tar = tarfile.open(tmpname, self.mode) |
| 681 | tarinfo = tar.gettarinfo(path) |
| 682 | self.assertEqual(tarinfo.size, 0) |
| 683 | finally: |
| 684 | os.remove(path) |
| 685 | |
| 686 | def test_add_self(self): |
| 687 | # Test for #1257255. |
| 688 | dstname = os.path.abspath(tmpname) |
| 689 | |
| 690 | tar = tarfile.open(tmpname, self.mode) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 691 | self.assertTrue(tar.name == dstname, "archive name must be absolute") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 692 | |
| 693 | tar.add(dstname) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 694 | self.assertTrue(tar.getnames() == [], "added the archive to itself") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 695 | |
| 696 | cwd = os.getcwd() |
| 697 | os.chdir(TEMPDIR) |
| 698 | tar.add(dstname) |
| 699 | os.chdir(cwd) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 700 | self.assertTrue(tar.getnames() == [], "added the archive to itself") |
Martin v. Löwis | 5dbdc59 | 2005-08-27 10:07:56 +0000 | [diff] [blame] | 701 | |
Lars Gustäbel | 104490e | 2007-06-18 11:42:11 +0000 | [diff] [blame] | 702 | def test_exclude(self): |
| 703 | tempdir = os.path.join(TEMPDIR, "exclude") |
| 704 | os.mkdir(tempdir) |
| 705 | try: |
| 706 | for name in ("foo", "bar", "baz"): |
| 707 | name = os.path.join(tempdir, name) |
| 708 | open(name, "wb").close() |
| 709 | |
Florent Xicluna | fc5f6a7 | 2010-03-20 22:26:42 +0000 | [diff] [blame] | 710 | exclude = os.path.isfile |
Lars Gustäbel | 104490e | 2007-06-18 11:42:11 +0000 | [diff] [blame] | 711 | |
| 712 | tar = tarfile.open(tmpname, self.mode, encoding="iso8859-1") |
Florent Xicluna | fc5f6a7 | 2010-03-20 22:26:42 +0000 | [diff] [blame] | 713 | with test_support.check_warnings(("use the filter argument", |
| 714 | DeprecationWarning)): |
| 715 | tar.add(tempdir, arcname="empty_dir", exclude=exclude) |
Lars Gustäbel | 104490e | 2007-06-18 11:42:11 +0000 | [diff] [blame] | 716 | tar.close() |
| 717 | |
| 718 | tar = tarfile.open(tmpname, "r") |
| 719 | self.assertEqual(len(tar.getmembers()), 1) |
| 720 | self.assertEqual(tar.getnames()[0], "empty_dir") |
| 721 | finally: |
| 722 | shutil.rmtree(tempdir) |
| 723 | |
Lars Gustäbel | 21121e6 | 2009-09-12 10:28:15 +0000 | [diff] [blame] | 724 | def test_filter(self): |
| 725 | tempdir = os.path.join(TEMPDIR, "filter") |
| 726 | os.mkdir(tempdir) |
| 727 | try: |
| 728 | for name in ("foo", "bar", "baz"): |
| 729 | name = os.path.join(tempdir, name) |
| 730 | open(name, "wb").close() |
| 731 | |
| 732 | def filter(tarinfo): |
| 733 | if os.path.basename(tarinfo.name) == "bar": |
| 734 | return |
| 735 | tarinfo.uid = 123 |
| 736 | tarinfo.uname = "foo" |
| 737 | return tarinfo |
| 738 | |
| 739 | tar = tarfile.open(tmpname, self.mode, encoding="iso8859-1") |
| 740 | tar.add(tempdir, arcname="empty_dir", filter=filter) |
| 741 | tar.close() |
| 742 | |
| 743 | tar = tarfile.open(tmpname, "r") |
| 744 | for tarinfo in tar: |
| 745 | self.assertEqual(tarinfo.uid, 123) |
| 746 | self.assertEqual(tarinfo.uname, "foo") |
| 747 | self.assertEqual(len(tar.getmembers()), 3) |
| 748 | tar.close() |
| 749 | finally: |
| 750 | shutil.rmtree(tempdir) |
| 751 | |
Lars Gustäbel | f7cda52 | 2009-08-28 19:23:44 +0000 | [diff] [blame] | 752 | # Guarantee that stored pathnames are not modified. Don't |
| 753 | # remove ./ or ../ or double slashes. Still make absolute |
| 754 | # pathnames relative. |
| 755 | # For details see bug #6054. |
| 756 | def _test_pathname(self, path, cmp_path=None, dir=False): |
| 757 | # Create a tarfile with an empty member named path |
| 758 | # and compare the stored name with the original. |
| 759 | foo = os.path.join(TEMPDIR, "foo") |
| 760 | if not dir: |
| 761 | open(foo, "w").close() |
| 762 | else: |
| 763 | os.mkdir(foo) |
| 764 | |
| 765 | tar = tarfile.open(tmpname, self.mode) |
| 766 | tar.add(foo, arcname=path) |
| 767 | tar.close() |
| 768 | |
| 769 | tar = tarfile.open(tmpname, "r") |
| 770 | t = tar.next() |
| 771 | tar.close() |
| 772 | |
| 773 | if not dir: |
| 774 | os.remove(foo) |
| 775 | else: |
| 776 | os.rmdir(foo) |
| 777 | |
| 778 | self.assertEqual(t.name, cmp_path or path.replace(os.sep, "/")) |
| 779 | |
| 780 | def test_pathnames(self): |
| 781 | self._test_pathname("foo") |
| 782 | self._test_pathname(os.path.join("foo", ".", "bar")) |
| 783 | self._test_pathname(os.path.join("foo", "..", "bar")) |
| 784 | self._test_pathname(os.path.join(".", "foo")) |
| 785 | self._test_pathname(os.path.join(".", "foo", ".")) |
| 786 | self._test_pathname(os.path.join(".", "foo", ".", "bar")) |
| 787 | self._test_pathname(os.path.join(".", "foo", "..", "bar")) |
| 788 | self._test_pathname(os.path.join(".", "foo", "..", "bar")) |
| 789 | self._test_pathname(os.path.join("..", "foo")) |
| 790 | self._test_pathname(os.path.join("..", "foo", "..")) |
| 791 | self._test_pathname(os.path.join("..", "foo", ".", "bar")) |
| 792 | self._test_pathname(os.path.join("..", "foo", "..", "bar")) |
| 793 | |
| 794 | self._test_pathname("foo" + os.sep + os.sep + "bar") |
| 795 | self._test_pathname("foo" + os.sep + os.sep, "foo", dir=True) |
| 796 | |
| 797 | def test_abs_pathnames(self): |
| 798 | if sys.platform == "win32": |
| 799 | self._test_pathname("C:\\foo", "foo") |
| 800 | else: |
| 801 | self._test_pathname("/foo", "foo") |
| 802 | self._test_pathname("///foo", "foo") |
| 803 | |
| 804 | def test_cwd(self): |
| 805 | # Test adding the current working directory. |
| 806 | cwd = os.getcwd() |
| 807 | os.chdir(TEMPDIR) |
| 808 | try: |
| 809 | open("foo", "w").close() |
| 810 | |
| 811 | tar = tarfile.open(tmpname, self.mode) |
| 812 | tar.add(".") |
| 813 | tar.close() |
| 814 | |
| 815 | tar = tarfile.open(tmpname, "r") |
| 816 | for t in tar: |
| 817 | self.assert_(t.name == "." or t.name.startswith("./")) |
| 818 | tar.close() |
| 819 | finally: |
| 820 | os.chdir(cwd) |
| 821 | |
Martin v. Löwis | 5dbdc59 | 2005-08-27 10:07:56 +0000 | [diff] [blame] | 822 | |
Lars Gustäbel | b1a54a3 | 2008-05-27 12:39:23 +0000 | [diff] [blame] | 823 | class StreamWriteTest(WriteTestBase): |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 824 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 825 | mode = "w|" |
Neal Norwitz | 8a51939 | 2006-08-21 17:59:46 +0000 | [diff] [blame] | 826 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 827 | def test_stream_padding(self): |
| 828 | # Test for bug #1543303. |
| 829 | tar = tarfile.open(tmpname, self.mode) |
| 830 | tar.close() |
| 831 | |
| 832 | if self.mode.endswith("gz"): |
| 833 | fobj = gzip.GzipFile(tmpname) |
| 834 | data = fobj.read() |
| 835 | fobj.close() |
| 836 | elif self.mode.endswith("bz2"): |
| 837 | dec = bz2.BZ2Decompressor() |
| 838 | data = open(tmpname, "rb").read() |
| 839 | data = dec.decompress(data) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 840 | self.assertTrue(len(dec.unused_data) == 0, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 841 | "found trailing data") |
Neal Norwitz | 8a51939 | 2006-08-21 17:59:46 +0000 | [diff] [blame] | 842 | else: |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 843 | fobj = open(tmpname, "rb") |
| 844 | data = fobj.read() |
| 845 | fobj.close() |
Neal Norwitz | 8a51939 | 2006-08-21 17:59:46 +0000 | [diff] [blame] | 846 | |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 847 | self.assertTrue(data.count("\0") == tarfile.RECORDSIZE, |
Neal Norwitz | 8a51939 | 2006-08-21 17:59:46 +0000 | [diff] [blame] | 848 | "incorrect zero padding") |
| 849 | |
| 850 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 851 | class GNUWriteTest(unittest.TestCase): |
| 852 | # This testcase checks for correct creation of GNU Longname |
| 853 | # and Longlink extended headers (cp. bug #812325). |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 854 | |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 855 | def _length(self, s): |
| 856 | blocks, remainder = divmod(len(s) + 1, 512) |
| 857 | if remainder: |
| 858 | blocks += 1 |
| 859 | return blocks * 512 |
| 860 | |
| 861 | def _calc_size(self, name, link=None): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 862 | # Initial tar header |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 863 | count = 512 |
| 864 | |
| 865 | if len(name) > tarfile.LENGTH_NAME: |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 866 | # GNU longname extended header + longname |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 867 | count += 512 |
| 868 | count += self._length(name) |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 869 | if link is not None and len(link) > tarfile.LENGTH_LINK: |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 870 | # GNU longlink extended header + longlink |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 871 | count += 512 |
| 872 | count += self._length(link) |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 873 | return count |
| 874 | |
| 875 | def _test(self, name, link=None): |
| 876 | tarinfo = tarfile.TarInfo(name) |
| 877 | if link: |
| 878 | tarinfo.linkname = link |
| 879 | tarinfo.type = tarfile.LNKTYPE |
| 880 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 881 | tar = tarfile.open(tmpname, "w") |
| 882 | tar.format = tarfile.GNU_FORMAT |
Georg Brandl | 87fa559 | 2006-12-06 22:21:18 +0000 | [diff] [blame] | 883 | tar.addfile(tarinfo) |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 884 | |
| 885 | v1 = self._calc_size(name, link) |
Georg Brandl | 87fa559 | 2006-12-06 22:21:18 +0000 | [diff] [blame] | 886 | v2 = tar.offset |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 887 | self.assertTrue(v1 == v2, "GNU longname/longlink creation failed") |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 888 | |
Georg Brandl | 87fa559 | 2006-12-06 22:21:18 +0000 | [diff] [blame] | 889 | tar.close() |
| 890 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 891 | tar = tarfile.open(tmpname) |
Georg Brandl | 87fa559 | 2006-12-06 22:21:18 +0000 | [diff] [blame] | 892 | member = tar.next() |
Florent Xicluna | fc5f6a7 | 2010-03-20 22:26:42 +0000 | [diff] [blame] | 893 | self.assertIsNotNone(member, |
| 894 | "unable to read longname member") |
| 895 | self.assertEqual(tarinfo.name, member.name, |
| 896 | "unable to read longname member") |
| 897 | self.assertEqual(tarinfo.linkname, member.linkname, |
| 898 | "unable to read longname member") |
Georg Brandl | 87fa559 | 2006-12-06 22:21:18 +0000 | [diff] [blame] | 899 | |
Neal Norwitz | 0662f8a | 2004-07-20 21:54:18 +0000 | [diff] [blame] | 900 | def test_longname_1023(self): |
| 901 | self._test(("longnam/" * 127) + "longnam") |
| 902 | |
| 903 | def test_longname_1024(self): |
| 904 | self._test(("longnam/" * 127) + "longname") |
| 905 | |
| 906 | def test_longname_1025(self): |
| 907 | self._test(("longnam/" * 127) + "longname_") |
| 908 | |
| 909 | def test_longlink_1023(self): |
| 910 | self._test("name", ("longlnk/" * 127) + "longlnk") |
| 911 | |
| 912 | def test_longlink_1024(self): |
| 913 | self._test("name", ("longlnk/" * 127) + "longlink") |
| 914 | |
| 915 | def test_longlink_1025(self): |
| 916 | self._test("name", ("longlnk/" * 127) + "longlink_") |
| 917 | |
| 918 | def test_longnamelink_1023(self): |
| 919 | self._test(("longnam/" * 127) + "longnam", |
| 920 | ("longlnk/" * 127) + "longlnk") |
| 921 | |
| 922 | def test_longnamelink_1024(self): |
| 923 | self._test(("longnam/" * 127) + "longname", |
| 924 | ("longlnk/" * 127) + "longlink") |
| 925 | |
| 926 | def test_longnamelink_1025(self): |
| 927 | self._test(("longnam/" * 127) + "longname_", |
| 928 | ("longlnk/" * 127) + "longlink_") |
| 929 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 930 | |
| 931 | class HardlinkTest(unittest.TestCase): |
| 932 | # Test the creation of LNKTYPE (hardlink) members in an archive. |
Georg Brandl | 38c6a22 | 2006-05-10 16:26:03 +0000 | [diff] [blame] | 933 | |
| 934 | def setUp(self): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 935 | self.foo = os.path.join(TEMPDIR, "foo") |
| 936 | self.bar = os.path.join(TEMPDIR, "bar") |
Georg Brandl | 38c6a22 | 2006-05-10 16:26:03 +0000 | [diff] [blame] | 937 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 938 | fobj = open(self.foo, "wb") |
| 939 | fobj.write("foo") |
| 940 | fobj.close() |
Georg Brandl | 38c6a22 | 2006-05-10 16:26:03 +0000 | [diff] [blame] | 941 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 942 | os.link(self.foo, self.bar) |
Georg Brandl | 38c6a22 | 2006-05-10 16:26:03 +0000 | [diff] [blame] | 943 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 944 | self.tar = tarfile.open(tmpname, "w") |
Neal Norwitz | b0e32e2 | 2005-10-20 04:50:13 +0000 | [diff] [blame] | 945 | self.tar.add(self.foo) |
| 946 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 947 | def tearDown(self): |
Hirokazu Yamamoto | 56d380d | 2008-09-21 11:44:23 +0000 | [diff] [blame] | 948 | self.tar.close() |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 949 | os.remove(self.foo) |
| 950 | os.remove(self.bar) |
| 951 | |
Neal Norwitz | b0e32e2 | 2005-10-20 04:50:13 +0000 | [diff] [blame] | 952 | def test_add_twice(self): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 953 | # The same name will be added as a REGTYPE every |
| 954 | # time regardless of st_nlink. |
Neal Norwitz | b0e32e2 | 2005-10-20 04:50:13 +0000 | [diff] [blame] | 955 | tarinfo = self.tar.gettarinfo(self.foo) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 956 | self.assertTrue(tarinfo.type == tarfile.REGTYPE, |
Neal Norwitz | b0e32e2 | 2005-10-20 04:50:13 +0000 | [diff] [blame] | 957 | "add file as regular failed") |
| 958 | |
| 959 | def test_add_hardlink(self): |
Neal Norwitz | b0e32e2 | 2005-10-20 04:50:13 +0000 | [diff] [blame] | 960 | tarinfo = self.tar.gettarinfo(self.bar) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 961 | self.assertTrue(tarinfo.type == tarfile.LNKTYPE, |
Neal Norwitz | b0e32e2 | 2005-10-20 04:50:13 +0000 | [diff] [blame] | 962 | "add file as hardlink failed") |
| 963 | |
| 964 | def test_dereference_hardlink(self): |
| 965 | self.tar.dereference = True |
Neal Norwitz | b0e32e2 | 2005-10-20 04:50:13 +0000 | [diff] [blame] | 966 | tarinfo = self.tar.gettarinfo(self.bar) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 967 | self.assertTrue(tarinfo.type == tarfile.REGTYPE, |
Neal Norwitz | b0e32e2 | 2005-10-20 04:50:13 +0000 | [diff] [blame] | 968 | "dereferencing hardlink failed") |
| 969 | |
Neal Norwitz | a4f651a | 2004-07-20 22:07:44 +0000 | [diff] [blame] | 970 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 971 | class PaxWriteTest(GNUWriteTest): |
Martin v. Löwis | 78be7df | 2005-03-05 12:47:42 +0000 | [diff] [blame] | 972 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 973 | def _test(self, name, link=None): |
| 974 | # See GNUWriteTest. |
| 975 | tarinfo = tarfile.TarInfo(name) |
| 976 | if link: |
| 977 | tarinfo.linkname = link |
| 978 | tarinfo.type = tarfile.LNKTYPE |
Andrew M. Kuchling | d4f2552 | 2004-10-20 11:47:01 +0000 | [diff] [blame] | 979 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 980 | tar = tarfile.open(tmpname, "w", format=tarfile.PAX_FORMAT) |
| 981 | tar.addfile(tarinfo) |
| 982 | tar.close() |
Andrew M. Kuchling | d4f2552 | 2004-10-20 11:47:01 +0000 | [diff] [blame] | 983 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 984 | tar = tarfile.open(tmpname) |
| 985 | if link: |
| 986 | l = tar.getmembers()[0].linkname |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 987 | self.assertTrue(link == l, "PAX longlink creation failed") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 988 | else: |
| 989 | n = tar.getmembers()[0].name |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 990 | self.assertTrue(name == n, "PAX longname creation failed") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 991 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 992 | def test_pax_global_header(self): |
| 993 | pax_headers = { |
| 994 | u"foo": u"bar", |
| 995 | u"uid": u"0", |
| 996 | u"mtime": u"1.23", |
| 997 | u"test": u"äöü", |
| 998 | u"äöü": u"test"} |
| 999 | |
Florent Xicluna | fc5f6a7 | 2010-03-20 22:26:42 +0000 | [diff] [blame] | 1000 | tar = tarfile.open(tmpname, "w", format=tarfile.PAX_FORMAT, |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1001 | pax_headers=pax_headers) |
| 1002 | tar.addfile(tarfile.TarInfo("test")) |
| 1003 | tar.close() |
| 1004 | |
| 1005 | # Test if the global header was written correctly. |
| 1006 | tar = tarfile.open(tmpname, encoding="iso8859-1") |
| 1007 | self.assertEqual(tar.pax_headers, pax_headers) |
| 1008 | self.assertEqual(tar.getmembers()[0].pax_headers, pax_headers) |
| 1009 | |
| 1010 | # Test if all the fields are unicode. |
| 1011 | for key, val in tar.pax_headers.iteritems(): |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 1012 | self.assertTrue(type(key) is unicode) |
| 1013 | self.assertTrue(type(val) is unicode) |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1014 | if key in tarfile.PAX_NUMBER_FIELDS: |
| 1015 | try: |
| 1016 | tarfile.PAX_NUMBER_FIELDS[key](val) |
| 1017 | except (TypeError, ValueError): |
| 1018 | self.fail("unable to convert pax header field") |
| 1019 | |
| 1020 | def test_pax_extended_header(self): |
| 1021 | # The fields from the pax header have priority over the |
| 1022 | # TarInfo. |
| 1023 | pax_headers = {u"path": u"foo", u"uid": u"123"} |
| 1024 | |
| 1025 | tar = tarfile.open(tmpname, "w", format=tarfile.PAX_FORMAT, encoding="iso8859-1") |
| 1026 | t = tarfile.TarInfo() |
| 1027 | t.name = u"äöü" # non-ASCII |
| 1028 | t.uid = 8**8 # too large |
| 1029 | t.pax_headers = pax_headers |
| 1030 | tar.addfile(t) |
| 1031 | tar.close() |
| 1032 | |
| 1033 | tar = tarfile.open(tmpname, encoding="iso8859-1") |
| 1034 | t = tar.getmembers()[0] |
| 1035 | self.assertEqual(t.pax_headers, pax_headers) |
| 1036 | self.assertEqual(t.name, "foo") |
| 1037 | self.assertEqual(t.uid, 123) |
| 1038 | |
| 1039 | |
| 1040 | class UstarUnicodeTest(unittest.TestCase): |
| 1041 | # All *UnicodeTests FIXME |
| 1042 | |
| 1043 | format = tarfile.USTAR_FORMAT |
| 1044 | |
| 1045 | def test_iso8859_1_filename(self): |
| 1046 | self._test_unicode_filename("iso8859-1") |
| 1047 | |
| 1048 | def test_utf7_filename(self): |
| 1049 | self._test_unicode_filename("utf7") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1050 | |
| 1051 | def test_utf8_filename(self): |
| 1052 | self._test_unicode_filename("utf8") |
| 1053 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1054 | def _test_unicode_filename(self, encoding): |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1055 | tar = tarfile.open(tmpname, "w", format=self.format, encoding=encoding, errors="strict") |
| 1056 | name = u"äöü" |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1057 | tar.addfile(tarfile.TarInfo(name)) |
| 1058 | tar.close() |
| 1059 | |
| 1060 | tar = tarfile.open(tmpname, encoding=encoding) |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 1061 | self.assertTrue(type(tar.getnames()[0]) is not unicode) |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1062 | self.assertEqual(tar.getmembers()[0].name, name.encode(encoding)) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1063 | tar.close() |
| 1064 | |
| 1065 | def test_unicode_filename_error(self): |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1066 | tar = tarfile.open(tmpname, "w", format=self.format, encoding="ascii", errors="strict") |
| 1067 | tarinfo = tarfile.TarInfo() |
| 1068 | |
| 1069 | tarinfo.name = "äöü" |
| 1070 | if self.format == tarfile.PAX_FORMAT: |
| 1071 | self.assertRaises(UnicodeError, tar.addfile, tarinfo) |
| 1072 | else: |
| 1073 | tar.addfile(tarinfo) |
| 1074 | |
| 1075 | tarinfo.name = u"äöü" |
| 1076 | self.assertRaises(UnicodeError, tar.addfile, tarinfo) |
| 1077 | |
| 1078 | tarinfo.name = "foo" |
| 1079 | tarinfo.uname = u"äöü" |
| 1080 | self.assertRaises(UnicodeError, tar.addfile, tarinfo) |
| 1081 | |
| 1082 | def test_unicode_argument(self): |
| 1083 | tar = tarfile.open(tarname, "r", encoding="iso8859-1", errors="strict") |
| 1084 | for t in tar: |
Benjamin Peterson | 5c8da86 | 2009-06-30 22:57:08 +0000 | [diff] [blame] | 1085 | self.assertTrue(type(t.name) is str) |
| 1086 | self.assertTrue(type(t.linkname) is str) |
| 1087 | self.assertTrue(type(t.uname) is str) |
| 1088 | self.assertTrue(type(t.gname) is str) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1089 | tar.close() |
| 1090 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1091 | def test_uname_unicode(self): |
| 1092 | for name in (u"äöü", "äöü"): |
| 1093 | t = tarfile.TarInfo("foo") |
| 1094 | t.uname = name |
| 1095 | t.gname = name |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1096 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1097 | fobj = StringIO.StringIO() |
| 1098 | tar = tarfile.open("foo.tar", mode="w", fileobj=fobj, format=self.format, encoding="iso8859-1") |
| 1099 | tar.addfile(t) |
| 1100 | tar.close() |
| 1101 | fobj.seek(0) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1102 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1103 | tar = tarfile.open("foo.tar", fileobj=fobj, encoding="iso8859-1") |
| 1104 | t = tar.getmember("foo") |
| 1105 | self.assertEqual(t.uname, "äöü") |
| 1106 | self.assertEqual(t.gname, "äöü") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1107 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1108 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1109 | class GNUUnicodeTest(UstarUnicodeTest): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1110 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1111 | format = tarfile.GNU_FORMAT |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1112 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1113 | |
| 1114 | class PaxUnicodeTest(UstarUnicodeTest): |
| 1115 | |
| 1116 | format = tarfile.PAX_FORMAT |
| 1117 | |
| 1118 | def _create_unicode_name(self, name): |
| 1119 | tar = tarfile.open(tmpname, "w", format=self.format) |
| 1120 | t = tarfile.TarInfo() |
| 1121 | t.pax_headers["path"] = name |
| 1122 | tar.addfile(t) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1123 | tar.close() |
| 1124 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1125 | def test_error_handlers(self): |
| 1126 | # Test if the unicode error handlers work correctly for characters |
| 1127 | # that cannot be expressed in a given encoding. |
| 1128 | self._create_unicode_name(u"äöü") |
Georg Brandl | ded1c4d | 2006-12-20 11:55:16 +0000 | [diff] [blame] | 1129 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1130 | for handler, name in (("utf-8", u"äöü".encode("utf8")), |
| 1131 | ("replace", "???"), ("ignore", "")): |
| 1132 | tar = tarfile.open(tmpname, format=self.format, encoding="ascii", |
| 1133 | errors=handler) |
| 1134 | self.assertEqual(tar.getnames()[0], name) |
Georg Brandl | ded1c4d | 2006-12-20 11:55:16 +0000 | [diff] [blame] | 1135 | |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1136 | self.assertRaises(UnicodeError, tarfile.open, tmpname, |
| 1137 | encoding="ascii", errors="strict") |
| 1138 | |
| 1139 | def test_error_handler_utf8(self): |
| 1140 | # Create a pathname that has one component representable using |
| 1141 | # iso8859-1 and the other only in iso8859-15. |
| 1142 | self._create_unicode_name(u"äöü/¤") |
| 1143 | |
| 1144 | tar = tarfile.open(tmpname, format=self.format, encoding="iso8859-1", |
| 1145 | errors="utf-8") |
| 1146 | self.assertEqual(tar.getnames()[0], "äöü/" + u"¤".encode("utf8")) |
Georg Brandl | ded1c4d | 2006-12-20 11:55:16 +0000 | [diff] [blame] | 1147 | |
Georg Brandl | ded1c4d | 2006-12-20 11:55:16 +0000 | [diff] [blame] | 1148 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1149 | class AppendTest(unittest.TestCase): |
| 1150 | # Test append mode (cp. patch #1652681). |
Tim Peters | 8ceefc5 | 2004-10-25 03:19:41 +0000 | [diff] [blame] | 1151 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1152 | def setUp(self): |
| 1153 | self.tarname = tmpname |
| 1154 | if os.path.exists(self.tarname): |
| 1155 | os.remove(self.tarname) |
Lars Gustäbel | a7ba6fc | 2006-12-27 10:30:46 +0000 | [diff] [blame] | 1156 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1157 | def _add_testfile(self, fileobj=None): |
| 1158 | tar = tarfile.open(self.tarname, "a", fileobj=fileobj) |
| 1159 | tar.addfile(tarfile.TarInfo("bar")) |
| 1160 | tar.close() |
Lars Gustäbel | a7ba6fc | 2006-12-27 10:30:46 +0000 | [diff] [blame] | 1161 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1162 | def _create_testtar(self, mode="w:"): |
Lars Gustäbel | a36cde4 | 2007-03-13 15:47:07 +0000 | [diff] [blame] | 1163 | src = tarfile.open(tarname, encoding="iso8859-1") |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1164 | t = src.getmember("ustar/regtype") |
| 1165 | t.name = "foo" |
| 1166 | f = src.extractfile(t) |
| 1167 | tar = tarfile.open(self.tarname, mode) |
| 1168 | tar.addfile(t, f) |
| 1169 | tar.close() |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 1170 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1171 | def _test(self, names=["bar"], fileobj=None): |
| 1172 | tar = tarfile.open(self.tarname, fileobj=fileobj) |
| 1173 | self.assertEqual(tar.getnames(), names) |
| 1174 | |
| 1175 | def test_non_existing(self): |
| 1176 | self._add_testfile() |
| 1177 | self._test() |
| 1178 | |
| 1179 | def test_empty(self): |
Lars Gustäbel | dd866d5 | 2009-11-22 18:30:53 +0000 | [diff] [blame] | 1180 | tarfile.open(self.tarname, "w:").close() |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1181 | self._add_testfile() |
| 1182 | self._test() |
| 1183 | |
| 1184 | def test_empty_fileobj(self): |
Lars Gustäbel | dd866d5 | 2009-11-22 18:30:53 +0000 | [diff] [blame] | 1185 | fobj = StringIO.StringIO("\0" * 1024) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1186 | self._add_testfile(fobj) |
| 1187 | fobj.seek(0) |
| 1188 | self._test(fileobj=fobj) |
| 1189 | |
| 1190 | def test_fileobj(self): |
| 1191 | self._create_testtar() |
| 1192 | data = open(self.tarname).read() |
| 1193 | fobj = StringIO.StringIO(data) |
| 1194 | self._add_testfile(fobj) |
| 1195 | fobj.seek(0) |
| 1196 | self._test(names=["foo", "bar"], fileobj=fobj) |
| 1197 | |
| 1198 | def test_existing(self): |
| 1199 | self._create_testtar() |
| 1200 | self._add_testfile() |
| 1201 | self._test(names=["foo", "bar"]) |
| 1202 | |
| 1203 | def test_append_gz(self): |
| 1204 | if gzip is None: |
| 1205 | return |
| 1206 | self._create_testtar("w:gz") |
| 1207 | self.assertRaises(tarfile.ReadError, tarfile.open, tmpname, "a") |
| 1208 | |
| 1209 | def test_append_bz2(self): |
| 1210 | if bz2 is None: |
| 1211 | return |
| 1212 | self._create_testtar("w:bz2") |
| 1213 | self.assertRaises(tarfile.ReadError, tarfile.open, tmpname, "a") |
| 1214 | |
Lars Gustäbel | dd866d5 | 2009-11-22 18:30:53 +0000 | [diff] [blame] | 1215 | # Append mode is supposed to fail if the tarfile to append to |
| 1216 | # does not end with a zero block. |
| 1217 | def _test_error(self, data): |
| 1218 | open(self.tarname, "wb").write(data) |
| 1219 | self.assertRaises(tarfile.ReadError, self._add_testfile) |
| 1220 | |
| 1221 | def test_null(self): |
| 1222 | self._test_error("") |
| 1223 | |
| 1224 | def test_incomplete(self): |
| 1225 | self._test_error("\0" * 13) |
| 1226 | |
| 1227 | def test_premature_eof(self): |
| 1228 | data = tarfile.TarInfo("foo").tobuf() |
| 1229 | self._test_error(data) |
| 1230 | |
| 1231 | def test_trailing_garbage(self): |
| 1232 | data = tarfile.TarInfo("foo").tobuf() |
| 1233 | self._test_error(data + "\0" * 13) |
| 1234 | |
| 1235 | def test_invalid(self): |
| 1236 | self._test_error("a" * 512) |
| 1237 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1238 | |
| 1239 | class LimitsTest(unittest.TestCase): |
| 1240 | |
| 1241 | def test_ustar_limits(self): |
| 1242 | # 100 char name |
| 1243 | tarinfo = tarfile.TarInfo("0123456789" * 10) |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1244 | tarinfo.tobuf(tarfile.USTAR_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1245 | |
| 1246 | # 101 char name that cannot be stored |
| 1247 | tarinfo = tarfile.TarInfo("0123456789" * 10 + "0") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1248 | self.assertRaises(ValueError, tarinfo.tobuf, tarfile.USTAR_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1249 | |
| 1250 | # 256 char name with a slash at pos 156 |
| 1251 | tarinfo = tarfile.TarInfo("123/" * 62 + "longname") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1252 | tarinfo.tobuf(tarfile.USTAR_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1253 | |
| 1254 | # 256 char name that cannot be stored |
| 1255 | tarinfo = tarfile.TarInfo("1234567/" * 31 + "longname") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1256 | self.assertRaises(ValueError, tarinfo.tobuf, tarfile.USTAR_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1257 | |
| 1258 | # 512 char name |
| 1259 | tarinfo = tarfile.TarInfo("123/" * 126 + "longname") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1260 | self.assertRaises(ValueError, tarinfo.tobuf, tarfile.USTAR_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1261 | |
| 1262 | # 512 char linkname |
| 1263 | tarinfo = tarfile.TarInfo("longlink") |
| 1264 | tarinfo.linkname = "123/" * 126 + "longname" |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1265 | self.assertRaises(ValueError, tarinfo.tobuf, tarfile.USTAR_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1266 | |
| 1267 | # uid > 8 digits |
| 1268 | tarinfo = tarfile.TarInfo("name") |
| 1269 | tarinfo.uid = 010000000 |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1270 | self.assertRaises(ValueError, tarinfo.tobuf, tarfile.USTAR_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1271 | |
| 1272 | def test_gnu_limits(self): |
| 1273 | tarinfo = tarfile.TarInfo("123/" * 126 + "longname") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1274 | tarinfo.tobuf(tarfile.GNU_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1275 | |
| 1276 | tarinfo = tarfile.TarInfo("longlink") |
| 1277 | tarinfo.linkname = "123/" * 126 + "longname" |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1278 | tarinfo.tobuf(tarfile.GNU_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1279 | |
| 1280 | # uid >= 256 ** 7 |
| 1281 | tarinfo = tarfile.TarInfo("name") |
| 1282 | tarinfo.uid = 04000000000000000000L |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1283 | self.assertRaises(ValueError, tarinfo.tobuf, tarfile.GNU_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1284 | |
| 1285 | def test_pax_limits(self): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1286 | tarinfo = tarfile.TarInfo("123/" * 126 + "longname") |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1287 | tarinfo.tobuf(tarfile.PAX_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1288 | |
| 1289 | tarinfo = tarfile.TarInfo("longlink") |
| 1290 | tarinfo.linkname = "123/" * 126 + "longname" |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1291 | tarinfo.tobuf(tarfile.PAX_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1292 | |
| 1293 | tarinfo = tarfile.TarInfo("name") |
| 1294 | tarinfo.uid = 04000000000000000000L |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1295 | tarinfo.tobuf(tarfile.PAX_FORMAT) |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1296 | |
| 1297 | |
Lars Gustäbel | 6458104 | 2010-03-03 11:55:48 +0000 | [diff] [blame] | 1298 | class ContextManagerTest(unittest.TestCase): |
| 1299 | |
| 1300 | def test_basic(self): |
| 1301 | with tarfile.open(tarname) as tar: |
| 1302 | self.assertFalse(tar.closed, "closed inside runtime context") |
| 1303 | self.assertTrue(tar.closed, "context manager failed") |
| 1304 | |
| 1305 | def test_closed(self): |
| 1306 | # The __enter__() method is supposed to raise IOError |
| 1307 | # if the TarFile object is already closed. |
| 1308 | tar = tarfile.open(tarname) |
| 1309 | tar.close() |
| 1310 | with self.assertRaises(IOError): |
| 1311 | with tar: |
| 1312 | pass |
| 1313 | |
| 1314 | def test_exception(self): |
| 1315 | # Test if the IOError exception is passed through properly. |
| 1316 | with self.assertRaises(Exception) as exc: |
| 1317 | with tarfile.open(tarname) as tar: |
| 1318 | raise IOError |
| 1319 | self.assertIsInstance(exc.exception, IOError, |
| 1320 | "wrong exception raised in context manager") |
| 1321 | self.assertTrue(tar.closed, "context manager failed") |
| 1322 | |
| 1323 | def test_no_eof(self): |
| 1324 | # __exit__() must not write end-of-archive blocks if an |
| 1325 | # exception was raised. |
| 1326 | try: |
| 1327 | with tarfile.open(tmpname, "w") as tar: |
| 1328 | raise Exception |
| 1329 | except: |
| 1330 | pass |
| 1331 | self.assertEqual(os.path.getsize(tmpname), 0, |
| 1332 | "context manager wrote an end-of-archive block") |
| 1333 | self.assertTrue(tar.closed, "context manager failed") |
| 1334 | |
| 1335 | def test_eof(self): |
| 1336 | # __exit__() must write end-of-archive blocks, i.e. call |
| 1337 | # TarFile.close() if there was no error. |
| 1338 | with tarfile.open(tmpname, "w"): |
| 1339 | pass |
| 1340 | self.assertNotEqual(os.path.getsize(tmpname), 0, |
| 1341 | "context manager wrote no end-of-archive block") |
| 1342 | |
| 1343 | def test_fileobj(self): |
| 1344 | # Test that __exit__() did not close the external file |
| 1345 | # object. |
| 1346 | fobj = open(tmpname, "wb") |
| 1347 | try: |
| 1348 | with tarfile.open(fileobj=fobj, mode="w") as tar: |
| 1349 | raise Exception |
| 1350 | except: |
| 1351 | pass |
| 1352 | self.assertFalse(fobj.closed, "external file object was closed") |
| 1353 | self.assertTrue(tar.closed, "context manager failed") |
| 1354 | fobj.close() |
| 1355 | |
| 1356 | |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1357 | class GzipMiscReadTest(MiscReadTest): |
| 1358 | tarname = gzipname |
| 1359 | mode = "r:gz" |
| 1360 | class GzipUstarReadTest(UstarReadTest): |
| 1361 | tarname = gzipname |
| 1362 | mode = "r:gz" |
| 1363 | class GzipStreamReadTest(StreamReadTest): |
| 1364 | tarname = gzipname |
| 1365 | mode = "r|gz" |
| 1366 | class GzipWriteTest(WriteTest): |
| 1367 | mode = "w:gz" |
| 1368 | class GzipStreamWriteTest(StreamWriteTest): |
| 1369 | mode = "w|gz" |
| 1370 | |
| 1371 | |
| 1372 | class Bz2MiscReadTest(MiscReadTest): |
| 1373 | tarname = bz2name |
| 1374 | mode = "r:bz2" |
| 1375 | class Bz2UstarReadTest(UstarReadTest): |
| 1376 | tarname = bz2name |
| 1377 | mode = "r:bz2" |
| 1378 | class Bz2StreamReadTest(StreamReadTest): |
| 1379 | tarname = bz2name |
| 1380 | mode = "r|bz2" |
| 1381 | class Bz2WriteTest(WriteTest): |
| 1382 | mode = "w:bz2" |
| 1383 | class Bz2StreamWriteTest(StreamWriteTest): |
| 1384 | mode = "w|bz2" |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 1385 | |
Lars Gustäbel | 2020a59 | 2009-03-22 20:09:33 +0000 | [diff] [blame] | 1386 | class Bz2PartialReadTest(unittest.TestCase): |
| 1387 | # Issue5068: The _BZ2Proxy.read() method loops forever |
| 1388 | # on an empty or partial bzipped file. |
| 1389 | |
| 1390 | def _test_partial_input(self, mode): |
| 1391 | class MyStringIO(StringIO.StringIO): |
| 1392 | hit_eof = False |
| 1393 | def read(self, n): |
| 1394 | if self.hit_eof: |
| 1395 | raise AssertionError("infinite loop detected in tarfile.open()") |
| 1396 | self.hit_eof = self.pos == self.len |
| 1397 | return StringIO.StringIO.read(self, n) |
Lars Gustäbel | dd866d5 | 2009-11-22 18:30:53 +0000 | [diff] [blame] | 1398 | def seek(self, *args): |
| 1399 | self.hit_eof = False |
| 1400 | return StringIO.StringIO.seek(self, *args) |
Lars Gustäbel | 2020a59 | 2009-03-22 20:09:33 +0000 | [diff] [blame] | 1401 | |
| 1402 | data = bz2.compress(tarfile.TarInfo("foo").tobuf()) |
| 1403 | for x in range(len(data) + 1): |
Lars Gustäbel | dd866d5 | 2009-11-22 18:30:53 +0000 | [diff] [blame] | 1404 | try: |
| 1405 | tarfile.open(fileobj=MyStringIO(data[:x]), mode=mode) |
| 1406 | except tarfile.ReadError: |
| 1407 | pass # we have no interest in ReadErrors |
Lars Gustäbel | 2020a59 | 2009-03-22 20:09:33 +0000 | [diff] [blame] | 1408 | |
| 1409 | def test_partial_input(self): |
| 1410 | self._test_partial_input("r") |
| 1411 | |
| 1412 | def test_partial_input_bz2(self): |
| 1413 | self._test_partial_input("r:bz2") |
| 1414 | |
| 1415 | |
Neal Norwitz | 996acf1 | 2003-02-17 14:51:41 +0000 | [diff] [blame] | 1416 | def test_main(): |
Antoine Pitrou | 310c9fe | 2009-11-11 20:55:07 +0000 | [diff] [blame] | 1417 | os.makedirs(TEMPDIR) |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 1418 | |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 1419 | tests = [ |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1420 | UstarReadTest, |
| 1421 | MiscReadTest, |
| 1422 | StreamReadTest, |
| 1423 | DetectReadTest, |
| 1424 | MemberReadTest, |
| 1425 | GNUReadTest, |
| 1426 | PaxReadTest, |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 1427 | WriteTest, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1428 | StreamWriteTest, |
| 1429 | GNUWriteTest, |
| 1430 | PaxWriteTest, |
Lars Gustäbel | a0fcb93 | 2007-05-27 19:49:30 +0000 | [diff] [blame] | 1431 | UstarUnicodeTest, |
| 1432 | GNUUnicodeTest, |
| 1433 | PaxUnicodeTest, |
Lars Gustäbel | 3f8aca1 | 2007-02-06 18:38:13 +0000 | [diff] [blame] | 1434 | AppendTest, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1435 | LimitsTest, |
Lars Gustäbel | 6458104 | 2010-03-03 11:55:48 +0000 | [diff] [blame] | 1436 | ContextManagerTest, |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 1437 | ] |
| 1438 | |
Neal Norwitz | a4f651a | 2004-07-20 22:07:44 +0000 | [diff] [blame] | 1439 | if hasattr(os, "link"): |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1440 | tests.append(HardlinkTest) |
| 1441 | |
| 1442 | fobj = open(tarname, "rb") |
| 1443 | data = fobj.read() |
| 1444 | fobj.close() |
Neal Norwitz | a4f651a | 2004-07-20 22:07:44 +0000 | [diff] [blame] | 1445 | |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 1446 | if gzip: |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1447 | # Create testtar.tar.gz and add gzip-specific tests. |
| 1448 | tar = gzip.open(gzipname, "wb") |
| 1449 | tar.write(data) |
| 1450 | tar.close() |
| 1451 | |
| 1452 | tests += [ |
| 1453 | GzipMiscReadTest, |
| 1454 | GzipUstarReadTest, |
| 1455 | GzipStreamReadTest, |
| 1456 | GzipWriteTest, |
| 1457 | GzipStreamWriteTest, |
| 1458 | ] |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 1459 | |
| 1460 | if bz2: |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1461 | # Create testtar.tar.bz2 and add bz2-specific tests. |
| 1462 | tar = bz2.BZ2File(bz2name, "wb") |
| 1463 | tar.write(data) |
| 1464 | tar.close() |
| 1465 | |
| 1466 | tests += [ |
| 1467 | Bz2MiscReadTest, |
| 1468 | Bz2UstarReadTest, |
| 1469 | Bz2StreamReadTest, |
| 1470 | Bz2WriteTest, |
| 1471 | Bz2StreamWriteTest, |
Lars Gustäbel | 2020a59 | 2009-03-22 20:09:33 +0000 | [diff] [blame] | 1472 | Bz2PartialReadTest, |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1473 | ] |
| 1474 | |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 1475 | try: |
Walter Dörwald | 21d3a32 | 2003-05-01 17:45:56 +0000 | [diff] [blame] | 1476 | test_support.run_unittest(*tests) |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 1477 | finally: |
Lars Gustäbel | c64e402 | 2007-03-13 10:47:19 +0000 | [diff] [blame] | 1478 | if os.path.exists(TEMPDIR): |
| 1479 | shutil.rmtree(TEMPDIR) |
Neal Norwitz | b9ef4ae | 2003-01-05 23:19:43 +0000 | [diff] [blame] | 1480 | |
Neal Norwitz | 996acf1 | 2003-02-17 14:51:41 +0000 | [diff] [blame] | 1481 | if __name__ == "__main__": |
| 1482 | test_main() |