Document how to work with events during packit-service local development

[majamassarini]

• Document how to capture and modify events that may be of interest to the Packit service
  - [ ] fedmsg events: how to capture and modify them, how to send them to a local packit-service instance
  - [ ] github events: where to obtain them, how to send them to a local packit-service instance
  - [ ] gitlab events: where to obtain them, how to send them to a local packit-service instance
• If changes in the packit-service code are necessary to test a certain event, document them or, even better, introduce a new environment variable that makes those changes permanent in the code.

[majamassarini]

In case they're useful, I'm sharing my local changes. I used them a long time ago, so they may not apply cleanly and might need modifications.

The following patch allows using the VS Code debugger with packit-service and the events I'm working on. Most patches look similar to this one:

diff --git a/docker-compose.yml b/docker-compose.yml
index d1a592dc..8ef9675f 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -81,11 +81,14 @@ services:
       - tokman
       - redis
       - postgres
+    ports:
+      - 5678:5678
     environment:
       DEPLOYMENT: dev
+      PACKIT_HOME: /home/packit
       REDIS_SERVICE_HOST: redis
       APP: packit_service.worker.tasks
-      KRB5CCNAME: FILE:/tmp/krb5cc_packit
+      KRB5CCNAME: "DIR:/home/packit/kerberos/"
       POSTGRESQL_USER: packit
       POSTGRESQL_PASSWORD: secret-password
       POSTGRESQL_HOST: postgres
diff --git a/files/docker/Dockerfile b/files/docker/Dockerfile
index f2a82282..19013b98 100644
--- a/files/docker/Dockerfile
+++ b/files/docker/Dockerfile
@@ -32,6 +32,9 @@ RUN git rev-parse HEAD >/.packit-service.git.commit.hash \
 COPY alembic.ini ./
 COPY alembic/ ./alembic/
 
+# Allow remote debugging
+RUN pip install --upgrade debugpy
+
 EXPOSE 8443
 
 CMD ["/usr/bin/run_httpd.sh"]
diff --git a/files/docker/Dockerfile.worker b/files/docker/Dockerfile.worker
index aa06755e..a292ef52 100644
--- a/files/docker/Dockerfile.worker
+++ b/files/docker/Dockerfile.worker
@@ -15,6 +15,9 @@ ENV USER=packit \
 # Ansible doesn't like /tmp
 WORKDIR /src
 
+# Allow remote debugging
+RUN pip install --upgrade debugpy
+
 COPY files/install-deps-worker.yaml ./files/
 COPY files/tasks/ ./files/tasks/
 RUN ansible-playbook -vv -c local -i localhost, files/install-deps-worker.yaml \
@@ -33,4 +36,12 @@ RUN git rev-parse HEAD >/.packit-service.git.commit.hash \
     && rm -rf /src/*
 # /src content is no longer needed, clean it for 'hardly'
 
+COPY token_ogr.patch token_ogr.patch
+RUN ls /usr/lib/python3.9/
+RUN ls /usr/lib/python3.9/site-packages/
+RUN ls /usr/lib/python3.9/site-packages/ogr
+RUN patch --verbose -p0 /usr/lib/python3.9/site-packages/ogr/services/github/service.py token_ogr.patch
+
+#COPY projects_allowed_packit.patch projects_allowed_packit.patch
+
 CMD ["/usr/bin/run_worker.sh"]
diff --git a/packit_service/celerizer.py b/packit_service/celerizer.py
index 99ff8b06..c7d37dc7 100644
--- a/packit_service/celerizer.py
+++ b/packit_service/celerizer.py
@@ -44,4 +44,65 @@ def get_celery_application():
     return app
 
 
+# Let a remote debugger (Visual Studio Code client)
+# access this running instance.
+import debugpy
+
+# Allow other computers to attach to debugpy at this IP address and port.
+try:
+    debugpy.listen(("0.0.0.0", 5678))
+
+    # Uncomment the following lines if you want to
+    # pause the program until a remote debugger is attached
+
+    # print("Waiting for debugger attach")
+    debugpy.wait_for_client()
+
+except RuntimeError as e:
+    pass
+
+
+# @todo: rerun docker-compose build --force-rm for every change!
+
+import json
+
+#comment_copr_build_event = """
+#{
+#  "task_id": 18304,
+#  "headers": {
+#    "fedora_messaging_schema": "base.message",
+#    "fedora_messaging_severity": 20,
+#    "priority": 0,
+#    "sent-at": "2024-10-20T07:58:23+00:00"
+#  },
+#  "topic": "org.fedoraproject.prod.openscanhub.task.started"  
+#}
+#"""
+comment_copr_build_event = """
+{
+  "added.js": "http://openscanhub.fedoraproject.org/task/18302/log/added.js?format=raw",
+  "fixed.js": "http://openscanhub.fedoraproject.org/task/18302/log/fixed.js?format=raw",
+  "scan-results.js": "http://openscanhub.fedoraproject.org/task/18302/log/podman-5.3.0~dev-1.20241020030546559147.pr24321.1796.24c178f39/scan-results.js?format=raw",
+  "status": "success",
+  "task_id": 18304,
+  "headers": {
+    "fedora_messaging_schema": "base.message",
+    "fedora_messaging_severity": 20,
+    "priority": 0,
+    "sent-at": "2024-10-20T03:44:53+00:00"
+  },
+  "id": "36b9d2be-5452-467d-8503-d68462e8aa74",
+  "priority": 0,
+  "queue": null,
+  "topic": "org.fedoraproject.prod.openscanhub.task.finished"  
+}
+"""
+
+event = json.loads(comment_copr_build_event)
 celery_app: Celery = Proxy(get_celery_application)
+celery_app.send_task(
+    name="task.steve_jobs.process_message",
+    kwargs={"event": event},
+)
+
+
diff --git a/packit_service/worker/checker/distgit.py b/packit_service/worker/checker/distgit.py
index 1df36cf1..cce46e51 100644
--- a/packit_service/worker/checker/distgit.py
+++ b/packit_service/worker/checker/distgit.py
@@ -255,29 +255,29 @@ class ValidInformationForPullFromUpstream(Checker, GetPagurePullRequestMixin):
 
 class IsUpstreamTagMatchingConfig(Checker):
     def pre_check(self) -> bool:
-        tag = self.data.tag_name
-
-        # if the tag in event is None (pull-from-upstream retriggering), we will filter
-        # only matching tags in the handler directly
-        if not tag:
-            return True
-
-        if upstream_tag_include := self.job_config.upstream_tag_include:
-            matching_include_regex = re.match(upstream_tag_include, tag)
-            if not matching_include_regex:
-                logger.info(
-                    f"Tag {tag} doesn't match the upstream_tag_include {upstream_tag_include} "
-                    f"from the config. Skipping the syncing."
-                )
-                return False
-
-        if upstream_tag_exclude := self.job_config.upstream_tag_exclude:
-            matching_exclude_regex = re.match(upstream_tag_exclude, tag)
-            if matching_exclude_regex:
-                logger.info(
-                    f"Tag {tag} matches the upstream_tag_exclude {upstream_tag_exclude} "
-                    f"from the config. Skipping the syncing."
-                )
-                return False
+        #tag = self.data.tag_name
+
+        ## if the tag in event is None (pull-from-upstream retriggering), we will filter
+        ## only matching tags in the handler directly
+        #if not tag:
+        #    return True
+
+        #if upstream_tag_include := self.job_config.upstream_tag_include:
+        #    matching_include_regex = re.match(upstream_tag_include, tag)
+        #    if not matching_include_regex:
+        #        logger.info(
+        #            f"Tag {tag} doesn't match the upstream_tag_include {upstream_tag_include} "
+        #            f"from the config. Skipping the syncing."
+        #        )
+        #        return False
+
+        #if upstream_tag_exclude := self.job_config.upstream_tag_exclude:
+        #    matching_exclude_regex = re.match(upstream_tag_exclude, tag)
+        #    if matching_exclude_regex:
+        #        logger.info(
+        #            f"Tag {tag} matches the upstream_tag_exclude {upstream_tag_exclude} "
+        #            f"from the config. Skipping the syncing."
+        #        )
+        #        return False
 
         return True
diff --git a/packit_service/worker/checker/open_scan_hub.py b/packit_service/worker/checker/open_scan_hub.py
index 33374bcd..f907a577 100644
--- a/packit_service/worker/checker/open_scan_hub.py
+++ b/packit_service/worker/checker/open_scan_hub.py
@@ -18,9 +18,9 @@ class RawhideX86Target(
         branches = aliases.get_build_targets(
             *self.job_config.targets,
         )
-        if "fedora-rawhide-x86_64" not in branches:
-            logger.debug(
-                "Skipping job configuration with no fedora-rawhide-x86_64 target."
-            )
-            return False
+        #if "fedora-rawhide-x86_64" not in branches:
+        #    logger.debug(
+        #        "Skipping job configuration with no fedora-rawhide-x86_64 target."
+        #    )
+        #    return False
         return True
diff --git a/packit_service/worker/jobs.py b/packit_service/worker/jobs.py
index 3ec8daa3..a6e7489e 100644
--- a/packit_service/worker/jobs.py
+++ b/packit_service/worker/jobs.py
@@ -195,19 +195,19 @@ class SteveJobs:
         Returns:
             List of processing task results.
         """
-        try:
-            if not self.is_project_public_or_enabled_private():
-                return []
-        except GithubAppNotInstalledError:
-            host, namespace, repo = (
-                self.event.project.service.hostname,
-                self.event.project.namespace,
-                self.event.project.repo,
-            )
-            logger.info(
-                "Packit is not installed on %s/%s/%s, skipping.", host, namespace, repo
-            )
-            return []
+        #try:
+        #    if not self.is_project_public_or_enabled_private():
+        #        return []
+        #except GithubAppNotInstalledError:
+        #    host, namespace, repo = (
+        #        self.event.project.service.hostname,
+        #        self.event.project.namespace,
+        #        self.event.project.repo,
+        #    )
+        #    logger.info(
+        #        "Packit is not installed on %s/%s/%s, skipping.", host, namespace, repo
+        #    )
+        #    return []
 
         processing_results = None
 
@@ -471,20 +471,20 @@ class SteveJobs:
 
             # check allowlist approval for every job to be able to track down which jobs
             # failed because of missing allowlist approval
-            if not allowlist.check_and_report(
-                self.event,
-                self.event.project,
-                job_configs=job_configs,
-            ):
-                return [
-                    TaskResults.create_from(
-                        success=False,
-                        msg="Account is not allowlisted!",
-                        job_config=job_config,
-                        event=self.event,
-                    )
-                    for job_config in job_configs
-                ]
+            #if not allowlist.check_and_report(
+            #    self.event,
+            #    self.event.project,
+            #    job_configs=job_configs,
+            #):
+            #    return [
+            #        TaskResults.create_from(
+            #            success=False,
+            #            msg="Account is not allowlisted!",
+            #            job_config=job_config,
+            #            event=self.event,
+            #        )
+            #        for job_config in job_configs
+            #    ]
 
             processing_results.extend(
                 self.create_tasks(job_configs, handler_kls, statuses_check_feedback)
@@ -559,13 +559,13 @@ class SteveJobs:
         Returns:
             Whether the task should be created.
         """
-        if self.service_config.deployment not in job_config.packit_instances:
-            logger.debug(
-                f"Current deployment ({self.service_config.deployment}) "
-                f"does not match the job configuration ({job_config.packit_instances}). "
-                "The job will not be run."
-            )
-            return False
+        #if self.service_config.deployment not in job_config.packit_instances:
+        #    logger.debug(
+        #        f"Current deployment ({self.service_config.deployment}) "
+        #        f"does not match the job configuration ({job_config.packit_instances}). "
+        #        "The job will not be run."
+        #    )
+        #    return False
 
         if not handler_kls.pre_check(
             package_config=(

The following patch is what I have used to make the dashboard work for me:

diff --git a/Dockerfile b/Dockerfile
index a171f2a..6db87c2 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,7 +1,7 @@
 FROM quay.io/packit/base:c9s
 
 # set default value, can be overriden by --build-arg while building
-ARG VITE_API_URL=https://stg.packit.dev/api
+ARG VITE_API_URL=https://service.localhost/api
 ENV VITE_API_URL ${VITE_API_URL}
 
 ARG VITE_GIT_SHA=dev
diff --git a/Makefile b/Makefile
index 0eaae60..5b6fac1 100644
--- a/Makefile
+++ b/Makefile
@@ -3,7 +3,7 @@ IMAGE ?= quay.io/packit/dashboard:stg
 TEST_IMAGE ?= packit-dashboard-tests
 TEST_TARGET ?= ./tests/
 CONTAINER_ENGINE ?= $(shell command -v podman 2> /dev/null || echo docker)
-API_URL ?= "https://stg.packit.dev/api"
+API_URL = "https://service.localhost/api"
 GIT_SHA_FETCH := $(shell git rev-parse HEAD)
 export GIT_SHA=$(GIT_SHA_FETCH)
 
diff --git a/files/scripts/run_httpd.sh b/files/scripts/run_httpd.sh
index 9c0c23e..1c87d2d 100755
--- a/files/scripts/run_httpd.sh
+++ b/files/scripts/run_httpd.sh
@@ -7,7 +7,7 @@ if [[ "${DEPLOYMENT:=dev}" == "dev" ]]; then
 elif [[ "${DEPLOYMENT}" == "prod" ]]; then
     SERVER_NAME="dashboard.packit.dev"
 else
-    SERVER_NAME="dashboard.${DEPLOYMENT}.packit.dev"
+    SERVER_NAME="dashboard.localhost"
 fi
 
 # See "mod_wsgi-express-3 start-server --help" for details on
diff --git a/packit_dashboard/app.py b/packit_dashboard/app.py
index 0664b9c..c752970 100644
--- a/packit_dashboard/app.py
+++ b/packit_dashboard/app.py
@@ -15,12 +15,12 @@ app = Flask(
 app.register_blueprint(home)
 
 
-csp = {
-    "default-src": ["'self'", "*.packit.dev"],
-    "object-src": "'none'",
-    "style-src": ["'unsafe-inline'", "'self'"],
-}
-Talisman(app, content_security_policy=csp)
+#csp = {
+#    "default-src": ["'self'", "*.packit.dev"],
+#    "object-src": "'none'",
+#    "style-src": ["'unsafe-inline'", "'self'"],
+#}
+#Talisman(app, content_security_policy=csp)
 
 if __name__ == "__main__":
     app.run(debug=getenv("DEPLOYMENT") != "prod")
diff --git a/packit_dashboard/config.py b/packit_dashboard/config.py
index 6339f84..392cb6d 100644
--- a/packit_dashboard/config.py
+++ b/packit_dashboard/config.py
@@ -2,4 +2,5 @@ from os import getenv
 
 deployment = getenv("DEPLOYMENT", "stg")
 
-API_URL = f"https://{deployment}.packit.dev/api"
+#API_URL = f"https://{deployment}.packit.dev/api"
+API_URL = f"https://service.localhost/api"