[tor-commits] [stem/master] Setuptools creates a dist directory

[atagar at torproject.org]

commit c132bf038a2bf547f32311a2efed7bb5e0ae35a2
Author: Damian Johnson <atagar at torproject.org>
Date:   Mon Mar 30 19:56:03 2020 -0700

    Setuptools creates a dist directory
    
    Unfortunately setuptools creates a superfluous 'dist' directory that isn't
    removed with clean...
    
      https://github.com/pypa/setuptools/issues/1347
    
    Working around the test failure it causes...
    
      ======================================================================
      FAIL: test_sdist
      ----------------------------------------------------------------------
      Traceback (most recent call last):
        File "/home/atagar/Desktop/stem/stem/util/test_tools.py", line 141, in <lambda>
          self.method = lambda test: self.result(test)  # method that can be mixed into TestCases
        File "/home/atagar/Desktop/stem/stem/util/test_tools.py", line 208, in result
          test.fail(self._result.msg)
      AssertionError: /home/atagar/Desktop/stem/dist already exists, maybe you manually ran 'python setup.py sdist'?
---
 test/integ/installation.py | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/test/integ/installation.py b/test/integ/installation.py
index 55906288..39b604bb 100644
--- a/test/integ/installation.py
+++ b/test/integ/installation.py
@@ -96,6 +96,9 @@ class TestInstallation(unittest.TestCase):
       if os.path.exists(BASE_INSTALL_PATH):
         shutil.rmtree(BASE_INSTALL_PATH)
 
+      if os.path.exists(DIST_PATH):
+        shutil.rmtree(DIST_PATH)
+
   @asynchronous
   def test_sdist(dependency_pid):
     """
@@ -114,9 +117,6 @@ class TestInstallation(unittest.TestCase):
     elif not os.path.exists(git_dir):
       raise unittest.case.SkipTest('(not a git checkout)')
 
-    if os.path.exists(DIST_PATH):
-      raise AssertionError("%s already exists, maybe you manually ran 'python setup.py sdist'?" % DIST_PATH)
-
     try:
       try:
         stem.util.system.call('%s setup.py sdist --dryrun' % PYTHON_EXE, timeout = 60, cwd = test.STEM_BASE)
@@ -127,7 +127,12 @@ class TestInstallation(unittest.TestCase):
 
       # tarball has a prefix 'stem-[verion]' directory so stipping that out
 
-      with tarfile.open(os.path.join(DIST_PATH, 'stem-dry-run-%s.tar.gz' % stem.__version__)) as dist_tar:
+      dist_content = glob.glob('%s/*' % DIST_PATH)
+
+      if len(dist_content) != 1:
+        raise AssertionError('We should only have a single file in our dist directory, but instead had: %s' % ', '.join(dist_content))
+
+      with tarfile.open(dist_content[0]) as dist_tar:
         tar_contents = ['/'.join(info.name.split('/')[1:]) for info in dist_tar.getmembers() if info.isfile()]
 
       issues = []
@@ -137,7 +142,7 @@ class TestInstallation(unittest.TestCase):
           issues.append('  * %s is missing from our release tarball' % path)
 
       for path in tar_contents:
-        if path not in git_contents and path not in ['MANIFEST.in', 'PKG-INFO']:
+        if path not in git_contents and path not in ['MANIFEST.in', 'PKG-INFO', 'setup.cfg'] and not path.startswith('stem_dry_run.egg-info'):
           issues.append("  * %s isn't expected in our release tarball" % path)
 
       if issues: