patchwork: derive check context field from CI job name

Currently for BPF CI the "context" field of a checks is effectively a
constant with enumerator, for example:

    bpf/vmtest-bpf-next-VM_Test-48

This has an undesirable side-effect: different checks (such as "AI
review" vs "test_progs") may overwrite each other, depending on when
they run: for every PR update or for every new revision of the series.

Change how the context identifier is constructed: slugify the job
name, so that the check is associated with a job, independent of the
order or run time.

Signed-off-by: Ihor Solodrai <ihor.solodrai@linux.dev>

Author: theihor

kernel_patches_daemon/branch_worker.py

@@ -56,7 +56,12 @@
 )
 from kernel_patches_daemon.github_connector import GithubConnector
 from kernel_patches_daemon.github_logs import GithubLogExtractor
-from kernel_patches_daemon.patchwork import Patchwork, Series, Subject
+from kernel_patches_daemon.patchwork import (
+    Patchwork,
+    Series,
+    slugify_check_context,
+    Subject,
+)
 from kernel_patches_daemon.stats import HistogramMetricTimer
 from kernel_patches_daemon.status import (
     gh_conclusion_to_status,
@@ -100,9 +105,7 @@
     "Commenting is disabled on issues with more than 2500 comments"
 }
 CI_APP = 15368  # GithubApp(url="/apps/github-actions", id=15368)
-CI_VMTEST_NAME = "VM_Test"
 
-CI_DESCRIPTION = "vmtest"
 MERGE_CONFLICT_LABEL = "merge-conflict"
 UPSTREAM_REMOTE_NAME = "upstream"
 
@@ -650,15 +653,6 @@ def _is_outdated_pr(pr: PullRequest) -> bool:
 
 
 class BranchWorker(GithubConnector):
-    @staticmethod
-    def slugify_context(s: str):
-        # According to patchwork rule:
-        # https://github.com/getpatchwork/patchwork/blob/2aa4742ec88be4cd07f569805d22a35c08a08f40/releasenotes/notes/slugify-check-context-dc586f204b5058a7.yaml
-        # the context need to be a slug, or a string consisting of only
-        # ASCII letters, numbers, underscores or hyphens.
-        # Lets replace all "." with "_"
-        return s.replace(".", "_")
-
     def __init__(
         self,
         patchwork: Patchwork,
@@ -1277,12 +1271,12 @@ async def sync_checks(self, pr: PullRequest, series: Series) -> None:
         # cached state).
         pr.update()
         # if it's merge conflict - report failure
-        ctx = BranchWorker.slugify_context(f"{CI_DESCRIPTION}-{self.repo_branch}")
+        ctx_prefix = slugify_check_context(f"{self.repo_branch}")
         if pr_has_label(pr, MERGE_CONFLICT_LABEL):
             await series.set_check(
                 status=Status.CONFLICT,
                 target_url=pr.html_url,
-                context=f"{ctx}-PR",
+                context=f"{ctx_prefix}_PR",
                 description=MERGE_CONFLICT_LABEL,
             )
             await self.evaluate_ci_result(Status.CONFLICT, series, pr, [])
@@ -1344,17 +1338,17 @@ async def sync_checks(self, pr: PullRequest, series: Series) -> None:
             self.submit_pr_summary(
                 series=series,
                 status=status,
-                context_name=ctx,
+                context_name=ctx_prefix,
                 target_url=pr.html_url,
             )
         ] + [
             series.set_check(
                 status=gh_conclusion_to_status(job.conclusion),
                 target_url=job.html_url,
-                context=BranchWorker.slugify_context(f"{ctx}-{CI_VMTEST_NAME}-{idx}"),
+                context=slugify_check_context(f"{ctx_prefix}_{job.name}"),
                 description=f"Logs for {job.name}",
             )
-            for idx, job in enumerate(jobs)
+            for job in jobs
         ]
         await asyncio.gather(*tasks)
 

kernel_patches_daemon/patchwork.py

@@ -96,6 +96,22 @@
 )
 
 
+CHECK_CONTEXT_NOT_ALLOWED_CHARS_RE: Final[re.Pattern] = re.compile(r"[^-a-zA-Z0-9_]+")
+MULTIPLE_UNDERSCORES_RE: Final[re.Pattern] = re.compile(r"_+")
+
+
+def slugify_check_context(check_context: str) -> str:
+    """
+    Slugify provided string, so that it can be used as a "context" field of a patchwork check.
+    See: https://github.com/getpatchwork/patchwork/blob/v3.1.3/docs/api/schemas/latest/patchwork.yaml#L1579
+    """
+    result = CHECK_CONTEXT_NOT_ALLOWED_CHARS_RE.sub("_", check_context)
+    result = MULTIPLE_UNDERSCORES_RE.sub("_", result)
+    result = result.strip("_")
+
+    return result
+
+
 ## Request Tracing
 class TraceContext(SimpleNamespace):
     """
@@ -700,11 +716,11 @@ async def post_check_for_patch_id(
                 )
                 return None
 
-            logger.info(
+            logger.debug(
                 f"Updating patch {patch_id} check, current state: '{check.get('state')}', new state: '{new_state}'"
             )
         except ValueError:
-            logger.info(f"Setting patch {patch_id} check to '{new_state}' state")
+            logger.debug(f"Setting patch {patch_id} check to '{new_state}' state")
 
         return await self.__try_post(
             f"patches/{patch_id}/checks/",

tests/test_github_sync.py

@@ -398,7 +398,7 @@ async def test_sync_patches_pr_summary_success(self, m: aioresponses) -> None:
         post_data = post_calls[0].kwargs["data"]
         expected_post_data = {
             "target_url": "https://github.com/org/repo/pull/98765",
-            "context": "vmtest-test-bpf-next-PR",
+            "context": "test-bpf-next-PR",
             "description": "PR summary",
             "state": "success",
         }