github-local 0.0.3b4575__tar.gz → 0.0.3b4586__tar.gz

{github_local-0.0.3b4575/python_packages/github_local.egg-info → github_local-0.0.3b4586}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: github-local
-Version: 0.0.3b4575
+Version: 0.0.3b4586
 Summary: PyPI github-local Python Package owned by Circlez.ai
 Home-page: https://github.com/circles-zone/github-local-python-package
 Author: Circles

{github_local-0.0.3b4575 → github_local-0.0.3b4586}/pyproject.toml

@@ -22,7 +22,7 @@ pythonpath = ["."]
 name = "github-local"
 # After the b (beta) comes the Jira Work Item ID (sdk-local Makec.ps1 updates it)
 # I believe we are still using the version from setup.py and not from here until Potery will work
-version = "0.0.3b4575" # https://pypi.org/project/github-local/
+version = "0.0.3b4586" # https://pypi.org/project/github-local/
 description = "github-local Python Package"
 readme = "README.md"
 authors = [

github_local-0.0.3b4586/python_packages/github_local/src/github_failed_job_reply.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+
+from .github_actions_failure_category import GitHubActionsFailureCategory
+
+
+@dataclass(frozen=True)
+class GitHubFailedJobReply:
+    channel_message: str
+    category: GitHubActionsFailureCategory
+    is_rerun_safe: bool

github_local-0.0.3b4586/python_packages/github_local/src/handle_github_failed_job.py

@@ -0,0 +1,62 @@
+"""A failed GitHub Actions job (GitHub webhook workflow_job event): classify it and tell the team in one Slack message,
+so nobody has to open the log to know whether it is their code, a runner or a missing secret."""
+from collections.abc import Callable
+from typing import Any
+
+from .classify_github_actions_failure import classify_github_actions_failure, main_error
+from .github_actions_failure import GitHubActionsFailure
+from .github_actions_failure_category import GitHubActionsFailureCategory, is_rerun_safe
+from .github_failed_job_reply import GitHubFailedJobReply
+
+WORKFLOW_JOB_EVENT = "workflow_job"
+NEXT_STEP = {
+    GitHubActionsFailureCategory.RUNNER: "The runner, not the code: rerun the job (another runner if it repeats).",
+    GitHubActionsFailureCategory.CONFIG_SECRET: "A secret / variable / permission is missing or wrong.",
+    GitHubActionsFailureCategory.PROCESS_GATE: "A company rule stopped it on purpose - see the error.",
+    GitHubActionsFailureCategory.SECURITY_DEPENDENCY: "A dependency or a security alert - update the package.",
+    GitHubActionsFailureCategory.TEST_FAILURE: "A test failed - the commit author please check.",
+    GitHubActionsFailureCategory.LINT_TYPE: "Lint / type check - the commit author please fix.",
+    GitHubActionsFailureCategory.PUBLISH_DEPLOY: "Build and tests passed; publishing or deploying failed.",
+    GitHubActionsFailureCategory.INVALID_WORKFLOW: "The workflow file itself is invalid.",
+    GitHubActionsFailureCategory.UNKNOWN: "Could not tell from the log.",
+}
+MESSAGE = (":red_circle: *{repo_name}* / {workflow_name} / {job_name} failed - `{category}`\n"
+           "{next_step}\n> {main_error}\n{html_url}")
+MAXIMUM_ERROR_LENGTH = 300
+
+
+class HandleGitHubFailedJob:
+    def __init__(self, get_job_log: Callable[[str, int], str]):
+        """get_job_log(repo full name, job id) -> the job log text, e.g. from the GitHub REST API"""
+        self.get_job_log = get_job_log
+
+    @staticmethod
+    def is_event(event_name: str, payload: dict[str, Any]) -> bool:
+        workflow_job = payload.get("workflow_job") or {}
+        is_failed_job = (event_name == WORKFLOW_JOB_EVENT and payload.get("action") == "completed"
+                         and workflow_job.get("conclusion") == "failure")
+        return is_failed_job
+
+    def handle(self, payload: dict[str, Any]) -> GitHubFailedJobReply:
+        workflow_job = payload["workflow_job"]
+        repo_full_name = payload["repository"]["full_name"]
+        try:
+            log = self.get_job_log(repo_full_name, workflow_job["id"])
+        except Exception:
+            # The message still goes out: the category is then UNKNOWN
+            log = ""
+        failed_step_name = next((step.get("name") for step in workflow_job.get("steps") or []
+                                 if step.get("conclusion") == "failure"), None)
+        failure = GitHubActionsFailure(repo_name=payload["repository"]["name"],
+                                       workflow_name=workflow_job.get("workflow_name") or "",
+                                       job_name=workflow_job.get("name"), failed_step_name=failed_step_name,
+                                       runner_name=workflow_job.get("runner_name"), log=log)
+        category = classify_github_actions_failure(failure)
+        error = main_error(log)[:MAXIMUM_ERROR_LENGTH] or f"Failed step: {failed_step_name or 'unknown'}"
+        channel_message = MESSAGE.format(repo_name=failure.repo_name, workflow_name=failure.workflow_name,
+                                         job_name=failure.job_name, category=category.value,
+                                         next_step=NEXT_STEP[category], main_error=error,
+                                         html_url=workflow_job.get("html_url", ""))
+        reply = GitHubFailedJobReply(channel_message=channel_message, category=category,
+                                     is_rerun_safe=is_rerun_safe(category))
+        return reply

github_local-0.0.3b4586/python_packages/github_local/tests/unit/handle_github_failed_job_unit_test.py

@@ -0,0 +1,66 @@
+import pytest
+
+from github_local.src.github_actions_failure_category import GitHubActionsFailureCategory
+from github_local.src.handle_github_failed_job import HandleGitHubFailedJob
+
+JOB_URL = "https://github.com/circles-zone/sdk-local/actions/runs/1/job/2"
+RUNNER_LOG = "Run tests\n##[error]No space left on device\n##[error]Process completed with exit code 1."
+
+
+def workflow_job_payload(conclusion: str = "failure", action: str = "completed") -> dict:
+    payload = {"action": action,
+               "repository": {"name": "sdk-local", "full_name": "circles-zone/sdk-local"},
+               "workflow_job": {"id": 2, "conclusion": conclusion, "name": "build", "workflow_name": "Play1",
+                                "runner_name": "runner-1", "html_url": JOB_URL,
+                                "steps": [{"name": "Checkout", "conclusion": "success"},
+                                          {"name": "Run tests", "conclusion": "failure"}]}}
+    return payload
+
+
+@pytest.mark.parametrize("event_name, payload, is_event", [
+    ("workflow_job", workflow_job_payload(), True),
+    ("workflow_job", workflow_job_payload(conclusion="success"), False),
+    ("workflow_job", workflow_job_payload(action="in_progress"), False),
+    ("push", workflow_job_payload(), False),
+    ("workflow_job", {"action": "completed"}, False),
+])
+def test_is_event_is_a_completed_failed_job(event_name, payload, is_event):
+    assert HandleGitHubFailedJob.is_event(event_name, payload) is is_event
+
+
+def test_a_runner_failure_says_to_rerun_and_links_the_job():
+    job_logs: list[tuple[str, int]] = []
+
+    def get_job_log(repo_full_name: str, job_id: int) -> str:
+        job_logs.append((repo_full_name, job_id))
+        return RUNNER_LOG
+
+    reply = HandleGitHubFailedJob(get_job_log).handle(workflow_job_payload())
+
+    assert job_logs == [("circles-zone/sdk-local", 2)]
+    assert reply.category == GitHubActionsFailureCategory.RUNNER
+    assert reply.is_rerun_safe
+    assert reply.channel_message.startswith(":red_circle: *sdk-local* / Play1 / build failed - `runner`\n")
+    assert "rerun the job" in reply.channel_message
+    assert "> No space left on device" in reply.channel_message
+    assert reply.channel_message.endswith(JOB_URL)
+
+
+def test_without_a_log_the_message_names_the_failed_step():
+    def get_job_log(repo_full_name: str, job_id: int) -> str:
+        raise RuntimeError("Not Found")
+
+    reply = HandleGitHubFailedJob(get_job_log).handle(workflow_job_payload())
+
+    assert reply.category == GitHubActionsFailureCategory.UNKNOWN
+    assert not reply.is_rerun_safe
+    assert "> Failed step: Run tests" in reply.channel_message
+
+
+def test_a_job_without_steps_still_gets_a_message():
+    payload = workflow_job_payload()
+    del payload["workflow_job"]["steps"]
+
+    reply = HandleGitHubFailedJob(lambda repo_full_name, job_id: "").handle(payload)
+
+    assert "> Failed step: unknown" in reply.channel_message

{github_local-0.0.3b4575 → github_local-0.0.3b4586/python_packages/github_local.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: github-local
-Version: 0.0.3b4575
+Version: 0.0.3b4586
 Summary: PyPI github-local Python Package owned by Circlez.ai
 Home-page: https://github.com/circles-zone/github-local-python-package
 Author: Circles

{github_local-0.0.3b4575 → github_local-0.0.3b4586}/python_packages/github_local.egg-info/SOURCES.txt

@@ -17,9 +17,12 @@ python_packages/github_local/src/classify_github_actions_failure.py
 python_packages/github_local/src/constants_github_local.py
 python_packages/github_local/src/github_actions_failure.py
 python_packages/github_local/src/github_actions_failure_category.py
+python_packages/github_local/src/github_failed_job_reply.py
 python_packages/github_local/src/github_local.py
+python_packages/github_local/src/handle_github_failed_job.py
 python_packages/github_local/tests/__init__.py
 python_packages/github_local/tests/unit/__init__.py
 python_packages/github_local/tests/unit/classify_github_actions_failure_unit_test.py
 python_packages/github_local/tests/unit/conftest.py
-python_packages/github_local/tests/unit/github_local_unit_test.py
+python_packages/github_local/tests/unit/github_local_unit_test.py
+python_packages/github_local/tests/unit/handle_github_failed_job_unit_test.py

{github_local-0.0.3b4575 → github_local-0.0.3b4586}/setup.py

@@ -32,7 +32,7 @@ setuptools.setup(
     # Updating the b{{JiraWorkItemId}} done automatically by makec.ps1 / make_py.ps1
     # According to GitFlow, in the Feature Branch, after the letter 'b' comes the
     #  Jira Work Item ID, i.e., 0.0.1b2432. Semantic Version simver.org
-    version='0.0.3b4575',  # https://pypi.org/project/github-local#History
+    version='0.0.3b4586',  # https://pypi.org/project/github-local#History
     author="Circles",
     author_email="info@circlez.ai",
     description=f"{PACKAGE_DESCRIPTION}",