Merge pull request sigmavirus24#987 from dmitrykiselev27/associated_prs

sigmavirus24 · web-flow · commit 197173b5669b · 2020-08-20T13:30:45.000-05:00
add ability to get the list of associated PRs for commit
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -198,3 +198,5 @@ Contributors
 - Kevin P. Fleming (@kpfleming)
 
 - Andrew Hayworth (@ahayworth)
+
+- Dmitry Kiselev (@dmitrykiselev27)
diff --git a/src/github3/repos/commit.py b/src/github3/repos/commit.py
@@ -26,6 +26,11 @@ class _RepoCommit(models.GitHubCore):
 
     """
 
+    PREVIEW_HEADERS = {
+        "Accept": "application/vnd.github.groot-preview+json,"
+                  "application/vnd.github.v3.full+json"
+    }
+
     class_name = "_RepoCommit"
 
     def _update_attributes(self, commit):
@@ -139,6 +144,30 @@ def comments(self, number=-1, etag=None):
         url = self._build_url("comments", base_url=self._api)
         return self._iter(int(number), url, RepoComment, etag=etag)
 
+    def associated_pull_requests(self, number=-1, etag=None):
+        """Iterate pull requests associated with a commit.
+
+        :param int number:
+            (optional), number of comments to return. Default: -1 returns all
+            pull requests
+        :param str etag:
+            (optional), ETag from a previous request to the same endpoint
+        :returns:
+            generator of pull requests
+        :rtype:
+            :class:~github3.pulls.PullRequest`
+        """
+        from .. import pulls
+
+        url = self._build_url("pulls", base_url=self._api)
+        return self._iter(
+            number,
+            url,
+            pulls.ShortPullRequest,
+            etag=etag,
+            headers=self.PREVIEW_HEADERS
+        )
+
 
 class RepoCommit(_RepoCommit):
     """Representation of a commit with repository and git data."""
diff --git a/tests/cassettes/RepoCommit_associated_pull_requests.json b/tests/cassettes/RepoCommit_associated_pull_requests.json
diff --git a/tests/integration/test_repos_commit.py b/tests/integration/test_repos_commit.py
@@ -55,3 +55,14 @@ def test_author_is_not_committer(self):
                 "6a0470c992dd97d97fa0fee503153b125141ca4c"
             )
             assert commit.author != commit.committer
+
+    def test_associated_pull_requests(self):
+        """Test the ability to retrieve associated pull requests of commit."""
+        cassette_name = self.cassette_name("associated_pull_requests")
+        with self.recorder.use_cassette(cassette_name):
+            repository = self.gh.repository("sigmavirus24", "github3.py")
+            commit = repository.commit(
+                "6b12e37bdc1bea465f04a53262194ab332711ee8"
+            )
+            for pr in commit.associated_pull_requests():
+                assert isinstance(pr, github3.pulls.ShortPullRequest)
diff --git a/tests/integration/test_repos_repo.py b/tests/integration/test_repos_repo.py
@@ -976,10 +976,10 @@ def test_languages(self):
         with self.recorder.use_cassette(cassette_name):
             repository = self.gh.repository("sigmavirus24", "github3.py")
             assert repository is not None
-            for l in repository.languages():
-                assert "ETag" not in l
-                assert "Last-Modified" not in l
-                assert isinstance(l, tuple)
+            for lang in repository.languages():
+                assert "ETag" not in lang
+                assert "Last-Modified" not in lang
+                assert isinstance(lang, tuple)
 
     def test_license(self):
         """Test that a repository's license can be retrieved."""
diff --git a/tests/unit/test_repos_commit.py b/tests/unit/test_repos_commit.py
@@ -34,6 +34,17 @@ def test_comments(self):
             url_for("comments"), params={"per_page": 100}, headers={}
         )
 
+    def test_associated_pull_requests(self):
+        """Verify the request to iterate over PRs associated with a commit."""
+        i = self.instance.associated_pull_requests()
+        self.get_next(i)
+
+        self.session.get.assert_called_once_with(
+            url_for("comments").replace("comments", "pulls"),
+            params={"per_page": 100},
+            headers=github3.repos.commit._RepoCommit.PREVIEW_HEADERS
+        )
+
 
 class TestRepoCommitIteratorAppInstAuth(helper.UnitIteratorAppInstHelper):
 
