Turn existing functions into two new Checker sub-classes

The two static methods `is_project_in_tests_namespace` and
`is_fmf_configured` have been removed and replaced with two new
checkers `IsFMFConfigPresent` and `IsProjectOutsideOfTestsNamespace`
in order to improve consistency of the code.

Additionally, the `@implements_fedora_ci_test` decorator no longer
expects a single optional callable `skipif`. Instead, it is
possible to specify a list of Checkers, making it possible to
specify multiple "skipif" conditions.

Changes have been made to `testing_farm_mixin.py` in order to resolve
the circular dependency introduced because of the aforementioned changes.

Author: betulependule

packit_service/worker/checker/testing_farm.py

@@ -330,3 +330,31 @@ def pre_check(self) -> bool:
             return False
 
         return True
+
+
+class IsFMFConfigPresent(_TestingFarmTestTypeChecker):
+    """
+    Check whether FMF configuration is missing in the given project.
+    """
+
+    def pre_check(self) -> bool:
+        try:
+            commit_sha = self.data.event_dict.get("commit_sha")
+
+            self.project.get_file_content(
+                path=".fmf/version",
+                ref=commit_sha,
+            )
+        except FileNotFoundError:
+            logger.debug("FMF configuration not found in repository.")
+            return False
+        return True
+
+
+class IsProjectOutsideOfTestsNamespace(_TestingFarmTestTypeChecker):
+    """
+    Check whether the current project is located inside the tests namespace.
+    """
+
+    def pre_check(self) -> bool:
+        return self.project.namespace != "tests"

packit_service/worker/helpers/testing_farm.py

@@ -45,6 +45,11 @@
     get_packit_commands_from_comment,
 )
 from packit_service.worker.celery_task import CeleryTask
+from packit_service.worker.checker.abstract import Checker
+from packit_service.worker.checker.testing_farm import (
+    IsFMFConfigPresent,
+    IsProjectOutsideOfTestsNamespace,
+)
 from packit_service.worker.helpers.build import CoprBuildJobHelper
 from packit_service.worker.helpers.fedora_ci import FedoraCIHelper
 from packit_service.worker.helpers.testing_farm_client import TestingFarmClient
@@ -685,14 +690,9 @@ def is_fmf_configured(self) -> bool:
         if self.custom_fmf:
             return True
 
-        try:
-            self.project.get_file_content(
-                path=f"{self.fmf_path}/.fmf/version",
-                ref=self.metadata.commit_sha,
-            )
-            return True
-        except FileNotFoundError:
-            return False
+        return IsFMFConfigPresent(
+            package_config=None, job_config=None, event=self.metadata.event_dict, task_name=None
+        ).pre_check()
 
     def report_missing_build_chroot(self, chroot: str):
         self.report_status_to_tests_for_chroot(
@@ -1303,9 +1303,11 @@ def cancel_running_tests(self):
 FEDORA_CI_TESTS = {}
 
 
-def implements_fedora_ci_test(test_name: str, skipif: Optional[Callable] = None) -> Callable:
+def implements_fedora_ci_test(
+    test_name: str, checkers: Optional[list[type[Checker]]] = None
+) -> Callable:
     def _update_mapping(function: Callable) -> Callable:
-        FEDORA_CI_TESTS[test_name] = (function, skipif)
+        FEDORA_CI_TESTS[test_name] = (function, checkers)
         return function
 
     return _update_mapping
@@ -1342,7 +1344,7 @@ def get_fedora_ci_tests(
         service_config: ServiceConfig,
         project: GitProject,
         metadata: EventData,
-        filter_specific_test: bool = True,
+        filter_specific_tests: bool = True,
     ) -> list[str]:
         """
         Gets relevant Fedora CI tests registered using the `@implements_fedora_ci_test()` decorator.
@@ -1354,32 +1356,47 @@ def get_fedora_ci_tests(
             service_config: Service config.
             project: Git project.
             metadata: Event metadata.
-            filter_specific_test: Whether to filter tests based on the command in user's comment.
+            filter_specific_tests: Whether to filter tests based on the command in user's comment.
 
         Returns:
             List of registered Fedora CI test names.
         """
+
+        def filter_tests(tests):
+            if metadata.event_type != pagure.pr.Comment.event_type():
+                return tests
+            # TODO: remove this once Fedora CI has its own instances and comment_command_prefixes
+            # comment_command_prefixes for Fedora CI are /packit-ci and /packit-ci-stg
+            comment_command_prefix = (
+                "/packit-ci-stg"
+                if service_config.comment_command_prefix.endswith("-stg")
+                else "/packit-ci"
+            )
+            commands = get_packit_commands_from_comment(
+                metadata.event_dict.get("comment"), comment_command_prefix
+            )
+            if not commands:
+                return []
+            if len(commands) > 1 and commands[1] in tests:
+                return [commands[1]]
+            return tests
+
         all_tests = [
             name
-            for name, (_, skipif) in FEDORA_CI_TESTS.items()
-            if not skipif or not skipif(service_config, project, metadata)
+            for name, (_, checkers) in FEDORA_CI_TESTS.items()
+            if all(
+                checker(
+                    package_config=None,
+                    job_config=None,
+                    event=metadata.event_dict,
+                    task_name=None,
+                ).pre_check()
+                for checker in checkers
+            )
         ]
-        if metadata.event_type != pagure.pr.Comment.event_type() or not filter_specific_test:
-            return all_tests
-        # TODO: remove this once Fedora CI has its own instances and comment_command_prefixes
-        # comment_command_prefixes for Fedora CI are /packit-ci and /packit-ci-stg
-        comment_command_prefix = (
-            "/packit-ci-stg"
-            if service_config.comment_command_prefix.endswith("-stg")
-            else "/packit-ci"
-        )
-        commands = get_packit_commands_from_comment(
-            metadata.event_dict.get("comment"), comment_command_prefix
-        )
-        if not commands:
-            return []
-        if len(commands) > 1 and commands[1] in all_tests:
-            return [commands[1]]
+
+        if filter_specific_tests:
+            return filter_tests(all_tests)
         return all_tests
 
     @property
@@ -1501,9 +1518,7 @@ def prepare_and_send_tf_request(
 
     @implements_fedora_ci_test(
         "installability",
-        skipif=lambda _, project, __: DownstreamTestingFarmJobHelper.is_project_in_tests_namespace(
-            project
-        ),
+        checkers=[IsProjectOutsideOfTestsNamespace],
     )
     def _payload_installability(self, distro: str, compose: str) -> dict:
         git_repo = "https://github.com/fedora-ci/installability-pipeline.git"
@@ -1553,9 +1568,7 @@ def _payload_installability(self, distro: str, compose: str) -> dict:
 
     @implements_fedora_ci_test(
         "rpminspect",
-        skipif=lambda _, project, __: DownstreamTestingFarmJobHelper.is_project_in_tests_namespace(
-            project
-        ),
+        checkers=[IsProjectOutsideOfTestsNamespace],
     )
     def _payload_rpminspect(self, distro: str, compose: str) -> dict:
         git_repo = "https://github.com/fedora-ci/rpminspect-pipeline.git"
@@ -1573,9 +1586,7 @@ def _payload_rpminspect(self, distro: str, compose: str) -> dict:
 
     @implements_fedora_ci_test(
         "rpmlint",
-        skipif=lambda _, project, __: DownstreamTestingFarmJobHelper.is_project_in_tests_namespace(
-            project
-        ),
+        checkers=[IsProjectOutsideOfTestsNamespace],
     )
     def _payload_rpmlint(self, distro: str, compose: str) -> dict:
         git_repo = "https://github.com/packit/tmt-plans.git"
@@ -1592,26 +1603,9 @@ def _payload_rpmlint(self, distro: str, compose: str) -> dict:
         }
         return payload
 
-    @staticmethod
-    def is_fmf_configured(project: GitProject, metadata: EventData) -> bool:
-        try:
-            project.get_file_content(
-                path=".fmf/version",
-                ref=metadata.commit_sha,
-            )
-        except FileNotFoundError:
-            return False
-        return True
-
-    @staticmethod
-    def is_project_in_tests_namespace(project: GitProject) -> bool:
-        return project.namespace == "tests"
-
     @implements_fedora_ci_test(
         "custom",
-        skipif=lambda _, project, metadata: not DownstreamTestingFarmJobHelper.is_fmf_configured(
-            project, metadata
-        ),
+        checkers=[IsFMFConfigPresent],
     )
     def _payload_custom(self, distro: str, compose: str) -> dict:
         payload = self._get_tf_base_payload(distro, compose)

packit_service/worker/helpers/testing_farm_mixin.py

@@ -9,7 +9,7 @@
 from __future__ import annotations
 
 from abc import abstractmethod
-from typing import Protocol
+from typing import TYPE_CHECKING, Protocol
 
 from packit.config import JobConfig, PackageConfig
 
@@ -18,12 +18,14 @@
     GetCoprBuildMixin,
     GetKojiBuildFromTaskOrPullRequestMixin,
 )
-from packit_service.worker.helpers.testing_farm import (
-    DownstreamTestingFarmJobHelper,
-    TestingFarmJobHelper,
-)
 from packit_service.worker.mixin import ConfigFromEventMixin
 
+if TYPE_CHECKING:
+    from packit_service.worker.helpers.testing_farm import (
+        DownstreamTestingFarmJobHelper,
+        TestingFarmJobHelper,
+    )
+
 
 class GetTestingFarmJobHelper(Protocol):
     package_config: PackageConfig
@@ -45,6 +47,8 @@ class GetTestingFarmJobHelperMixin(
     @property
     def testing_farm_job_helper(self) -> TestingFarmJobHelper:
         if not self._testing_farm_job_helper:
+            from packit_service.worker.helpers.testing_farm import TestingFarmJobHelper
+
             self._testing_farm_job_helper = TestingFarmJobHelper(
                 service_config=self.service_config,
                 package_config=self.package_config,
@@ -77,6 +81,10 @@ class GetDownstreamTestingFarmJobHelperMixin(
     @property
     def downstream_testing_farm_job_helper(self) -> DownstreamTestingFarmJobHelper:
         if not self._downstream_testing_farm_job_helper:
+            from packit_service.worker.helpers.testing_farm import (
+                DownstreamTestingFarmJobHelper,
+            )
+
             self._downstream_testing_farm_job_helper = DownstreamTestingFarmJobHelper(
                 service_config=self.service_config,
                 project=self.project,

packit_service/worker/jobs.py

@@ -273,7 +273,7 @@ def parse_comment(
                 self.service_config,
                 self.event.project,
                 EventData.from_event_dict(self.event.get_dict()),
-                filter_specific_test=False,
+                filter_specific_tests=False,
             )
             parser = get_comment_parser_fedora_ci(supported_test_types=supported_test_types)
         else: