Implement GitProject.get_commits() (#857)

Implement `GitProject.get_commits()`

Related to packit/packit-service#2495.

Reviewed-by: Matej Focko
Reviewed-by: Laura Barcziová

COMPATIBILITY.md

@@ -54,6 +54,7 @@ In case you find any error, please [create a new issue](https://github.com/packi
 | ----------------------------- | :----: | :----: | :---------------------: |
 | `change_token`                |   ✘    |   ✔   |           ✔            |
 | `get_release`                 |   ✔   |   ✔   |            ✘            |
+| `get_commits`                 |   ✔   |   ✔   |            ✘            |
 | `get_latest_release`          |   ✔   |   ✔   |            ✘            |
 | `is_private`                  |   ✔   |   ✔   | ✘ (may not be accurate) |
 | `remove_user`                 |   ✘    |   ✘    |           ✔            |

ogr/abstract.py

@@ -1476,6 +1476,18 @@ def default_branch(self) -> str:
         """Default branch (usually `main`, `master` or `trunk`)."""
         raise NotImplementedError()
 
+    def get_commits(self, ref: Optional[str] = None) -> list[str]:
+        """
+        Get list of commits for the project.
+
+        Args:
+            ref: Ref to start listing commits from, defaults to the default project branch.
+
+        Returns:
+            List of commit SHAs for the project.
+        """
+        raise NotImplementedError()
+
     def get_description(self) -> str:
         """
         Returns:

ogr/services/github/project.py

@@ -163,6 +163,10 @@ def default_branch(self):
     def get_branches(self) -> list[str]:
         return [branch.name for branch in self.github_repo.get_branches()]
 
+    def get_commits(self, ref: Optional[str] = None) -> list[str]:
+        ref = ref or self.github_repo.default_branch
+        return [commit.sha for commit in self.github_repo.get_commits(sha=ref)]
+
     def get_description(self) -> str:
         return self.github_repo.description
 

ogr/services/gitlab/project.py

@@ -360,6 +360,13 @@ def change_token(self, new_token: str):
     def get_branches(self) -> list[str]:
         return [branch.name for branch in self.gitlab_repo.branches.list(all=True)]
 
+    def get_commits(self, ref: Optional[str] = None) -> list[str]:
+        ref = ref or self.default_branch
+        return [
+            commit.id
+            for commit in self.gitlab_repo.commits.list(ref_name=ref, all=True)
+        ]
+
     def get_file_content(self, path, ref=None) -> str:
         ref = ref or self.default_branch
         # GitLab cannot resolve './'

tests/integration/github/test_generic_commands.py

@@ -50,6 +50,11 @@ def test_branches(self):
         assert branches
         assert {"master"}.issubset(set(branches))
 
+    def test_commits(self):
+        commits = self.ogr_project.get_commits()
+        assert commits
+        assert commits[-1] == "7d4b107e0aa5a3fa55886ceb8acfb0b718919b37"
+
     def test_git_urls(self):
         urls = self.ogr_project.get_git_urls()
         assert urls