feat: add woodpecker provider

Signed-off-by: 6543 <[email protected]>

Author: 6543

src/ci_providers/index.ts

@@ -16,6 +16,7 @@ import * as providerLocal from './provider_local'
 import * as providerTeamCity from './provider_teamcity'
 import * as providerTravisci from './provider_travisci'
 import * as providerWercker from './provider_wercker'
+import * as providerWoodpecker from './provider_woodpecker'
 
 // Please make sure provider_local is last
 const providerList: IProvider[] = [
@@ -34,6 +35,7 @@ const providerList: IProvider[] = [
   providerTeamCity,
   providerTravisci,
   providerWercker,
+  providerWoodpecker,
   providerLocal,
 ]
 

src/ci_providers/provider_woodpecker.ts

@@ -0,0 +1,86 @@
+/**
+ * https://woodpecker-ci.org/docs/usage/environment#built-in-environment-variables
+ */
+import { IServiceParams, UploaderEnvs, UploaderInputs } from '../types'
+
+export function detect(envs: UploaderEnvs): boolean {
+  return envs.CI === 'woodpecker'
+}
+
+function _getBuild(inputs: UploaderInputs): string {
+  const { args, environment: envs } = inputs
+  return args.build || envs.CI_BUILD_NUMBER || ''
+}
+
+function _getBuildURL(inputs: UploaderInputs): string {
+  const { environment: envs } = inputs
+  return envs.CI_BUILD_LINK || ''
+}
+
+function _getBranch(inputs: UploaderInputs): string {
+  const { args, environment: envs } = inputs
+  return args.branch || envs.CI_COMMIT_SOURCE_BRANCH || envs.CI_COMMIT_BRANCH || ''
+}
+
+function _getJob(inputs: UploaderInputs): string {
+  const { environment: envs } = inputs
+  return envs.CI_JOB_NUMBER || ''
+}
+
+function _getPR(inputs: UploaderInputs): string {
+  const { args, environment: envs } = inputs
+  return args.pr || envs.CI_COMMIT_PULL_REQUEST || ''
+}
+
+function _getService(): string {
+  return 'woodpecker'
+}
+
+export function getServiceName(): string {
+  return 'Woodpecker CI'
+}
+
+function _getSHA(inputs: UploaderInputs): string {
+  const { args, environment: envs } = inputs
+  return args.sha || envs.CI_COMMIT_SHA || ''
+}
+
+function _getTag(inputs: UploaderInputs): string {
+  const { args, environment: envs } = inputs
+  return args.tag || envs.CI_COMMIT_TAG || ''
+}
+
+function _getSlug(inputs: UploaderInputs): string {
+  const { args, environment: envs } = inputs
+  if (args.slug !== '') return args.slug
+  return envs.CI_REPO || ''
+}
+
+export function getServiceParams(inputs: UploaderInputs): IServiceParams {
+  return {
+    branch: _getBranch(inputs),
+    build: _getBuild(inputs),
+    buildURL: _getBuildURL(inputs),
+    commit: _getSHA(inputs),
+    tag: _getTag(inputs),
+    pr: _getPR(inputs),
+    job: _getJob(inputs),
+    service: _getService(),
+    slug: _getSlug(inputs),
+  }
+}
+
+export function getEnvVarNames(): string[] {
+  return [
+    'CI',
+    'CI_BUILD_NUMBER',
+    'CI_BUILD_LINK',
+    'CI_COMMIT_SOURCE_BRANCH',
+    'CI_COMMIT_BRANCH',
+    'CI_JOB_NUMBER',
+    'CI_COMMIT_PULL_REQUEST',
+    'CI_COMMIT_SHA',
+    'CI_COMMIT_TAG',
+    'CI_REPO',
+  ]
+}

src/helpers/logger.ts

@@ -15,7 +15,7 @@ function _getTimestamp() {
  * @param {boolean} shouldVerbose - value of the verbose flag
  * @return void
  */
- export function verbose(message: string, shouldVerbose: boolean): void {
+export function verbose(message: string, shouldVerbose: boolean): void {
   if (shouldVerbose === true) {
     console.debug(`[${_getTimestamp()}] ['verbose'] ${message}`)
   }
@@ -61,4 +61,4 @@ export class UploadLogger {
   static verbose(message: string) {
     verbose(message, UploadLogger.getInstance().logLevel === 'verbose')
   }
-}
+}

test/providers/provider_woodpecker.test.ts

@@ -0,0 +1,89 @@
+import td from 'testdouble'
+
+import * as providerWoodpecker from '../../src/ci_providers/provider_woodpecker'
+import { IServiceParams, UploaderInputs } from '../../src/types'
+import { createEmptyArgs } from '../test_helpers'
+
+describe('Woodpecker Params', () => {
+  afterEach(() => {
+    td.reset()
+  })
+
+  describe('detect()', () => {
+    it('does not run without Woodpecker env variable', () => {
+      const inputs: UploaderInputs = {
+        args: { ...createEmptyArgs() },
+        environment: {},
+      }
+      const detected = providerWoodpecker.detect(inputs.environment)
+      expect(detected).toBeFalsy()
+    })
+
+    it('does run with Woodpecker env variable', () => {
+      const inputs: UploaderInputs = {
+        args: { ...createEmptyArgs() },
+        environment: {
+          CI: 'woodpecker',
+        },
+      }
+      const detected = providerWoodpecker.detect(inputs.environment)
+      expect(detected).toBeTruthy()
+    })
+  })
+
+  it('gets correct params', () => {
+    const inputs: UploaderInputs = {
+      args: { ...createEmptyArgs() },
+      environment: {
+        CI: 'woodpecker',
+        CI_COMMIT_BRANCH: 'master',
+        CI_COMMIT_SHA: 'testingsha',
+        CI_BUILD_NUMBER: '2',
+        CI_BUILD_LINK: 'https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker/build/1629',
+        CI_JOB_NUMBER: '12',
+        CI_REPO: 'testOrg/testRepo',
+      },
+    }
+    const expected: IServiceParams = {
+      branch: 'master',
+      build: '2',
+      buildURL: 'https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker/build/1629',
+      commit: 'testingsha',
+      pr: '',
+      job: '12',
+      service: 'woodpecker',
+      slug: 'testOrg/testRepo',
+    }
+    const params = providerWoodpecker.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+  
+  it('gets correct params for pull request', () => {
+    const inputs: UploaderInputs = {
+      args: { ...createEmptyArgs() },
+      environment: {
+        CI: 'woodpecker',
+        CI_COMMIT_BRANCH: 'master',
+        CI_COMMIT_SOURCE_BRANCH: 'new-feature',
+        CI_COMMIT_SHA: 'testingsha',
+        CI_BUILD_NUMBER: '2',
+        CI_JOB_NUMBER: '20',
+        CI_COMMIT_PULL_REQUEST: '1',
+        CI_BUILD_LINK: 'https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker/build/1629',
+        CI_REPO: 'testOrg/testRepo',
+      },
+    }
+    const expected: IServiceParams = {
+      branch: 'new-feature',
+      build: '2',
+      buildURL: 'https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker/build/1629',
+      commit: 'testingsha',
+      job: '20',
+      pr: '1',
+      service: 'woodpecker',
+      slug: 'testOrg/testRepo',
+    }
+    const params = providerWoodpecker.getServiceParams(inputs)
+    expect(params).toMatchObject(expected)
+  })
+})