Refine the pipelines registration from files to support SubSubclasses #237

Signed-off-by: Thomas Druez <tdruez@nexb.com>

Author: tdruez

scanpipe/apps.py

@@ -105,9 +105,13 @@ def register_pipeline_from_file(self, path):
         Search for a Pipeline subclass in the provided file `path` and register it
         when found.
         """
-        module_name = path.stem
+        module_name = inspect.getmodulename(path)
         module = SourceFileLoader(module_name, str(path)).load_module()
-        pipeline_classes = inspect.getmembers(module, is_pipeline)
+
+        def is_local_module_pipeline(obj):
+            return is_pipeline(obj) and obj.__module__ == module_name
+
+        pipeline_classes = inspect.getmembers(module, is_local_module_pipeline)
 
         if len(pipeline_classes) > 1:
             raise ImproperlyConfigured(

scanpipe/pipelines/__init__.py

@@ -63,8 +63,8 @@ def get_steps(cls):
             return cls.steps()
 
         warnings.warn(
-            "Defining ``steps`` as a tuple is deprecated. "
-            "Use a ``steps(cls)`` classmethod instead."
+            f"Defining ``steps`` as a tuple is deprecated in {cls} "
+            f"Use a ``steps(cls)`` classmethod instead."
         )
         return cls.steps
 

scanpipe/tests/pipelines/register_from_file.py

@@ -20,10 +20,10 @@
 # ScanCode.io is a free software code scanning tool from nexB Inc. and others.
 # Visit https://github.com/nexB/scancode.io for support and download.
 
-from scanpipe.pipelines import Pipeline
+from scanpipe.tests.pipelines.do_nothing import DoNothing
 
 
-class RegisterFromFile(Pipeline):
+class RegisterFromFile(DoNothing):
     """
     A pipeline to be registered from its file path.
     """

scanpipe/tests/test_apps.py

@@ -28,6 +28,7 @@
 from django.test import override_settings
 
 from scanpipe.apps import ScanPipeConfig
+from scanpipe.models import Project
 from scanpipe.tests import license_policies
 from scanpipe.tests import license_policies_index
 from scanpipe.tests.pipelines.register_from_file import RegisterFromFile
@@ -86,3 +87,10 @@ def test_scanpipe_apps_register_pipeline_from_file(self):
             RegisterFromFile.__name__,
             scanpipe_app.pipelines.get("register_from_file").__name__,
         )
+
+        project1 = Project.objects.create(name="Analysis")
+        run = project1.add_pipeline("register_from_file")
+        pipeline_instance = run.make_pipeline_instance()
+
+        exitcode, output = pipeline_instance.execute()
+        self.assertEqual(0, exitcode)

scanpipe/tests/test_pipelines.py

@@ -121,6 +121,11 @@ def test_scanpipe_pipelines_is_pipeline(self):
         self.assertFalse(is_pipeline(Pipeline))
         self.assertTrue(is_pipeline(DoNothing))
 
+        class SubSubClass(DoNothing):
+            pass
+
+        self.assertTrue(is_pipeline(SubSubClass))
+
     def test_scanpipe_pipelines_class_get_graph(self):
         expected = [
             {"doc": "Step1 doc.", "name": "step1"},
@@ -159,8 +164,8 @@ def test_scanpipe_pipelines_class_get_steps(self):
             caught_warning = caught_warnings[0]
 
         expected = (
-            "Defining ``steps`` as a tuple is deprecated. "
-            "Use a ``steps(cls)`` classmethod instead."
+            f"Defining ``steps`` as a tuple is deprecated in {StepsAsAttribute} "
+            f"Use a ``steps(cls)`` classmethod instead."
         )
         self.assertEqual(expected, str(caught_warning.message))