Replace allow_symlinks with follow_symlinks

    * Test that resource_iter can follow symlinks

Signed-off-by: Jono Yang <jyang@nexb.com>

Author: JonoYang

src/commoncode/filetype.py

@@ -45,22 +45,22 @@ def is_link(location):
     return location and os.path.islink(location)
 
 
-def is_file(location, allow_symlinks=False):
+def is_file(location, follow_symlinks=False):
     """
     Return True if `location` is a file.
     """
     _is_file = location and os.path.isfile(location)
-    if allow_symlinks:
+    if follow_symlinks:
         return _is_file
     return _is_file and not is_link(location) and not is_broken_link(location)
 
 
-def is_dir(location, allow_symlinks=False):
+def is_dir(location, follow_symlinks=False):
     """
     Return True if `location` is a directory.
     """
     _is_dir = location and os.path.isdir(location) and not is_file(location)
-    if allow_symlinks:
+    if follow_symlinks:
         return _is_dir
     return _is_dir and not is_link(location) and not is_broken_link(location)
 

src/commoncode/fileutils.py

@@ -365,18 +365,18 @@ def ignore_nothing(_):
     return False
 
 
-def walk(location, ignored=None, allow_symlinks=False):
+def walk(location, ignored=None, follow_symlinks=False):
     """
     Walk location returning the same tuples as os.walk but with a different
     behavior:
      - always walk top-down, breadth-first.
-     - always ignore and never follow symlinks (unless `allow_symlinks` is True),
+     - always ignore and never follow symlinks (unless `follow_symlinks` is True),
      - always ignore special files (FIFOs, etc.)
      - optionally ignore files and directories by invoking the `ignored`
        callable on files and directories returning True if it should be ignored.
      - location is a directory or a file: for a file, the file is returned.
 
-    If `allow_symlinks` is True, then symlinks will not be ignored and be
+    If `follow_symlinks` is True, then symlinks will not be ignored and be
     collected like regular files and directories
     """
     if on_linux and py2:
@@ -390,17 +390,17 @@ def walk(location, ignored=None, allow_symlinks=False):
             logger_debug('walk: ignored:', location, is_ignored)
         return
 
-    if filetype.is_file(location, allow_symlinks=allow_symlinks) :
+    if filetype.is_file(location, follow_symlinks=follow_symlinks) :
         yield parent_directory(location), [], [file_name(location)]
 
-    elif filetype.is_dir(location, allow_symlinks=allow_symlinks):
+    elif filetype.is_dir(location, follow_symlinks=follow_symlinks):
         dirs = []
         files = []
         # TODO: consider using scandir
         for name in os.listdir(location):
             loc = os.path.join(location, name)
             if filetype.is_special(loc) or (ignored and ignored(loc)):
-                if (allow_symlinks
+                if (follow_symlinks
                         and filetype.is_link(loc)
                         and not filetype.is_broken_link(location)):
                     pass
@@ -410,18 +410,18 @@ def walk(location, ignored=None, allow_symlinks=False):
                         logger_debug('walk: ignored:', loc, ign)
                     continue
             # special files and symlinks are always ignored
-            if filetype.is_dir(loc, allow_symlinks=allow_symlinks):
+            if filetype.is_dir(loc, follow_symlinks=follow_symlinks):
                 dirs.append(name)
-            elif filetype.is_file(loc, allow_symlinks=allow_symlinks):
+            elif filetype.is_file(loc, follow_symlinks=follow_symlinks):
                 files.append(name)
         yield location, dirs, files
 
         for dr in dirs:
-            for tripple in walk(os.path.join(location, dr), ignored, allow_symlinks=allow_symlinks):
+            for tripple in walk(os.path.join(location, dr), ignored, follow_symlinks=follow_symlinks):
                 yield tripple
 
 
-def resource_iter(location, ignored=ignore_nothing, with_dirs=True, allow_symlinks=False):
+def resource_iter(location, ignored=ignore_nothing, with_dirs=True, follow_symlinks=False):
     """
     Return an iterable of paths at `location` recursively.
 
@@ -432,7 +432,7 @@ def resource_iter(location, ignored=ignore_nothing, with_dirs=True, allow_symlin
     """
     if on_linux and py2:
         location = fsencode(location)
-    for top, dirs, files in walk(location, ignored, allow_symlinks=allow_symlinks):
+    for top, dirs, files in walk(location, ignored, follow_symlinks=follow_symlinks):
         if with_dirs:
             for d in dirs:
                 yield os.path.join(top, d)

tests/commoncode/data/symlink/walk/a

@@ -220,14 +220,14 @@ def test_is_file(self):
         temp_dir = fileutils.get_temp_dir()
         test_link = join(temp_dir, 'test-link')
         os.symlink(test_file, test_link)
-        assert filetype.is_file(test_link, allow_symlinks=True)
-        assert not filetype.is_file(test_link, allow_symlinks=False)
+        assert filetype.is_file(test_link, follow_symlinks=True)
+        assert not filetype.is_file(test_link, follow_symlinks=False)
 
     @skipIf(on_windows, 'os.symlink does not work on Windows')
     def test_is_dir(self):
         test_dir = self.get_test_loc('symlink', copy=True)
         temp_dir = fileutils.get_temp_dir()
         test_link = join(temp_dir, 'test-dir-link')
         os.symlink(test_dir, test_link)
-        assert filetype.is_dir(test_link, allow_symlinks=True)
-        assert not filetype.is_dir(test_link, allow_symlinks=False)
+        assert filetype.is_dir(test_link, follow_symlinks=True)
+        assert not filetype.is_dir(test_link, follow_symlinks=False)

tests/commoncode/data/symlink/walk/dir/b

@@ -386,17 +386,17 @@ def test_os_walk_can_walk_non_utf8_path_from_unicode_path(self):
 
     @skipIf(on_windows, 'os.symlink does not work on Windows')
     def test_walk_on_symlinks(self):
-        test_dir = self.get_test_loc('symlink', copy=True)
+        test_dir = self.get_test_loc('symlink/walk', copy=True)
         temp_dir = fileutils.get_temp_dir()
         test_link = join(temp_dir, 'test-dir-link')
         os.symlink(test_dir, test_link)
-        results = list(fileutils.walk(test_link, allow_symlinks=True))
-        assert len(results) == 1
-        top, dirs, files = results[0]
-        top = os.path.basename(top)
-        assert 'test-dir-link' == top
-        assert [] == dirs
-        assert ['test'] == files
+        results = list(fileutils.walk(test_link, follow_symlinks=True))
+        results = [(os.path.basename(top), dirs, files) for top, dirs, files in results]
+        expected = [
+            ('test-dir-link', ['dir'], ['a']),
+            ('dir', [], ['b'])
+        ]
+        assert expected == results
 
 
 class TestFileUtilsIter(FileBasedTesting):
@@ -567,6 +567,19 @@ def test_resource_iter_can_walk_non_utf8_path_from_unicode_path(self):
         result = list(fileutils.resource_iter(test_dir, with_dirs=False))
         assert 18 == len(result)
 
+    def test_resource_iter_follow_symlinks(self):
+        test_dir = self.get_test_loc('symlink/walk', copy=True)
+        temp_dir = fileutils.get_temp_dir()
+        test_link = join(temp_dir, 'test-dir-link')
+        os.symlink(test_dir, test_link)
+        result = [os.path.basename(f) for f in fileutils.resource_iter(test_dir, follow_symlinks=True)]
+        expected = [
+            'dir',
+            'a',
+            'b'
+        ]
+        assert sorted(expected) == sorted(result)
+
 
 class TestBaseName(FileBasedTesting):
     test_data_dir = os.path.join(os.path.dirname(__file__), 'data')