Merged in philip_thiem/setuptools (pull request #24)

Issue #101 and tweak legacy fallback

Author: jaraco

setuptools/svn_utils.py

@@ -219,7 +219,13 @@ def get_svn_version():
     def load(cls, dirname=''):
         normdir = os.path.normpath(dirname)
         code, data = _run_command(['svn', 'info', normdir])
-        has_svn = os.path.isdir(os.path.join(normdir, '.svn'))
+        # Must check for some contents, as some use empty directories
+        # in testcases
+        svn_dir = os.path.join(normdir, '.svn')
+        has_svn = (os.path.isfile(os.path.join(svn_dir, 'entries')) or
+                   os.path.isfile(os.path.join(svn_dir, 'dir-props')) or
+                   os.path.isfile(os.path.join(svn_dir, 'dir-prop-base')))
+
         svn_version = tuple(cls.get_svn_version().split('.'))
 
         try:
@@ -229,7 +235,6 @@ def load(cls, dirname=''):
 
         if has_svn and (code or not base_svn_version 
                              or base_svn_version < (1, 3)):
-            log.warn('Fallback onto .svn parsing')
             warnings.warn(("No SVN 1.3+ command found: falling back "
                            "on pre 1.7 .svn parsing"), DeprecationWarning)
             return SvnFileInfo(dirname)

setuptools/tests/environment.py

@@ -5,6 +5,9 @@
 import unittest
 import shutil
 import stat
+import unicodedata
+
+from subprocess import Popen as _Popen, PIPE as _PIPE
 
 
 def _extract(self, member, path=None, pwd=None):
@@ -25,13 +28,14 @@ def _extract_from_zip(self, name, dest_path):
     finally:
         dest_file.close()
 
+
 def _extract_member(self, member, targetpath, pwd):
     """for zipfile py2.5 borrowed from cpython"""
     # build the destination pathname, replacing
     # forward slashes to platform specific separators.
     # Strip trailing path separator, unless it represents the root.
     if (targetpath[-1:] in (os.path.sep, os.path.altsep)
-        and len(os.path.splitdrive(targetpath)[1]) > 1):
+            and len(os.path.splitdrive(targetpath)[1]) > 1):
         targetpath = targetpath[:-1]
 
     # don't include leading "/" from file name if present
@@ -102,3 +106,53 @@ def tearDown(self):
             #sigh?
             pass
 
+
+def _which_dirs(cmd):
+    result = set()
+    for path in os.environ.get('PATH', '').split(os.pathsep):
+        filename = os.path.join(path, cmd)
+        if os.access(filename, os.X_OK):
+            result.add(path)
+    return result
+
+
+def run_setup_py(cmd, pypath=None, path=None,
+                 data_stream=0, env=None):
+    """
+    Execution command for tests, separate from those used by the
+    code directly to prevent accidental behavior issues
+    """
+    if env is None:
+        env = dict()
+        for envname in os.environ:
+            env[envname] = os.environ[envname]
+
+    #override the python path if needed
+    if pypath is not None:
+        env["PYTHONPATH"] = pypath
+
+    #overide the execution path if needed
+    if path is not None:
+        env["PATH"] = path
+    if not env.get("PATH", ""):
+        env["PATH"] = _which_dirs("tar").union(_which_dirs("gzip"))
+        env["PATH"] = os.pathsep.join(env["PATH"])
+
+    cmd = [sys.executable, "setup.py"] + list(cmd)
+
+    #regarding the shell argument, see: http://bugs.python.org/issue8557
+    try:
+        proc = _Popen(cmd, stdout=_PIPE, stderr=_PIPE,
+                      shell=(sys.platform == 'win32'), env=env)
+
+        data = proc.communicate()[data_stream]
+    except OSError:
+        return 1, ''
+
+    #decode the console string if needed
+    if hasattr(data,  "decode"):
+        data = data.decode()  # should use the preffered encoding
+        data = unicodedata.normalize('NFC', data)
+
+    #communciate calls wait()
+    return proc.returncode, data

setuptools/tests/svn_data/dummy.zip

@@ -1,16 +1,20 @@
+
 import os
 import sys
 import tempfile
 import shutil
 import unittest
 
 import pkg_resources
+import warnings
 from setuptools.command import egg_info
+from setuptools.tests import environment
 from setuptools import svn_utils
 
 ENTRIES_V10 = pkg_resources.resource_string(__name__, 'entries-v10')
 "An entries file generated with svn 1.6.17 against the legacy Setuptools repo"
 
+
 class TestEggInfo(unittest.TestCase):
 
     def setUp(self):
@@ -37,7 +41,7 @@ def test_version_10_format(self):
         #to ensure I return using svnversion what would had been returned
         version_str = svn_utils.SvnInfo.get_svn_version()
         version = [int(x) for x in version_str.split('.')[:2]]
-        if version != [1,6]:
+        if version != [1, 6]:
             if hasattr(self, 'skipTest'):
                 self.skipTest('')
             else:
@@ -61,14 +65,104 @@ def test_version_10_format_legacy_parser(self):
 
         old_path = os.environ[path_variable]
         os.environ[path_variable] = ''
+        #catch_warnings not available until py26
+        warning_filters = warnings.filters
+        warnings.filters = warning_filters[:]
         try:
+            warnings.simplefilter("ignore", DeprecationWarning)
             self._write_entries(ENTRIES_V10)
             rev = egg_info.egg_info.get_svn_revision()
         finally:
+            #restore the warning filters
+            warnings.filters = warning_filters
+            #restore the os path
             os.environ[path_variable] = old_path
 
         self.assertEqual(rev, '89000')
 
+DUMMY_SOURCE_TXT = """CHANGES.txt
+CONTRIBUTORS.txt
+HISTORY.txt
+LICENSE
+MANIFEST.in
+README.txt
+setup.py
+dummy/__init__.py
+dummy/test.txt
+dummy.egg-info/PKG-INFO
+dummy.egg-info/SOURCES.txt
+dummy.egg-info/dependency_links.txt
+dummy.egg-info/top_level.txt"""
+
+
+class TestSvnDummy(environment.ZippedEnvironment):
+
+    def setUp(self):
+        version = svn_utils.SvnInfo.get_svn_version()
+        self.base_version = tuple([int(x) for x in version.split('.')][:2])
+
+        if not self.base_version:
+            raise ValueError('No SVN tools installed')
+        elif self.base_version < (1, 3):
+            raise ValueError('Insufficient SVN Version %s' % version)
+        elif self.base_version >= (1, 9):
+            #trying the latest version
+            self.base_version = (1, 8)
+
+        self.dataname = "dummy%i%i" % self.base_version
+        self.datafile = os.path.join('setuptools', 'tests',
+                                     'svn_data', self.dataname + ".zip")
+        super(TestSvnDummy, self).setUp()
+
+    def test_sources(self):
+        code, data = environment.run_setup_py(["sdist"],
+                                              pypath=self.old_cwd,
+                                              data_stream=1)
+        if code:
+            raise AssertionError(data)
+
+        sources = os.path.join('dummy.egg-info', 'SOURCES.txt')
+        infile = open(sources, 'r')
+        try:
+            read_contents = infile.read()
+        finally:
+            infile.close()
+            del infile
+
+        self.assertEqual(DUMMY_SOURCE_TXT, read_contents)
+
+        return data
+
+
+class TestSvnDummyLegacy(environment.ZippedEnvironment):
+
+    def setUp(self):
+        self.base_version = (1, 6)
+        self.dataname = "dummy%i%i" % self.base_version
+        self.datafile = os.path.join('setuptools', 'tests',
+                                     'svn_data', self.dataname + ".zip")
+        super(TestSvnDummyLegacy, self).setUp()
+
+    def test_sources(self):
+        code, data = environment.run_setup_py(["sdist"],
+                                              pypath=self.old_cwd,
+                                              path="",
+                                              data_stream=1)
+        if code:
+            raise AssertionError(data)
+
+        sources = os.path.join('dummy.egg-info', 'SOURCES.txt')
+        infile = open(sources, 'r')
+        try:
+            read_contents = infile.read()
+        finally:
+            infile.close()
+            del infile
+
+        self.assertEqual(DUMMY_SOURCE_TXT, read_contents)
+
+        return data
+
 
 def test_suite():
     return unittest.defaultTestLoader.loadTestsFromName(__name__)