diff --git a/distutils2/tests/test_command_sdist.py b/distutils2/tests/test_command_sdist.py --- a/distutils2/tests/test_command_sdist.py +++ b/distutils2/tests/test_command_sdist.py @@ -23,20 +23,6 @@ from distutils2.tests import support, un from distutils2.tests.support import requires_zlib -MANIFEST = """\ -# file GENERATED by distutils2, do NOT edit -inroot.txt -setup.cfg -data%(sep)sdata.dt -scripts%(sep)sscript.py -some%(sep)sfile.txt -some%(sep)sother_file.txt -somecode%(sep)s__init__.py -somecode%(sep)sdoc.dat -somecode%(sep)sdoc.txt -""" - - def builder(dist, filelist): filelist.append('bah') @@ -50,76 +36,54 @@ class SDistTestCase(support.TempdirManag def setUp(self): super(SDistTestCase, self).setUp() - self.tmp_dir = self.mkdtemp() - os.environ['HOME'] = self.tmp_dir - # setting up an environment - self.old_path = os.getcwd() - os.mkdir(join(self.tmp_dir, 'somecode')) - os.mkdir(join(self.tmp_dir, 'dist')) - # a package, and a README - self.write_file((self.tmp_dir, 'README'), 'xxx') - self.write_file((self.tmp_dir, 'somecode', '__init__.py'), '#') - os.chdir(self.tmp_dir) + os.environ['HOME'] = self.mkdtemp() + # create a minimal project with a Python package and a README + os.chdir(self.mkdtemp()) + os.mkdir('somecode') + self.write_file('README', 'xxx') + self.write_file(('somecode', '__init__.py'), '#') - def tearDown(self): - # back to normal - os.chdir(self.old_path) - super(SDistTestCase, self).tearDown() - - def get_cmd(self, metadata=None): - """Returns a cmd""" - if metadata is None: + def get_cmd(self, **metadata): + if not metadata: metadata = {'name': 'fake', 'version': '1.0', 'home_page': 'xxx', 'author': 'xxx', 'author_email': 'xxx'} dist = Distribution(metadata) dist.packages = ['somecode'] - dist.include_package_data = True cmd = sdist(dist) cmd.dist_dir = 'dist' return dist, cmd @requires_zlib def test_prune_file_list(self): - # this test creates a package with some vcs dirs in it - # and launch sdist to make sure they get pruned - # on all systems + # create a project with some VCS dirs in it and run sdist to make sure + # they get pruned on all systems # creating VCS directories with some files in them - os.mkdir(join(self.tmp_dir, 'somecode', '.svn')) - self.write_file((self.tmp_dir, 'somecode', '.svn', 'ok.py'), 'xxx') - - os.mkdir(join(self.tmp_dir, 'somecode', '.hg')) - self.write_file((self.tmp_dir, 'somecode', '.hg', - 'ok'), 'xxx') - - os.mkdir(join(self.tmp_dir, 'somecode', '.git')) - self.write_file((self.tmp_dir, 'somecode', '.git', - 'ok'), 'xxx') + for d in ('.svn', '.hg', '.git'): + os.mkdir(d) + self.write_file((d, 'ok'), 'xxx') # now building a sdist dist, cmd = self.get_cmd() - # zip is available universally - # (tar might not be installed under win32) + # always use zip, not the platform default cmd.formats = ['zip'] - cmd.ensure_finalized() cmd.run() # now let's check what we have - dist_folder = join(self.tmp_dir, 'dist') - files = os.listdir(dist_folder) - self.assertEqual(files, ['fake-1.0.zip']) + self.assertEqual(os.listdir('dist'), ['fake-1.0.zip']) - zip_file = zipfile.ZipFile(join(dist_folder, 'fake-1.0.zip')) + zip_file = zipfile.ZipFile(join('dist', 'fake-1.0.zip')) try: content = zip_file.namelist() finally: zip_file.close() # making sure everything has been pruned correctly - self.assertEqual(len(content), 2) + self.assertEqual(sorted(content), ['fake-1.0/PKG-INFO', + 'fake-1.0/somecode/__init__.py']) @requires_zlib @unittest.skipIf(find_executable('tar') is None or @@ -135,12 +99,11 @@ class SDistTestCase(support.TempdirManag cmd.run() # making sure we have two files - dist_folder = join(self.tmp_dir, 'dist') - result = sorted(os.listdir(dist_folder)) - self.assertEqual(result, ['fake-1.0.tar', 'fake-1.0.tar.gz']) + self.assertEqual(sorted(os.listdir('dist')), + ['fake-1.0.tar', 'fake-1.0.tar.gz']) - os.remove(join(dist_folder, 'fake-1.0.tar')) - os.remove(join(dist_folder, 'fake-1.0.tar.gz')) + os.remove(join('dist', 'fake-1.0.tar')) + os.remove(join('dist', 'fake-1.0.tar.gz')) # now trying a tar then a gztar cmd.formats = ['tar', 'gztar'] @@ -148,80 +111,91 @@ class SDistTestCase(support.TempdirManag cmd.ensure_finalized() cmd.run() - result = sorted(os.listdir(dist_folder)) - self.assertEqual(result, ['fake-1.0.tar', 'fake-1.0.tar.gz']) + self.assertEqual(sorted(os.listdir('dist')), + ['fake-1.0.tar', 'fake-1.0.tar.gz']) @requires_zlib def test_add_defaults(self): - - # http://bugs.python.org/issue2279 - - # add_default should also include - # data_files and package_data + # add_default should also include data_files and package_data, + # see #2279 dist, cmd = self.get_cmd() - # filling data_files by pointing files - # in package_data + # adding files and directories in package_data dist.package_data = {'': ['*.cfg', '*.dat'], 'somecode': ['*.txt']} - self.write_file((self.tmp_dir, 'setup.cfg'), '#') - self.write_file((self.tmp_dir, 'somecode', 'doc.txt'), '#') - self.write_file((self.tmp_dir, 'somecode', 'doc.dat'), '#') + # 'somecode.help': ['somecode/help/doc*']} + #os.makedirs(join('somecode', 'help', 'a')) + #os.makedirs(join('somecode', 'help', 'b')) + self.write_file('setup.cfg', '#') + self.write_file('setup.dat', '#') + # next one should not be picked + self.write_file('doc.txt', '#') + self.write_file(('somecode', 'doc.txt'), '#') + self.write_file(('somecode', 'doc.dat'), '#') # adding some data in data_files - data_dir = join(self.tmp_dir, 'data') - os.mkdir(data_dir) - self.write_file((data_dir, 'data.dt'), '#') - some_dir = join(self.tmp_dir, 'some') - os.mkdir(some_dir) - self.write_file((self.tmp_dir, 'inroot.txt'), '#') - self.write_file((some_dir, 'file.txt'), '#') - self.write_file((some_dir, 'other_file.txt'), '#') - dist.data_files = {'data/data.dt': '{appdata}/data.dt', 'inroot.txt': '{appdata}/inroot.txt', 'some/file.txt': '{appdata}/file.txt', 'some/other_file.txt': '{appdata}/other_file.txt'} + self.write_file('inroot.txt', '#') + os.mkdir('data') + self.write_file(('data', 'data.dt'), '#') + os.mkdir('some') + self.write_file(('some', 'file.txt'), '#') + self.write_file(('some', 'other_file.txt'), '#') # adding a script - script_dir = join(self.tmp_dir, 'scripts') - os.mkdir(script_dir) - self.write_file((script_dir, 'script.py'), '#') dist.scripts = [join('scripts', 'script.py')] + os.mkdir('scripts') + self.write_file(('scripts', 'script.py'), '#') + # run the command and check what we have cmd.formats = ['zip'] cmd.use_defaults = True - cmd.ensure_finalized() cmd.run() - # now let's check what we have - dist_folder = join(self.tmp_dir, 'dist') - files = os.listdir(dist_folder) - self.assertEqual(files, ['fake-1.0.zip']) + self.assertEqual(os.listdir('dist'), ['fake-1.0.zip']) - zip_file = zipfile.ZipFile(join(dist_folder, 'fake-1.0.zip')) + # list used to check the manifest and the content of the zip file + files = ['setup.cfg', + 'inroot.txt', + join('data', 'data.dt'), + join('scripts', 'script.py'), + join('some', 'file.txt'), + join('some', 'other_file.txt'), + join('somecode', '__init__.py'), + join('somecode', 'doc.dat'), + join('somecode', 'doc.txt'), + ] + + # make sure everything was added + zip_file = zipfile.ZipFile(join('dist', 'fake-1.0.zip')) try: content = zip_file.namelist() finally: zip_file.close() - # Making sure everything was added. This includes 8 code and data - # files in addition to PKG-INFO and setup.cfg - self.assertEqual(len(content), 10) + wanted = [join('fake-1.0', 'PKG-INFO')] + wanted += [join('fake-1.0', fn) for fn in files] + self.assertEqual(sorted(content), sorted(wanted)) - # Checking the MANIFEST - fp = open(join(self.tmp_dir, 'MANIFEST')) + # check the MANIFEST + fp = open('MANIFEST') try: - manifest = fp.read() + manifest = fp.read().splitlines() finally: fp.close() - self.assertEqual(manifest, MANIFEST % {'sep': os.sep}) + + # the comment must be on the first line, then order doesn't matter + self.assertEqual(manifest[0], + '# file GENERATED by distutils2, do NOT edit') + self.assertEqual(sorted(manifest[1:]), sorted(files)) @requires_zlib - def test_metadata_check_option(self): - # testing the `check-metadata` option - dist, cmd = self.get_cmd(metadata={'name': 'xxx', 'version': 'xxx'}) + def test_check_metadata_option(self): + dist, cmd = self.get_cmd(name='xxx', version='xxx') # this should cause the check subcommand to log two warnings: # version is invalid, home-page and author are missing @@ -282,7 +256,7 @@ class SDistTestCase(support.TempdirManag dist, cmd = self.get_cmd() dist.extra_files = ['include yeah'] cmd.ensure_finalized() - self.write_file((self.tmp_dir, 'yeah'), 'xxx') + self.write_file('yeah', 'xxx') cmd.run() f = open(cmd.manifest) try: @@ -309,7 +283,7 @@ class SDistTestCase(support.TempdirManag cmd.run() # making sure we have the good rights - archive_name = join(self.tmp_dir, 'dist', 'fake-1.0.tar.gz') + archive_name = join('dist', 'fake-1.0.tar.gz') archive = tarfile.open(archive_name) try: for member in archive.getmembers(): @@ -327,7 +301,7 @@ class SDistTestCase(support.TempdirManag cmd.run() # making sure we have the good rights - archive_name = join(self.tmp_dir, 'dist', 'fake-1.0.tar.gz') + archive_name = join('dist', 'fake-1.0.tar.gz') archive = tarfile.open(archive_name) try: # note that we are not testing the group ownership here @@ -344,7 +318,7 @@ class SDistTestCase(support.TempdirManag dist, cmd = self.get_cmd() # filling data_files by pointing files in package_data dist.package_data = {'somecode': ['*.txt']} - self.write_file((self.tmp_dir, 'somecode', 'doc.txt'), '#') + self.write_file(('somecode', 'doc.txt'), '#') cmd.ensure_finalized() cmd.run() @@ -359,7 +333,7 @@ class SDistTestCase(support.TempdirManag self.assertEqual(len(manifest), 3) # Adding a file - self.write_file((self.tmp_dir, 'somecode', 'doc2.txt'), '#') + self.write_file(('somecode', 'doc2.txt'), '#') # make sure build_py is reinitialized, like a fresh run build_py = dist.get_command_obj('build_py') @@ -401,7 +375,7 @@ class SDistTestCase(support.TempdirManag # check that a MANIFEST without a marker is left alone dist, cmd = self.get_cmd() cmd.ensure_finalized() - self.write_file((self.tmp_dir, cmd.manifest), 'README.manual') + self.write_file(cmd.manifest, 'README.manual') cmd.run() f = open(cmd.manifest)