Refactor false-positive .sh helper into .py #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

mikeBashStuff wants to merge 2 commits into spdk:main from mikeBashStuff:mb-refactor-python

.github/scripts/helpers/__init__.py

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    from .env import Env
+    from .gerrit import Gerrit
+    from .github import GitHub
+    __all__ = [
+        "Env",
+        "Gerrit",
+        "GitHub",
+    ]

.github/scripts/helpers/env.py

-Original file line number
+Diff line change
@@ -0,0 +1,29 @@
+    import os
+    class Env:
+        def __init__(self):
+            self.reported_by = os.getenv("AUTHOR")
+            self.gerrit_comment = os.getenv("COMMENT")
+            self.gerrit_bot_http_passwd = os.getenv("GERRIT_BOT_HTTP_PASSWD")
+            self.gerrit_bot_user = os.getenv("GERRIT_BOT_USER")
+            self.gh_issue_pat = os.getenv("GH_ISSUES_PAT")
+            self.gh_repo = os.getenv("GH_REPO")
+            self.spdk_repo = os.getenv("REPO")
+            self.change_num = os.getenv("change_num")  # FIXME: to uppercase
+            self.patch_set = os.getenv("patch_set")  # FIXME: to uppercase
+            self.gh_auth = not os.getenv("GITHUB_DISABLE_AUTH")
+            self.gerrit_auth = not os.getenv("GERRIT_DISABLE_AUTH")
+            self._ignore = ["gh_auth", "gerrit_auth"]
+            for var, val in self.__dict__.items():
+                if var in self._ignore:
+                    continue
+                if not val:
+                    raise AttributeError(
+                        f"Not all env attributes were set: {self.__dict__.items()}"
+                    )
+            self.change_num = int(self.change_num)
+            self.patch_set = int(self.patch_set)

.github/scripts/helpers/gerrit.py

-Original file line number
+Diff line change
@@ -0,0 +1,38 @@
+    import json
+    import requests
+    class Gerrit:
+        def __init__(self, env, auth=True):
+            self.env = env
+            self.auth = auth
+            self.format = "o=DETAILED_ACCOUNTS&o=MESSAGES&o=LABELS&o=SKIP_DIFFSTAT"
+            self.gerrit_url = "https://review.spdk.io"
+            self.creds = ()
+            if self.auth:
+                self.creds = (self.env.gerrit_bot_user, self.env.gerrit_bot_http_passwd)
+                self.gerrit_url += "/a/changes"
+            else:
+                self.gerrit_url += "/changes"
+        def get_change(self):
+            raw = requests.get(
+                f"{self.gerrit_url}/{self.env.spdk_repo.replace("/", "%2F")}~{self.env.change_num}?{self.format}",
+                auth=self.creds,
+            )
+            raw.raise_for_status()
+            details = raw.text.splitlines()
+            if len(details) != 2:
+                return {}
+            return json.loads(details[1])
+        def post_comment(self, msg):
+            post = requests.post(
+                f"{self.gerrit_url}/{self.env.change_num}/revisions/{self.env.patch_set}/review",
+                headers={"Content-Type": "application/json"},
+                data=json.dumps(msg),
+            )
+            post.raise_for_status()

.github/scripts/helpers/github.py

-Original file line number
+Diff line change
@@ -0,0 +1,46 @@
+    import re
+    import requests
+    import json
+    class GitHub:
+        def __init__(self, env, auth=True):
+            self.env = env
+            self.auth = auth
+            self.gh_url = f"https://api.github.com/repos/{self.env.gh_repo}"
+            self.gh_auth_headers = {}
+            if self.auth:
+                self.gh_auth_headers = {
+                    "Accept": "application/vnd.github+json",
+                    "Authorization": f"Bearer {self.env.gh_issue_pat}",
+                }
+        def get_issue_from_gerrit_comment(self):
+            pattern = re.compile(
+                r"patch set [0-9]+:\n\nfalse positive:\s*[#]?([0-9]+)$",
+                re.IGNORECASE,
+            )
+            gh_issue = int(re.search(pattern, self.env.gerrit_comment).groups()[0])
+            gh_issue_j = requests.get(
+                f"{self.gh_url}/issues/{gh_issue}", headers=self.gh_auth_headers
+            ).json()
+            return gh_issue, gh_issue_j
+        def post_comment(self, gh_issue, msg):
+            post = requests.post(
+                f"{self.gh_url}/issues/{gh_issue}/comments",
+                headers=self.gh_auth_headers,
+                json=json.dumps(msg),
+            )
+            post.raise_for_status()
+        def post_rerun(self, run_id):
+            post = requests.post(
+                f"{self.gh_url}/actions/runs/{run_id}/run",
+                headers=self.gh_auth_headers,
+            )
+            post.raise_for_status()

.github/scripts/parse_false_positive_comment.py

-Original file line number
+Diff line change
@@ -0,0 +1,134 @@
+    #!/usr/bin/env python3
+    import re
+    import sys
+    from helpers import Env, Gerrit, GitHub
+    def is_wip(change):
+        return change.get("work_in_progress")
+    def is_current_revision(change, patch_set):
+        return change.get("current_revision_number") == patch_set
+    def is_negative_from_user(change, user):
+        user_ver = next(
+            (ver for ver in change["labels"]["Verified"]["all"] if ver["username"] == user),
+            {},
+        )
+        return user_ver and user_ver.get("value", 0) == -1
+    def is_issue_state(issue, state="open"):
+        set_state = issue.get("state").lower()
+        return set_state == state.lower()
+    def get_failed_builds_for_patch_by_user(change, user, patch_set):
+        # Group comments into respective patchsets, pick the latest "Build failed" comment from
+        # the latest patchset it was recorded at and check if that patchset is older or the
+        # same as patch_set.
+        pattern = "Build failed. Results: "
+        comments_per_patchset = {}
+        for msg in change["messages"]:
+            if msg["author"]["username"] != user:
+                continue
+            if msg["_revision_number"] not in comments_per_patchset:
+                comments_per_patchset[msg["_revision_number"]] = []
+            comments_per_patchset[msg["_revision_number"]].append(msg["message"])
+        latest_build_failed_patchset = -1
+        for p in sorted(comments_per_patchset.keys()):
+            if pattern in "\n".join(comments_per_patchset[p]):
+                latest_build_failed_patchset = p
+        if latest_build_failed_patchset == -1 or latest_build_failed_patchset > patch_set:
+            return []
+        failed_builds = []
+        for comment in comments_per_patchset[latest_build_failed_patchset]:
+            for line in comment.splitlines():
+                if pattern in line:
+                    failed_builds.append(line)
+        return failed_builds
+    def get_url_details_from_failed_build(build):
+        run_url_pattern = re.compile(r"\((https://.+)\)")
+        run_id_pattern = re.compile(r"\[([0-9]+)/[0-9]+\]")
+        return (
+            re.search(run_url_pattern, build).groups()[0],
+            re.search(run_id_pattern, build).groups()[0],
+        )
+    def main():
+        env = Env()
+        gerrit = Gerrit(env, auth=env.gh_auth)
+        github = GitHub(env, auth=env.gerrit_auth)
+        change_details = gerrit.get_change()
+        change_gh_details = github.get_issue_from_gerrit_comment()
+        (gh_issue, gh_issue_j) = change_gh_details
+        if not change_details:
+            print(f"Change {env.change_num} does not exist? Verify the environment.")
+            sys.exit(0)
+        if not gh_issue:
+            print(
+                "Ignore. Comment does not include valid false positive phrase, no issue number found."
+            )
+            sys.exit(0)
+        if is_wip(change_details):
+            print("Ignore. Comment posted to WIP change.")
+            sys.exit(0)
+        if not is_current_revision(change_details, env.patch_set):
+            print("Ignore. Comment posted to different patch set.")
+            sys.exit(0)
+        if not is_negative_from_user(change_details, env.gerrit_bot_user):
+            print("Ignore. Comment posted with no negative vote from CI")
+            sys.exit(0)
+        if not is_issue_state(gh_issue_j, "open"):
+            print("Comment points to incorrect GitHub issue.")
+            gerrit.post_to_gerrit(
+                {"message": f"Issue #{gh_issue} does not exist or is already closed."}
+            )
+            sys.exit(0)
+        failed_builds = get_failed_builds_for_patch_by_user(
+            change_details, env.gerrit_bot_user, env.patch_set
+        )
+        if not failed_builds:
+            print("Did not find comments indicating build failure")
+            sys.exit(1)
+        (fp_run_url, fp_run_id) = get_url_details_from_failed_build(failed_builds[-1])
+        github.post_comment(
+            gh_issue,
+            {
+                "body": f"Another instance of this failure. Reported by @{env.reported_by}. Log: {fp_run_url}"
+            },
+        )
+        github.post_rerun(fp_run_id)
+        gerrit.post_comment({"message": "Retriggered", "labels": {"Verified": 0}})
+    if __name__ == "__main__":
+        main()

.github/scripts/parse_false_positive_comment.sh

This file was deleted.

.github/workflows/gerrit-false-positives-handler.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -40,4 +40,4 @@ jobs: @@
         steps:
         - uses: actions/checkout@v4
         - name: Parse for false positive
-          run: .github/scripts/parse_false_positive_comment.sh
+          run: .github/scripts/parse_false_positive_comment.py

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor false-positive .sh helper into .py #67

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Refactor false-positive .sh helper into .py #67

Are you sure you want to change the base?

Uh oh!

Refactor false-positive .sh helper into .py #67

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!