implement support for forgejo commit statuses

Signed-off-by: Olamidepeterojo <[email protected]>

Author: olamidepeterojo

ogr/services/forgejo/__init__.py

@@ -1,12 +1,14 @@
 # Copyright Contributors to the Packit project.
 # SPDX-License-Identifier: MIT
 
+from ogr.services.forgejo.commit_flag import ForgejoCommitFlag
 from ogr.services.forgejo.issue import ForgejoIssue
 from ogr.services.forgejo.project import ForgejoProject
 from ogr.services.forgejo.pull_request import ForgejoPullRequest
 from ogr.services.forgejo.service import ForgejoService
 
 __all__ = [
+    ForgejoCommitFlag.__name__,
     ForgejoPullRequest.__name__,
     ForgejoIssue.__name__,
     ForgejoProject.__name__,

ogr/services/forgejo/commit_flag.py

@@ -4,7 +4,7 @@
 from datetime import datetime
 from typing import Any
 
-import requests
+from pyforgejo import PyforgejoApi
 
 from ogr.abstract import CommitFlag, CommitStatus
 
@@ -51,29 +51,24 @@ def _from_raw_commit_flag(self) -> None:
         self.comment = raw.get("comment")
         self.uid = raw.get("id")
         self.url = raw.get("url")
-        # Parse timestamps in ISO8601 format (adjust format if needed)
-        self._created = datetime.strptime(raw.get("created"), "%Y-%m-%dT%H:%M:%SZ")
-        self._edited = datetime.strptime(raw.get("updated"), "%Y-%m-%dT%H:%M:%SZ")
+        self._created = raw.get("created")
+        self._edited = raw.get("updated")
 
     @staticmethod
     def get(project: Any, commit: str) -> list["CommitFlag"]:
         """
-        Retrieve commit statuses for the given commit from Forgejo.
-        This method should use Forgejo's API to fetch statuses.
+        Retrieve commit statuses for the given commit from Forgejo using the pyforgejo SDK.
         """
-        # Construct the URL using the project's forge_api_url, owner, repo, and commit hash.
-        url = (
-            f"{project.forge_api_url}/repos/{project.owner}/{project.repo}/commits/"
-            f"{commit}/statuses"
+        client = PyforgejoApi(api_url=project.forge_api_url, token=project.token)
+        raw_flags = client.get_commit_statuses(
+            owner=project.owner,
+            repo=project.repo,
+            commit=commit,
         )
-        headers = project.get_auth_header()  # Get auth headers from project config
-        response = requests.get(url, headers=headers)
-        response.raise_for_status()
-        flags: list[CommitFlag] = [
+        return [
             ForgejoCommitFlag(raw_commit_flag=raw_flag, project=project, commit=commit)
-            for raw_flag in response.json()
+            for raw_flag in raw_flags
         ]
-        return flags
 
     @staticmethod
     def set(
@@ -85,22 +80,20 @@ def set(
         context: str,
     ) -> "CommitFlag":
         """
-        Set a new commit status on Forgejo via its API.
+        Set a new commit status on Forgejo via the pyforgejo SDK.
         """
-        url = (
-            f"{project.forge_api_url}/repos/{project.owner}/{project.repo}/commits/"
-            f"{commit}/statuses"
+        client = PyforgejoApi(api_url=project.forge_api_url, token=project.token)
+        raw_response = client.set_commit_status(
+            owner=project.owner,
+            repo=project.repo,
+            commit=commit,
+            state=state.name.lower(),
+            target_url=target_url,
+            description=description,
+            context=context,
         )
-        payload = {
-            "state": state.name.lower(),
-            "target_url": target_url,
-            "description": description,
-            "context": context,
-        }
-        headers = project.get_auth_header()
-        response = requests.post(url, json=payload, headers=headers)
         return ForgejoCommitFlag(
-            raw_commit_flag=response.json(),
+            raw_commit_flag=raw_response,
             project=project,
             commit=commit,
         )

tests/integration/forgejo/conftest.py

@@ -15,3 +15,13 @@ def service():
         instance_url="https://v10.next.forgejo.org",
         api_key=api_key,
     )
+
+
+@pytest.fixture
+def project(service):
+    repo = os.environ.get("FORGEJO_REPO", "existing_repo_name")
+    namespace = os.environ.get("FORGEJO_NAMESPACE", "existing_namespace")
+    project = service.get_project(repo=repo, namespace=namespace)
+    if not project:
+        pytest.skip(f"Project {namespace}/{repo} does not exist.")
+    return project

tests/integration/forgejo/test_commit_flag.py

@@ -2,95 +2,162 @@
 # SPDX-License-Identifier: MIT
 
 import datetime
-import responses
+
 import pytest
-from typing import Any, Dict, List, Optional
-import requests
 
-from ogr.abstract import CommitStatus, CommitFlag
+from ogr.abstract import CommitFlag, CommitStatus
 from ogr.services.forgejo.commit_flag import ForgejoCommitFlag
 
+
+def fake_get_commit_statuses(self, owner, repo, commit):
+    return [
+        {
+            "commit": commit,
+            "state": "success",
+            "context": "CI",
+            "comment": "All tests passed",
+            "id": "123",
+            "url": f"http://dummy-forgejo/commit/{commit}/status",
+            "created": datetime.datetime.strptime(
+                "2023-01-01T12:00:00Z",
+                "%Y-%m-%dT%H:%M:%SZ",
+            ),
+            "updated": datetime.datetime.strptime(
+                "2023-01-01T12:30:00Z",
+                "%Y-%m-%dT%H:%M:%SZ",
+            ),
+        },
+    ]
+
+
+def fake_set_commit_status(
+    self,
+    owner,
+    repo,
+    commit,
+    state,
+    target_url,
+    description,
+    context,
+):
+    return {
+        "commit": commit,
+        "state": state,
+        "context": context,
+        "comment": description,
+        "id": "456",
+        "url": f"http://dummy-forgejo/commit/{commit}/status",
+        "created": datetime.datetime.strptime(
+            "2023-02-01T12:00:00Z",
+            "%Y-%m-%dT%H:%M:%SZ",
+        ),
+        "updated": datetime.datetime.strptime(
+            "2023-02-01T12:30:00Z",
+            "%Y-%m-%dT%H:%M:%SZ",
+        ),
+    }
+
+
+class FakePyforgejoApi:
+    def __init__(self, api_url, token):
+        self.api_url = api_url
+        self.token = token
+
+    def get_commit_statuses(self, owner, repo, commit):
+        return fake_get_commit_statuses(self, owner, repo, commit)
+
+    def set_commit_status(
+        self,
+        owner,
+        repo,
+        commit,
+        state,
+        target_url,
+        description,
+        context,
+    ):
+        return fake_set_commit_status(
+            self,
+            owner,
+            repo,
+            commit,
+            state,
+            target_url,
+            description,
+            context,
+        )
+
+
 class MockProject:
     forge_api_url = "http://dummy-forgejo/api/v1"
     owner = "dummy_owner"
     repo = "dummy_repo"
+    token = "dummy_token"
 
-    def get_auth_header(self) -> Dict[str, str]:
+    def get_auth_header(self) -> dict[str, str]:
         return {"Authorization": "Bearer dummy_token"}
 
-@responses.activate
+
+@pytest.fixture(autouse=True)
+def patch_pyforgejo_api(monkeypatch):
+    monkeypatch.setattr(
+        "ogr.services.forgejo.commit_flag.PyforgejoApi",
+        FakePyforgejoApi,
+    )
+
+
 def test_get_commit_flag_integration():
     project = MockProject()
     commit = "abcdef123456"
-    url = f"{project.forge_api_url}/repos/{project.owner}/{project.repo}/commits/{commit}/statuses"
-    
-    # Dummy response data simulating Forgejo API output.
-    dummy_response = [{
-        "commit": commit,
-        "state": "success",
-        "context": "CI",
-        "comment": "All tests passed",
-        "id": "123",
-        "url": "http://dummy-forgejo/commit/abcdef123456/status",
-        "created": "2023-01-01T12:00:00Z",
-        "updated": "2023-01-01T12:30:00Z"
-    }]
-    responses.add(responses.GET, url, json=dummy_response, status=200)
-    
-    # Call the method under test.
-    flags: List[CommitFlag] = ForgejoCommitFlag.get(project, commit)
-    
-    # Assertions using CommitStatus from packit.ogr.abstract.
+
+    flags: list[CommitFlag] = ForgejoCommitFlag.get(project, commit)
+
     assert len(flags) == 1
     flag = flags[0]
     assert flag.commit == commit
     assert flag.state == CommitStatus.success
     assert flag.context == "CI"
     assert flag.comment == "All tests passed"
     assert flag.uid == "123"
-    
-    expected_created = datetime.datetime.strptime("2023-01-01T12:00:00Z", "%Y-%m-%dT%H:%M:%SZ")
-    expected_updated = datetime.datetime.strptime("2023-01-01T12:30:00Z", "%Y-%m-%dT%H:%M:%SZ")
+
+    expected_created = datetime.datetime.strptime(
+        "2023-01-01T12:00:00Z",
+        "%Y-%m-%dT%H:%M:%SZ",
+    )
+    expected_updated = datetime.datetime.strptime(
+        "2023-01-01T12:30:00Z",
+        "%Y-%m-%dT%H:%M:%SZ",
+    )
     assert flag.created == expected_created
     assert flag.edited == expected_updated
 
-@responses.activate
+
 def test_set_commit_flag_integration():
     project = MockProject()
     commit = "abcdef123456"
-    url = f"{project.forge_api_url}/repos/{project.owner}/{project.repo}/commits/{commit}/statuses"
-    
-    # Dummy response for setting a commit status.
-    dummy_response = {
-        "commit": commit,
-        "state": "success",
-        "context": "CI",
-        "comment": "Build succeeded",
-        "id": "456",
-        "url": "http://dummy-forgejo/commit/abcdef123456/status",
-        "created": "2023-02-01T12:00:00Z",
-        "updated": "2023-02-01T12:30:00Z"
-    }
-    responses.add(responses.POST, url, json=dummy_response, status=200)
-    
-    # Call the set method to create a new commit flag.
+
     flag = ForgejoCommitFlag.set(
         project=project,
         commit=commit,
         state=CommitStatus.success,
         target_url="http://dummy-target",
         description="Build succeeded",
-        context="CI"
+        context="CI",
     )
-    
-    # Assertions to verify correct mapping using CommitStatus.
+
     assert flag.commit == commit
     assert flag.state == CommitStatus.success
     assert flag.context == "CI"
     assert flag.comment == "Build succeeded"
     assert flag.uid == "456"
-    
-    expected_created = datetime.datetime.strptime("2023-02-01T12:00:00Z", "%Y-%m-%dT%H:%M:%SZ")
-    expected_updated = datetime.datetime.strptime("2023-02-01T12:30:00Z", "%Y-%m-%dT%H:%M:%SZ")
+
+    expected_created = datetime.datetime.strptime(
+        "2023-02-01T12:00:00Z",
+        "%Y-%m-%dT%H:%M:%SZ",
+    )
+    expected_updated = datetime.datetime.strptime(
+        "2023-02-01T12:30:00Z",
+        "%Y-%m-%dT%H:%M:%SZ",
+    )
     assert flag.created == expected_created
     assert flag.edited == expected_updated