@datadog/datadog-ci 0.17.12 → 0.17.13

package/dist/commands/synthetics/utils.d.ts

@@ -22,3 +22,6 @@ export declare const getTestsToTrigger: (api: APIHelper, triggerConfigs: Trigger
 }>;
 export declare const runTests: (api: APIHelper, testsToTrigger: TestPayload[]) => Promise<Trigger>;
 export declare const retry: <T, E extends Error>(func: () => Promise<T>, shouldRetryAfterWait: (retries: number, error: E) => number | undefined) => Promise<T>;
+export declare const parseVariablesFromCli: (variableArguments: string[] | undefined, logFunction: (log: string) => void) => {
+    [key: string]: string;
+} | undefined;

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.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,3 +435,22 @@ const retry = (func, shouldRetryAfterWait) => __awaiter(void 0, void 0, void 0,
     return trier();
 });
 exports.retry = retry;
+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 Object.keys(variables).length > 0 ? variables : undefined;
+};
+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/helpers/__tests__/ci.test.js

@@ -8,6 +8,42 @@ 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', () => {
     test('non-recognized CI returns undefined', () => {
         process.env = {};
@@ -41,11 +77,44 @@ describe('getCIMetadata', () => {
             expect(ci_1.getCIMetadata()).toEqual(expectedMetadata);
         });
     });
+    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',
+        };
+        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({});
     });
     CI_PROVIDERS.forEach((ciProvider) => {
@@ -53,31 +122,9 @@ describe('ci spec', () => {
         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);
             });
         });
     });
 });
-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;
-};

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

@@ -2,19 +2,22 @@
 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_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',
@@ -29,8 +32,8 @@ 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',
@@ -44,11 +47,12 @@ describe('getUserGitMetadata', () => {
         });
     });
     it('overwrites branch when tag is available', () => {
-        process.env.DD_GIT_TAG = 'DD_GIT_TAG';
-        const result = user_provided_git_1.getUserGitMetadata();
+        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',
@@ -59,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/ci.js

@@ -288,7 +288,7 @@ const getCISpanTags = () => {
 };
 exports.getCISpanTags = getCISpanTags;
 const getCIMetadata = () => {
-    const tags = Object.assign(Object.assign({}, exports.getCISpanTags()), user_provided_git_1.getUserGitMetadata());
+    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;
     }

package/dist/helpers/user-provided-git.d.ts

@@ -1 +1,2 @@
-export declare const getUserGitMetadata: () => {};
+export declare const getUserGitSpanTags: () => {};
+export declare const getUserCISpanTags: () => {};

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

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUserGitMetadata = void 0;
+exports.getUserCISpanTags = exports.getUserGitSpanTags = void 0;
 const tags_1 = require("./tags");
 const utils_1 = require("./utils");
-const getUserGitMetadata = () => {
+const getUserGitSpanTags = () => {
     const { DD_GIT_REPOSITORY_URL, DD_GIT_COMMIT_SHA, DD_GIT_BRANCH, DD_GIT_TAG, DD_GIT_COMMIT_MESSAGE, DD_GIT_COMMIT_AUTHOR_NAME, DD_GIT_COMMIT_AUTHOR_EMAIL, DD_GIT_COMMIT_AUTHOR_DATE, DD_GIT_COMMIT_COMMITTER_NAME, DD_GIT_COMMIT_COMMITTER_EMAIL, DD_GIT_COMMIT_COMMITTER_DATE, } = process.env;
     let branch = utils_1.normalizeRef(DD_GIT_BRANCH);
     let tag = utils_1.normalizeRef(DD_GIT_TAG);
@@ -28,4 +28,19 @@ const getUserGitMetadata = () => {
         [tags_1.GIT_COMMIT_AUTHOR_NAME]: DD_GIT_COMMIT_AUTHOR_NAME,
     });
 };
-exports.getUserGitMetadata = getUserGitMetadata;
+exports.getUserGitSpanTags = getUserGitSpanTags;
+const getUserCISpanTags = () => {
+    const { DD_CI_JOB_NAME, DD_CI_JOB_URL, DD_CI_PIPELINE_ID, DD_CI_PIPELINE_NAME, DD_CI_PIPELINE_NUMBER, DD_CI_PIPELINE_URL, DD_CI_PROVIDER_NAME, DD_CI_STAGE_NAME, DD_CI_WORKSPACE_PATH, } = process.env;
+    return utils_1.removeEmptyValues({
+        [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,
+    });
+};
+exports.getUserCISpanTags = getUserCISpanTags;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datadog/datadog-ci",
-  "version": "0.17.12",
+  "version": "0.17.13",
   "description": "Run datadog actions from the CI.",
   "repository": "https://github.com/DataDog/datadog-ci",
   "license": "Apache-2.0",