implement support for forgejo commit statuses

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

Author: olamidepeterojo

ogr/services/forgejo/commit_flag.py

@@ -0,0 +1,97 @@
+# Copyright Contributors to the Packit project.
+# SPDX-License-Identifier: MIT
+
+import requests
+
+from datetime import datetime
+from typing import Any, List, Optional
+from ogr.abstract import CommitFlag, CommitStatus
+
+class ForgejoCommitFlag(CommitFlag):
+    """
+    CommitFlag implementation for Forgejo.
+    """
+
+    @classmethod
+    def _state_from_str(cls, state: str) -> CommitStatus:
+        # Convert a status string returned by Forgejo API into CommitStatus enum.
+        state = state.lower()
+        if state == "success":
+            return CommitStatus.success
+        elif state == "failure":
+            return CommitStatus.failure
+        elif state == "pending":
+            return CommitStatus.pending
+        else:
+            raise ValueError(f"Unknown commit state from Forgejo: {state}")
+
+    @classmethod
+    def _validate_state(cls, state: CommitStatus) -> CommitStatus:
+        # Validate that the provided state is acceptable for Forgejo.
+        valid_states = {CommitStatus.success, CommitStatus.failure, CommitStatus.pending}
+        if state in valid_states:
+            return state
+        raise ValueError(f"Invalid commit state for Forgejo: {state}")
+
+    def _from_raw_commit_flag(self) -> None:
+        """
+        Populate attributes from the raw commit flag data obtained from Forgejo's API.
+        Expected keys in self._raw_commit_flag: 'commit', 'state', 'context', 'comment', 'id',
+        'created', and 'updated'.
+        """
+        raw = self._raw_commit_flag
+        self.commit = raw.get("commit")
+        self.state = self._state_from_str(raw.get("state", "pending"))
+        self.context = raw.get("context")
+        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")
+
+    @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.
+        """
+        # 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/{commit}/statuses"
+        headers = project.get_auth_header()  # Get auth headers from project config
+        response = requests.get(url, headers=headers)
+        flags = []
+        for raw_flag in response.json():
+            flags.append(ForgejoCommitFlag(raw_commit_flag=raw_flag, project=project, commit=commit))
+        return flags
+
+    @staticmethod
+    def set(
+        project: Any,
+        commit: str,
+        state: CommitStatus,
+        target_url: str,
+        description: str,
+        context: str,
+    ) -> "CommitFlag":
+        """
+        Set a new commit status on Forgejo via its API.
+        """
+        url = f"{project.forge_api_url}/repos/{project.owner}/{project.repo}/commits/{commit}/statuses"
+        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(), project=project, commit=commit)
+
+    @property
+    def created(self) -> datetime:
+        return self._created
+
+    @property
+    def edited(self) -> datetime:
+        return self._edited

tests/integration/forgejo/test_commit_flag.py

@@ -0,0 +1,96 @@
+# Copyright Contributors to the Packit project.
+# 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.services.forgejo.commit_flag import ForgejoCommitFlag
+
+class MockProject:
+    forge_api_url = "http://dummy-forgejo/api/v1"
+    owner = "dummy_owner"
+    repo = "dummy_repo"
+
+    def get_auth_header(self) -> Dict[str, str]:
+        return {"Authorization": "Bearer dummy_token"}
+
+@responses.activate
+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.
+    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")
+    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"
+    )
+    
+    # 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")
+    assert flag.created == expected_created
+    assert flag.edited == expected_updated