Merge pull request #193 from eddiemoore/feature/provider-cirrus

Adding Cirrus CI provider

Author: drazisil-codecov

src/ci_providers/index.js

@@ -3,6 +3,7 @@ const providerAzurepipelines = require('./provider_azurepipelines')
 const providerBitbucket = require('./provider_bitbucket')
 const providerBuildkite = require('./provider_buildkite')
 const providerCircleci = require('./provider_circleci')
+const providerCirrus = require('./provider_cirrus')
 const providerDrone = require('./provider_drone')
 const providerGitHubactions = require('./provider_githubactions')
 const providerGitLabci = require('./provider_gitlabci')
@@ -17,6 +18,7 @@ const providers = [
   providerBitbucket,
   providerBuildkite,
   providerCircleci,
+  providerCirrus,
   providerDrone,
   providerGitHubactions,
   providerGitLabci,

src/ci_providers/provider_cirrus.js

@@ -0,0 +1,64 @@
+function detect(envs) {
+  return !!envs.CIRRUS_CI
+}
+
+function _getBuild(inputs) {
+  const { args, envs } = inputs
+  return args.build || envs.CIRRUS_BUILD_ID
+}
+
+// eslint-disable-next-line no-unused-vars
+function _getBuildURL(inputs) {
+  return ''
+}
+
+function _getBranch(inputs) {
+  const { args, envs } = inputs
+  return args.branch || envs.CIRRUS_BRANCH
+}
+
+function _getJob(envs) {
+  return envs.CIRRUS_TASK_ID || ''
+}
+
+function _getPR(inputs) {
+  const { args, envs } = inputs
+  return args.pr || envs.CIRRUS_PR
+}
+
+function _getService() {
+  return 'cirrus-ci'
+}
+
+function getServiceName() {
+  return 'Cirrus CI'
+}
+
+function _getSHA(inputs) {
+  const { args, envs } = inputs
+  return args.sha || envs.CIRRUS_CHANGE_IN_REPO
+}
+
+function _getSlug(inputs) {
+  const { args, envs } = inputs
+  return args.slug || envs.CIRRUS_REPO_FULL_NAME
+}
+
+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,
+}

test/providers/provider_cirrus.test.js

@@ -0,0 +1,93 @@
+const td = require('testdouble')
+
+const providerCirrus = require('../../src/ci_providers/provider_cirrus')
+
+describe('Cirrus Params', () => {
+  afterEach(() => {
+    td.reset()
+  })
+
+  describe('detect()', () => {
+    it('does not run without Cirrus env variable', () => {
+      const inputs = {
+        args: {},
+        envs: {},
+      }
+      const detected = providerCirrus.detect(inputs.envs)
+      expect(detected).toBeFalsy()
+    })
+
+    it('does run with Cirrus env variable', () => {
+      const inputs = {
+        args: {},
+        envs: {
+          CI: true,
+          CIRRUS_CI: true,
+        },
+      }
+      const detected = providerCirrus.detect(inputs.envs)
+      expect(detected).toBeTruthy()
+    })
+  })
+
+  it('gets correct params', () => {
+    const inputs = {
+      args: {},
+      envs: {
+        CI: true,
+        CIRRUS_CI: true,
+        CIRRUS_BRANCH: 'master',
+        CIRRUS_CHANGE_IN_REPO: 'testingsha',
+        CIRRUS_BUILD_ID: 2,
+        CIRRUS_PR: 1,
+        CIRRUS_REPO_FULL_NAME: 'https:/example.com/repo',
+      },
+    }
+    const expected = {
+      branch: 'master',
+      build: 2,
+      buildURL: '',
+      commit: 'testingsha',
+      job: '',
+      pr: 1,
+      service: 'cirrus-ci',
+      slug: 'https:/example.com/repo',
+    }
+    const params = providerCirrus.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+
+  it('gets correct params for overrides', () => {
+    const inputs = {
+      args: {
+        branch: 'branch',
+        build: 3,
+        pr: '2',
+        sha: 'testsha',
+        slug: 'testOrg/testRepo',
+      },
+      envs: {
+        CI: true,
+        CIRRUS_CI: true,
+        CIRRUS_BRANCH: 'master',
+        CIRRUS_CHANGE_IN_REPO: 'testingsha',
+        CIRRUS_BUILD_ID: 2,
+        CIRRUS_PR: 1,
+        CIRRUS_REPO_FULL_NAME: 'https:/example.com/repo',
+      },
+    }
+    const expected = {
+      branch: 'branch',
+      build: 3,
+      buildURL: '',
+      commit: 'testsha',
+      job: '',
+      pr: '2',
+      service: 'cirrus-ci',
+      slug: 'testOrg/testRepo',
+    }
+
+    const params = providerCirrus.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+})