feat: add _getPrInfo function

Author: minzcmu

index.js

@@ -447,9 +447,14 @@ class BitbucketScm extends Scm {
      * @param  {Object}   config            Configuration
      * @param  {String}   config.scmUri     The scmUri
      * @param  {String}   config.token      The token used to authenticate to the SCM
+     * @param  {Integer}  [config.prNum]    The PR number used to fetch the PR
      * @return {Promise}                    Resolves to the sha for the scmUri
      */
     _getCommitSha(config) {
+        if (config.prNum) {
+            return this._getPrInfo(config).then(pr => pr.sha);
+        }
+
         const scm = getScmUriParts(config.scmUri);
         const branchUrl =
             `${REPO_URL}/${scm.repoId}/refs/branches/${scm.branch}`;
@@ -688,6 +693,38 @@ class BitbucketScm extends Scm {
         });
     }
 
+    /**
+    * Resolve a pull request object based on the config
+    * @method getPrRef
+    * @param  {Object}   config            Configuration
+    * @param  {String}   config.scmUri     The scmUri to get PR info of
+    * @param  {String}   config.token      The token used to authenticate to the SCM
+    * @param  {Integer}  config.prNum      The PR number used to fetch the PR
+    * @return {Promise}
+    */
+    _getPrInfo(config) {
+        const repoId = getScmUriParts(config.scmUri).repoId;
+
+        return this.breaker.runCommand({
+            url: `${API_URL_V2}/repositories/${repoId}/pullrequests/${config.prNum}`,
+            method: 'GET',
+            json: true,
+            auth: {
+                bearer: config.token
+            }
+        }).then((response) => {
+            checkResponseError(response);
+
+            const pr = response.body;
+
+            return {
+                name: `PR-${pr.id}`,
+                ref: pr.source.branch.name,
+                sha: pr.source.commit.hash
+            };
+        });
+    }
+
     /**
      * Retrieve stats for the scm
      * @method stats

test/index.test.js

@@ -693,7 +693,7 @@ describe('index', function () {
             requestMock.yieldsAsync(null, fakeResponse, fakeResponse.body);
         });
 
-        it('resolves to correct commit sha', () =>
+        it('resolves to correct commit sha without prNum', () =>
             scm.getCommitSha({
                 scmUri,
                 token
@@ -703,6 +703,42 @@ describe('index', function () {
             })
         );
 
+        it('resolves to correct commit sha with prNum', () => {
+            const prNum = 1;
+            const prExpectedOptions = {
+                url: `${API_URL_V2}/repositories/repoId/pullrequests/${prNum}`,
+                method: 'GET',
+                json: true,
+                auth: {
+                    bearer: token
+                }
+            };
+
+            requestMock.yieldsAsync(null, {
+                body: {
+                    id: 1,
+                    source: {
+                        branch: {
+                            name: 'testbranch'
+                        },
+                        commit: {
+                            hash: 'hashValue'
+                        }
+                    }
+                },
+                statusCode: 200
+            });
+
+            return scm.getCommitSha({
+                scmUri,
+                token,
+                prNum: 1
+            }).then((sha) => {
+                assert.calledWith(requestMock, prExpectedOptions);
+                assert.deepEqual(sha, 'hashValue');
+            });
+        });
+
         it('rejects if status code is not 200', () => {
             fakeResponse = {
                 statusCode: 404,
@@ -1528,4 +1564,51 @@ describe('index', function () {
             );
         });
     });
+
+    describe('_getPrInfo', () => {
+        const oauthToken = 'oauthToken';
+        const scmUri = 'hostName:repoId:branchName';
+        const prNum = 1;
+        const expectedOptions = {
+            url: `${API_URL_V2}/repositories/repoId/pullrequests/${prNum}`,
+            method: 'GET',
+            json: true,
+            auth: {
+                bearer: oauthToken
+            }
+        };
+
+        it('returns response of expected format from Bitbucket', () => {
+            requestMock.yieldsAsync(null, {
+                body: {
+                    id: 1,
+                    source: {
+                        branch: {
+                            name: 'testbranch'
+                        },
+                        commit: {
+                            hash: 'hashValue'
+                        }
+                    }
+                },
+                statusCode: 200
+            });
+
+            // eslint-disable-next-line no-underscore-dangle
+            return scm._getPrInfo({
+                scmUri,
+                token: oauthToken,
+                prNum
+            })
+            .then((response) => {
+                assert.calledWith(requestMock, expectedOptions);
+                assert.deepEqual(response, {
+                    name: 'PR-1',
+                    ref: 'testbranch',
+                    sha: 'hashValue'
+                });
+            }
+            );
+        });
+    });
 });