feat(1082): Use commit branch to clone (#50)

Author: yuichi10

index.js

@@ -663,33 +663,35 @@ class BitbucketScm extends Scm {
      * Checkout the source code from a repository; resolves as an object with checkout commands
      * @method getCheckoutCommand
      * @param  {Object}    config
-     * @param  {String}    config.branch        Pipeline branch
-     * @param  {String}    config.host          Scm host to checkout source code from
-     * @param  {String}    config.org           Scm org name
-     * @param  {String}    config.repo          Scm repo name
-     * @param  {String}    config.sha           Commit sha
-     * @param  {String}    [config.prRef]       PR reference (can be a PR branch or reference)
+     * @param  {String}    config.branch         Pipeline branch
+     * @param  {String}    config.host           Scm host to checkout source code from
+     * @param  {String}    config.org            Scm org name
+     * @param  {String}    config.repo           Scm repo name
+     * @param  {String}    config.sha            Commit sha
+     * @param  {String}    [config.commitBranch] Commit branch
+     * @param  {String}    [config.prRef]        PR reference (can be a PR branch or reference)
      * @return {Promise}
      */
     _getCheckoutCommand(config) {
         const checkoutUrl = `${config.host}/${config.org}/${config.repo}`;
         const sshCheckoutUrl = `git@${config.host}:${config.org}/${config.repo}`;
-        const checkoutRef = config.prRef ? config.branch : config.sha;
+        const branch = config.commitBranch ? config.commitBranch : config.branch;
+        const checkoutRef = config.prRef ? branch : config.sha;
         const gitWrapper = '$(if git --version > /dev/null 2>&1; ' +
             "then echo 'eval'; " +
             "else echo 'sd-step exec core/git'; fi)";
         const command = [];
 
         // Git clone
-        command.push(`echo Cloning ${checkoutUrl}, on branch ${config.branch}`);
+        command.push(`echo Cloning ${checkoutUrl}, on branch ${branch}`);
         command.push('if [ ! -z $SCM_CLONE_TYPE ] && [ $SCM_CLONE_TYPE = ssh ]; ' +
             `then export SCM_URL=${sshCheckoutUrl}; ` +
             'elif [ ! -z $SCM_USERNAME ] && [ ! -z $SCM_ACCESS_TOKEN ]; ' +
             `then export SCM_URL=https://$SCM_USERNAME:$SCM_ACCESS_TOKEN@${checkoutUrl}; ` +
             `else export SCM_URL=https://${checkoutUrl}; fi`
         );
         command.push(`${gitWrapper} `
-            + `"git clone --quiet --progress --branch ${config.branch} $SCM_URL $SD_SOURCE_DIR"`);
+            + `"git clone --quiet --progress --branch ${branch} $SCM_URL $SD_SOURCE_DIR"`);
         // Reset to Sha
         command.push(`echo Reset to SHA ${checkoutRef}`);
         command.push(`${gitWrapper} "git reset --hard ${checkoutRef}"`);
@@ -702,7 +704,7 @@ class BitbucketScm extends Scm {
         if (config.prRef) {
             const prRef = config.prRef.replace('merge', 'head:pr');
 
-            command.push(`echo Fetching PR and merging with ${config.branch}`);
+            command.push(`echo Fetching PR and merging with ${branch}`);
             command.push(`${gitWrapper} "git fetch origin ${prRef}"`);
             command.push(`${gitWrapper} "git merge --no-edit ${config.sha}"`);
         }

test/data/commitBranchCommands.json

@@ -0,0 +1,4 @@
+{
+    "name": "sd-checkout-code",
+    "command": "echo Cloning hostName/orgName/repoName, on branch commitBranch && if [ ! -z $SCM_CLONE_TYPE ] && [ $SCM_CLONE_TYPE = ssh ]; then export SCM_URL=git@hostName:orgName/repoName; elif [ ! -z $SCM_USERNAME ] && [ ! -z $SCM_ACCESS_TOKEN ]; then export SCM_URL=https://$SCM_USERNAME:$SCM_ACCESS_TOKEN@hostName/orgName/repoName; else export SCM_URL=https://hostName/orgName/repoName; fi && $(if git --version > /dev/null 2>&1; then echo 'eval'; else echo 'sd-step exec core/git'; fi) \"git clone --quiet --progress --branch commitBranch $SCM_URL $SD_SOURCE_DIR\" && echo Reset to SHA shaValue && $(if git --version > /dev/null 2>&1; then echo 'eval'; else echo 'sd-step exec core/git'; fi) \"git reset --hard shaValue\" && echo Setting user name and user email && $(if git --version > /dev/null 2>&1; then echo 'eval'; else echo 'sd-step exec core/git'; fi) \"git config user.name sd-buildbot\" && $(if git --version > /dev/null 2>&1; then echo 'eval'; else echo 'sd-step exec core/git'; fi) \"git config user.email dev-null@screwdriver.cd\""
+}

test/index.test.js

@@ -6,6 +6,7 @@ const sinon = require('sinon');
 const testCommands = require('./data/commands.json');
 const testPrCommands = require('./data/prCommands.json');
 const testCustomPrCommands = require('./data/customPrCommands.json');
+const testCommitBranchCommands = require('./data/commitBranchCommands.json');
 const testPayloadOpen = require('./data/pr.opened.json');
 const testPayloadSync = require('./data/pr.sync.json');
 const testPayloadClose = require('./data/pr.closed.json');
@@ -1196,6 +1197,15 @@ describe('index', function () {
                     assert.deepEqual(command, testCustomPrCommands);
                 });
         });
+
+        it('resolves checkout command without prRef', () => {
+            config.commitBranch = 'commitBranch';
+            config.prRef = undefined;
+
+            return scm.getCheckoutCommand(config).then((command) => {
+                assert.deepEqual(command, testCommitBranchCommands);
+            });
+        });
     });
 
     describe('stats', () => {