Add GitCommentHelpHandler class (#2853)

Add GitCommentHelpHandler class

A new job handler has been created so that packit-service now has the ability to respond to the help command used in issue and PR comments. A comment is then added to the issue / PR, which contains a help message that includes the usage, link to documentation and contacts. Three tests are included to ensure functionality.

TODO:

 Update or write new documentation in packit/packit.dev.
 In the help message, add reference to /packit-ci when user uses /packit and the other way around. This is in case the user uses /packit when they should be using /packit-ci and vice versa.



Fixes #1668
Related to
Merge after #2850

RELEASE NOTES BEGIN
Packit-service now supports the help command in issue and PR comments.
RELEASE NOTES END

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

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

packit_service/constants.py

@@ -17,16 +17,27 @@
 DOCS_VALIDATE_CONFIG = f"{DOCS_URL}/cli/config/validate"
 DOCS_VALIDATE_HOOKS = "https://packit.dev/posts/pre-commit-hooks#validate-config"
 
-HELP_COMMENT_PROG = "/packit | /packit-stg"
-HELP_COMMENT_PROG_FEDORA_CI = "/packit-ci | /packit-ci-stg"
+HELP_COMMENT_PROG = "/packit"
+HELP_COMMENT_PROG_STG = "/packit-stg"
+HELP_COMMENT_PROG_FEDORA_CI = "/packit-ci"
+HELP_COMMENT_PROG_FEDORA_CI_STG = "/packit-ci-stg"
 HELP_COMMENT_DESCRIPTION = ""
 HELP_COMMENT_EPILOG = (
+    "Note: {note}\n"
     f"Documentation: {DOCS_URL}\n"
     "Contact:\n"
     "     Email:    hello@packit.dev\n"
     "     Matrix:   #packit:fedora.im\n"
     "     Mastodon: @packit@fosstodon.org"
 )
+HELP_NOTE = (
+    "If using Fedora CI, refer to `/packit-ci help` instead. "
+    "Refer to `/packit-ci-stg help` if using the staging instance."
+)
+HELP_NOTE_FEDORA_CI = (
+    "For default Packit behaviour, refer to `/packit help` instead. "
+    "Refer to `/packit-stg help` if using the staging instance."
+)
 
 KOJI_PRODUCTION_BUILDS_ISSUE = "https://pagure.io/releng/issue/9801"
 
@@ -260,6 +271,7 @@ def from_number(number: int):
 FASJSON_URL = "https://fasjson.fedoraproject.org"
 
 PACKIT_VERIFY_FAS_COMMAND = "verify-fas"
+PACKIT_HELP_COMMAND = "help"
 
 MISSING_PERMISSIONS_TO_BUILD_IN_COPR = "You don't have permissions to build in this copr."
 NOT_ALLOWED_TO_BUILD_IN_COPR = "is not allowed to build in the copr"

packit_service/utils.py

@@ -228,7 +228,11 @@ def get_packit_commands_from_comment(
     return []
 
 
-def _create_base_parser(prog: str, description: str, epilog: str) -> argparse.ArgumentParser:
+def _create_base_parser(
+    prog: Optional[str] = None,
+    description: Optional[str] = None,
+    epilog: Optional[str] = None,
+) -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         prog=prog,
         description=description,
@@ -239,7 +243,11 @@ def _create_base_parser(prog: str, description: str, epilog: str) -> argparse.Ar
     return parser
 
 
-def get_pr_comment_parser(prog: str, description: str, epilog: str) -> argparse.ArgumentParser:
+def get_comment_parser(
+    prog: Optional[str] = None,
+    description: Optional[str] = None,
+    epilog: Optional[str] = None,
+) -> argparse.ArgumentParser:
     parser = _create_base_parser(prog, description, epilog)
 
     subparsers = parser.add_subparsers(
@@ -313,8 +321,10 @@ def get_pr_comment_parser(prog: str, description: str, epilog: str) -> argparse.
     return parser
 
 
-def get_pr_comment_parser_fedora_ci(
-    prog: str, description: str, epilog: str
+def get_comment_parser_fedora_ci(
+    prog: Optional[str] = None,
+    description: Optional[str] = None,
+    epilog: Optional[str] = None,
 ) -> argparse.ArgumentParser:
     parser = _create_base_parser(prog, description, epilog)
 
@@ -329,7 +339,7 @@ def get_pr_comment_parser_fedora_ci(
         choices=["installability", "rpmlint", "rpminspect", "custom"],
         help="Specific type of tests to run",
     )
-    subparsers.add_parser("scratch-build", help="Build package in Scratch")
+    subparsers.add_parser("scratch-build", help="Build package in Koji")
 
     return parser
 

packit_service/worker/handlers/__init__.py

@@ -23,8 +23,11 @@
     SyncFromDownstream,
 )
 from packit_service.worker.handlers.forges import (
+    GitCommentHelpHandler,
     GithubAppInstallationHandler,
     GithubFasVerificationHandler,
+    GitIssueCommentHelpHandler,
+    GitPullRequestCommentHelpHandler,
 )
 from packit_service.worker.handlers.koji import (
     KojiBuildHandler,
@@ -68,6 +71,9 @@
     TestingFarmHandler.__name__,
     TestingFarmResultsHandler.__name__,
     GithubFasVerificationHandler.__name__,
+    GitCommentHelpHandler.__name__,
+    GitIssueCommentHelpHandler.__name__,
+    GitPullRequestCommentHelpHandler.__name__,
     VMImageBuildHandler.__name__,
     VMImageBuildResultHandler.__name__,
     CoprOpenScanHubTaskFinishedHandler.__name__,

packit_service/worker/handlers/abstract.py

@@ -234,6 +234,8 @@ def _add_to_mapping(kls: type["JobHandler"]):
 
 
 class TaskName(str, enum.Enum):
+    help_pr = "task.run_help_pr_handler"
+    help_issue = "task.run_help_issue_handler"
     copr_build_start = "task.run_copr_build_start_handler"
     copr_build_end = "task.run_copr_build_end_handler"
     copr_build = "task.run_copr_build_handler"

packit_service/worker/handlers/forges.py

@@ -7,23 +7,44 @@
 """
 
 import logging
+from abc import ABC, abstractmethod
+from typing import Optional
 
+from packit.api import PackitAPI
 from packit.config import (
     Deployment,
     JobConfig,
 )
 from packit.config.package_config import PackageConfig
 
-from packit_service.constants import CONTACTS_URL, DOCS_APPROVAL_URL, NOTIFICATION_REPO
+from packit_service.constants import (
+    CONTACTS_URL,
+    DOCS_APPROVAL_URL,
+    HELP_COMMENT_DESCRIPTION,
+    HELP_COMMENT_EPILOG,
+    HELP_COMMENT_PROG,
+    HELP_COMMENT_PROG_FEDORA_CI,
+    HELP_COMMENT_PROG_FEDORA_CI_STG,
+    HELP_COMMENT_PROG_STG,
+    HELP_NOTE,
+    HELP_NOTE_FEDORA_CI,
+    NOTIFICATION_REPO,
+)
 from packit_service.events import (
     github,
+    gitlab,
+    pagure,
 )
 from packit_service.models import (
     AllowlistModel,
     AllowlistStatus,
     GithubInstallationModel,
 )
-from packit_service.utils import get_packit_commands_from_comment
+from packit_service.utils import (
+    get_comment_parser,
+    get_comment_parser_fedora_ci,
+    get_packit_commands_from_comment,
+)
 from packit_service.worker.allowlist import Allowlist
 from packit_service.worker.checker.abstract import Checker
 from packit_service.worker.checker.forges import IsIssueInNotificationRepoChecker
@@ -35,6 +56,7 @@
 from packit_service.worker.mixin import (
     ConfigFromEventMixin,
     GetIssueMixin,
+    GetPullRequestMixin,
     PackitAPIWithDownstreamMixin,
 )
 from packit_service.worker.reporting import create_issue_if_needed
@@ -279,3 +301,84 @@ def verify(self, namespace: str, fas_account: str) -> TaskResults:
             self.issue.comment(msg)
 
         return TaskResults(success=True, details={"msg": msg})
+
+
+class GitCommentHelpHandler(
+    ABC,
+    JobHandler,
+):
+    @property
+    def packit_api(self) -> PackitAPI: ...
+
+    def clean_api(self) -> None: ...
+
+    def __init__(
+        self,
+        package_config: Optional[PackageConfig],
+        job_config: Optional[JobConfig],
+        event: dict,
+    ):
+        super().__init__(
+            package_config=package_config,
+            job_config=job_config,
+            event=event,
+        )
+        self.sender_login = self.data.actor
+        self.comment = self.data.event_dict.get("comment")
+
+    @abstractmethod
+    def add_comment(self, body: str) -> None:
+        pass
+
+    def run(self) -> TaskResults:
+        if self.comment.startswith("/packit-ci-stg"):  # type: ignore
+            parser = get_comment_parser_fedora_ci(
+                prog=HELP_COMMENT_PROG_FEDORA_CI_STG,
+                description=HELP_COMMENT_DESCRIPTION,
+                epilog=HELP_COMMENT_EPILOG.format(note=HELP_NOTE_FEDORA_CI),
+            )
+
+        elif self.comment.startswith("/packit-ci"):  # type: ignore
+            parser = get_comment_parser_fedora_ci(
+                prog=HELP_COMMENT_PROG_FEDORA_CI,
+                description=HELP_COMMENT_DESCRIPTION,
+                epilog=HELP_COMMENT_EPILOG.format(note=HELP_NOTE_FEDORA_CI),
+            )
+
+        elif self.comment.startswith("/packit-stg"):  # type: ignore
+            parser = get_comment_parser(
+                prog=HELP_COMMENT_PROG_STG,
+                description=HELP_COMMENT_DESCRIPTION,
+                epilog=HELP_COMMENT_EPILOG.format(note=HELP_NOTE),
+            )
+
+        else:
+            parser = get_comment_parser(
+                prog=HELP_COMMENT_PROG,
+                description=HELP_COMMENT_DESCRIPTION,
+                epilog=HELP_COMMENT_EPILOG.format(note=HELP_NOTE),
+            )
+
+        help_message = parser.format_help()
+        self.add_comment(body=help_message)
+
+        return TaskResults(success=True, details={"msg": help_message})
+
+
+@reacts_to(event=github.pr.Comment)
+@reacts_to(event=gitlab.mr.Comment)
+@reacts_to(event=pagure.pr.Comment)
+class GitPullRequestCommentHelpHandler(GitCommentHelpHandler, GetPullRequestMixin):
+    task_name = TaskName.help_pr
+
+    def add_comment(self, body: str) -> None:
+        self.pr.comment(body=body)
+
+
+@reacts_to(event=github.issue.Comment)
+@reacts_to(event=gitlab.issue.Comment)
+class GitIssueCommentHelpHandler(GitCommentHelpHandler, GetIssueMixin):
+    task_name = TaskName.help_issue
+
+    def add_comment(self, body: str) -> None:
+        self.issue.comment(body=body)

packit_service/worker/jobs.py

@@ -28,16 +28,14 @@
 from packit_service.constants import (
     COMMENT_REACTION,
     FEDORA_CI_TRANSITION_COMMENT,
-    HELP_COMMENT_DESCRIPTION,
-    HELP_COMMENT_EPILOG,
-    HELP_COMMENT_PROG,
-    HELP_COMMENT_PROG_FEDORA_CI,
+    PACKIT_HELP_COMMAND,
     PACKIT_VERIFY_FAS_COMMAND,
     TASK_ACCEPTED,
 )
 from packit_service.events import (
     abstract,
     github,
+    gitlab,
     koji,
     logdetective,
     pagure,
@@ -48,9 +46,9 @@
 from packit_service.package_config_getter import PackageConfigGetter
 from packit_service.utils import (
     elapsed_seconds,
+    get_comment_parser,
+    get_comment_parser_fedora_ci,
     get_packit_commands_from_comment,
-    get_pr_comment_parser,
-    get_pr_comment_parser_fedora_ci,
     pr_labels_match_configuration,
 )
 from packit_service.worker.allowlist import Allowlist
@@ -83,6 +81,10 @@
     RetriggerDownstreamKojiBuildHandler,
     TagIntoSidetagHandler,
 )
+from packit_service.worker.handlers.forges import (
+    GitIssueCommentHelpHandler,
+    GitPullRequestCommentHelpHandler,
+)
 from packit_service.worker.helpers.build import (
     BaseBuildJobHelper,
     CoprBuildJobHelper,
@@ -135,17 +137,9 @@ def parse_comment(
         return ParsedComment()
 
     if comment.startswith("/packit-ci"):
-        parser = get_pr_comment_parser_fedora_ci(
-            prog=HELP_COMMENT_PROG_FEDORA_CI,
-            description=HELP_COMMENT_DESCRIPTION,
-            epilog=HELP_COMMENT_EPILOG,
-        )
+        parser = get_comment_parser_fedora_ci()
     else:
-        parser = get_pr_comment_parser(
-            prog=HELP_COMMENT_PROG,
-            description=HELP_COMMENT_DESCRIPTION,
-            epilog=HELP_COMMENT_EPILOG,
-        )
+        parser = get_comment_parser()
 
     try:
         args = parser.parse_args(commands)
@@ -359,6 +353,29 @@ def process(self) -> list[TaskResults]:
                 ).apply_async()
             # should we comment about not processing if the comment is not
             # on the issue created by us or not in packit/notifications?
+        elif isinstance(
+            self.event,
+            (
+                github.pr.Comment,
+                gitlab.mr.Comment,
+                pagure.pr.Comment,
+                github.issue.Comment,
+                gitlab.issue.Comment,
+            ),
+        ) and self.is_help_comment(self.event.comment):
+            self.event.comment_object.add_reaction(COMMENT_REACTION)
+            handler = (
+                GitPullRequestCommentHelpHandler
+                if isinstance(
+                    self.event,
+                    (github.pr.Comment, gitlab.mr.Comment, pagure.pr.Comment),
+                )
+                else GitIssueCommentHelpHandler
+            )
+            handler.get_signature(
+                event=self.event,
+                job=None,
+            ).apply_async()
         else:
             if (
                 isinstance(
@@ -1313,6 +1330,45 @@ def is_fas_verification_comment(self, comment: str) -> bool:
 
         return bool(command and command[0] == PACKIT_VERIFY_FAS_COMMAND)
 
+    def retrieve_comment_command_prefix(self, comment: str) -> Optional[str]:
+        """
+        Retrieves the Packit prefix used in comment.
+
+        Args:
+            comment: Comment to retrieve prefix from.
+
+        Returns:
+            Packit comment command prefix or None if none is found.
+        """
+        prefixes = ["/packit-ci-stg", "/packit-ci", "/packit-stg", "/packit"]
+
+        for prefix in prefixes:
+            if comment.startswith(prefix):
+                return prefix
+
+        return None
+
+    def is_help_comment(self, comment: str) -> bool:
+        """
+        Checks whether the comment contains Packit help command:
+        `/packit(-stg) | /packit-ci(-stg) help`
+
+        Args:
+            comment: Comment to be checked.
+
+        Returns:
+            `True`, if is help comment, `False` otherwise.
+        """
+        if not (packit_comment_command_prefix := self.retrieve_comment_command_prefix(comment)):
+            return False
+
+        command = get_packit_commands_from_comment(
+            comment,
+            packit_comment_command_prefix,
+        )
+
+        return bool(command and command[0] == PACKIT_HELP_COMMAND)
+
     def report_task_accepted_for_downstream_retrigger_comments(
         self,
         handler_kls: type[JobHandler],