github-local 0.0.3b4586__tar.gz → 0.0.5b4611__tar.gz

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

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: github-local
-Version: 0.0.3b4586
+Version: 0.0.5b4611
 Summary: PyPI github-local Python Package owned by Circlez.ai
 Home-page: https://github.com/circles-zone/github-local-python-package
 Author: Circles
 Author-email: info@circlez.ai
+License: MIT
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
@@ -16,6 +17,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license
 Dynamic: requires-dist
 Dynamic: summary
 

{github_local-0.0.3b4586 → github_local-0.0.5b4611}/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.3b4586" # https://pypi.org/project/github-local/
+version = "0.0.5b4611" # https://pypi.org/project/github-local/
 description = "github-local Python Package"
 readme = "README.md"
 authors = [

github_local-0.0.5b4611/python_packages/github_local/src/github_run_conclusion_enum.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class GitHubRunConclusionEnum(Enum):
+    """The conclusion of a completed GitHub Actions run, as the GitHub REST API returns it"""
+    SUCCESS = "success"
+    FAILURE = "failure"
+    CANCELLED = "cancelled"
+    SKIPPED = "skipped"
+    TIMED_OUT = "timed_out"
+    ACTION_REQUIRED = "action_required"
+    NEUTRAL = "neutral"
+    STALE = "stale"
+    STARTUP_FAILURE = "startup_failure"

github_local-0.0.5b4611/python_packages/github_local/src/github_run_rerun.py

@@ -0,0 +1,36 @@
+import requests
+from python_sdk_remote.utilities import our_get_env
+
+from .github_run_conclusion_enum import GitHubRunConclusionEnum
+
+DEFAULT_GITHUB_API_URL = "https://api.github.com"
+REQUEST_TIMEOUT_SECONDS = 30
+COMPLETED_STATUS = "completed"
+
+
+class GitHubRunRerun:
+    """Re-runs the failed jobs of a GitHub Actions run - the automated fix of a failed run"""
+
+    def __init__(self, token: str | None = None, api_url: str | None = None,
+                 session: requests.Session | None = None):
+        self.token = token or our_get_env("GITHUB_TOKEN", raise_if_empty=True)
+        self.api_url = (api_url or our_get_env("GITHUB_API_URL", DEFAULT_GITHUB_API_URL)).rstrip("/")
+        self.session = session or requests.Session()
+
+    def _headers(self) -> dict[str, str]:
+        headers = {"Authorization": f"Bearer {self.token}", "Accept": "application/vnd.github+json"}
+        return headers
+
+    def rerun_failed_jobs(self, repo: str, run_id: int) -> None:
+        response = self.session.post(f"{self.api_url}/repos/{repo}/actions/runs/{run_id}/rerun-failed-jobs",
+                                     headers=self._headers(), timeout=REQUEST_TIMEOUT_SECONDS)
+        response.raise_for_status()
+
+    def get_conclusion(self, repo: str, run_id: int) -> GitHubRunConclusionEnum | None:
+        """None while the run is not completed"""
+        response = self.session.get(f"{self.api_url}/repos/{repo}/actions/runs/{run_id}",
+                                    headers=self._headers(), timeout=REQUEST_TIMEOUT_SECONDS)
+        response.raise_for_status()
+        run = response.json()
+        conclusion = GitHubRunConclusionEnum(run["conclusion"]) if run["status"] == COMPLETED_STATUS else None
+        return conclusion

github_local-0.0.5b4611/python_packages/github_local/tests/unit/github_run_rerun_unit_test.py

@@ -0,0 +1,75 @@
+from http import HTTPStatus
+from unittest.mock import MagicMock
+
+import pytest
+import requests
+from python_sdk_remote.utilities import OurEnvironmentVariableException
+
+from github_local.src.github_run_conclusion_enum import GitHubRunConclusionEnum
+from github_local.src.github_run_rerun import GitHubRunRerun
+
+API_URL = "https://api.github.test"
+REPO = "circles-zone/sdk-local"
+
+
+def response(status_code: HTTPStatus = HTTPStatus.CREATED, json_result: dict | None = None) -> MagicMock:
+    result = MagicMock(status_code=status_code)
+    result.json.return_value = json_result
+    result.raise_for_status.side_effect = requests.HTTPError(str(status_code)) if status_code >= HTTPStatus.BAD_REQUEST else None
+    return result
+
+
+@pytest.fixture(autouse=True)
+def environment(monkeypatch):
+    monkeypatch.setenv("GITHUB_TOKEN", "token")
+    monkeypatch.setenv("GITHUB_API_URL", API_URL)
+
+
+def test_re_runs_the_failed_jobs_of_the_run():
+    session = MagicMock()
+    session.post.return_value = response()
+
+    GitHubRunRerun(session=session).rerun_failed_jobs(REPO, 41918691683)
+
+    assert session.post.call_args.args[0] == f"{API_URL}/repos/{REPO}/actions/runs/41918691683/rerun-failed-jobs"
+    assert session.post.call_args.kwargs["headers"]["Authorization"] == "Bearer token"
+
+
+def test_re_run_raises_on_an_http_error():
+    session = MagicMock()
+    session.post.return_value = response(HTTPStatus.FORBIDDEN)
+
+    with pytest.raises(requests.HTTPError):
+        GitHubRunRerun(session=session).rerun_failed_jobs(REPO, 1)
+
+
+def test_the_conclusion_is_none_while_the_run_is_in_progress():
+    session = MagicMock()
+    session.get.return_value = response(HTTPStatus.OK, {"status": "in_progress", "conclusion": None})
+
+    assert GitHubRunRerun(session=session).get_conclusion(REPO, 1) is None
+    assert session.get.call_args.args[0] == f"{API_URL}/repos/{REPO}/actions/runs/1"
+
+
+def test_the_conclusion_of_a_completed_run_is_an_enum():
+    session = MagicMock()
+    session.get.return_value = response(HTTPStatus.OK, {"status": "completed", "conclusion": "success"})
+
+    assert GitHubRunRerun(session=session).get_conclusion(REPO, 1) is GitHubRunConclusionEnum.SUCCESS
+
+
+def test_explicit_token_and_api_url_win():
+    session = MagicMock()
+    session.post.return_value = response()
+
+    GitHubRunRerun(token="explicit", api_url="https://ghe.test/", session=session).rerun_failed_jobs("o/r", 2)
+
+    assert session.post.call_args.args[0] == "https://ghe.test/repos/o/r/actions/runs/2/rerun-failed-jobs"
+    assert session.post.call_args.kwargs["headers"]["Authorization"] == "Bearer explicit"
+
+
+def test_a_missing_token_raises(monkeypatch):
+    monkeypatch.setenv("GITHUB_TOKEN", "")
+
+    with pytest.raises(OurEnvironmentVariableException):
+        GitHubRunRerun()

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

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: github-local
-Version: 0.0.3b4586
+Version: 0.0.5b4611
 Summary: PyPI github-local Python Package owned by Circlez.ai
 Home-page: https://github.com/circles-zone/github-local-python-package
 Author: Circles
 Author-email: info@circlez.ai
+License: MIT
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
@@ -16,6 +17,7 @@ Dynamic: classifier
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license
 Dynamic: requires-dist
 Dynamic: summary
 

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

@@ -17,12 +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/src/github_run_conclusion_enum.py
+python_packages/github_local/src/github_run_rerun.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/handle_github_failed_job_unit_test.py
+python_packages/github_local/tests/unit/github_run_rerun_unit_test.py

{github_local-0.0.3b4586 → github_local-0.0.5b4611}/setup.py

@@ -24,6 +24,7 @@ package_dir = PACKAGE_NAME.replace("-", "_")
 PACKAGE_DESCRIPTION = f"PyPI {PACKAGE_NAME} Python Package owned by Circlez.ai"
 
 setuptools.setup(
+    license='MIT',
     name=PACKAGE_NAME,
     # Increase this number every time you make a change
     #  want to publish. After 0.0.9 switch to 0.0.10 and not 0.1.0
@@ -32,7 +33,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.3b4586',  # https://pypi.org/project/github-local#History
+    version="0.0.5b4611",  # https://pypi.org/project/github-local#History
     author="Circles",
     author_email="info@circlez.ai",
     description=f"{PACKAGE_DESCRIPTION}",
@@ -60,7 +61,7 @@ setuptools.setup(
         "Programming Language :: Python :: 3",
         # https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license
         # TODO Fix all repos, especially the Python templates
-        # "License :: MIT AND (Apache-2.0 OR BSD-2-Clause)",
+        #
         "Operating System :: OS Independent",
     ],
     # Do not add packages needed only for tests, i.e., packages for get_test_xxx(
@@ -71,3 +72,4 @@ setuptools.setup(
         'requests',
     ]
 )
+

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

@@ -1,10 +0,0 @@
-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

@@ -1,62 +0,0 @@
-"""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

@@ -1,66 +0,0 @@
-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