feat(1082): Implement getBranchList function (#49)

Author: yuichi10

index.js

@@ -17,6 +17,7 @@ const MATCH_COMPONENT_HOSTNAME = 1;
 const MATCH_COMPONENT_USER = 2;
 const MATCH_COMPONENT_REPO = 3;
 const MATCH_COMPONENT_BRANCH = 4;
+const BRANCH_PAGE_SIZE = 100;
 const STATE_MAP = {
     SUCCESS: 'SUCCESSFUL',
     RUNNING: 'INPROGRESS',
@@ -816,6 +817,56 @@ class BitbucketScm extends Scm {
             Promise.resolve(false)
         ));
     }
+
+    /**
+     * Look up a branches from a repo
+     * @async  _findBranches
+     * @param  {Object}     config
+     * @param  {String}     config.repoId       The bitbucket repo ID (e.g., "username/repoSlug")
+     * @param  {String}     config.token        Admin Oauth2 token for the repo
+     * @param  {Number}     config.page         pagination: page number to search next. 1-index.
+     * @return {Promise}                        Resolves to a list of branches
+     */
+    async _findBranches(config) {
+        const response = await this.breaker.runCommand({
+            json: true,
+            method: 'GET',
+            auth: {
+                bearer: config.token
+            },
+            url: `${API_URL_V2}/repositories/${config.repoId}`
+                + `/refs/branches?pagelen=${BRANCH_PAGE_SIZE}&page=${config.page}`
+        });
+
+        let branches = hoek.reach(response, 'body.values');
+
+        if (branches.length === BRANCH_PAGE_SIZE) {
+            config.page += 1;
+            const nextPageBranches = await this._findBranches(config);
+
+            branches = branches.concat(nextPageBranches);
+        }
+
+        return branches.map(branch => ({ name: hoek.reach(branch, 'name') }));
+    }
+
+    /**
+     * Get branch list from the Github repository
+     * @async  _getBranchList
+     * @param  {Object}     config
+     * @param  {String}     config.scmUri      The SCM URI to get branch list
+     * @param  {String}     config.token       Service token to authenticate with Github
+     * @return {Promise}                       Resolves when complete
+     */
+    async _getBranchList(config) {
+        const repoInfo = getScmUriParts(config.scmUri);
+
+        return this._findBranches({
+            repoId: repoInfo.repoId,
+            page: 1,
+            token: config.token
+        });
+    }
 }
 
 module.exports = BitbucketScm;

test/index.test.js

@@ -1739,4 +1739,85 @@ describe('index', function () {
             });
         });
     });
+
+    describe('getBranchList', () => {
+        const branchListConfig = {
+            scmUri: 'hostName:repoId:branchName',
+            token: 'oauthToken'
+        };
+
+        beforeEach(() => {
+            requestMock.yieldsAsync(null, {
+                statusCode: 200,
+                body: {
+                    values: []
+                }
+            });
+        });
+
+        it('gets branches', (done) => {
+            requestMock.onFirstCall().yieldsAsync(null, {
+                body: {
+                    values: [{ name: 'master' }],
+                    size: 1
+                },
+                statusCode: 200
+            });
+            scm.getBranchList(branchListConfig).then((b) => {
+                assert.calledWith(requestMock, {
+                    json: true,
+                    method: 'GET',
+                    auth: {
+                        bearer: branchListConfig.token
+                    },
+                    url: `${API_URL_V2}/repositories/repoId/refs/branches?pagelen=100&page=1`
+                });
+                assert.deepEqual(b, [{ name: 'master' }]);
+                done();
+            }).catch(done);
+        });
+
+        it('gets a lot of branches', (done) => {
+            const fakeBranches = [];
+
+            for (let i = 0; i < 100; i += 1) {
+                fakeBranches.push({
+                    name: `master${i}`
+                });
+            }
+
+            const fakeResponse = {
+                statusCode: 200,
+                body: {
+                    values: fakeBranches
+                }
+            };
+
+            const fakeResponseEmpty = {
+                statusCode: 200,
+                body: {
+                    values: []
+                }
+            };
+
+            requestMock.onCall(0).yieldsAsync(null, fakeResponse, fakeResponse.body);
+            requestMock.onCall(1).yieldsAsync(null, fakeResponse, fakeResponse.body);
+            requestMock.onCall(2).yieldsAsync(null, fakeResponse, fakeResponse.body);
+            requestMock.onCall(3).yieldsAsync(null, fakeResponseEmpty, fakeResponseEmpty.body);
+            scm.getBranchList(branchListConfig).then((branches) => {
+                assert.equal(branches.length, 300);
+                done();
+            }).catch(done);
+        });
+
+        it('throws an error when failing to getBranches', () => {
+            const testError = new Error('getBranchesError');
+
+            requestMock.yieldsAsync(testError);
+
+            return scm.getBranchList(branchListConfig).then(assert.fail, (err) => {
+                assert.equal(err, testError);
+            });
+        });
+    });
 });