@datadog/datadog-ci 1.1.1 → 1.1.2

package/dist/commands/synthetics/__tests__/run-test.test.js

@@ -129,30 +129,36 @@ describe('run-test', () => {
             expect(startTunnelSpy).toHaveBeenCalledTimes(1);
             expect(stopTunnelSpy).toHaveBeenCalledTimes(1);
         }));
-        test('getTestsList throws', () => __awaiter(void 0, void 0, void 0, function* () {
-            const serverError = new Error('Server Error');
-            serverError.response = { data: { errors: ['Bad Gateway'] }, status: 502 };
-            serverError.config = { baseURL: 'baseURL', url: 'url' };
-            const apiHelper = {
-                searchTests: jest.fn(() => {
-                    throw serverError;
-                }),
-            };
-            jest.spyOn(runTests, 'getApiHelper').mockImplementation(() => apiHelper);
-            yield expect(runTests.executeTests(fixtures_1.mockReporter, Object.assign(Object.assign({}, fixtures_1.ciConfig), { testSearchQuery: 'a-search-query', tunnel: true }))).rejects.toMatchError(new errors_1.CriticalError('UNAVAILABLE_TEST_CONFIG'));
-        }));
-        test('getTestsToTrigger throws', () => __awaiter(void 0, void 0, void 0, function* () {
-            const serverError = new Error('Server Error');
-            serverError.response = { data: { errors: ['Bad Gateway'] }, status: 502 };
-            serverError.config = { baseURL: 'baseURL', url: 'url' };
-            const apiHelper = {
-                getTest: jest.fn(() => {
-                    throw serverError;
-                }),
-            };
-            jest.spyOn(runTests, 'getApiHelper').mockImplementation(() => apiHelper);
-            yield expect(runTests.executeTests(fixtures_1.mockReporter, Object.assign(Object.assign({}, fixtures_1.ciConfig), { publicIds: ['public-id-1'], tunnel: true }))).rejects.toMatchError(new errors_1.CriticalError('UNAVAILABLE_TEST_CONFIG'));
-        }));
+        const cases = [
+            [403, 'AUTHORIZATION_ERROR'],
+            [502, 'UNAVAILABLE_TEST_CONFIG'],
+        ];
+        describe.each(cases)('%s triggers %s', (status, error) => {
+            test(`getTestsList throws - ${status}`, () => __awaiter(void 0, void 0, void 0, function* () {
+                const serverError = new Error('Server Error');
+                serverError.response = { data: { errors: ['Error'] }, status };
+                serverError.config = { baseURL: 'baseURL', url: 'url' };
+                const apiHelper = {
+                    searchTests: jest.fn(() => {
+                        throw serverError;
+                    }),
+                };
+                jest.spyOn(runTests, 'getApiHelper').mockImplementation(() => apiHelper);
+                yield expect(runTests.executeTests(fixtures_1.mockReporter, Object.assign(Object.assign({}, fixtures_1.ciConfig), { testSearchQuery: 'a-search-query', tunnel: true }))).rejects.toMatchError(new errors_1.CriticalError(error));
+            }));
+            test(`getTestsToTrigger throws - ${status}`, () => __awaiter(void 0, void 0, void 0, function* () {
+                const serverError = new Error('Server Error');
+                serverError.response = { data: { errors: ['Bad Gateway'] }, status };
+                serverError.config = { baseURL: 'baseURL', url: 'url' };
+                const apiHelper = {
+                    getTest: jest.fn(() => {
+                        throw serverError;
+                    }),
+                };
+                jest.spyOn(runTests, 'getApiHelper').mockImplementation(() => apiHelper);
+                yield expect(runTests.executeTests(fixtures_1.mockReporter, Object.assign(Object.assign({}, fixtures_1.ciConfig), { publicIds: ['public-id-1'], tunnel: true }))).rejects.toMatchError(new errors_1.CriticalError(error));
+            }));
+        });
         test('getPresignedURL throws', () => __awaiter(void 0, void 0, void 0, function* () {
             jest.spyOn(utils, 'getTestsToTrigger').mockReturnValue(Promise.resolve({
                 overriddenTestsToTrigger: [],

package/dist/commands/synthetics/__tests__/utils.test.js

@@ -87,27 +87,36 @@ describe('utils', () => {
         test('runTests sends batch metadata', () => __awaiter(void 0, void 0, void 0, function* () {
             jest.spyOn(ciHelpers, 'getCIMetadata').mockImplementation(() => undefined);
             const payloadMetadataSpy = jest.fn();
-            const axiosMock = jest.spyOn(axios_1.default, 'create');
-            axiosMock.mockImplementation((() => (e) => {
-                payloadMetadataSpy(e.data.metadata);
-                if (e.url === '/synthetics/tests/trigger/ci') {
+            jest.spyOn(axios_1.default, 'create').mockImplementation((() => (request) => {
+                payloadMetadataSpy(request.data.metadata);
+                if (request.url === '/synthetics/tests/trigger/ci') {
                     return { data: fakeTrigger };
                 }
             }));
             yield utils.runTests(api, [{ public_id: fakeId, executionRule: interfaces_1.ExecutionRule.NON_BLOCKING }]);
-            expect(payloadMetadataSpy).toHaveBeenCalledWith({
-                ci: { job: {}, pipeline: {}, provider: {}, stage: {} },
-                git: { commit: { author: {}, committer: {} } },
-                trigger_app: 'npm_package',
-            });
+            expect(payloadMetadataSpy).toHaveBeenCalledWith(undefined);
             const metadata = {
                 ci: { job: { name: 'job' }, pipeline: {}, provider: { name: 'jest' }, stage: {} },
                 git: { commit: { author: {}, committer: {}, message: 'test' } },
             };
             jest.spyOn(ciHelpers, 'getCIMetadata').mockImplementation(() => metadata);
+            yield utils.runTests(api, [{ public_id: fakeId, executionRule: interfaces_1.ExecutionRule.NON_BLOCKING }]);
+            expect(payloadMetadataSpy).toHaveBeenCalledWith(metadata);
+        }));
+        test('runTests api call includes trigger app header', () => __awaiter(void 0, void 0, void 0, function* () {
+            jest.spyOn(ciHelpers, 'getCIMetadata').mockImplementation(() => undefined);
+            const headersMetadataSpy = jest.fn();
+            jest.spyOn(axios_1.default, 'create').mockImplementation((() => (request) => {
+                headersMetadataSpy(request.headers);
+                if (request.url === '/synthetics/tests/trigger/ci') {
+                    return { data: fakeTrigger };
+                }
+            }));
+            yield utils.runTests(api, [{ public_id: fakeId, executionRule: interfaces_1.ExecutionRule.NON_BLOCKING }]);
+            expect(headersMetadataSpy).toHaveBeenCalledWith(expect.objectContaining({ 'X-Trigger-App': 'npm_package' }));
             utils.setCiTriggerApp('unit_test');
             yield utils.runTests(api, [{ public_id: fakeId, executionRule: interfaces_1.ExecutionRule.NON_BLOCKING }]);
-            expect(payloadMetadataSpy).toHaveBeenCalledWith(Object.assign(Object.assign({}, metadata), { trigger_app: 'unit_test' }));
+            expect(headersMetadataSpy).toHaveBeenCalledWith(expect.objectContaining({ 'X-Trigger-App': 'unit_test' }));
         }));
         test('should run test with publicId from url', () => __awaiter(void 0, void 0, void 0, function* () {
             const axiosMock = jest.spyOn(axios_1.default, 'create');

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

@@ -1,5 +1,5 @@
 import { AxiosError } from 'axios';
-import { APIConfiguration, Payload, PollResult, Test, TestSearchResult, Trigger } from './interfaces';
+import { APIConfiguration, APIHelper } from './interfaces';
 interface BackendError {
     errors: string[];
 }
@@ -9,17 +9,8 @@ export declare class EndpointError extends Error {
     constructor(message: string, status: number);
 }
 export declare const formatBackendErrors: (requestError: AxiosError<BackendError>) => string;
+export declare const isForbiddenError: (error: AxiosError | EndpointError) => boolean;
 export declare const isNotFoundError: (error: AxiosError | EndpointError) => boolean;
 export declare const is5xxError: (error: AxiosError | EndpointError) => boolean | 0 | undefined;
-export declare const apiConstructor: (configuration: APIConfiguration) => {
-    getPresignedURL: (testIds: string[]) => Promise<{
-        url: string;
-    }>;
-    getTest: (testId: string) => Promise<Test>;
-    pollResults: (resultIds: string[]) => Promise<{
-        results: PollResult[];
-    }>;
-    searchTests: (query: string) => Promise<TestSearchResult>;
-    triggerTests: (data: Payload) => Promise<Trigger>;
-};
+export declare const apiConstructor: (configuration: APIConfiguration) => APIHelper;
 export {};

package/dist/commands/synthetics/api.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.apiConstructor = exports.is5xxError = exports.isNotFoundError = exports.formatBackendErrors = exports.EndpointError = void 0;
+exports.apiConstructor = exports.is5xxError = exports.isNotFoundError = exports.isForbiddenError = exports.formatBackendErrors = exports.EndpointError = void 0;
 const querystring_1 = require("querystring");
 const utils_1 = require("../../helpers/utils");
 const utils_2 = require("./utils");
@@ -43,6 +43,7 @@ exports.formatBackendErrors = formatBackendErrors;
 const triggerTests = (request) => (data) => __awaiter(void 0, void 0, void 0, function* () {
     const resp = yield retryRequest({
         data,
+        headers: { 'X-Trigger-App': utils_2.ciTriggerApp },
         method: 'POST',
         url: '/synthetics/tests/trigger/ci',
     }, request);
@@ -88,6 +89,8 @@ const retryOn5xxErrors = (retries, error) => {
     }
 };
 const getErrorHttpStatus = (error) => { var _a; return 'status' in error ? error.status : (_a = error.response) === null || _a === void 0 ? void 0 : _a.status; };
+const isForbiddenError = (error) => getErrorHttpStatus(error) === 403;
+exports.isForbiddenError = isForbiddenError;
 const isNotFoundError = (error) => getErrorHttpStatus(error) === 404;
 exports.isNotFoundError = isNotFoundError;
 const is5xxError = (error) => {

package/dist/commands/synthetics/command.js

@@ -142,6 +142,10 @@ class RunTestCommand extends clipanion_1.Command {
                 reporter.log('No test to run.\n');
                 break;
             // Critical command errors
+            case 'AUTHORIZATION_ERROR':
+                reporter.error(`\n${chalk_1.default.bgRed.bold(' ERROR: authorization error ')}\n${error.message}\n\n`);
+                reporter.log('Credentials refused, make sure `apiKey`, `appKey` and `datadogSite` are correct.\n');
+                break;
             case 'MISSING_APP_KEY':
                 reporter.error(`Missing ${chalk_1.default.red.bold('DATADOG_APP_KEY')} in your environment.\n`);
                 break;

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

@@ -1,8 +1,8 @@
 declare const nonCriticalErrorCodes: readonly ["NO_TESTS_TO_RUN", "NO_RESULTS_TO_POLL"];
-declare type NonCriticalCiErrorCode = typeof nonCriticalErrorCodes[number];
-declare const criticalErrorCodes: readonly ["UNAVAILABLE_TEST_CONFIG", "MISSING_API_KEY", "MISSING_APP_KEY", "UNAVAILABLE_TUNNEL_CONFIG", "TUNNEL_START_FAILED", "TRIGGER_TESTS_FAILED", "POLL_RESULTS_FAILED"];
-declare type CriticalCiErrorCode = typeof criticalErrorCodes[number];
-declare type CiErrorCode = NonCriticalCiErrorCode | CriticalCiErrorCode;
+export declare type NonCriticalCiErrorCode = typeof nonCriticalErrorCodes[number];
+declare const criticalErrorCodes: readonly ["AUTHORIZATION_ERROR", "MISSING_API_KEY", "MISSING_APP_KEY", "POLL_RESULTS_FAILED", "TRIGGER_TESTS_FAILED", "TUNNEL_START_FAILED", "UNAVAILABLE_TEST_CONFIG", "UNAVAILABLE_TUNNEL_CONFIG"];
+export declare type CriticalCiErrorCode = typeof criticalErrorCodes[number];
+export declare type CiErrorCode = NonCriticalCiErrorCode | CriticalCiErrorCode;
 export declare class CiError extends Error {
     code: CiErrorCode;
     constructor(code: CiErrorCode);

package/dist/commands/synthetics/errors.js

@@ -4,13 +4,14 @@ exports.CriticalError = exports.CiError = void 0;
 /* tslint:disable:max-classes-per-file */
 const nonCriticalErrorCodes = ['NO_TESTS_TO_RUN', 'NO_RESULTS_TO_POLL'];
 const criticalErrorCodes = [
-    'UNAVAILABLE_TEST_CONFIG',
+    'AUTHORIZATION_ERROR',
     'MISSING_API_KEY',
     'MISSING_APP_KEY',
-    'UNAVAILABLE_TUNNEL_CONFIG',
-    'TUNNEL_START_FAILED',
-    'TRIGGER_TESTS_FAILED',
     'POLL_RESULTS_FAILED',
+    'TRIGGER_TESTS_FAILED',
+    'TUNNEL_START_FAILED',
+    'UNAVAILABLE_TEST_CONFIG',
+    'UNAVAILABLE_TUNNEL_CONFIG',
 ];
 class CiError extends Error {
     constructor(code) {

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

@@ -253,12 +253,9 @@ export interface ConfigOverride {
     };
 }
 export interface Payload {
-    metadata?: SyntheticsMetadata;
+    metadata?: Metadata;
     tests: TestPayload[];
 }
-export declare type SyntheticsMetadata = Metadata & {
-    trigger_app: string;
-};
 export interface TestPayload extends ConfigOverride {
     executionRule: ExecutionRule;
     public_id: string;

package/dist/commands/synthetics/reporters/default.js

@@ -195,7 +195,7 @@ class DefaultReporter {
         this.write(error);
     }
     initErrors(errors) {
-        this.write(errors.join('\n') + '\n');
+        this.write(errors.join('\n') + '\n\n');
     }
     log(log) {
         this.write(log);
@@ -246,7 +246,7 @@ class DefaultReporter {
             testsList.push('…');
         }
         const testsDisplay = chalk_1.default.gray(`(${testsList.join(', ')})`);
-        this.write(`\nWaiting for ${chalk_1.default.bold.cyan(tests.length)} test result${tests.length > 1 ? 's' : ''} ${testsDisplay}…\n`);
+        this.write(`Waiting for ${chalk_1.default.bold.cyan(tests.length)} test result${tests.length > 1 ? 's' : ''} ${testsDisplay}…\n`);
     }
     testTrigger(test, testId, executionRule, config) {
         const idDisplay = `[${chalk_1.default.bold.dim(testId)}]`;

package/dist/commands/synthetics/run-test.d.ts

@@ -62,15 +62,5 @@ export declare const getTestsList: (api: APIHelper, config: SyntheticsCIConfig,
     id: string;
     suite: string | undefined;
 }[]>;
-export declare const getApiHelper: (config: SyntheticsCIConfig) => {
-    getPresignedURL: (testIds: string[]) => Promise<{
-        url: string;
-    }>;
-    getTest: (testId: string) => Promise<Test>;
-    pollResults: (resultIds: string[]) => Promise<{
-        results: PollResult[];
-    }>;
-    searchTests: (query: string) => Promise<import("./interfaces").TestSearchResult>;
-    triggerTests: (data: import("./interfaces").Payload) => Promise<Trigger>;
-};
+export declare const getApiHelper: (config: SyntheticsCIConfig) => APIHelper;
 export declare const getDatadogHost: (useIntake: boolean | undefined, config: SyntheticsCIConfig) => string;

package/dist/commands/synthetics/run-test.js

@@ -32,7 +32,7 @@ const executeTests = (reporter, config) => __awaiter(void 0, void 0, void 0, fun
             testsToTrigger = yield exports.getTestsList(api, config, reporter);
         }
         catch (error) {
-            throw new errors_1.CriticalError('UNAVAILABLE_TEST_CONFIG');
+            throw new errors_1.CriticalError(api_1.isForbiddenError(error) ? 'AUTHORIZATION_ERROR' : 'UNAVAILABLE_TEST_CONFIG');
         }
     }
     if (!testsToTrigger.length) {
@@ -43,7 +43,10 @@ const executeTests = (reporter, config) => __awaiter(void 0, void 0, void 0, fun
         testsToTriggerResult = yield utils_1.getTestsToTrigger(api, testsToTrigger, reporter);
     }
     catch (error) {
-        throw error instanceof errors_1.CiError ? error : new errors_1.CriticalError('UNAVAILABLE_TEST_CONFIG');
+        if (error instanceof errors_1.CiError) {
+            throw error;
+        }
+        throw new errors_1.CriticalError(api_1.isForbiddenError(error) ? 'AUTHORIZATION_ERROR' : 'UNAVAILABLE_TEST_CONFIG');
     }
     const { tests, overriddenTestsToTrigger, summary } = testsToTriggerResult;
     // All tests have been skipped or are missing.

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

@@ -1,5 +1,6 @@
 import { APIHelper, ConfigOverride, ExecutionRule, InternalTest, MainReporter, PollResult, Reporter, Result, Suite, Summary, TestPayload, Trigger, TriggerConfig, TriggerResponse, TriggerResult } from './interfaces';
 import { Tunnel } from './tunnel';
+export declare let ciTriggerApp: string;
 export declare const handleConfig: (test: InternalTest, publicId: string, reporter: MainReporter, config?: ConfigOverride | undefined) => TestPayload;
 export declare const setCiTriggerApp: (source: string) => void;
 export declare const getExecutionRule: (test: InternalTest, configOverride?: ConfigOverride | undefined) => ExecutionRule;

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.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.setCiTriggerApp = 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.setCiTriggerApp = exports.handleConfig = exports.ciTriggerApp = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const url_1 = require("url");
@@ -48,7 +48,7 @@ const PUBLIC_ID_REGEX = /^[\d\w]{3}-[\d\w]{3}-[\d\w]{3}$/;
 const SUBDOMAIN_REGEX = /(.*?)\.(?=[^\/]*\..{2,5})/;
 const TEMPLATE_REGEX = /{{\s*([^{}]*?)\s*}}/g;
 const template = (st, context) => st.replace(TEMPLATE_REGEX, (match, p1) => (p1 in context ? context[p1] : match));
-let ciTriggerApp = 'npm_package';
+exports.ciTriggerApp = 'npm_package';
 const handleConfig = (test, publicId, reporter, config) => {
     const executionRule = exports.getExecutionRule(test, config);
     let handledConfig = {
@@ -86,7 +86,7 @@ const handleConfig = (test, publicId, reporter, config) => {
 };
 exports.handleConfig = handleConfig;
 const setCiTriggerApp = (source) => {
-    ciTriggerApp = source;
+    exports.ciTriggerApp = source;
 };
 exports.setCiTriggerApp = setCiTriggerApp;
 const parseUrlVariables = (url, reporter) => {
@@ -425,8 +425,9 @@ exports.getTestsToTrigger = getTestsToTrigger;
 const runTests = (api, testsToTrigger) => __awaiter(void 0, void 0, void 0, function* () {
     const payload = { tests: testsToTrigger };
     const ciMetadata = ci_1.getCIMetadata();
-    const syntheticsMetadata = Object.assign(Object.assign({ ci: { job: {}, pipeline: {}, provider: {}, stage: {} }, git: { commit: { author: {}, committer: {} } } }, ciMetadata), { trigger_app: ciTriggerApp });
-    payload.metadata = syntheticsMetadata;
+    if (ciMetadata) {
+        payload.metadata = ciMetadata;
+    }
     try {
         return yield api.triggerTests(payload);
     }

package/package.json

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