@datadog/datadog-ci 2.18.0 → 2.19.0

package/dist/cli.d.ts

@@ -1 +1,3 @@
-export {};
+import { Cli } from 'clipanion';
+declare const cli: Cli<import("clipanion").BaseContext>;
+export { cli };

package/dist/cli.js

@@ -4,9 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.cli = void 0;
 const fs_1 = __importDefault(require("fs"));
 const clipanion_1 = require("clipanion");
-const BETA_COMMANDS = ['gate'];
+const version_1 = require("./helpers/version");
+const BETA_COMMANDS = ['gate', 'sbom'];
 const onError = (err) => {
     console.log(err);
     process.exitCode = 1;
@@ -16,8 +18,11 @@ process.on('unhandledRejection', onError);
 const cli = new clipanion_1.Cli({
     binaryLabel: 'Datadog CI',
     binaryName: 'datadog-ci',
-    binaryVersion: require('../package.json').version,
+    binaryVersion: version_1.version,
 });
+exports.cli = cli;
+cli.register(clipanion_1.Builtins.HelpCommand);
+cli.register(clipanion_1.Builtins.VersionCommand);
 const commandsPath = `${__dirname}/commands`;
 for (const commandFolder of fs_1.default.readdirSync(commandsPath)) {
     const betaCommandsEnabled = process.env.DD_BETA_COMMANDS_ENABLED === '1' || process.env.DD_BETA_COMMANDS_ENABLED === 'true';
@@ -26,6 +31,8 @@ for (const commandFolder of fs_1.default.readdirSync(commandsPath)) {
     }
     const commandPath = `${commandsPath}/${commandFolder}`;
     if (fs_1.default.statSync(commandPath).isDirectory()) {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        ;
         require(`${commandPath}/cli`).forEach((command) => cli.register(command));
     }
 }

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,4CAAmB;AAEnB,yCAA6B;AAG7B,MAAM,aAAa,GAAG,CAAC,MAAM,CAAC,CAAA;AAE9B,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAE,EAAE;IAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAChB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAA;AACxC,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAA;AAEzC,MAAM,GAAG,GAAG,IAAI,eAAG,CAAC;IAClB,WAAW,EAAE,YAAY;IACzB,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO;CAClD,CAAC,CAAA;AAEF,MAAM,YAAY,GAAG,GAAG,SAAS,WAAW,CAAA;AAC5C,KAAK,MAAM,aAAa,IAAI,YAAE,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE;IACxD,MAAM,mBAAmB,GACvB,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,MAAM,CAAA;IACjG,IAAI,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,EAAE;QACjE,SAAQ;KACT;IACD,MAAM,WAAW,GAAG,GAAG,YAAY,IAAI,aAAa,EAAE,CAAA;IACtD,IAAI,YAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE;QAC1C,OAAO,CAAC,GAAG,WAAW,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,OAAqB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;KACxF;CACF;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,KAAK,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACtC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAA;CACH"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AAEnB,yCAAuC;AAGvC,+CAAyC;AAEzC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAEtC,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAE,EAAE;IAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAChB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAA;AACxC,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAA;AAEzC,MAAM,GAAG,GAAG,IAAI,eAAG,CAAC;IAClB,WAAW,EAAE,YAAY;IACzB,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,iBAAO;CACvB,CAAC,CAAA;AA2BM,kBAAG;AAzBX,GAAG,CAAC,QAAQ,CAAC,oBAAQ,CAAC,WAAW,CAAC,CAAA;AAClC,GAAG,CAAC,QAAQ,CAAC,oBAAQ,CAAC,cAAc,CAAC,CAAA;AAErC,MAAM,YAAY,GAAG,GAAG,SAAS,WAAW,CAAA;AAC5C,KAAK,MAAM,aAAa,IAAI,YAAE,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE;IACxD,MAAM,mBAAmB,GACvB,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,MAAM,CAAA;IACjG,IAAI,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,EAAE;QACjE,SAAQ;KACT;IACD,MAAM,WAAW,GAAG,GAAG,YAAY,IAAI,aAAa,EAAE,CAAA;IACtD,IAAI,YAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE;QAC1C,8DAA8D;QAC9D,CAAC;QAAC,OAAO,CAAC,GAAG,WAAW,MAAM,CAAoB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;KAC/F;CACF;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,KAAK,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACtC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAA;CACH"}

package/dist/commands/cloud-run/cli.d.ts

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

package/dist/commands/cloud-run/cli.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const flare_1 = require("./flare");
+module.exports = [flare_1.CloudRunFlareCommand];
+//# sourceMappingURL=cli.js.map

package/dist/commands/cloud-run/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../src/commands/cloud-run/cli.ts"],"names":[],"mappings":";;AAAA,mCAA4C;AAE5C,MAAM,CAAC,OAAO,GAAG,CAAC,4BAAoB,CAAC,CAAA"}

package/dist/commands/cloud-run/constants.d.ts

@@ -0,0 +1 @@
+export declare const SKIP_MASKING_CLOUDRUN_ENV_VARS: Set<string>;

package/dist/commands/cloud-run/constants.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SKIP_MASKING_CLOUDRUN_ENV_VARS = void 0;
+const constants_1 = require("../../constants");
+const NODE_OPTIONS_ENV_VAR = 'NODE_OPTIONS';
+const DD_TRACE_PROPAGATION_STYLE_ENV_VAR = 'DD_TRACE_PROPAGATION_STYLE';
+const DD_SOURCE_ENV_VAR = 'DD_SOURCE';
+const DD_TAGS_ENV_VAR = 'DD_TAGS';
+const DD_OLTP_HTTPS_ENV_VAR = 'DD_OTLP_CONFIG_RECEIVER_PROTOCOLS_HTTP_ENDPOINT';
+const DD_OLTP_GRPC_ENV_VAR = 'DD_OTLP_CONFIG_RECEIVER_PROTOCOLS_GRPC_ENDPOINT';
+exports.SKIP_MASKING_CLOUDRUN_ENV_VARS = new Set([
+    constants_1.SITE_ENV_VAR,
+    constants_1.SERVICE_ENV_VAR,
+    constants_1.ENVIRONMENT_ENV_VAR,
+    NODE_OPTIONS_ENV_VAR,
+    DD_TRACE_PROPAGATION_STYLE_ENV_VAR,
+    DD_SOURCE_ENV_VAR,
+    DD_TAGS_ENV_VAR,
+    DD_OLTP_HTTPS_ENV_VAR,
+    DD_OLTP_GRPC_ENV_VAR,
+]);
+//# sourceMappingURL=constants.js.map

package/dist/commands/cloud-run/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/commands/cloud-run/constants.ts"],"names":[],"mappings":";;;AAAA,+CAAkF;AAElF,MAAM,oBAAoB,GAAG,cAAc,CAAA;AAC3C,MAAM,kCAAkC,GAAG,4BAA4B,CAAA;AACvE,MAAM,iBAAiB,GAAG,WAAW,CAAA;AACrC,MAAM,eAAe,GAAG,SAAS,CAAA;AACjC,MAAM,qBAAqB,GAAG,iDAAiD,CAAA;AAC/E,MAAM,oBAAoB,GAAG,iDAAiD,CAAA;AAEjE,QAAA,8BAA8B,GAAG,IAAI,GAAG,CAAC;IACpD,wBAAY;IACZ,2BAAe;IACf,+BAAmB;IACnB,oBAAoB;IACpB,kCAAkC;IAClC,iBAAiB;IACjB,eAAe;IACf,qBAAqB;IACrB,oBAAoB;CACrB,CAAC,CAAA"}

package/dist/commands/cloud-run/flare.d.ts

@@ -0,0 +1,91 @@
+import IService = google.cloud.run.v2.IService;
+import { Logging } from '@google-cloud/logging';
+import { ServicesClient } from '@google-cloud/run';
+import { google } from '@google-cloud/run/build/protos/protos';
+import { Command } from 'clipanion';
+import { CloudRunLog } from './interfaces';
+export declare const MAX_LOGS = 1000;
+export declare class CloudRunFlareCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
+    private isDryRun;
+    private withLogs;
+    private service;
+    private project;
+    private region;
+    private caseId;
+    private email;
+    private start;
+    private end;
+    private apiKey?;
+    /**
+     * Entry point for the `cloud-run flare` command.
+     * Gathers Cloud Run service configuration and sends it to Datadog.
+     * @returns 0 if the command ran successfully, 1 otherwise.
+     */
+    execute(): Promise<0 | 1>;
+}
+/**
+ * Check if the user is authenticated with GCP.
+ * @returns true if the user is authenticated, false otherwise
+ */
+export declare const checkAuthentication: () => Promise<boolean>;
+/**
+ * Call the google-cloud run sdk to get the configuration
+ * for the given service.
+ * @param runClient the google-cloud run sdk client
+ * @param serviceName the name of the service
+ * @param projectName the project where the service is deployed
+ * @param region the region where the service is deployed
+ * @returns the configuration for the given service
+ */
+export declare const getCloudRunServiceConfig: (runClient: ServicesClient, serviceName: string, projectName: string, region: string) => Promise<IService>;
+/**
+ * Masks environment variables in a Cloud Run service configuration.
+ * Makes a copy as to not modify the config in place.
+ * @param config
+ * @returns masked config
+ */
+export declare const maskConfig: (config: any) => IService;
+/**
+ * Summarizes the Cloud Run config as to not flood the terminal
+ * @param config
+ * @returns a summarized config
+ */
+export declare const summarizeConfig: (config: IService) => any;
+/**
+ * Gets recent logs
+ * @param logClient Logging client
+ * @param serviceId
+ * @param location
+ * @param startMillis start time in milliseconds or undefined if no start time is specified
+ * @param endMillis end time in milliseconds or undefined if no end time is specified
+ * @param severityFilter if included, adds the string to the filter
+ * @returns array of logs as CloudRunLog interfaces
+ */
+export declare const getLogs: (logClient: Logging, serviceId: string, location: string, startMillis?: number, endMillis?: number, severityFilter?: string) => Promise<CloudRunLog[]>;
+/**
+ * Save logs in a CSV format
+ * @param logs array of logs stored as CloudRunLog interfaces
+ * @param filePath path to save the CSV file
+ */
+export declare const saveLogsFile: (logs: CloudRunLog[], filePath: string) => void;
+/**
+ * Gets recent revisions for a cloud-run service
+ * @param service
+ * @param location
+ * @param project
+ * @returns a string array of recent revisions and their deployment timestamp
+ */
+export declare const getRecentRevisions: (service: string, location: string, project: string) => Promise<string[]>;
+/**
+ * Generate the insights file
+ * @param insightsFilePath path to the insights file
+ * @param isDryRun whether or not this is a dry run
+ * @param config Cloud run service configuration
+ * @param service
+ * @param location
+ * @param project
+ * @param revisions a string array of recent revisions
+ */
+export declare const generateInsightsFile: (insightsFilePath: string, isDryRun: boolean, config: IService, service: string, location: string, project: string, revisions: string[]) => void;