Merge pull request #186 from codecov/bb-support

feat: add bitbucket pipelines support

Author: drazisil-codecov

.circleci/config.yml

@@ -100,7 +100,7 @@ jobs:
             npm ci
             npm test
             mkdir -p coverage-alpine
-            cp coverage/* coverage-alpine/
+            cp -r coverage/* coverage-alpine/
 
       - run:
           name: Build uploader binary on alpine

package.json

@@ -43,18 +43,6 @@
     "testdouble": "3.16.1",
     "testdouble-jest": "2.0.0"
   },
-  "nyc": {
-    "all": true,
-    "reporter": [
-      "text",
-      "cobertura"
-    ],
-    "exclude": [
-      "src/ci_providers/provider_template.js",
-      "rollup.config.js",
-      "test/**/*"
-    ]
-  },
   "jest": {
     "collectCoverage": true,
     "collectCoverageFrom": [
@@ -65,7 +53,8 @@
     ],
     "coverageReporters": [
       "text",
-      "cobertura"
+      "cobertura",
+      "html"
     ],
     "setupFilesAfterEnv": [
       "<rootDir>/test/test_helpers.js"

src/ci_providers/index.js

@@ -1,5 +1,6 @@
 const providerAppveyorci = require('./provider_appveyorci')
 const providerAzurepipelines = require('./provider_azurepipelines')
+const providerBitbucket = require('./provider_bitbucket')
 const providerBuildkite = require('./provider_buildkite')
 const providerCircleci = require('./provider_circleci')
 const providerDrone = require('./provider_drone')
@@ -13,6 +14,7 @@ const providerTravisci = require('./provider_travisci')
 const providers = [
   providerAppveyorci,
   providerAzurepipelines,
+  providerBitbucket,
   providerBuildkite,
   providerCircleci,
   providerDrone,

src/ci_providers/provider_bitbucket.js

@@ -0,0 +1,78 @@
+const childProcess = require('child_process')
+const { validateSHA } = require('../helpers/validate.js')
+
+function detect(envs) {
+  return envs.CI && envs.BITBUCKET_BUILD_NUMBER
+}
+
+function _getBuild(inputs) {
+  const { args, envs } = inputs
+  return args.build || envs.BITBUCKET_BUILD_NUMBER
+}
+
+// eslint-disable-next-line no-unused-vars
+function _getBuildURL(inputs) {
+  return ''
+}
+
+function _getBranch(inputs) {
+  const { args, envs } = inputs
+  return args.branch || envs.BITBUCKET_BRANCH || ''
+}
+
+function _getJob(envs) {
+  return envs.BITBUCKET_BUILD_NUMBER
+}
+
+function _getPR(inputs) {
+  const { args, envs } = inputs
+  return args.pr || envs.BITBUCKET_PR_ID || ''
+}
+
+function _getService() {
+  return 'bitbucket'
+}
+
+function getServiceName() {
+  return 'Bitbucket'
+}
+
+function _getSHA(inputs) {
+  const { args, envs } = inputs
+  let commit = envs.BITBUCKET_COMMIT
+
+  if (commit && validateSHA(commit, 12)) {
+    commit = childProcess.execFileSync('git', ['rev-parse', commit])
+  }
+
+  return args.sha || commit
+}
+
+function _getSlug(inputs) {
+  const { args, envs } = inputs
+
+  let slug = ''
+  if (envs.BITBUCKET_REPO_OWNER && envs.BITBUCKET_REPO_SLUG) {
+    slug = `${envs.BITBUCKET_REPO_OWNER}/${envs.BITBUCKET_REPO_SLUG}`
+  }
+  return args.slug || slug
+}
+
+function getServiceParams(inputs) {
+  return {
+    branch: _getBranch(inputs),
+    build: _getBuild(inputs),
+    buildURL: _getBuildURL(inputs),
+    commit: _getSHA(inputs),
+    job: _getJob(inputs.envs),
+    pr: _getPR(inputs),
+    service: _getService(),
+    slug: _getSlug(inputs),
+  }
+}
+
+module.exports = {
+  detect,
+  getServiceName,
+  getServiceParams,
+}

src/helpers/validate.js

@@ -9,6 +9,7 @@ function validateURL(url) {
 }
 
 function validateFlags(flags) {
+  // eslint-disable-next-line no-useless-escape
   const mask = /^[\w\.\-]{1,45}$/
   return mask.test(flags)
 }
@@ -18,9 +19,24 @@ function validateFileNamePath(path) {
   return mask.test(path)
 }
 
+/**
+ * Validate that a SHA is the correct length and content
+ * @param {string} commitSHA
+ * @param {number} requestedLength
+ * @returns {boolean}
+ */
+const GIT_SHA_LENGTH = 40;
+
+function validateSHA(commitSHA, requestedLength = GIT_SHA_LENGTH) {
+  return (
+    commitSHA.length === requestedLength && validator.isAlphanumeric(commitSHA)
+  )
+}
+
 module.exports = {
   validateToken,
   validateURL,
   validateFlags,
   validateFileNamePath,
+  validateSHA,
 }

test/helpers/validate.test.js

@@ -33,7 +33,7 @@ describe('Input Validators', () => {
     it('Should pass with a period in the middle', () => {
       expect(validate.validateFlags('moo.foor')).toBe(true)
     })
-    
+
     it('Should pass with a dash at the start', () => {
       expect(validate.validateFlags('-moo-foor')).toBe(true)
     })
@@ -54,4 +54,16 @@ describe('Input Validators', () => {
       expect(validate.validateFileNamePath('/path{}to/file')).toBe(false)
     })
   })
+
+  describe('validateSHA()', () => {
+    it('should fail with invalid characters', () => {
+      expect(validate.validateSHA('abc 123', 7)).toBe(false)
+    })
+    it('should fail with incorrect length', () => {
+      expect(validate.validateSHA('abc123', 7)).toBe(false)
+    })
+    it('should pass with correct content and length', () => {
+      expect(validate.validateSHA('abc123', 6)).toBe(true)
+    })
+  })
 })

test/providers/provider_bitbucket.test.js

@@ -0,0 +1,176 @@
+const td = require('testdouble')
+const childProcess = require('child_process')
+
+const providerBitbucket = require('../../src/ci_providers//provider_bitbucket')
+
+describe('Bitbucket Params', () => {
+  afterEach(() => {
+    td.reset()
+  })
+
+  describe('detect()', () => {
+    it('does not run without Bitbucket env variable', () => {
+      const inputs = {
+        args: {},
+        envs: {},
+      }
+      let detected = providerBitbucket.detect(inputs.envs)
+      expect(detected).toBeFalsy()
+
+      inputs.envs['CI'] = true
+      detected = providerBitbucket.detect(inputs.envs)
+      expect(detected).toBeFalsy()
+    })
+
+    it('does not run without Bitbucket env variable', () => {
+      const inputs = {
+        args: {},
+        envs: {
+          BITBUCKET_BUILD_NUMBER: 1,
+          CI: true,
+        },
+      }
+      const detected = providerBitbucket.detect(inputs.envs)
+      expect(detected).toBeTruthy()
+    })
+  })
+
+  it('gets the correct params on no env variables', () => {
+    const inputs = {
+      args: {},
+      envs: {
+        BITBUCKET_BUILD_NUMBER: 1,
+        CI: true,
+      },
+    }
+    const expected = {
+      branch: '',
+      build: 1,
+      buildURL: '',
+      commit: undefined,
+      job: 1,
+      pr: '',
+      service: 'bitbucket',
+      slug: '',
+    }
+    const params = providerBitbucket.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+
+  it('gets the correct params on pr', () => {
+    const inputs = {
+      args: {},
+      envs: {
+        BITBUCKET_BRANCH: 'main',
+        BITBUCKET_BUILD_NUMBER: 1,
+        BITBUCKET_COMMIT: 'testingsha',
+        BITBUCKET_PR_ID: 2,
+        BITBUCKET_REPO_OWNER: 'testOwner',
+        BITBUCKET_REPO_SLUG: 'testSlug',
+        CI: true,
+      },
+    }
+    const expected = {
+      branch: 'main',
+      build: 1,
+      buildURL: '',
+      commit: 'testingsha',
+      job: 1,
+      pr: 2,
+      service: 'bitbucket',
+      slug: 'testOwner/testSlug',
+    }
+    const params = providerBitbucket.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+
+  it('gets the correct params on push', () => {
+    const inputs = {
+      args: {},
+      envs: {
+        BITBUCKET_BRANCH: 'main',
+        BITBUCKET_BUILD_NUMBER: 1,
+        BITBUCKET_COMMIT: 'testingsha',
+        BITBUCKET_REPO_OWNER: 'testOwner',
+        BITBUCKET_REPO_SLUG: 'testSlug',
+        CI: true,
+      },
+    }
+    const expected = {
+      branch: 'main',
+      build: 1,
+      buildURL: '',
+      commit: 'testingsha',
+      job: 1,
+      pr: '',
+      service: 'bitbucket',
+      slug: 'testOwner/testSlug',
+    }
+    const params = providerBitbucket.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+
+  it('gets the correct params with short SHA', () => {
+    const inputs = {
+      args: {},
+      envs: {
+        BITBUCKET_BRANCH: 'main',
+        BITBUCKET_BUILD_NUMBER: 1,
+        BITBUCKET_COMMIT: 'testingsha12',
+        BITBUCKET_REPO_OWNER: 'testOwner',
+        BITBUCKET_REPO_SLUG: 'testSlug',
+        CI: true,
+      },
+    }
+    const expected = {
+      branch: 'main',
+      build: 1,
+      buildURL: '',
+      commit: 'newtestsha',
+      job: 1,
+      pr: '',
+      service: 'bitbucket',
+      slug: 'testOwner/testSlug',
+    }
+
+    const execFileSync = td.replace(childProcess, 'execFileSync')
+    td.when(execFileSync('git', ['rev-parse', 'testingsha12'])).thenReturn(
+      'newtestsha',
+    )
+    const params = providerBitbucket.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+
+  it('gets the correct params on overrides', () => {
+    const inputs = {
+      args: {
+        branch: 'feature',
+        build: 3,
+        pr: 4,
+        sha: 'overwriteSha',
+        slug: 'overwriteOwner/overwriteRepo',
+      },
+      envs: {
+        BITBUCKET_BRANCH: 'main',
+        BITBUCKET_BUILD_NUMBER: 1,
+        BITBUCKET_COMMIT: 'testingsha',
+        BITBUCKET_PR_ID: 2,
+        BITBUCKET_REPO_OWNER: 'testOwner',
+        BITBUCKET_REPO_SLUG: 'testSlug',
+        CI: true,
+      },
+    }
+    const expected = {
+      branch: 'feature',
+      build: 3,
+      buildURL: '',
+      commit: 'overwriteSha',
+      job: 1,
+      pr: 4,
+      service: 'bitbucket',
+      slug: 'overwriteOwner/overwriteRepo',
+    }
+    const params = providerBitbucket.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+})