Add more debugging messages to shebangs check

Author: Michal Cyprian

taskotron_python_versions/unversioned_shebangs.py

@@ -38,9 +38,15 @@ def get_problematic_files(archive, query):
     return problematic
 
 
-def shebang_to_require(shebang):
-    """Convert shebang to the format of requirement."""
-    return shebang.split()[0][2:].encode()
+def shebang_to_require(shebang, use_bytes=True):
+    """Convert shebang to the format of requirement.
+    If the use_bytes argument is set to False, executable path
+    is returned as a string instead of the default bytes type."""
+    executable_path = shebang.split()[0][2:]
+    if use_bytes:
+        return executable_path.encode()
+    else:
+        return executable_path
 
 
 def get_scripts_summary(package):
@@ -52,8 +58,13 @@ def get_scripts_summary(package):
 
     for shebang in FORBIDDEN_SHEBANGS:
         if shebang_to_require(shebang) in package.require_names:
+            log.debug('Package {} requires {}'.format(
+                package.filename, shebang_to_require(
+                    shebang, use_bytes=False)))
             problematic = get_problematic_files(package.path, shebang)
             if problematic:
+                log.debug('{} shebang was found in scripts: {}'.format(
+                    shebang, ', '.join(problematic)))
                 scripts_summary[shebang] = problematic
     return scripts_summary
 

test/functional/test_unversioned_shebangs.py

@@ -40,13 +40,15 @@ def test_get_problematic_files(archive, query, expected):
     assert get_problematic_files(gpkg_path(archive), query) == expected
 
 
-@pytest.mark.parametrize(('shebang', 'expected'), (
-    ("#!/foo", b"/foo"),
-    ("#!/usr/bin/python", b"/usr/bin/python"),
-    ("#!/usr/bin/env python", b"/usr/bin/env"),
+@pytest.mark.parametrize(('shebang', 'use_bytes', 'expected'), (
+    ("#!/foo", True, b"/foo"),
+    ("#!/usr/bin/python", True, b"/usr/bin/python"),
+    ("#!/usr/bin/env python", True, b"/usr/bin/env"),
+    ("#!/usr/bin/python", False, "/usr/bin/python"),
+    ("#!/usr/bin/env python", False, "/usr/bin/env"),
 ))
-def test_shebang_to_require(shebang, expected):
-    assert shebang_to_require(shebang) == expected
+def test_shebang_to_require(shebang, use_bytes, expected):
+    assert shebang_to_require(shebang, use_bytes) == expected
 
 
 @pytest.mark.parametrize(('glob', 'expected'), (