feat: implement getOpenedPrs

Author: FenrirUnbound

index.js

@@ -302,6 +302,37 @@ class GithubScm extends Scm {
         });
     }
 
+    /**
+     * Get a list of objects which consist of opened PR names and refs
+     * @method _getOpenedPRs
+     * @param  {Object}      config
+     * @param  {String}      config.scmUri  The scmUri to get opened PRs from
+     * @param  {String}      config.token   The token used to authenticate with the SCM
+     * @return {Promise}
+     */
+    _getOpenedPRs(config) {
+        return this.lookupScmUri({
+            scmUri: config.scmUri,
+            token: config.token
+        }).then(scmInfo =>
+            this.breaker.runCommand({
+                action: 'getAll',
+                scopeType: 'pullRequests',
+                token: config.token,
+                params: {
+                    owner: scmInfo.owner,
+                    repo: scmInfo.repo,
+                    state: 'open'
+                }
+            })
+        ).then(pullRequests =>
+            pullRequests.map(pullRequestInfo => ({
+                name: `PR-${pullRequestInfo.number}`,
+                ref: `pull/${pullRequestInfo.number}/merge`
+            }))
+        );
+    }
+
     /**
     * Get a owners permissions on a repository
     * @method _getPermissions

test/.eslintrc.yaml

@@ -2,3 +2,4 @@ extends: screwdriver
 rules:
     func-names: off
     prefer-arrow-callback: off
+    no-underscore-dangle: off

test/index.test.js

@@ -36,6 +36,9 @@ describe('index', function () {
     beforeEach(() => {
         githubMock = {
             authenticate: sinon.stub(),
+            pullRequests: {
+                getAll: sinon.stub()
+            },
             repos: {
                 createHook: sinon.stub(),
                 createStatus: sinon.stub(),
@@ -1319,4 +1322,67 @@ jobs:
             });
         });
     });
+
+    describe('_getOpenedPRs', () => {
+        const scmUri = 'github.com:111:branchName';
+        const config = {
+            scmUri,
+            token: 'token'
+        };
+
+        beforeEach(() => {
+            githubMock.repos.getById.yieldsAsync(null, {
+                full_name: 'repoOwner/repoName'
+            });
+        });
+
+        it('returns a list of opened pull requests', () => {
+            githubMock.pullRequests.getAll.yieldsAsync(null, [
+                { number: 1 },
+                { number: 2 }
+            ]);
+
+            return scm._getOpenedPRs(config).then((data) => {
+                assert.deepEqual(data, [
+                    {
+                        name: 'PR-1',
+                        ref: 'pull/1/merge'
+                    },
+                    {
+                        name: 'PR-2',
+                        ref: 'pull/2/merge'
+                    }
+                ]);
+
+                assert.calledWith(githubMock.repos.getById, { id: '111' });
+                assert.calledWith(githubMock.pullRequests.getAll, {
+                    owner: 'repoOwner',
+                    repo: 'repoName',
+                    state: 'open'
+                });
+            });
+        });
+
+        it('rejects when failing to lookup the SCM URI information', () => {
+            const testError = new Error('testError');
+
+            githubMock.repos.getById.yieldsAsync(testError);
+
+            return scm._getOpenedPRs(config).then(assert.fail, (err) => {
+                assert.instanceOf(err, Error);
+                assert.strictEqual(testError.message, err.message);
+            });
+        });
+
+        it('rejects when failing to fetch opened pull requests', () => {
+            const testError = new Error('testError');
+
+            githubMock.pullRequests.getAll.yieldsAsync(testError);
+
+            return scm._getOpenedPRs(config).then(assert.fail, (err) => {
+                assert.instanceOf(err, Error);
+                assert.strictEqual(testError.message, err.message);
+            });
+        });
+    });
 });