Process dist-git onboarding requests

Signed-off-by: Nikola Forró <nforro@redhat.com>

Author: nforro

packit_service/constants.py

@@ -341,3 +341,66 @@ def from_number(number: int):
 
 # Default URL of the logdetective-packit interface server for sending the Log Detective requests.
 LOGDETECTIVE_PACKIT_SERVER_URL = "https://logdetective01.fedorainfracloud.org"
+
+DG_ONBOARDING_TITLE = "Add initial Packit configuration"
+DG_ONBOARDING_DESCRIPTION = """
+Hello,
+
+thank you for introducing a new package to Fedora!
+
+Let us present you [Packit](https://packit.dev/), an automation for Fedora releases.
+We are sending a configuration file with a basic setup.
+The automation will be enabled by merging this pull-request into the `rawhide` branch.
+
+If you have any question or concern, ask here or on `#packit:fedora.im` Matrix channel
+and Packit team will help.
+
+If you look at the configuration file, you can see that Packit is configured to do 3 jobs for you:
+* [`pull_from_upstream`](https://packit.dev/docs/configuration/downstream/pull_from_upstream):
+  Create a new set of pull-requests when there is a new upstream release.
+  (The specfile-changes and sources are taken care of. Packit is notified about new release from
+  [Release Monitoring](https://release-monitoring.org/) service. Check if your project is there.)
+* [`koji_build`](https://packit.dev/docs/configuration/downstream/koji_build):
+  Submit a Koji build as reaction to a merged pull request.
+* [`bodhi_update`](https://packit.dev/docs/configuration/downstream/bodhi_update):
+  Create a Bodhi update as a reaction to a succesful Koji build.
+
+These jobs are independent so you can pick just those that are relevant to you.
+For each, you can also configure Fedora/EPEL versions other than Rawhide that the jobs
+should be run for.
+
+You can also further tweak the process. A few handy options are prepared for you
+in the confguration file to uncomment. Rest can be found in
+[the documentation](https://packit.dev/docs/fedora-releases-guide/dist-git-onboarding).
+In case you have a group of dependent packages, you might want to take a look at
+[how to configure multi-package updates]
+(https://packit.dev/docs/fedora-releases-guide/releasing-multiple-packages).
+
+
+Things you still need to be aware of:
+
+* The package maintenance is still your responsibility -- Packit is just a handy tool that can
+  save you some time.
+* When Packit introduces new releases in form of the pull-request, it's your responsibility
+  to check the pull-request including the newly-introduced source. This is the place where human
+  intervention is required.
+* Be aware that there are other packages and packagers and that you might break someone else's work
+  by using Packit in a wrong way. (E.g. be careful about dependent packages since there is
+  no automatic check for these in place.)
+* Check [Fedora updates policy](https://docs.fedoraproject.org/en-US/fesco/Updates_Policy/).
+* Check [Fedora Packaging guidelines](https://docs.fedoraproject.org/en-US/packaging-guidelines/)
+  including the specifics for your package type.
+* Consult the approach with other maintainers of this package and care about the Packit results
+  so you don't introduce spam and extra work for others.
+* Speaking of notifications -- you might want to setup a rule on
+  [Fedora Notifications](https://notifications.fedoraproject.org/) so you won't miss
+  anything important, since `packit` FAS account will be the actor of the jobs.
+
+
+In case you don't want to receive these pull-requests in the future, you can use
+the `--onboard-packit no` option when running `fedpkg request-repo`.
+
+
+I hope you will be happy with the automation!
+*[Packit team](https://packit.dev/#contact)*
+"""

packit_service/events/onboarding.py

@@ -0,0 +1,25 @@
+# Copyright Contributors to the Packit project.
+# SPDX-License-Identifier: MIT
+
+from typing import Optional
+
+from packit.config import PackageConfig
+
+from .abstract.base import ForgeIndependent
+
+
+class Request(ForgeIndependent):
+    @classmethod
+    def event_type(cls) -> str:
+        return "onboarding.Request"
+
+    def __init__(
+        self,
+        package: str,
+        open_pr: bool = True,
+    ):
+        super().__init__(project_url=f"https://src.fedoraproject.org/rpms/{package}")
+        self.open_pr = open_pr
+
+    def get_packages_config(self) -> Optional[PackageConfig]:
+        return None

packit_service/worker/checker/onboarding.py

@@ -0,0 +1,18 @@
+# Copyright Contributors to the Packit project.
+# SPDX-License-Identifier: MIT
+
+import logging
+
+from packit.constants import CONFIG_FILE_NAMES
+
+from packit_service.worker.checker.abstract import Checker
+
+logger = logging.getLogger(__name__)
+
+
+class ProjectIsNotOnboarded(Checker):
+    def pre_check(self) -> bool:
+        if any(f for f in self.project.get_files(ref="rawhide") if f in CONFIG_FILE_NAMES):
+            logger.info(f"Package {self.project.repo} is already onboarded")
+            return False
+        return True

packit_service/worker/handlers/abstract.py

@@ -265,6 +265,7 @@ class TaskName(str, enum.Enum):
     tag_into_sidetag = "task.tag_into_sidetag"
     openscanhub_task_finished = "task.openscanhub_task_finished"
     openscanhub_task_started = "task.openscanhub_task_started"
+    onboarding_request = "task.run_onboarding_request_handler"
     downstream_koji_scratch_build = "task.run_downstream_koji_scratch_build_handler"
     downstream_koji_scratch_build_report = "task.run_downstream_koji_scratch_build_report_handler"
     downstream_koji_eln_scratch_build = "task.run_downstream_koji_eln_scratch_build_handler"

packit_service/worker/handlers/onboarding.py

@@ -0,0 +1,107 @@
+# Copyright Contributors to the Packit project.
+# SPDX-License-Identifier: MIT
+
+"""
+This file defines classes for job handlers specific to onboarding tasks
+"""
+
+import logging
+
+from packit.cli.dist_git_init import (
+    COMMIT_MESSAGE,
+    CONFIG_FILE_NAME,
+    ONBOARD_BRANCH_NAME,
+    DistGitInitializer,
+)
+from packit.config.config import Config
+from packit.config.package_config import PackageConfig
+
+from packit_service.constants import DG_ONBOARDING_DESCRIPTION, DG_ONBOARDING_TITLE
+from packit_service.events import (
+    onboarding,
+)
+from packit_service.worker.checker.abstract import Checker
+from packit_service.worker.checker.onboarding import ProjectIsNotOnboarded
+from packit_service.worker.handlers.abstract import (
+    JobHandler,
+    TaskName,
+    reacts_to,
+)
+from packit_service.worker.mixin import ConfigFromEventMixin, PackitAPIWithDownstreamMixin
+from packit_service.worker.result import TaskResults
+
+logger = logging.getLogger(__name__)
+
+
+@reacts_to(event=onboarding.Request)
+class OnboardingRequestHandler(
+    JobHandler,
+    ConfigFromEventMixin,
+    PackitAPIWithDownstreamMixin,
+):
+    task_name = TaskName.onboarding_request
+
+    @staticmethod
+    def get_checkers() -> tuple[type[Checker], ...]:
+        return (ProjectIsNotOnboarded,)
+
+    def _run(self) -> TaskResults:
+        package = self.project.repo
+        logger.debug(f"Running onboarding for {package}")
+
+        # generate and load config
+        initializer = DistGitInitializer(
+            config=Config(),
+            path_or_url="",
+            upstream_git_url=None,
+        )
+        self.package_config = self.job_config = PackageConfig.get_from_dict(
+            initializer.package_config_dict | {"downstream_package_name": package},
+        )
+
+        self.perform_onboarding(
+            config=initializer.package_config_content,
+            open_pr=self.data.event_dict.get("open_pr", True),
+        )
+
+        return TaskResults(success=True, details={})
+
+    def perform_onboarding(self, config: str, open_pr: bool) -> None:
+        # clone the repo and fetch rawhide
+        self.packit_api.dg.create_branch(
+            "rawhide",
+            base="remotes/origin/rawhide",
+            setup_tracking=True,
+        )
+        self.packit_api.dg.update_branch("rawhide")
+        self.packit_api.dg.switch_branch("rawhide", force=True)
+
+        if open_pr:
+            self.packit_api.dg.create_branch(ONBOARD_BRANCH_NAME)
+            self.packit_api.dg.switch_branch(ONBOARD_BRANCH_NAME, force=True)
+            self.packit_api.dg.reset_workdir()
+
+        working_dir = self.packit_api.dg.local_project.working_dir
+
+        # create config file
+        (working_dir / CONFIG_FILE_NAME).write_text(config)
+
+        # create or update .gitignore
+        with (working_dir / ".gitignore").open("a") as f:
+            print("prepare_sources_result*/", file=f)
+
+        self.packit_api.dg.commit(
+            title=COMMIT_MESSAGE,
+            msg="",
+            prefix="",
+        )
+
+        if open_pr:
+            self.packit_api.push_and_create_pr(
+                pr_title=DG_ONBOARDING_TITLE,
+                pr_description=DG_ONBOARDING_DESCRIPTION,
+                git_branch="rawhide",
+                repo=self.packit_api.dg,
+            )
+        else:
+            self.packit_api.dg.push(refspec="HEAD:rawhide")

packit_service/worker/jobs.py

@@ -32,6 +32,7 @@
     github,
     koji,
     logdetective,
+    onboarding,
     pagure,
     testing_farm,
 )
@@ -75,6 +76,7 @@
     RetriggerDownstreamKojiBuildHandler,
     TagIntoSidetagHandler,
 )
+from packit_service.worker.handlers.onboarding import OnboardingRequestHandler
 from packit_service.worker.helpers.build import (
     BaseBuildJobHelper,
     CoprBuildJobHelper,
@@ -348,6 +350,16 @@ 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, onboarding.Request):
+            if OnboardingRequestHandler.pre_check(
+                package_config=None,
+                job_config=None,
+                event=self.event.get_dict(),
+            ):
+                OnboardingRequestHandler.get_signature(
+                    event=self.event,
+                    job=None,
+                ).apply_async()
         else:
             if (
                 isinstance(

packit_service/worker/parser.py

@@ -30,6 +30,7 @@
     gitlab,
     koji,
     logdetective,
+    onboarding,
     openscanhub,
     pagure,
     testing_farm,
@@ -134,6 +135,7 @@ def parse_event(
             koji.result.Task,
             openscanhub.task.Finished,
             openscanhub.task.Started,
+            onboarding.Request,
             pagure.pr.Comment,
             pagure.pr.Flag,
             pagure.pr.Action,
@@ -189,6 +191,7 @@ def parse_event(
                 Parser.parse_anitya_version_update_event,
                 Parser.parse_openscanhub_task_finished_event,
                 Parser.parse_openscanhub_task_started_event,
+                Parser.parse_onboarding_request_event,
                 Parser.parse_commit_comment_event,
                 Parser.parse_pagure_pull_request_event,
                 Parser.parse_logdetective_analysis_event,
@@ -1560,6 +1563,23 @@ def parse_koji_build_tag_event(event) -> Optional[koji.tag.Build]:
             owner=owner,
         )
 
+    @staticmethod
+    def parse_onboarding_request_event(
+        event: dict,
+    ) -> Optional[onboarding.Request]:
+        if event.get("source") != "onboarding" or not event.get("package"):
+            return None
+
+        package: str = event["package"]
+        logger.info(f"dist-git onboarding request event for package {package}")
+
+        open_pr = bool(event.get("open_pr", True))
+
+        return onboarding.Request(
+            package=package,
+            open_pr=open_pr,
+        )
+
     @staticmethod
     def parse_pipeline_event(event) -> Optional[gitlab.pipeline.Pipeline]:
         """

packit_service/worker/tasks.py

@@ -89,6 +89,7 @@
     KojiBuildTagHandler,
     KojiTaskReportDownstreamHandler,
 )
+from packit_service.worker.handlers.onboarding import OnboardingRequestHandler
 from packit_service.worker.handlers.usage import check_onboarded_projects
 from packit_service.worker.helpers.build.babysit import (
     check_copr_build,
@@ -812,6 +813,20 @@ def run_downstream_log_detective_results_handler(
     return get_handlers_task_results(handler.run_job(), event)
 
 
+@celery_app.task(name=TaskName.onboarding_request, base=TaskWithRetry)
+def run_onboarding_request_handler(
+    event: dict,
+    package_config: dict,
+    job_config: dict,
+):
+    handler = OnboardingRequestHandler(
+        package_config=load_package_config(package_config),
+        job_config=load_job_config(job_config),
+        event=event,
+    )
+    return get_handlers_task_results(handler.run_job(), event)
+
+
 def get_handlers_task_results(results: dict, event: dict) -> dict:
     # include original event to provide more info
     return {"job": results, "event": event}