| """Tests for distutils.archive_util.""" |
| import unittest |
| import os |
| import tarfile |
| from os.path import splitdrive |
| import warnings |
| |
| from distutils import archive_util |
| from distutils.archive_util import (check_archive_formats, make_tarball, |
| make_zipfile, make_archive, |
| ARCHIVE_FORMATS) |
| from distutils.spawn import find_executable, spawn |
| from distutils.tests import support |
| from test.support import check_warnings, run_unittest, patch |
| |
| try: |
| import zipfile |
| ZIP_SUPPORT = True |
| except ImportError: |
| ZIP_SUPPORT = find_executable('zip') |
| |
| try: |
| import zlib |
| ZLIB_SUPPORT = True |
| except ImportError: |
| ZLIB_SUPPORT = False |
| |
| |
| class ArchiveUtilTestCase(support.TempdirManager, |
| support.LoggingSilencer, |
| unittest.TestCase): |
| |
| @unittest.skipUnless(ZLIB_SUPPORT, 'Need zlib support to run') |
| def test_make_tarball(self): |
| # creating something to tar |
| tmpdir = self.mkdtemp() |
| self.write_file([tmpdir, 'file1'], 'xxx') |
| self.write_file([tmpdir, 'file2'], 'xxx') |
| os.mkdir(os.path.join(tmpdir, 'sub')) |
| self.write_file([tmpdir, 'sub', 'file3'], 'xxx') |
| |
| tmpdir2 = self.mkdtemp() |
| unittest.skipUnless(splitdrive(tmpdir)[0] == splitdrive(tmpdir2)[0], |
| "Source and target should be on same drive") |
| |
| base_name = os.path.join(tmpdir2, 'archive') |
| |
| # working with relative paths to avoid tar warnings |
| old_dir = os.getcwd() |
| os.chdir(tmpdir) |
| try: |
| make_tarball(splitdrive(base_name)[1], '.') |
| finally: |
| os.chdir(old_dir) |
| |
| # check if the compressed tarball was created |
| tarball = base_name + '.tar.gz' |
| self.assertTrue(os.path.exists(tarball)) |
| |
| # trying an uncompressed one |
| base_name = os.path.join(tmpdir2, 'archive') |
| old_dir = os.getcwd() |
| os.chdir(tmpdir) |
| try: |
| make_tarball(splitdrive(base_name)[1], '.', compress=None) |
| finally: |
| os.chdir(old_dir) |
| tarball = base_name + '.tar' |
| self.assertTrue(os.path.exists(tarball)) |
| |
| def _tarinfo(self, path): |
| tar = tarfile.open(path) |
| try: |
| names = tar.getnames() |
| names.sort() |
| return tuple(names) |
| finally: |
| tar.close() |
| |
| def _create_files(self): |
| # creating something to tar |
| tmpdir = self.mkdtemp() |
| dist = os.path.join(tmpdir, 'dist') |
| os.mkdir(dist) |
| self.write_file([dist, 'file1'], 'xxx') |
| self.write_file([dist, 'file2'], 'xxx') |
| os.mkdir(os.path.join(dist, 'sub')) |
| self.write_file([dist, 'sub', 'file3'], 'xxx') |
| os.mkdir(os.path.join(dist, 'sub2')) |
| tmpdir2 = self.mkdtemp() |
| base_name = os.path.join(tmpdir2, 'archive') |
| return tmpdir, tmpdir2, base_name |
| |
| @unittest.skipUnless(find_executable('tar') and find_executable('gzip') |
| and ZLIB_SUPPORT, |
| 'Need the tar, gzip and zlib command to run') |
| def test_tarfile_vs_tar(self): |
| tmpdir, tmpdir2, base_name = self._create_files() |
| old_dir = os.getcwd() |
| os.chdir(tmpdir) |
| try: |
| make_tarball(base_name, 'dist') |
| finally: |
| os.chdir(old_dir) |
| |
| # check if the compressed tarball was created |
| tarball = base_name + '.tar.gz' |
| self.assertTrue(os.path.exists(tarball)) |
| |
| # now create another tarball using `tar` |
| tarball2 = os.path.join(tmpdir, 'archive2.tar.gz') |
| tar_cmd = ['tar', '-cf', 'archive2.tar', 'dist'] |
| gzip_cmd = ['gzip', '-f9', 'archive2.tar'] |
| old_dir = os.getcwd() |
| os.chdir(tmpdir) |
| try: |
| spawn(tar_cmd) |
| spawn(gzip_cmd) |
| finally: |
| os.chdir(old_dir) |
| |
| self.assertTrue(os.path.exists(tarball2)) |
| # let's compare both tarballs |
| self.assertEqual(self._tarinfo(tarball), self._tarinfo(tarball2)) |
| |
| # trying an uncompressed one |
| base_name = os.path.join(tmpdir2, 'archive') |
| old_dir = os.getcwd() |
| os.chdir(tmpdir) |
| try: |
| make_tarball(base_name, 'dist', compress=None) |
| finally: |
| os.chdir(old_dir) |
| tarball = base_name + '.tar' |
| self.assertTrue(os.path.exists(tarball)) |
| |
| # now for a dry_run |
| base_name = os.path.join(tmpdir2, 'archive') |
| old_dir = os.getcwd() |
| os.chdir(tmpdir) |
| try: |
| make_tarball(base_name, 'dist', compress=None, dry_run=True) |
| finally: |
| os.chdir(old_dir) |
| tarball = base_name + '.tar' |
| self.assertTrue(os.path.exists(tarball)) |
| |
| @unittest.skipUnless(find_executable('compress'), |
| 'The compress program is required') |
| def test_compress_deprecated(self): |
| tmpdir, tmpdir2, base_name = self._create_files() |
| |
| # using compress and testing the PendingDeprecationWarning |
| old_dir = os.getcwd() |
| os.chdir(tmpdir) |
| try: |
| with check_warnings() as w: |
| warnings.simplefilter("always") |
| make_tarball(base_name, 'dist', compress='compress') |
| finally: |
| os.chdir(old_dir) |
| tarball = base_name + '.tar.Z' |
| self.assertTrue(os.path.exists(tarball)) |
| self.assertEqual(len(w.warnings), 1) |
| |
| # same test with dry_run |
| os.remove(tarball) |
| old_dir = os.getcwd() |
| os.chdir(tmpdir) |
| try: |
| with check_warnings() as w: |
| warnings.simplefilter("always") |
| make_tarball(base_name, 'dist', compress='compress', |
| dry_run=True) |
| finally: |
| os.chdir(old_dir) |
| self.assertTrue(not os.path.exists(tarball)) |
| self.assertEqual(len(w.warnings), 1) |
| |
| @unittest.skipUnless(ZIP_SUPPORT and ZLIB_SUPPORT, |
| 'Need zip and zlib support to run') |
| def test_make_zipfile(self): |
| # creating something to tar |
| tmpdir = self.mkdtemp() |
| self.write_file([tmpdir, 'file1'], 'xxx') |
| self.write_file([tmpdir, 'file2'], 'xxx') |
| |
| tmpdir2 = self.mkdtemp() |
| base_name = os.path.join(tmpdir2, 'archive') |
| make_zipfile(base_name, tmpdir) |
| |
| # check if the compressed tarball was created |
| tarball = base_name + '.zip' |
| self.assertTrue(os.path.exists(tarball)) |
| |
| @unittest.skipUnless(ZIP_SUPPORT, 'Need zip support to run') |
| def test_make_zipfile_no_zlib(self): |
| patch(self, archive_util.zipfile, 'zlib', None) # force zlib ImportError |
| |
| called = [] |
| zipfile_class = zipfile.ZipFile |
| def fake_zipfile(*a, **kw): |
| if kw.get('compression', None) == zipfile.ZIP_STORED: |
| called.append((a, kw)) |
| return zipfile_class(*a, **kw) |
| |
| patch(self, archive_util.zipfile, 'ZipFile', fake_zipfile) |
| |
| # create something to tar and compress |
| tmpdir, tmpdir2, base_name = self._create_files() |
| make_zipfile(base_name, tmpdir) |
| |
| tarball = base_name + '.zip' |
| self.assertEqual(called, |
| [((tarball, "w"), {'compression': zipfile.ZIP_STORED})]) |
| self.assertTrue(os.path.exists(tarball)) |
| |
| def test_check_archive_formats(self): |
| self.assertEqual(check_archive_formats(['gztar', 'xxx', 'zip']), |
| 'xxx') |
| self.assertEqual(check_archive_formats(['gztar', 'zip']), None) |
| |
| def test_make_archive(self): |
| tmpdir = self.mkdtemp() |
| base_name = os.path.join(tmpdir, 'archive') |
| self.assertRaises(ValueError, make_archive, base_name, 'xxx') |
| |
| def test_make_archive_cwd(self): |
| current_dir = os.getcwd() |
| def _breaks(*args, **kw): |
| raise RuntimeError() |
| ARCHIVE_FORMATS['xxx'] = (_breaks, [], 'xxx file') |
| try: |
| try: |
| make_archive('xxx', 'xxx', root_dir=self.mkdtemp()) |
| except: |
| pass |
| self.assertEqual(os.getcwd(), current_dir) |
| finally: |
| del ARCHIVE_FORMATS['xxx'] |
| |
| def test_suite(): |
| return unittest.makeSuite(ArchiveUtilTestCase) |
| |
| if __name__ == "__main__": |
| run_unittest(test_suite()) |