Implement for GitCommit and CommitChanges for Github

Signed-off-by: Cristian Le <[email protected]>

Author: LecrisUT

ogr/services/github/__init__.py

@@ -1,8 +1,10 @@
 # Copyright Contributors to the Packit project.
 # SPDX-License-Identifier: MIT
 
+from ogr.services.github.changes import GithubCommitChanges, GithubPullRequestChanges
 from ogr.services.github.check_run import GithubCheckRun
 from ogr.services.github.comments import GithubIssueComment, GithubPRComment
+from ogr.services.github.commit import GithubCommit
 from ogr.services.github.issue import GithubIssue
 from ogr.services.github.project import GithubProject
 from ogr.services.github.pull_request import GithubPullRequest
@@ -12,7 +14,10 @@
 
 __all__ = [
     GithubCheckRun.__name__,
+    GithubCommit.__name__,
+    GithubCommitChanges.__name__,
     GithubPullRequest.__name__,
+    GithubPullRequestChanges.__name__,
     GithubIssueComment.__name__,
     GithubPRComment.__name__,
     GithubIssue.__name__,

ogr/services/github/changes.py

@@ -0,0 +1,61 @@
+# Copyright Contributors to the Packit project.
+# SPDX-License-Identifier: MIT
+from collections.abc import Iterable
+
+import requests
+
+from ogr.abstract import CommitChanges, PullRequestChanges
+from ogr.exceptions import GithubAPIException, OgrNetworkError
+from ogr.services import github as ogr_github
+
+
+class GithubCommitChanges(CommitChanges):
+    commit: "ogr_github.GithubCommit"
+
+    @property
+    def files(self) -> Iterable[str]:
+        for file in self.commit._raw_commit.files:
+            yield file.filename
+
+    @property
+    def patch(self) -> bytes:
+        patch_url = f"{self.commit._raw_commit.html_url}.patch"
+        response = requests.get(patch_url)
+
+        if not response.ok:
+            cls = OgrNetworkError if response.status_code >= 500 else GithubAPIException
+            raise cls(
+                f"Couldn't get patch from {patch_url} because {response.reason}.",
+            )
+
+        return response.content
+
+    @property
+    def diff_url(self) -> str:
+        return f"{self.commit._raw_commit.html_url}.diff"
+
+
+class GithubPullRequestChanges(PullRequestChanges):
+    pull_request: "ogr_github.GithubPullRequest"
+
+    @property
+    def files(self) -> Iterable[str]:
+        for file in self.pull_request._raw_pr.get_files():
+            yield file.filename
+
+    @property
+    def patch(self) -> bytes:
+        patch_url = self.pull_request._raw_pr.patch_url
+        response = requests.get(patch_url)
+
+        if not response.ok:
+            cls = OgrNetworkError if response.status_code >= 500 else GithubAPIException
+            raise cls(
+                f"Couldn't get patch from {patch_url} because {response.reason}.",
+            )
+
+        return response.content
+
+    @property
+    def diff_url(self) -> str:
+        return f"{self.pull_request._raw_pr.html_url}.diff"

ogr/services/github/commit.py

@@ -0,0 +1,32 @@
+# Copyright Contributors to the Packit project.
+# SPDX-License-Identifier: MIT
+import github
+from github.Commit import Commit as _GitCommit
+
+from ogr.exceptions import GithubAPIException
+from ogr.services import github as ogr_github
+from ogr.services.base import BaseGitCommit
+from ogr.services.github.changes import GithubCommitChanges
+
+
+class GithubCommit(BaseGitCommit):
+    _raw_commit: _GitCommit
+    _changes: GithubCommitChanges = None
+
+    @property
+    def sha(self) -> str:
+        return self._raw_commit.sha
+
+    @property
+    def changes(self) -> GithubCommitChanges:
+        if not self._changes:
+            self._changes = GithubCommitChanges(self)
+        return self._changes
+
+    @staticmethod
+    def get(project: "ogr_github.GithubProject", sha: str) -> "GithubCommit":
+        try:
+            commit = project.github_repo.get_commit(sha=sha)
+        except github.UnknownObjectException as ex:
+            raise GithubAPIException(f"No git commit with id {sha} found") from ex
+        return GithubCommit(commit, project)

ogr/services/github/project.py

@@ -17,6 +17,7 @@
     CommitComment,
     CommitFlag,
     CommitStatus,
+    GitCommit,
     GitTag,
     Issue,
     IssueStatus,
@@ -35,6 +36,7 @@
     GithubCheckRunStatus,
 )
 from ogr.services.github.comments import GithubCommitComment
+from ogr.services.github.commit import GithubCommit
 from ogr.services.github.flag import GithubCommitFlag
 from ogr.services.github.issue import GithubIssue
 from ogr.services.github.pull_request import GithubPullRequest
@@ -301,6 +303,10 @@ def get_pr_list(self, status: PRStatus = PRStatus.open) -> list[PullRequest]:
     def get_pr(self, pr_id: int) -> PullRequest:
         pass
 
+    @indirect(GithubCommit.get)
+    def get_commit(self, sha: str) -> GitCommit:
+        pass
+
     def get_sha_from_tag(self, tag_name: str) -> str:
         # TODO: This is ugly. Can we do it better?
         all_tags = self.github_repo.get_tags()

ogr/services/github/pull_request.py

@@ -18,6 +18,7 @@
 from ogr.exceptions import GithubAPIException, OgrNetworkError
 from ogr.services import github as ogr_github
 from ogr.services.base import BasePullRequest
+from ogr.services.github.changes import GithubPullRequestChanges
 from ogr.services.github.comments import GithubPRComment
 from ogr.services.github.label import GithubPRLabel
 
@@ -28,6 +29,7 @@ class GithubPullRequest(BasePullRequest):
     _raw_pr: _GithubPullRequest
     _target_project: "ogr_github.GithubProject"
     _source_project: "ogr_github.GithubProject" = None
+    _changes: GithubPullRequestChanges = None
 
     @property
     def title(self) -> str:
@@ -83,6 +85,12 @@ def labels(self) -> list[PRLabel]:
             GithubPRLabel(raw_label, self) for raw_label in self._raw_pr.get_labels()
         ]
 
+    @property
+    def changes(self) -> GithubPullRequestChanges:
+        if not self._changes:
+            self._changes = GithubPullRequestChanges(self)
+        return self._changes
+
     @property
     def diff_url(self) -> str:
         return f"{self._raw_pr.html_url}/files"