Allow retriggering builds/tests on ELN rawhide PRs independently (#3032)

Allow retriggering builds/tests on ELN rawhide PRs independently

TODO:

 Write new tests or update the old ones to cover new functionality.
 Update doc-strings where appropriate.
 Update or write new documentation in packit/packit.dev.



NOTE 1
When figuring out how to implement this PR, I noticed that separate handlers are run when running jobs for eln and rawhide. This implementation is based on discarding the one handler associated with the jobs that are not needed (removing it from the handlers_triggered_by_job variable). For example:
/packit-ci test rpminspect eln
Would lead to the handler corresponding with the rawhide target being removed from the list of handlers to be run. It's possible that there could be a better way of implementing this.
NOTE 2
I implemented the retriggering comment syntax as was described in the issue. However, having it implemented as a positional argument means that comments like this are valid:
/packit-ci test custom eln
/packit-ci build rawhide
But the following would be invalid and lead to a parsing error because of the missing positional argument before eln (the first positional argument cannot be missing if the second one is present):
/packit-ci test eln
If needed, I could instead turn the new argument into a keyword argument like this:
/packit-ci test --target-branch eln
EDIT: I've made it into a keyword argument in the second commit. I should probably write a new test to test the functionality of /packit-ci test --target-branch eln.
Fixes #2958

RELEASE NOTES BEGIN
In Fedora CI, it is now possible to retrigger builds and tests on ELN rawhide PRs with no dedicated eln branch independently.
RELEASE NOTES END

Reviewed-by: gemini-code-assist[bot]
Reviewed-by: Alžběta Kučerová
Reviewed-by: Nikola Forró
Reviewed-by: Laura Barcziová

Author: centosinfra-prod-github-app[bot]

packit_service/utils.py

@@ -334,12 +334,28 @@ def get_comment_parser_fedora_ci(
     )
     test_parser = subparsers.add_parser("test", help="Run tests in Testing Farm")
     test_parser.add_argument(
-        "target",
+        "test_identifier",
         nargs="?",
         choices=["installability", "rpmlint", "rpminspect", "custom"],
         help="Specific type of tests to run",
     )
-    subparsers.add_parser("scratch-build", help="Build package in Koji")
+
+    test_parser.add_argument(
+        "--target",
+        dest="check_target",
+        nargs="?",
+        choices=["eln", "rawhide"],
+        help="Target for which to trigger tests",
+    )
+
+    scratch_build_parser = subparsers.add_parser("scratch-build", help="Build package in Koji")
+    scratch_build_parser.add_argument(
+        "--target",
+        dest="check_target",
+        nargs="?",
+        choices=["eln", "rawhide"],
+        help="Target for which to trigger a scratch build in Koji",
+    )
 
     return parser
 

packit_service/worker/handlers/abstract.py

@@ -70,6 +70,37 @@ class RateLimitRequeueException(Exception):
 MAP_COMMENT_TO_HANDLER_FEDORA_CI: dict[str, set[type["FedoraCIJobHandler"]]] = defaultdict(set)
 MAP_CHECK_PREFIX_TO_HANDLER: dict[str, set[type["JobHandler"]]] = defaultdict(set)
 
+MAP_TARGET_TO_HANDLER: dict[type["FedoraCIJobHandler"], str] = defaultdict(str)
+
+
+def corresponds_to_check_target(check_target: str):
+    """
+    [class decorator]
+    Specify which target the handler corresponds to.
+
+    Normally, when retriggering jobs on ELN rawhide PRs with no
+    existing eln branch, jobs would be run for both the rawhide
+    and eln targets. When the check target is specified like this,
+
+    /packit-ci test installability rawhide
+
+    then only the handler corresponding to the specified target
+    (rawhide in this example) will be run, resulting in jobs being run
+    only for the desired target.
+
+    Example:
+    ```
+    @corresponds_to_check_target(check_target="rawhide")
+    class DownstreamKojiScratchBuildHandler(
+    ```
+    """
+
+    def _add_to_mapping(kls: type["FedoraCIJobHandler"]):
+        MAP_TARGET_TO_HANDLER[kls] = check_target
+        return kls
+
+    return _add_to_mapping
+
 
 def configured_as(job_type: JobType):
     """

packit_service/worker/handlers/distgit.py

@@ -95,6 +95,7 @@
     RetriableJobHandler,
     TaskName,
     configured_as,
+    corresponds_to_check_target,
     reacts_to,
     reacts_to_as_fedora_ci,
     run_for_check_rerun,
@@ -776,6 +777,7 @@ def _run(self) -> TaskResults:
 
 
 @run_for_comment_as_fedora_ci(command="scratch-build")
+@corresponds_to_check_target(check_target="rawhide")
 @reacts_to_as_fedora_ci(event=pagure.pr.Action)
 @reacts_to_as_fedora_ci(event=pagure.pr.Comment)
 class DownstreamKojiScratchBuildHandler(
@@ -1010,6 +1012,7 @@ def run_koji_build(
 
 
 @run_for_comment_as_fedora_ci(command="scratch-build")
+@corresponds_to_check_target(check_target="eln")
 @reacts_to_as_fedora_ci(event=pagure.pr.Action)
 @reacts_to_as_fedora_ci(event=pagure.pr.Comment)
 class DownstreamKojiELNScratchBuildHandler(DownstreamKojiScratchBuildHandler):

packit_service/worker/handlers/testing_farm.py

@@ -67,6 +67,7 @@
     RetriableJobHandler,
     TaskName,
     configured_as,
+    corresponds_to_check_target,
     reacts_to,
     reacts_to_as_fedora_ci,
     run_for_check_rerun,
@@ -360,6 +361,7 @@ def _run(self) -> TaskResults:
 
 
 @run_for_comment_as_fedora_ci(command="test")
+@corresponds_to_check_target(check_target="rawhide")
 @reacts_to_as_fedora_ci(event=koji.result.Task)
 @reacts_to_as_fedora_ci(event=pagure.pr.Comment)
 class DownstreamTestingFarmHandler(
@@ -520,6 +522,7 @@ def _run(self) -> TaskResults:
 
 
 @run_for_comment_as_fedora_ci(command="test")
+@corresponds_to_check_target(check_target="eln")
 @reacts_to_as_fedora_ci(event=pagure.pr.Comment)
 class DownstreamTestingFarmELNHandler(DownstreamTestingFarmHandler):
     """

packit_service/worker/jobs.py

@@ -66,6 +66,7 @@
     MAP_COMMENT_TO_HANDLER_FEDORA_CI,
     MAP_JOB_TYPE_TO_HANDLER,
     MAP_REQUIRED_JOB_TYPE_TO_HANDLER,
+    MAP_TARGET_TO_HANDLER,
     SUPPORTED_EVENTS_FOR_HANDLER,
     SUPPORTED_EVENTS_FOR_HANDLER_FEDORA_CI,
     FedoraCIJobHandler,
@@ -112,6 +113,7 @@
 class ParsedComment:
     command: Optional[str] = None
     package: Optional[str] = None
+    check_target: Optional[str] = None
 
 
 def parse_comment(
@@ -143,7 +145,8 @@ def parse_comment(
 
     try:
         args = parser.parse_args(commands)
-        return ParsedComment(command=args.command, package=args.package)
+        check_target = getattr(args, "check_target", None)
+        return ParsedComment(command=args.command, package=args.package, check_target=check_target)
     except SystemExit:
         # tests expect invalid syntax comments be ignored
         logger.debug(
@@ -176,12 +179,16 @@ def get_handlers_for_command(
 
 def get_handlers_for_command_fedora_ci(
     command: str,
+    check_target: Optional[str],
 ) -> set[type[FedoraCIJobHandler]]:
     """
-    Get handlers for the given command.
+    Get handlers for the given command. If check_target is specified
+    (for example: eln), then only handlers relevant to this target
+    will be returned.
 
     Args:
         command: command to get handler to
+        check_target: target for which to run jobs
 
     Returns:
         Set of handlers for Fecora CI that are triggered by command.
@@ -192,6 +199,12 @@ def get_handlers_for_command_fedora_ci(
     handlers = MAP_COMMENT_TO_HANDLER_FEDORA_CI[command]
     if not handlers:
         logger.debug(f"Command {command} not supported by packit.")
+
+    if check_target:
+        handlers = {
+            handler for handler in handlers if MAP_TARGET_TO_HANDLER[handler] == check_target
+        }
+
     return handlers
 
 
@@ -552,7 +565,11 @@ def _post_fedora_ci_transition_comment(self) -> None:
             # Don't fail the job if we can't post the comment
             logger.warning(f"Failed to post CI transition comment: {ex}")
 
-    def report_task_accepted_for_fedora_ci(self, handler_kls: type[FedoraCIJobHandler]):
+    def report_task_accepted_for_fedora_ci(
+        self,
+        handler_kls: type[FedoraCIJobHandler],
+        user_specified_target_branch: Optional[str] = None,
+    ):
         """
         For CI-related dist-git PR comment events report the initial status
         "Task was accepted" to inform user we are working on the request.
@@ -572,10 +589,12 @@ def report_task_accepted_for_fedora_ci(self, handler_kls: type[FedoraCIJobHandle
         if (target_branch := self.event.pull_request_object.target_branch) == "main":
             target_branch = "rawhide"
 
+        # target_branch determines the check's title such as:
+        # "Packit - installability - rawhide [beaf90b]"
         helper = FedoraCIHelper(
             project=self.event.project,
             metadata=metadata,
-            target_branch=target_branch,
+            target_branch=user_specified_target_branch or target_branch,
         )
 
         first_status_reported = False
@@ -683,9 +702,10 @@ def process_fedora_ci_jobs(self) -> list[TaskResults]:
             A list of task results for each task created.
         """
         handlers_triggered_by_job = None
+        check_target = None
+
         # [XXX] if there are ever monorepos in Fedora CI…
         # monorepo_package = None
-
         if isinstance(self.event, abstract.comment.CommentEvent):
             arguments = parse_comment(
                 self.event.comment,
@@ -695,7 +715,8 @@ def process_fedora_ci_jobs(self) -> list[TaskResults]:
             # [XXX] if there are ever monorepos in Fedora CI…
             # monorepo_package = arguments.package
             command = arguments.command
-            handlers_triggered_by_job = get_handlers_for_command_fedora_ci(command)
+            check_target = getattr(arguments, "check_target", None)
+            handlers_triggered_by_job = get_handlers_for_command_fedora_ci(command, check_target)
 
         matching_handlers = {
             handler
@@ -726,7 +747,7 @@ def process_fedora_ci_jobs(self) -> list[TaskResults]:
             # if monorepo_package and handler_kls.job_config.package == monorepo_package:
             #     continue
 
-            self.report_task_accepted_for_fedora_ci(handler_kls)
+            self.report_task_accepted_for_fedora_ci(handler_kls, check_target)
 
             celery_signature = celery.signature(
                 handler_kls.task_name.value,