testing branch code

Author: bahmutov

package.json

@@ -83,9 +83,11 @@
     "nsp": "2.8.1",
     "pre-git": "3.15.3",
     "prettier-standard": "7.0.3",
+    "ramda": "0.25.0",
     "semantic-release": "8.2.0",
     "simple-commit-message": "3.3.2",
-    "standard": "10.0.3"
+    "standard": "10.0.3",
+    "stub-spawn-once": "2.3.0"
   },
   "dependencies": {
     "chdir-promise": "0.6.2",

src/utils-spec.js

@@ -0,0 +1,95 @@
+'use strict'
+
+const la = require('lazy-ass')
+const R = require('ramda')
+const { stubSpawnShellOnce } = require('stub-spawn-once')
+
+/* eslint-env mocha */
+describe('utils', () => {
+  describe('getBranch', () => {
+    const { getBranch } = require('./utils')
+
+    context('CI environment', () => {
+      const initialEnv = R.clone(process.env)
+
+      beforeEach(() => {
+        process.env.TRAVIS_BRANCH = 'travis-branch'
+        process.env.CI_BRANCH = 'ci-branch'
+      })
+
+      afterEach(() => {
+        process.env = R.clone(initialEnv)
+      })
+
+      it('finds travis branch', () =>
+        getBranch().then(branch =>
+          la(branch === 'travis-branch', 'wrong branch', branch)
+        ))
+    })
+
+    context('local environment', () => {
+      const initialEnv = R.clone(process.env)
+
+      beforeEach(() => {
+        // remove all possible CI branch variables
+        delete process.env.CIRCLE_BRANCH
+        delete process.env.TRAVIS_BRANCH
+        delete process.env.BUILDKITE_BRANCH
+        delete process.env.CI_BRANCH
+      })
+
+      afterEach(() => {
+        process.env = R.clone(initialEnv)
+      })
+
+      it('uses git to determine branch', () => {
+        const cmd = 'git rev-parse --abbrev-ref HEAD'
+        stubSpawnShellOnce(cmd, 0, 'mock-test-branch', '')
+        return getBranch().then(branch =>
+          la(branch === 'mock-test-branch', 'wrong branch from git', branch)
+        )
+      })
+
+      it('returns empty string on failure', () => {
+        const cmd = 'git rev-parse --abbrev-ref HEAD'
+        stubSpawnShellOnce(cmd, 1, '', 'nope')
+        return getBranch().then(branch =>
+          la(branch === '', 'wrong empty branch from git', branch)
+        )
+      })
+
+      it('returns empty string on HEAD', () => {
+        const cmd = 'git rev-parse --abbrev-ref HEAD'
+        stubSpawnShellOnce(cmd, 0, 'HEAD', '')
+        return getBranch().then(branch =>
+          la(branch === '', 'wrong HEAD branch from git', branch)
+        )
+      })
+    })
+  })
+
+  describe('firstFoundValue', () => {
+    const { firstFoundValue } = require('./utils')
+
+    const env = {
+      a: 1,
+      b: 2,
+      c: 3
+    }
+
+    it('finds first value', () => {
+      const found = firstFoundValue(['a', 'b'], env)
+      la(found === 1, found)
+    })
+
+    it('finds second value', () => {
+      const found = firstFoundValue(['z', 'a', 'b'], env)
+      la(found === 1, found)
+    })
+
+    it('finds nothing', () => {
+      const found = firstFoundValue(['z', 'x'], env)
+      la(found === null, found)
+    })
+  })
+})

src/utils.js

@@ -3,6 +3,7 @@ const execa = require('execa')
 const debug = require('debug')('commit-info')
 const la = require('lazy-ass')
 const is = require('check-more-types')
+const Promise = require('bluebird')
 
 const prop = name => object => object[name]
 const emptyString = () => ''
@@ -22,4 +23,43 @@ const runGitCommand = (pathToRepo, gitCommand) => {
     .catch(emptyString)
 }
 
-module.exports = { runGitCommand }
+/*
+  "gift" module returns "" for detached checkouts
+  and our current command returns "HEAD"
+  so we must imitate gift's behavior
+
+  example:
+  git checkout <commit sha>
+  get git branch returns "HEAD"
+*/
+const checkIfDetached = branch => (branch === 'HEAD' ? '' : branch)
+
+function getGitBranch (pathToRepo) {
+  return runGitCommand(pathToRepo, 'git rev-parse --abbrev-ref HEAD')
+    .then(checkIfDetached)
+    .catch(emptyString)
+}
+
+function firstFoundValue (keys, object = process.env) {
+  const found = keys.find(key => {
+    return key in object
+  })
+  return found ? object[found] : null
+}
+
+function getBranch (pathToRepo) {
+  pathToRepo = pathToRepo || process.cwd()
+  const ciNames = [
+    'CIRCLE_BRANCH',
+    'TRAVIS_BRANCH',
+    'BUILDKITE_BRANCH',
+    'CI_BRANCH'
+  ]
+  const ciBranch = firstFoundValue(ciNames, process.env)
+  if (ciBranch) {
+    return Promise.resolve(ciBranch)
+  }
+  return getGitBranch(pathToRepo)
+}
+
+module.exports = { runGitCommand, firstFoundValue, getBranch }