Handle case-senstive dir/file paths by using pathlib.Path

Author: sschulz92

build.py

@@ -115,8 +115,9 @@ def run_tests() -> int:
     for i, file_name_path in enumerate(all_python_test_files):
         command = ["coverage", "run", file_name_path]
         exit_code = call(command) if exit_code == 0 else exit_code
-        # Keep coverage files
-        os.rename(".coverage", f".coverage.{i}")
+        if Path(".coverage").is_file():
+            # Keep coverage files
+            os.rename(".coverage", f".coverage.{i}")
     call(["coverage", "combine"])
     return exit_code
 

getgauge/impl_loader.py

@@ -1,3 +1,4 @@
+import glob
 import importlib
 import inspect
 import json
@@ -58,12 +59,8 @@ def copy_skel_files():
 
 
 def _import_impl(base_dir, step_impl_dir):
-    for f in os.listdir(step_impl_dir):
-        file_path = os.path.join(step_impl_dir, f)
-        if f.endswith('.py'):
-            _import_file(base_dir, file_path)
-        elif path.isdir(file_path):
-            _import_impl(base_dir, file_path)
+    for python_file in glob.glob(f"{step_impl_dir}/**/*.py", recursive=True):
+        _import_file(base_dir, python_file)
 
 @contextmanager
 def use_temporary_sys_path():
@@ -88,15 +85,17 @@ def _import_file(base_dir, file_path):
         classes = inspect.getmembers(m, lambda member: inspect.isclass(member) and member.__module__ == module_name)
         if len(classes) > 0:
             for c in classes:
-                file = inspect.getfile(c[1])
-                # Create instance of step implementation class.
-                if _has_methods_with_gauge_decoratores(c[1]):
-                    update_step_registry_with_class(c[1](), file_path) # c[1]() will create a new instance of the class
+                class_obj = c[1]
+                if _has_methods_with_gauge_decoratores(class_obj):
+                    update_step_registry_with_class(
+                        instance=class_obj(), # class_obj() will create a new instance of the class
+                        file_path=file_path
+                    )
     except:
         logger.fatal('Exception occurred while loading step implementations from file: {}.\n{}'.format(rel_path, traceback.format_exc()))
 
-# Inject instance in each class method (hook/step)
 def update_step_registry_with_class(instance, file_path):
+    """ Inject instance in each class method (hook/step) """
     # Resolve the absolute path from relative path
     # Note: relative path syntax ".." can appear in between the file_path too like "<Project_Root>/../../Other_Project/src/step_impl/file.py"
     file_path = os.path.abspath(file_path) if ".." in str(file_path) else file_path

getgauge/registry.py

@@ -2,6 +2,7 @@
 import os
 import re
 import sys
+from pathlib import Path
 from subprocess import call
 from uuid import uuid1
 
@@ -172,35 +173,33 @@ def get_step_positions(self, file_name):
         positions = []
         for step, infos in self.__steps_map.items():
             positions = positions + [{'stepValue': step, 'span': i.span}
-                                     for i in infos if str(i.file_name).lower() == str(file_name).lower()]
+                                     for i in infos if paths_equal(i.file_name, file_name)]
         return positions
 
     def _get_all_hooks(self, file_name):
         all_hooks = []
         for hook in self.hooks:
             all_hooks = all_hooks + \
-                        [h for h in getattr(self, "__{}".format(hook))
-                         if str(h.file_name).lower() == str(file_name).lower()]
+                [h for h in getattr(self, "__{}".format(hook))
+                 if paths_equal(h.file_name, file_name)]
         return all_hooks
 
     def get_all_methods_in(self, file_name):
         methods = []
         for _, infos in self.__steps_map.items():
-            # Using relative paths may lead to different spelling of the C drive (lower or capital C)
-            methods = methods + [i for i in infos if str(i.file_name).lower() == str(file_name).lower()]
+            methods = methods + [i for i in infos if paths_equal(i.file_name, file_name)]
         return methods + self._get_all_hooks(file_name)
 
     def is_file_cached(self, file_name):
         for _, infos in self.__steps_map.items():
-            # Using relative paths may lead to different spelling of the C drive (lower or capital C)
-            if any(str(i.file_name).lower() == str(file_name).lower() for i in infos):
+            if any(Path(i.file_name).resolve() == Path(file_name).resolve() for i in infos):
                 return True
         return False
 
     def remove_steps(self, file_name):
         new_map = {}
         for step, infos in self.__steps_map.items():
-            filtered_info = [i for i in infos if i.file_name != file_name]
+            filtered_info = [i for i in infos if not paths_equal(i.file_name, file_name)]
             if len(filtered_info) > 0:
                 new_map[step] = filtered_info
         self.__steps_map = new_map
@@ -211,6 +210,17 @@ def clear(self):
             setattr(self, '__{}'.format(hook), [])
 
 
+def paths_equal(p1: str | Path, p2: str | Path) -> bool:
+    """
+    Compare two paths in a cross-platform safe way.
+    On Windows: case-insensitive, slash-insensitive.
+    On Linux/macOS: case-sensitive.
+    """
+    p1 = Path(p1).resolve()
+    p2 = Path(p2).resolve()
+    return os.path.normcase(str(p1)) == os.path.normcase(str(p2))
+
+
 def _filter_hooks(tags, hooks):
     filtered_hooks = []
     for hook in hooks:

getgauge/util.py

@@ -14,9 +14,9 @@ def get_project_root():
 def get_step_impl_dirs():
     step_impl_dir_names = map(str.strip, os.getenv(STEP_IMPL_DIR_ENV).split(',')) if os.getenv(STEP_IMPL_DIR_ENV) else ['step_impl']
     full_path_dir_names = []
-    for name in step_impl_dir_names:
-        name = name.replace("/", os.path.sep).replace("\\", os.path.sep)
-        impl_dir = name if os.path.isabs(name) else os.path.join(get_project_root(), name)
+    for dir_name in step_impl_dir_names:
+        dir_name = dir_name.replace("/", os.path.sep).replace("\\", os.path.sep)
+        impl_dir = dir_name if os.path.isabs(dir_name) else os.path.join(get_project_root(), dir_name)
         full_path_dir_names.append(impl_dir)
     return full_path_dir_names
 

tests/test_processor.py

@@ -354,7 +354,7 @@ def test_Processor_failing_ending_execution_request(self):
         registry.add_after_suite(failing_impl)
         request = ExecutionEndingRequest()
         response = processor.process_execution_ending_request(request)
-        print(response)
+
         self.assertIsInstance(response, ExecutionStatusResponse)
         self.assertTrue(response.executionResult.failed)
         self.assertEqual(ProtoExecutionResult.ASSERTION,
@@ -528,8 +528,8 @@ def foo():
 
         processor.process_cache_file_request(request)
 
-        self.assertEqual(registry.is_implemented('foo1'), False)
-        self.assertEqual(registry.is_implemented('foo {}'), True)
+        self.assertFalse(registry.is_implemented('foo1'))
+        self.assertTrue(registry.is_implemented('foo {}'))
 
     def test_Processor_cache_file_with_changed_status(self):
         request = CacheFileRequest()