@datadog/datadog-ci 0.17.9 → 0.17.13

package/dist/commands/synthetics/utils.js

@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeUndefinedValues = exports.retry = exports.runTests = exports.getTestsToTrigger = exports.getReporter = exports.getResultDuration = exports.createSummary = exports.createTriggerResultMap = exports.waitForResults = exports.wait = exports.getSuites = exports.hasTestSucceeded = exports.hasResultPassed = exports.isCriticalError = exports.getStrictestExecutionRule = exports.getExecutionRule = exports.handleConfig = void 0;
+exports.parseVariablesFromCli = exports.retry = exports.runTests = exports.getTestsToTrigger = exports.getReporter = exports.getResultDuration = exports.createSummary = exports.createTriggerResultMap = exports.waitForResults = exports.wait = exports.getSuites = exports.hasTestSucceeded = exports.hasResultPassed = exports.isCriticalError = exports.getStrictestExecutionRule = exports.getExecutionRule = exports.handleConfig = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const url_1 = require("url");
@@ -435,13 +435,22 @@ const retry = (func, shouldRetryAfterWait) => __awaiter(void 0, void 0, void 0,
     return trier();
 });
 exports.retry = retry;
-const removeUndefinedValues = (object) => {
-    const newObject = Object.assign({}, object);
-    for (const [key, value] of Object.entries(newObject)) {
-        if (value === undefined) {
-            delete newObject[key];
+const parseVariablesFromCli = (variableArguments = [], logFunction) => {
+    const variables = {};
+    for (const variableArgument of variableArguments) {
+        const separatorIndex = variableArgument.indexOf('=');
+        if (separatorIndex === -1) {
+            logFunction(`Ignoring variable "${variableArgument}" as separator "=" was not found`);
+            continue;
         }
+        if (separatorIndex === 0) {
+            logFunction(`Ignoring variable "${variableArgument}" as variable name is empty`);
+            continue;
+        }
+        const key = variableArgument.substring(0, separatorIndex);
+        const value = variableArgument.substring(separatorIndex + 1);
+        variables[key] = value;
     }
-    return newObject;
+    return Object.keys(variables).length > 0 ? variables : undefined;
 };
-exports.removeUndefinedValues = removeUndefinedValues;
+exports.parseVariablesFromCli = parseVariablesFromCli;

package/dist/commands/trace/api.js

@@ -18,7 +18,7 @@ const utils_1 = require("../../helpers/utils");
 const maxBodyLength = Infinity;
 const reportCustomSpan = (request) => (customSpan, provider) => __awaiter(void 0, void 0, void 0, function* () {
     const gitSpanTags = yield git_1.getGitMetadata();
-    const userGitSpanTags = user_provided_git_1.getUserGitMetadata();
+    const userGitSpanTags = user_provided_git_1.getUserGitSpanTags();
     return request({
         data: Object.assign(Object.assign({}, customSpan), { tags: Object.assign(Object.assign(Object.assign({}, gitSpanTags), userGitSpanTags), customSpan.tags) }),
         headers: {

package/dist/commands/trace/cli.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/trace/trace.d.ts

@@ -1,7 +1,7 @@
 import { Command } from 'clipanion';
 import { Provider } from './interfaces';
 export declare class TraceCommand extends Command {
-    static usage: import("clipanion/lib/advanced").Usage;
+    static usage: import("clipanion").Usage;
     private command?;
     private config;
     private name?;

package/dist/helpers/__tests__/ci.test.js

@@ -3,165 +3,126 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const ci_1 = require("../ci");
-const user_provided_git_1 = require("../user-provided-git");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const ci_1 = require("../ci");
+const user_provided_git_1 = require("../user-provided-git");
+const CI_PROVIDERS = fs_1.default.readdirSync(path_1.default.join(__dirname, 'ci-env'));
+const ciAppTagsToMetadata = (tags) => {
+    const metadata = {
+        ci: { job: {}, pipeline: {}, provider: {}, stage: {} },
+        git: { commit: { author: {}, committer: {} } },
+    };
+    Object.entries(tags).forEach(([tag, value]) => {
+        // Ignore JSON fixtures pipeline number that can't be parsed to numbers
+        if (!value || tag === 'ci.pipeline.number') {
+            return;
+        }
+        // Get Metadata nested property from tag name ('git.commit.author.name')
+        let currentAttr = metadata;
+        // Current attribute up to second to last
+        const properties = tag.split('.');
+        for (let i = 0; i < properties.length - 1; i++) {
+            currentAttr = currentAttr[properties[i]];
+        }
+        const attributeName = properties[properties.length - 1];
+        currentAttr[attributeName] = value;
+    });
+    return metadata;
+};
+const ddMetadataToSpanTags = (ddMetadata) => {
+    const spanTags = {};
+    Object.entries(ddMetadata).map(([key, value]) => {
+        let tagKey = key.split('_').slice(1).join('.').toLocaleLowerCase(); // Split and remove DD prefix
+        if (tagKey === 'git.repository.url') {
+            tagKey = 'git.repository_url';
+        }
+        else if (tagKey === 'ci.workspace.path') {
+            tagKey = 'ci.workspace_path';
+        }
+        spanTags[tagKey] = value;
+    });
+    return spanTags;
+};
 describe('getCIMetadata', () => {
-    const branch = 'fakeBranch';
-    const commit = 'fakeCommitSha';
-    const pipelineURL = 'fakePipelineUrl';
     test('non-recognized CI returns undefined', () => {
         process.env = {};
         expect(ci_1.getCIMetadata()).toBeUndefined();
     });
-    test('circle CI is recognized', () => {
-        process.env = {
-            CIRCLECI: 'true',
-            CIRCLE_BRANCH: branch,
-            CIRCLE_BUILD_URL: pipelineURL,
-            CIRCLE_SHA1: commit,
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.CIRCLECI },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
-    });
-    test('travis CI is recognized', () => {
-        process.env = {
-            TRAVIS: 'true',
-            TRAVIS_BRANCH: branch,
-            TRAVIS_COMMIT: commit,
-            TRAVIS_JOB_WEB_URL: pipelineURL,
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.TRAVIS },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
+    test('pipeline number is parsed to int or ignored', () => {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        process.env = { GITLAB_CI: 'gitlab' };
+        process.env.CI_PIPELINE_IID = '0';
+        expect((_a = ci_1.getCIMetadata()) === null || _a === void 0 ? void 0 : _a.ci.pipeline.number).toBe(0);
+        process.env.CI_PIPELINE_IID = ' \n\r 12345 \n\n ';
+        expect((_b = ci_1.getCIMetadata()) === null || _b === void 0 ? void 0 : _b.ci.pipeline.number).toBe(12345);
+        process.env.CI_PIPELINE_IID = '123.45';
+        expect((_c = ci_1.getCIMetadata()) === null || _c === void 0 ? void 0 : _c.ci.pipeline.number).toBe(123);
+        process.env.CI_PIPELINE_IID = '999b';
+        expect((_d = ci_1.getCIMetadata()) === null || _d === void 0 ? void 0 : _d.ci.pipeline.number).toBe(999);
+        process.env.CI_PIPELINE_IID = '-1';
+        expect((_e = ci_1.getCIMetadata()) === null || _e === void 0 ? void 0 : _e.ci.pipeline.number).toBe(-1);
+        process.env.CI_PIPELINE_IID = '';
+        expect((_f = ci_1.getCIMetadata()) === null || _f === void 0 ? void 0 : _f.ci.pipeline.number).toBeUndefined();
+        process.env.CI_PIPELINE_IID = 'not a number';
+        expect((_g = ci_1.getCIMetadata()) === null || _g === void 0 ? void 0 : _g.ci.pipeline.number).toBeUndefined();
+        process.env.CI_PIPELINE_IID = '$1';
+        expect((_h = ci_1.getCIMetadata()) === null || _h === void 0 ? void 0 : _h.ci.pipeline.number).toBeUndefined();
     });
-    test('gitlab CI is recognized', () => {
-        process.env = {
-            CI_COMMIT_REF_NAME: branch,
-            CI_COMMIT_SHA: commit,
-            CI_JOB_URL: pipelineURL,
-            GITLAB_CI: 'true',
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.GITLAB },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
-    });
-    test('github actions is recognized', () => {
-        process.env = {
-            GITHUB_ACTIONS: 'true',
-            GITHUB_REF: branch,
-            GITHUB_REPOSITORY: 'DataDog/datadog-ci',
-            GITHUB_RUN_ID: '42',
-            GITHUB_SERVER_URL: 'https://github.com',
-            GITHUB_SHA: commit,
-        };
-        const expectedPipelineURL = 'https://github.com/DataDog/datadog-ci/actions/runs/42';
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: expectedPipelineURL },
-                provider: { name: ci_1.CI_ENGINES.GITHUB },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
-    });
-    test('github actions with run attempt is recognized', () => {
-        process.env = {
-            GITHUB_ACTIONS: 'true',
-            GITHUB_REF: branch,
-            GITHUB_REPOSITORY: 'DataDog/datadog-ci',
-            GITHUB_RUN_ATTEMPT: '2',
-            GITHUB_RUN_ID: '42',
-            GITHUB_SERVER_URL: 'https://github.com',
-            GITHUB_SHA: commit,
-        };
-        const expectedPipelineURL = 'https://github.com/DataDog/datadog-ci/actions/runs/42/attempts/2';
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: expectedPipelineURL },
-                provider: { name: ci_1.CI_ENGINES.GITHUB },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
-        });
-    });
-    test('jenkins is recognized', () => {
-        process.env = {
-            BUILD_URL: pipelineURL,
-            GIT_BRANCH: branch,
-            GIT_COMMIT: commit,
-            JENKINS_URL: 'https://fakebuildserver.url/',
-        };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.JENKINS },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
+    describe.each(CI_PROVIDERS)('%s', (ciProvider) => {
+        const assertions = require(path_1.default.join(__dirname, 'ci-env', ciProvider));
+        test.each(assertions)('spec %#', (env, tags) => {
+            process.env = env;
+            const expectedMetadata = ciAppTagsToMetadata(tags);
+            expect(ci_1.getCIMetadata()).toEqual(expectedMetadata);
         });
     });
-    test('jenkins context is recognized', () => {
-        process.env = {
-            BUILD_URL: pipelineURL,
-            GIT_BRANCH: branch,
-            GIT_COMMIT: commit,
-            JENKINS_URL: 'https://fakebuildserver.url/',
+    describe.each(CI_PROVIDERS)('Ensure DD env variables override %s env variables', (ciProvider) => {
+        const DD_METADATA = {
+            DD_CI_JOB_NAME: 'DD_CI_JOB_NAME',
+            DD_CI_JOB_URL: 'DD_CI_JOB_URL',
+            DD_CI_PIPELINE_ID: 'DD_CI_PIPELINE_ID',
+            DD_CI_PIPELINE_NAME: 'DD_CI_PIPELINE_NAME',
+            DD_CI_PIPELINE_NUMBER: 'DD_CI_PIPELINE_NUMBER',
+            DD_CI_PIPELINE_URL: 'DD_CI_PIPELINE_URL',
+            DD_CI_PROVIDER_NAME: 'DD_CI_PROVIDER_NAME',
+            DD_CI_STAGE_NAME: 'DD_CI_STAGE_NAME',
+            DD_CI_WORKSPACE_PATH: 'DD_CI_WORKSPACE_PATH',
+            DD_GIT_BRANCH: 'DD_GIT_BRANCH',
+            DD_GIT_COMMIT_AUTHOR_DATE: 'DD_GIT_COMMIT_AUTHOR_DATE',
+            DD_GIT_COMMIT_AUTHOR_EMAIL: 'DD_GIT_COMMIT_AUTHOR_EMAIL',
+            DD_GIT_COMMIT_AUTHOR_NAME: 'DD_GIT_COMMIT_AUTHOR_NAME',
+            DD_GIT_COMMIT_COMMITTER_DATE: 'DD_GIT_COMMIT_COMMITTER_DATE',
+            DD_GIT_COMMIT_COMMITTER_EMAIL: 'DD_GIT_COMMIT_COMMITTER_EMAIL',
+            DD_GIT_COMMIT_COMMITTER_NAME: 'DD_GIT_COMMIT_COMMITTER_NAME',
+            DD_GIT_COMMIT_MESSAGE: 'DD_GIT_COMMIT_MESSAGE',
+            DD_GIT_COMMIT_SHA: 'DD_GIT_COMMIT_SHA',
+            DD_GIT_REPOSITORY_URL: 'DD_GIT_REPOSITORY_URL',
+            DD_GIT_TAG: 'DD_GIT_TAG',
         };
-        expect(ci_1.getCIMetadata()).toEqual({
-            ci: {
-                pipeline: { url: pipelineURL },
-                provider: { name: ci_1.CI_ENGINES.JENKINS },
-            },
-            git: {
-                branch,
-                commitSha: commit,
-            },
+        const expectedMetadata = ciAppTagsToMetadata(ddMetadataToSpanTags(DD_METADATA));
+        delete expectedMetadata.git.branch;
+        const assertions = require(path_1.default.join(__dirname, 'ci-env', ciProvider));
+        it.each(assertions)('spec %#', (env, tags) => {
+            process.env = Object.assign(Object.assign({}, env), DD_METADATA);
+            const ciMetadata = ci_1.getCIMetadata();
+            ciMetadata === null || ciMetadata === void 0 ? true : delete ciMetadata.git.branch;
+            expect(ciMetadata).toEqual(expectedMetadata);
         });
     });
 });
 describe('ci spec', () => {
     test('returns an empty object if the CI is not supported', () => {
         process.env = {};
-        const tags = Object.assign(Object.assign({}, ci_1.getCISpanTags()), user_provided_git_1.getUserGitMetadata());
+        const tags = Object.assign(Object.assign(Object.assign({}, ci_1.getCISpanTags()), user_provided_git_1.getUserCISpanTags()), user_provided_git_1.getUserGitSpanTags());
         expect(tags).toEqual({});
     });
-    const ciProviders = fs_1.default.readdirSync(path_1.default.join(__dirname, 'ci-env'));
-    ciProviders.forEach((ciProvider) => {
+    CI_PROVIDERS.forEach((ciProvider) => {
         const assertions = require(path_1.default.join(__dirname, 'ci-env', ciProvider));
         assertions.forEach(([env, expectedSpanTags], index) => {
             test(`reads env info for spec ${index} from ${ciProvider}`, () => {
                 process.env = env;
-                const tags = Object.assign(Object.assign({}, ci_1.getCISpanTags()), user_provided_git_1.getUserGitMetadata());
+                const tags = Object.assign(Object.assign({}, ci_1.getCISpanTags()), user_provided_git_1.getUserGitSpanTags());
                 expect(tags).toEqual(expectedSpanTags);
             });
         });

package/dist/helpers/__tests__/user-provided-git.test.js

@@ -2,25 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tags_1 = require("../tags");
 const user_provided_git_1 = require("../user-provided-git");
-describe('getUserGitMetadata', () => {
+describe('getUserGitSpanTags', () => {
+    const DD_GIT_METADATA = {
+        DD_GIT_BRANCH: 'DD_GIT_BRANCH',
+        DD_GIT_COMMIT_AUTHOR_DATE: 'DD_GIT_COMMIT_AUTHOR_DATE',
+        DD_GIT_COMMIT_AUTHOR_EMAIL: 'DD_GIT_COMMIT_AUTHOR_EMAIL',
+        DD_GIT_COMMIT_AUTHOR_NAME: 'DD_GIT_COMMIT_AUTHOR_NAME',
+        DD_GIT_COMMIT_COMMITTER_DATE: 'DD_GIT_COMMIT_COMMITTER_DATE',
+        DD_GIT_COMMIT_COMMITTER_EMAIL: 'DD_GIT_COMMIT_COMMITTER_EMAIL',
+        DD_GIT_COMMIT_COMMITTER_NAME: 'DD_GIT_COMMIT_COMMITTER_NAME',
+        DD_GIT_COMMIT_MESSAGE: 'DD_GIT_COMMIT_MESSAGE',
+        DD_GIT_COMMIT_SHA: 'DD_GIT_COMMIT_SHA',
+        DD_GIT_REPOSITORY_URL: 'DD_GIT_REPOSITORY_URL',
+    };
     it('reads user defined git metadata successfully', () => {
-        process.env.DD_GIT_COMMIT_SHA = 'DD_GIT_COMMIT_SHA';
-        process.env.DD_GIT_REPOSITORY_URL = 'DD_GIT_REPOSITORY_URL';
-        process.env.DD_GIT_BRANCH = 'DD_GIT_BRANCH';
-        process.env.DD_GIT_TAG = 'DD_GIT_TAG';
-        process.env.DD_GIT_COMMIT_MESSAGE = 'DD_GIT_COMMIT_MESSAGE';
-        process.env.DD_GIT_COMMIT_AUTHOR_NAME = 'DD_GIT_COMMIT_AUTHOR_NAME';
-        process.env.DD_GIT_COMMIT_AUTHOR_EMAIL = 'DD_GIT_COMMIT_AUTHOR_EMAIL';
-        process.env.DD_GIT_COMMIT_AUTHOR_DATE = 'DD_GIT_COMMIT_AUTHOR_DATE';
-        process.env.DD_GIT_COMMIT_COMMITTER_NAME = 'DD_GIT_COMMIT_COMMITTER_NAME';
-        process.env.DD_GIT_COMMIT_COMMITTER_EMAIL = 'DD_GIT_COMMIT_COMMITTER_EMAIL';
-        process.env.DD_GIT_COMMIT_COMMITTER_DATE = 'DD_GIT_COMMIT_COMMITTER_DATE';
-        const result = user_provided_git_1.getUserGitMetadata();
+        process.env = Object.assign({}, DD_GIT_METADATA);
+        const result = user_provided_git_1.getUserGitSpanTags();
         expect(result).toEqual({
             [tags_1.GIT_REPOSITORY_URL]: 'DD_GIT_REPOSITORY_URL',
             [tags_1.GIT_BRANCH]: 'DD_GIT_BRANCH',
             [tags_1.GIT_SHA]: 'DD_GIT_COMMIT_SHA',
-            [tags_1.GIT_TAG]: 'DD_GIT_TAG',
             [tags_1.GIT_COMMIT_MESSAGE]: 'DD_GIT_COMMIT_MESSAGE',
             [tags_1.GIT_COMMIT_COMMITTER_DATE]: 'DD_GIT_COMMIT_COMMITTER_DATE',
             [tags_1.GIT_COMMIT_COMMITTER_EMAIL]: 'DD_GIT_COMMIT_COMMITTER_EMAIL',
@@ -31,12 +32,27 @@ describe('getUserGitMetadata', () => {
         });
     });
     it('does not include empty values', () => {
-        delete process.env.DD_GIT_COMMIT_SHA;
-        const result = user_provided_git_1.getUserGitMetadata();
+        process.env = Object.assign(Object.assign({}, DD_GIT_METADATA), { DD_GIT_COMMIT_SHA: undefined });
+        const result = user_provided_git_1.getUserGitSpanTags();
         expect(result).toEqual({
             [tags_1.GIT_REPOSITORY_URL]: 'DD_GIT_REPOSITORY_URL',
             [tags_1.GIT_BRANCH]: 'DD_GIT_BRANCH',
+            [tags_1.GIT_COMMIT_MESSAGE]: 'DD_GIT_COMMIT_MESSAGE',
+            [tags_1.GIT_COMMIT_COMMITTER_DATE]: 'DD_GIT_COMMIT_COMMITTER_DATE',
+            [tags_1.GIT_COMMIT_COMMITTER_EMAIL]: 'DD_GIT_COMMIT_COMMITTER_EMAIL',
+            [tags_1.GIT_COMMIT_COMMITTER_NAME]: 'DD_GIT_COMMIT_COMMITTER_NAME',
+            [tags_1.GIT_COMMIT_AUTHOR_DATE]: 'DD_GIT_COMMIT_AUTHOR_DATE',
+            [tags_1.GIT_COMMIT_AUTHOR_EMAIL]: 'DD_GIT_COMMIT_AUTHOR_EMAIL',
+            [tags_1.GIT_COMMIT_AUTHOR_NAME]: 'DD_GIT_COMMIT_AUTHOR_NAME',
+        });
+    });
+    it('overwrites branch when tag is available', () => {
+        process.env = Object.assign(Object.assign({}, DD_GIT_METADATA), { DD_GIT_TAG: 'DD_GIT_TAG' });
+        const result = user_provided_git_1.getUserGitSpanTags();
+        expect(result).toEqual({
             [tags_1.GIT_TAG]: 'DD_GIT_TAG',
+            [tags_1.GIT_REPOSITORY_URL]: 'DD_GIT_REPOSITORY_URL',
+            [tags_1.GIT_SHA]: 'DD_GIT_COMMIT_SHA',
             [tags_1.GIT_COMMIT_MESSAGE]: 'DD_GIT_COMMIT_MESSAGE',
             [tags_1.GIT_COMMIT_COMMITTER_DATE]: 'DD_GIT_COMMIT_COMMITTER_DATE',
             [tags_1.GIT_COMMIT_COMMITTER_EMAIL]: 'DD_GIT_COMMIT_COMMITTER_EMAIL',
@@ -47,17 +63,55 @@ describe('getUserGitMetadata', () => {
         });
     });
     it('returns an empty object if no user git is defined', () => {
-        delete process.env.DD_GIT_REPOSITORY_URL;
-        delete process.env.DD_GIT_BRANCH;
-        delete process.env.DD_GIT_TAG;
-        delete process.env.DD_GIT_COMMIT_MESSAGE;
-        delete process.env.DD_GIT_COMMIT_AUTHOR_NAME;
-        delete process.env.DD_GIT_COMMIT_AUTHOR_EMAIL;
-        delete process.env.DD_GIT_COMMIT_AUTHOR_DATE;
-        delete process.env.DD_GIT_COMMIT_COMMITTER_NAME;
-        delete process.env.DD_GIT_COMMIT_COMMITTER_EMAIL;
-        delete process.env.DD_GIT_COMMIT_COMMITTER_DATE;
-        const result = user_provided_git_1.getUserGitMetadata();
+        process.env = {};
+        const result = user_provided_git_1.getUserGitSpanTags();
+        expect(result).toEqual({});
+    });
+});
+describe('getUserCISpanTags', () => {
+    const DD_CI_METADATA = {
+        DD_CI_JOB_NAME: 'DD_CI_JOB_NAME',
+        DD_CI_JOB_URL: 'DD_CI_JOB_URL',
+        DD_CI_PIPELINE_ID: 'DD_CI_PIPELINE_ID',
+        DD_CI_PIPELINE_NAME: 'DD_CI_PIPELINE_NAME',
+        DD_CI_PIPELINE_NUMBER: 'DD_CI_PIPELINE_NUMBER',
+        DD_CI_PIPELINE_URL: 'DD_CI_PIPELINE_URL',
+        DD_CI_PROVIDER_NAME: 'DD_CI_PROVIDER_NAME',
+        DD_CI_STAGE_NAME: 'DD_CI_STAGE_NAME',
+        DD_CI_WORKSPACE_PATH: 'DD_CI_WORKSPACE_PATH',
+    };
+    it('reads user defined CI metadata successfully', () => {
+        process.env = Object.assign({}, DD_CI_METADATA);
+        const result = user_provided_git_1.getUserCISpanTags();
+        expect(result).toEqual({
+            [tags_1.CI_JOB_NAME]: 'DD_CI_JOB_NAME',
+            [tags_1.CI_JOB_URL]: 'DD_CI_JOB_URL',
+            [tags_1.CI_PIPELINE_ID]: 'DD_CI_PIPELINE_ID',
+            [tags_1.CI_PIPELINE_NAME]: 'DD_CI_PIPELINE_NAME',
+            [tags_1.CI_PIPELINE_NUMBER]: 'DD_CI_PIPELINE_NUMBER',
+            [tags_1.CI_PIPELINE_URL]: 'DD_CI_PIPELINE_URL',
+            [tags_1.CI_PROVIDER_NAME]: 'DD_CI_PROVIDER_NAME',
+            [tags_1.CI_STAGE_NAME]: 'DD_CI_STAGE_NAME',
+            [tags_1.CI_WORKSPACE_PATH]: 'DD_CI_WORKSPACE_PATH',
+        });
+    });
+    it('does not include empty values', () => {
+        process.env = Object.assign(Object.assign({}, DD_CI_METADATA), { DD_CI_PIPELINE_ID: undefined });
+        const result = user_provided_git_1.getUserCISpanTags();
+        expect(result).toEqual({
+            [tags_1.CI_JOB_NAME]: 'DD_CI_JOB_NAME',
+            [tags_1.CI_JOB_URL]: 'DD_CI_JOB_URL',
+            [tags_1.CI_PIPELINE_NAME]: 'DD_CI_PIPELINE_NAME',
+            [tags_1.CI_PIPELINE_NUMBER]: 'DD_CI_PIPELINE_NUMBER',
+            [tags_1.CI_PIPELINE_URL]: 'DD_CI_PIPELINE_URL',
+            [tags_1.CI_PROVIDER_NAME]: 'DD_CI_PROVIDER_NAME',
+            [tags_1.CI_STAGE_NAME]: 'DD_CI_STAGE_NAME',
+            [tags_1.CI_WORKSPACE_PATH]: 'DD_CI_WORKSPACE_PATH',
+        });
+    });
+    it('returns an empty object if no user CI is defined', () => {
+        process.env = {};
+        const result = user_provided_git_1.getUserCISpanTags();
         expect(result).toEqual({});
     });
 });

package/dist/helpers/__tests__/utils.test.js

@@ -363,3 +363,7 @@ describe('utils', () => {
         }));
     });
 });
+test('removeUndefinedValues', () => {
+    // tslint:disable-next-line: no-null-keyword
+    expect(ciUtils.removeUndefinedValues({ a: 'b', c: 'd', e: undefined, g: null })).toEqual({ a: 'b', c: 'd', g: null });
+});

package/dist/helpers/ci.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCIMetadata = exports.getCISpanTags = exports.CI_ENGINES = void 0;
 const url_1 = require("url");
 const tags_1 = require("./tags");
+const user_provided_git_1 = require("./user-provided-git");
 const utils_1 = require("./utils");
 exports.CI_ENGINES = {
     APPVEYOR: 'appveyor',
@@ -57,12 +58,6 @@ const filterSensitiveInfoFromRepository = (repositoryUrl) => {
         return repositoryUrl;
     }
 };
-const normalizeRef = (ref) => {
-    if (!ref) {
-        return ref;
-    }
-    return ref.replace(/origin\/|refs\/heads\/|tags\//gm, '');
-};
 const getCISpanTags = () => {
     const env = process.env;
     let tags = {};
@@ -160,7 +155,7 @@ const getCISpanTags = () => {
         };
         const isTag = JENKINS_GIT_BRANCH && JENKINS_GIT_BRANCH.includes('tags');
         const refKey = isTag ? tags_1.GIT_TAG : tags_1.GIT_BRANCH;
-        const ref = normalizeRef(JENKINS_GIT_BRANCH);
+        const ref = utils_1.normalizeRef(JENKINS_GIT_BRANCH);
         tags[refKey] = ref;
         let finalPipelineName = '';
         if (JOB_NAME) {
@@ -284,101 +279,65 @@ const getCISpanTags = () => {
         tags[tags_1.GIT_REPOSITORY_URL] = filterSensitiveInfoFromRepository(tags[tags_1.GIT_REPOSITORY_URL]);
     }
     if (tags[tags_1.GIT_BRANCH]) {
-        tags[tags_1.GIT_BRANCH] = normalizeRef(tags[tags_1.GIT_BRANCH]);
+        tags[tags_1.GIT_BRANCH] = utils_1.normalizeRef(tags[tags_1.GIT_BRANCH]);
     }
     if (tags[tags_1.GIT_TAG]) {
-        tags[tags_1.GIT_TAG] = normalizeRef(tags[tags_1.GIT_TAG]);
+        tags[tags_1.GIT_TAG] = utils_1.normalizeRef(tags[tags_1.GIT_TAG]);
     }
     return utils_1.removeEmptyValues(tags);
 };
 exports.getCISpanTags = getCISpanTags;
 const getCIMetadata = () => {
-    const env = process.env;
-    if (env.CIRCLECI) {
-        return {
-            ci: {
-                pipeline: {
-                    url: env.CIRCLE_BUILD_URL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.CIRCLECI,
-                },
-            },
-            git: {
-                branch: env.CIRCLE_BRANCH,
-                commitSha: env.CIRCLE_SHA1,
-            },
-        };
-    }
-    if (env.TRAVIS) {
-        return {
-            ci: {
-                pipeline: {
-                    url: env.TRAVIS_JOB_WEB_URL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.TRAVIS,
-                },
-            },
-            git: {
-                branch: env.TRAVIS_BRANCH,
-                commitSha: env.TRAVIS_COMMIT,
-            },
-        };
-    }
-    if (env.GITLAB_CI) {
-        return {
-            ci: {
-                pipeline: {
-                    url: env.CI_JOB_URL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.GITLAB,
-                },
-            },
-            git: {
-                branch: env.CI_COMMIT_REF_NAME,
-                commitSha: env.CI_COMMIT_SHA,
-            },
-        };
-    }
-    if (env.GITHUB_ACTIONS) {
-        const { GITHUB_REF, GITHUB_SHA, GITHUB_REPOSITORY, GITHUB_RUN_ID, GITHUB_SERVER_URL } = env;
-        let pipelineURL = `${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}`;
-        if (env.GITHUB_RUN_ATTEMPT) {
-            pipelineURL += `/attempts/${env.GITHUB_RUN_ATTEMPT}`;
-        }
-        return {
-            ci: {
-                pipeline: {
-                    url: pipelineURL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.GITHUB,
-                },
-            },
-            git: {
-                branch: GITHUB_REF,
-                commitSha: GITHUB_SHA,
-            },
-        };
-    }
-    if (env.JENKINS_URL) {
-        const { BUILD_URL, GIT_COMMIT, GIT_BRANCH: JENKINS_GIT_BRANCH } = env;
-        return {
-            ci: {
-                pipeline: {
-                    url: BUILD_URL,
-                },
-                provider: {
-                    name: exports.CI_ENGINES.JENKINS,
-                },
-            },
-            git: {
-                branch: JENKINS_GIT_BRANCH,
-                commitSha: GIT_COMMIT,
-            },
-        };
+    const tags = Object.assign(Object.assign(Object.assign({}, exports.getCISpanTags()), user_provided_git_1.getUserCISpanTags()), user_provided_git_1.getUserGitSpanTags());
+    if (!tags || !Object.keys(tags).length) {
+        return;
     }
+    const metadata = {
+        ci: utils_1.removeUndefinedValues({
+            job: utils_1.removeUndefinedValues({
+                name: tags[tags_1.CI_JOB_NAME],
+                url: tags[tags_1.CI_JOB_URL],
+            }),
+            pipeline: utils_1.removeUndefinedValues({
+                id: tags[tags_1.CI_PIPELINE_ID],
+                name: tags[tags_1.CI_PIPELINE_NAME],
+                number: parsePipelineNumber(tags[tags_1.CI_PIPELINE_NUMBER]),
+                url: tags[tags_1.CI_PIPELINE_URL],
+            }),
+            provider: utils_1.removeUndefinedValues({
+                name: tags[tags_1.CI_PROVIDER_NAME],
+            }),
+            stage: utils_1.removeUndefinedValues({
+                name: tags[tags_1.CI_STAGE_NAME],
+            }),
+            workspace_path: tags[tags_1.CI_WORKSPACE_PATH],
+        }),
+        git: utils_1.removeUndefinedValues({
+            branch: tags[tags_1.GIT_BRANCH],
+            commit: utils_1.removeUndefinedValues({
+                author: utils_1.removeUndefinedValues({
+                    date: tags[tags_1.GIT_COMMIT_AUTHOR_DATE],
+                    email: tags[tags_1.GIT_COMMIT_AUTHOR_EMAIL],
+                    name: tags[tags_1.GIT_COMMIT_AUTHOR_NAME],
+                }),
+                committer: utils_1.removeUndefinedValues({
+                    date: tags[tags_1.GIT_COMMIT_COMMITTER_DATE],
+                    email: tags[tags_1.GIT_COMMIT_COMMITTER_EMAIL],
+                    name: tags[tags_1.GIT_COMMIT_COMMITTER_NAME],
+                }),
+                message: tags[tags_1.GIT_COMMIT_MESSAGE],
+                sha: tags[tags_1.GIT_SHA],
+            }),
+            repository_url: tags[tags_1.GIT_REPOSITORY_URL],
+            tag: tags[tags_1.GIT_TAG],
+        }),
+    };
+    return metadata;
 };
 exports.getCIMetadata = getCIMetadata;
+const parsePipelineNumber = (pipelineNumberStr) => {
+    if (pipelineNumberStr) {
+        const pipelineNumber = parseInt(pipelineNumberStr, 10);
+        return isFinite(pipelineNumber) ? pipelineNumber : undefined;
+    }
+};