[Bitbucket Cloud] Pull Request Builds (#667)

* - Add PR property for pipeline
- add statuses() response for PR

* Adds builds for pull requests

* unittests, build properties refname + website

Author: sti0

atlassian/bitbucket/cloud/repositories/pipelines.py

@@ -1,5 +1,6 @@
 # coding=utf-8
 
+from .pullRequests import PullRequest
 from requests import HTTPError
 
 from ..base import BitbucketCloudBase
@@ -126,6 +127,17 @@ def completed_on(self):
         """ The pipeline completion time """
         return self.get_time("completed_on")
 
+    @property
+    def pullrequest(self):
+        """ Returns a PullRequest object if the pipeline was triggered by a pull request, else None """
+        target = self.get_data("target")
+        if target["type"] == "pipeline_pullrequest_target":
+            return PullRequest(
+                target["pullrequest"]["links"]["self"]["href"], target["pullrequest"], **self._new_session_args
+            )
+        else:
+            return None
+
     def stop(self):
         """
         Stop the pipeline

atlassian/bitbucket/cloud/repositories/pullRequests.py

@@ -197,6 +197,14 @@ def author(self):
         """ User object of the author """
         return User(None, self.get_data("author"))
 
+    def statuses(self):
+        """
+        Returns generator object of the statuses endpoint
+
+        API docs: https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/pullrequests/%7Bpull_request_id%7D/statuses
+        """
+        return self._get_paged("{}/statuses".format(self.url), absolute=True)
+
     def participants(self):
         """ Returns a generator object of participants """
         for participant in self.get_data("participants"):
@@ -211,6 +219,14 @@ def reviewers(self):
 
         return
 
+    def builds(self):
+        """Returns the latest Build objects for the pull request."""
+        builds = [b for b in self.statuses() if b["type"] == "build"]
+        for build in builds:
+            yield Build(build, **self._new_session_args)
+
+        return
+
     def comment(self, raw_message):
         """
         Commenting the pull request in raw format
@@ -321,6 +337,10 @@ def is_reviewer(self):
         """ True if the user is a pull request reviewer """
         return self.get_data("role") == self.ROLE_REVIEWER
 
+    @property
+    def is_default_reviewer(self):
+        """ True if the user is a default reviewer """
+
     @property
     def has_changes_requested(self):
         """ True if user requested changes """
@@ -335,3 +355,75 @@ def has_approved(self):
     def participated_on(self):
         """ time of last participation """
         return self.get_time("participated_on")
+
+
+class Build(BitbucketCloudBase):
+    STATE_FAILED = "FAILED"
+    STATE_INPROGRESS = "INPROGRESS"
+    STATE_STOPPED = "STOPPED"
+    STATE_SUCCESSFUL = "SUCCESSFUL"
+
+    def __init__(self, data, *args, **kwargs) -> None:
+        super(Build, self).__init__(None, None, *args, data=data, expected_type="build", **kwargs)
+
+    @property
+    def key(self):
+        """Key of the build"""
+        return self.get_data("key")
+
+    @property
+    def name(self):
+        """Name of the build"""
+        return self.get_data("name")
+
+    @property
+    def description(self):
+        """Build description"""
+        return self.get_data("description")
+
+    @property
+    def failed(self):
+        """True if the build was stopped"""
+        return self.get_data("state") == self.STATE_FAILED
+
+    @property
+    def inprogress(self):
+        """True if the build is inprogress"""
+        return self.get_data("state") == self.STATE_INPROGRESS
+
+    @property
+    def successful(self):
+        """True if the build was successful"""
+        return self.get_data("state") == self.STATE_SUCCESSFUL
+
+    @property
+    def stopped(self):
+        """True if the build was stopped"""
+        return self.get_data("state") == self.STATE_STOPPED
+
+    @property
+    def created_on(self):
+        """ time of creation """
+        return self.get_time("created_on")
+
+    @property
+    def updated_on(self):
+        """ time of last update """
+        return self.get_time("updated_on")
+
+    @property
+    def commit(self):
+        """Returns the hash key of the commit"""
+        return self.get_data("commit")["hash"]
+
+    @property
+    def website(self):
+        """Returns the url to the builds webpage.
+        This url points to the build's frontend website (Pipelines, Jenkins ...)
+        """
+        return self.get_data("url")
+
+    @property
+    def refname(self):
+        """Returns the refname"""
+        return self.get_data("refname")

tests/responses/bitbucket/cloud/2.0/repositories/TestWorkspace1/testrepository1/pullrequests/1/statuses/GET

@@ -0,0 +1,47 @@
+responses[None] = {
+    "pagelen": 30,
+    "values": [
+        {
+            "key": "12345",
+            "description": "This commit looks good.",
+            "repository": {
+                "links": {
+                    "self": {"href": "bitbucket/cloud/2.0/repositories/TestWorkspace1/testrepository1"},
+                    "html": {"href": "https://bitbucket.org/TestWorkspace1/testrepository1"},
+                    "avatar": {"href": "https://bytebucket.org/ravatar/%7BRepoUUID%7D?ts=default"},
+                },
+                "type": "repository",
+                "name": "testrepository1",
+                "full_name": "TestWorkspace1/testrepository1",
+                "uuid": "{RepoUUID}",
+            },
+            "url": "http://urltothebui.ld/5",
+            "links": {
+                "commit": {
+                    "href": "bitbucket/cloud/2.0/repositories/TestWorkspace1/testrepository1/commit/1fbd047cd99a"
+                },
+                "self": {
+                    "href": "bitbucket/cloud/2.0/repositories/TestWorkspace1/testrepository1/commit/1fbd047cd99a/statuses/build/12345"
+                },
+            },
+            "refname": "feature/abranch",
+            "state": "SUCCESSFUL",
+            "created_on": "2021-01-22T14:47:16.366063+00:00",
+            "commit": {
+                "hash": "1fbd047cd99a",
+                "type": "commit",
+                "links": {
+                    "self": {
+                        "href": "bitbucket/cloud/2.0/repositories/TestWorkspace1/testrepository1/commit/1fbd047cd99a"
+                    },
+                    "html": {"href": "https://bitbucket.org/TestWorkspace1/testrepository1/commits/1fbd047cd99a"},
+                },
+            },
+            "updated_on": "2021-01-22T14:51:00.667312+00:00",
+            "type": "build",
+            "name": "Build #5",
+        }
+    ],
+    "page": 1,
+    "size": 1,
+}

tests/test_bitbucket_cloud.py

@@ -6,7 +6,7 @@
 from atlassian import Bitbucket
 from atlassian.bitbucket import Cloud
 from atlassian.bitbucket.cloud.common.users import User
-from atlassian.bitbucket.cloud.repositories.pullRequests import Participant, PullRequest
+from atlassian.bitbucket.cloud.repositories.pullRequests import Participant, PullRequest, Build
 
 BITBUCKET = None
 try:
@@ -289,3 +289,18 @@ def test_create(self, tc2):
         )
         assert pr.id == 1
         assert len(list(pr.reviewers())) == 3
+
+    def test_builds(self, tc1):
+        builds = list(tc1.builds())
+        assert len(builds) == 1
+
+        build = builds[0]
+        assert isinstance(build, Build)
+        assert build.successful
+        assert build.name == "Build #5"
+        assert build.description == "This commit looks good."
+        assert build.key == "12345"
+        assert _datetimetostr(build.created_on) == _datetimetostr(datetime(2021, 1, 22, 14, 47, 16, 366063))
+        assert build.commit == "1fbd047cd99a"
+        assert build.refname == "feature/abranch"
+        assert build.website == "http://urltothebui.ld/5"