Jason R. Coombs | e7437a7 | 2011-12-26 12:17:01 -0500 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 2 | """Tests for distutils.archive_util.""" |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 3 | import unittest |
| 4 | import os |
Jason R. Coombs | bbb0803 | 2011-12-28 10:45:08 -0500 | [diff] [blame] | 5 | import sys |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 6 | import tarfile |
Tarek Ziadé | 93fb3aa | 2009-05-18 12:29:06 +0000 | [diff] [blame] | 7 | from os.path import splitdrive |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 8 | import warnings |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 9 | |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 10 | from distutils import archive_util |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 11 | from distutils.archive_util import (check_archive_formats, make_tarball, |
Tarek Ziadé | 53fdb18 | 2009-10-24 13:42:10 +0000 | [diff] [blame] | 12 | make_zipfile, make_archive, |
| 13 | ARCHIVE_FORMATS) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 14 | from distutils.spawn import find_executable, spawn |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 15 | from distutils.tests import support |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 16 | from test.support import check_warnings, run_unittest, patch |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 17 | |
| 18 | try: |
| 19 | import zipfile |
| 20 | ZIP_SUPPORT = True |
| 21 | except ImportError: |
| 22 | ZIP_SUPPORT = find_executable('zip') |
| 23 | |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 24 | try: |
| 25 | import zlib |
| 26 | ZLIB_SUPPORT = True |
| 27 | except ImportError: |
| 28 | ZLIB_SUPPORT = False |
| 29 | |
Jason R. Coombs | bbb0803 | 2011-12-28 10:45:08 -0500 | [diff] [blame] | 30 | def can_fs_encode(filename): |
| 31 | """ |
| 32 | Return True if the filename can be saved in the file system. |
| 33 | """ |
| 34 | if os.path.supports_unicode_filenames: |
| 35 | return True |
| 36 | try: |
| 37 | filename.encode(sys.getfilesystemencoding()) |
| 38 | except UnicodeEncodeError: |
| 39 | return False |
| 40 | return True |
| 41 | |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 42 | |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 43 | class ArchiveUtilTestCase(support.TempdirManager, |
Tarek Ziadé | e2cedaa | 2009-05-28 14:02:58 +0000 | [diff] [blame] | 44 | support.LoggingSilencer, |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 45 | unittest.TestCase): |
| 46 | |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 47 | @unittest.skipUnless(ZLIB_SUPPORT, 'Need zlib support to run') |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 48 | def test_make_tarball(self): |
Jason R. Coombs | e7437a7 | 2011-12-26 12:17:01 -0500 | [diff] [blame] | 49 | self._make_tarball('archive') |
| 50 | |
| 51 | @unittest.skipUnless(ZLIB_SUPPORT, 'Need zlib support to run') |
Jason R. Coombs | bbb0803 | 2011-12-28 10:45:08 -0500 | [diff] [blame] | 52 | @unittest.skipUnless(can_fs_encode('årchiv'), |
| 53 | 'File system cannot handle this filename') |
Jason R. Coombs | e7437a7 | 2011-12-26 12:17:01 -0500 | [diff] [blame] | 54 | def test_make_tarball_latin1(self): |
| 55 | """ |
| 56 | Mirror test_make_tarball, except filename contains latin characters. |
| 57 | """ |
| 58 | self._make_tarball('årchiv') # note this isn't a real word |
| 59 | |
| 60 | @unittest.skipUnless(ZLIB_SUPPORT, 'Need zlib support to run') |
Jason R. Coombs | bbb0803 | 2011-12-28 10:45:08 -0500 | [diff] [blame] | 61 | @unittest.skipUnless(can_fs_encode('のアーカイブ'), |
| 62 | 'File system cannot handle this filename') |
Jason R. Coombs | e7437a7 | 2011-12-26 12:17:01 -0500 | [diff] [blame] | 63 | def test_make_tarball_extended(self): |
| 64 | """ |
| 65 | Mirror test_make_tarball, except filename contains extended |
| 66 | characters outside the latin charset. |
| 67 | """ |
| 68 | self._make_tarball('のアーカイブ') # japanese for archive |
| 69 | |
| 70 | def _make_tarball(self, target_name): |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 71 | # creating something to tar |
| 72 | tmpdir = self.mkdtemp() |
| 73 | self.write_file([tmpdir, 'file1'], 'xxx') |
| 74 | self.write_file([tmpdir, 'file2'], 'xxx') |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 75 | os.mkdir(os.path.join(tmpdir, 'sub')) |
| 76 | self.write_file([tmpdir, 'sub', 'file3'], 'xxx') |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 77 | |
| 78 | tmpdir2 = self.mkdtemp() |
Tarek Ziadé | 93fb3aa | 2009-05-18 12:29:06 +0000 | [diff] [blame] | 79 | unittest.skipUnless(splitdrive(tmpdir)[0] == splitdrive(tmpdir2)[0], |
| 80 | "Source and target should be on same drive") |
| 81 | |
Jason R. Coombs | e7437a7 | 2011-12-26 12:17:01 -0500 | [diff] [blame] | 82 | base_name = os.path.join(tmpdir2, target_name) |
Tarek Ziadé | 40c0027 | 2009-05-18 08:22:38 +0000 | [diff] [blame] | 83 | |
| 84 | # working with relative paths to avoid tar warnings |
| 85 | old_dir = os.getcwd() |
| 86 | os.chdir(tmpdir) |
| 87 | try: |
Tarek Ziadé | 93fb3aa | 2009-05-18 12:29:06 +0000 | [diff] [blame] | 88 | make_tarball(splitdrive(base_name)[1], '.') |
Tarek Ziadé | 40c0027 | 2009-05-18 08:22:38 +0000 | [diff] [blame] | 89 | finally: |
| 90 | os.chdir(old_dir) |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 91 | |
| 92 | # check if the compressed tarball was created |
| 93 | tarball = base_name + '.tar.gz' |
Georg Brandl | ab91fde | 2009-08-13 08:51:18 +0000 | [diff] [blame] | 94 | self.assertTrue(os.path.exists(tarball)) |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 95 | |
| 96 | # trying an uncompressed one |
Jason R. Coombs | e7437a7 | 2011-12-26 12:17:01 -0500 | [diff] [blame] | 97 | base_name = os.path.join(tmpdir2, target_name) |
Tarek Ziadé | 40c0027 | 2009-05-18 08:22:38 +0000 | [diff] [blame] | 98 | old_dir = os.getcwd() |
| 99 | os.chdir(tmpdir) |
| 100 | try: |
Tarek Ziadé | 93fb3aa | 2009-05-18 12:29:06 +0000 | [diff] [blame] | 101 | make_tarball(splitdrive(base_name)[1], '.', compress=None) |
Tarek Ziadé | 40c0027 | 2009-05-18 08:22:38 +0000 | [diff] [blame] | 102 | finally: |
| 103 | os.chdir(old_dir) |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 104 | tarball = base_name + '.tar' |
Georg Brandl | ab91fde | 2009-08-13 08:51:18 +0000 | [diff] [blame] | 105 | self.assertTrue(os.path.exists(tarball)) |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 106 | |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 107 | def _tarinfo(self, path): |
| 108 | tar = tarfile.open(path) |
| 109 | try: |
| 110 | names = tar.getnames() |
| 111 | names.sort() |
| 112 | return tuple(names) |
| 113 | finally: |
| 114 | tar.close() |
| 115 | |
| 116 | def _create_files(self): |
| 117 | # creating something to tar |
| 118 | tmpdir = self.mkdtemp() |
| 119 | dist = os.path.join(tmpdir, 'dist') |
| 120 | os.mkdir(dist) |
| 121 | self.write_file([dist, 'file1'], 'xxx') |
| 122 | self.write_file([dist, 'file2'], 'xxx') |
| 123 | os.mkdir(os.path.join(dist, 'sub')) |
| 124 | self.write_file([dist, 'sub', 'file3'], 'xxx') |
| 125 | os.mkdir(os.path.join(dist, 'sub2')) |
| 126 | tmpdir2 = self.mkdtemp() |
| 127 | base_name = os.path.join(tmpdir2, 'archive') |
| 128 | return tmpdir, tmpdir2, base_name |
| 129 | |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 130 | @unittest.skipUnless(find_executable('tar') and find_executable('gzip') |
| 131 | and ZLIB_SUPPORT, |
| 132 | 'Need the tar, gzip and zlib command to run') |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 133 | def test_tarfile_vs_tar(self): |
| 134 | tmpdir, tmpdir2, base_name = self._create_files() |
| 135 | old_dir = os.getcwd() |
| 136 | os.chdir(tmpdir) |
| 137 | try: |
| 138 | make_tarball(base_name, 'dist') |
| 139 | finally: |
| 140 | os.chdir(old_dir) |
| 141 | |
| 142 | # check if the compressed tarball was created |
| 143 | tarball = base_name + '.tar.gz' |
Georg Brandl | ab91fde | 2009-08-13 08:51:18 +0000 | [diff] [blame] | 144 | self.assertTrue(os.path.exists(tarball)) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 145 | |
| 146 | # now create another tarball using `tar` |
| 147 | tarball2 = os.path.join(tmpdir, 'archive2.tar.gz') |
Tarek Ziadé | e2cedaa | 2009-05-28 14:02:58 +0000 | [diff] [blame] | 148 | tar_cmd = ['tar', '-cf', 'archive2.tar', 'dist'] |
| 149 | gzip_cmd = ['gzip', '-f9', 'archive2.tar'] |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 150 | old_dir = os.getcwd() |
| 151 | os.chdir(tmpdir) |
| 152 | try: |
Tarek Ziadé | e2cedaa | 2009-05-28 14:02:58 +0000 | [diff] [blame] | 153 | spawn(tar_cmd) |
| 154 | spawn(gzip_cmd) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 155 | finally: |
| 156 | os.chdir(old_dir) |
| 157 | |
Georg Brandl | ab91fde | 2009-08-13 08:51:18 +0000 | [diff] [blame] | 158 | self.assertTrue(os.path.exists(tarball2)) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 159 | # let's compare both tarballs |
Ezio Melotti | 19f2aeb | 2010-11-21 01:30:29 +0000 | [diff] [blame] | 160 | self.assertEqual(self._tarinfo(tarball), self._tarinfo(tarball2)) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 161 | |
| 162 | # trying an uncompressed one |
| 163 | base_name = os.path.join(tmpdir2, 'archive') |
| 164 | old_dir = os.getcwd() |
| 165 | os.chdir(tmpdir) |
| 166 | try: |
| 167 | make_tarball(base_name, 'dist', compress=None) |
| 168 | finally: |
| 169 | os.chdir(old_dir) |
| 170 | tarball = base_name + '.tar' |
Georg Brandl | ab91fde | 2009-08-13 08:51:18 +0000 | [diff] [blame] | 171 | self.assertTrue(os.path.exists(tarball)) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 172 | |
| 173 | # now for a dry_run |
| 174 | base_name = os.path.join(tmpdir2, 'archive') |
| 175 | old_dir = os.getcwd() |
| 176 | os.chdir(tmpdir) |
| 177 | try: |
| 178 | make_tarball(base_name, 'dist', compress=None, dry_run=True) |
| 179 | finally: |
| 180 | os.chdir(old_dir) |
| 181 | tarball = base_name + '.tar' |
Georg Brandl | ab91fde | 2009-08-13 08:51:18 +0000 | [diff] [blame] | 182 | self.assertTrue(os.path.exists(tarball)) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 183 | |
| 184 | @unittest.skipUnless(find_executable('compress'), |
| 185 | 'The compress program is required') |
| 186 | def test_compress_deprecated(self): |
| 187 | tmpdir, tmpdir2, base_name = self._create_files() |
| 188 | |
| 189 | # using compress and testing the PendingDeprecationWarning |
| 190 | old_dir = os.getcwd() |
| 191 | os.chdir(tmpdir) |
| 192 | try: |
| 193 | with check_warnings() as w: |
| 194 | warnings.simplefilter("always") |
| 195 | make_tarball(base_name, 'dist', compress='compress') |
| 196 | finally: |
| 197 | os.chdir(old_dir) |
| 198 | tarball = base_name + '.tar.Z' |
Georg Brandl | ab91fde | 2009-08-13 08:51:18 +0000 | [diff] [blame] | 199 | self.assertTrue(os.path.exists(tarball)) |
Ezio Melotti | 19f2aeb | 2010-11-21 01:30:29 +0000 | [diff] [blame] | 200 | self.assertEqual(len(w.warnings), 1) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 201 | |
| 202 | # same test with dry_run |
| 203 | os.remove(tarball) |
| 204 | old_dir = os.getcwd() |
| 205 | os.chdir(tmpdir) |
| 206 | try: |
| 207 | with check_warnings() as w: |
| 208 | warnings.simplefilter("always") |
| 209 | make_tarball(base_name, 'dist', compress='compress', |
| 210 | dry_run=True) |
| 211 | finally: |
| 212 | os.chdir(old_dir) |
Serhiy Storchaka | 3998915 | 2013-11-17 00:17:46 +0200 | [diff] [blame^] | 213 | self.assertFalse(os.path.exists(tarball)) |
Ezio Melotti | 19f2aeb | 2010-11-21 01:30:29 +0000 | [diff] [blame] | 214 | self.assertEqual(len(w.warnings), 1) |
Tarek Ziadé | 77c8b37 | 2009-05-28 13:01:13 +0000 | [diff] [blame] | 215 | |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 216 | @unittest.skipUnless(ZIP_SUPPORT and ZLIB_SUPPORT, |
| 217 | 'Need zip and zlib support to run') |
Tarek Ziadé | 441efa8 | 2009-05-17 15:03:23 +0000 | [diff] [blame] | 218 | def test_make_zipfile(self): |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 219 | # creating something to tar |
| 220 | tmpdir = self.mkdtemp() |
| 221 | self.write_file([tmpdir, 'file1'], 'xxx') |
| 222 | self.write_file([tmpdir, 'file2'], 'xxx') |
| 223 | |
| 224 | tmpdir2 = self.mkdtemp() |
| 225 | base_name = os.path.join(tmpdir2, 'archive') |
| 226 | make_zipfile(base_name, tmpdir) |
| 227 | |
| 228 | # check if the compressed tarball was created |
| 229 | tarball = base_name + '.zip' |
Antoine Pitrou | 2c50a09 | 2011-03-15 21:02:59 +0100 | [diff] [blame] | 230 | self.assertTrue(os.path.exists(tarball)) |
| 231 | |
| 232 | @unittest.skipUnless(ZIP_SUPPORT, 'Need zip support to run') |
| 233 | def test_make_zipfile_no_zlib(self): |
| 234 | patch(self, archive_util.zipfile, 'zlib', None) # force zlib ImportError |
| 235 | |
| 236 | called = [] |
| 237 | zipfile_class = zipfile.ZipFile |
| 238 | def fake_zipfile(*a, **kw): |
| 239 | if kw.get('compression', None) == zipfile.ZIP_STORED: |
| 240 | called.append((a, kw)) |
| 241 | return zipfile_class(*a, **kw) |
| 242 | |
| 243 | patch(self, archive_util.zipfile, 'ZipFile', fake_zipfile) |
| 244 | |
| 245 | # create something to tar and compress |
| 246 | tmpdir, tmpdir2, base_name = self._create_files() |
| 247 | make_zipfile(base_name, tmpdir) |
| 248 | |
| 249 | tarball = base_name + '.zip' |
| 250 | self.assertEqual(called, |
| 251 | [((tarball, "w"), {'compression': zipfile.ZIP_STORED})]) |
| 252 | self.assertTrue(os.path.exists(tarball)) |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 253 | |
| 254 | def test_check_archive_formats(self): |
Ezio Melotti | 19f2aeb | 2010-11-21 01:30:29 +0000 | [diff] [blame] | 255 | self.assertEqual(check_archive_formats(['gztar', 'xxx', 'zip']), |
| 256 | 'xxx') |
| 257 | self.assertEqual(check_archive_formats(['gztar', 'zip']), None) |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 258 | |
| 259 | def test_make_archive(self): |
| 260 | tmpdir = self.mkdtemp() |
| 261 | base_name = os.path.join(tmpdir, 'archive') |
| 262 | self.assertRaises(ValueError, make_archive, base_name, 'xxx') |
| 263 | |
Tarek Ziadé | 53fdb18 | 2009-10-24 13:42:10 +0000 | [diff] [blame] | 264 | def test_make_archive_cwd(self): |
| 265 | current_dir = os.getcwd() |
| 266 | def _breaks(*args, **kw): |
| 267 | raise RuntimeError() |
| 268 | ARCHIVE_FORMATS['xxx'] = (_breaks, [], 'xxx file') |
| 269 | try: |
| 270 | try: |
| 271 | make_archive('xxx', 'xxx', root_dir=self.mkdtemp()) |
| 272 | except: |
| 273 | pass |
Ezio Melotti | 19f2aeb | 2010-11-21 01:30:29 +0000 | [diff] [blame] | 274 | self.assertEqual(os.getcwd(), current_dir) |
Tarek Ziadé | 53fdb18 | 2009-10-24 13:42:10 +0000 | [diff] [blame] | 275 | finally: |
| 276 | del ARCHIVE_FORMATS['xxx'] |
| 277 | |
Tarek Ziadé | eb5f27e | 2009-05-17 12:12:02 +0000 | [diff] [blame] | 278 | def test_suite(): |
| 279 | return unittest.makeSuite(ArchiveUtilTestCase) |
| 280 | |
| 281 | if __name__ == "__main__": |
Éric Araujo | b344dd0 | 2011-02-02 21:38:37 +0000 | [diff] [blame] | 282 | run_unittest(test_suite()) |