@gatling.io/cli 3.11.7 → 3.12.0

package/src/java.ts

@@ -0,0 +1,48 @@
+import { spawn } from "child_process";
+
+import { osType } from "./dependencies/os";
+import { logger } from "./log";
+
+export interface RunJavaProcessOptions {
+  graalvmHome: string;
+  jvmClasspath: string;
+}
+
+export const runJavaProcess = (
+  options: RunJavaProcessOptions,
+  mainClass: string,
+  additionalClasspathElements: string[],
+  javaArgs: string[],
+  mainClassArgs: string[]
+): Promise<void> => {
+  const command = `${options.graalvmHome}/bin/java`;
+  const classpathSeparator = osType === "Windows_NT" ? ";" : ":";
+  const classpath = [...additionalClasspathElements, options.jvmClasspath].join(classpathSeparator);
+  const allArgs = [
+    "-server",
+    "-XX:+HeapDumpOnOutOfMemoryError",
+    "-XX:MaxInlineLevel=20",
+    "-XX:MaxTrivialSize=12",
+    "-classpath",
+    classpath,
+    ...javaArgs,
+    mainClass,
+    ...mainClassArgs
+  ];
+
+  const spawned = spawn(command, allArgs, {
+    env: process.env,
+    stdio: [process.stdin, process.stdout, process.stderr]
+  });
+
+  return new Promise((resolve, reject) => {
+    spawned.on("error", (error) => logger.error("Failed to run Gatling process: " + error.toString()));
+    spawned.on("close", (code) => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(Error("Gatling process finished with code " + code));
+      }
+    });
+  });
+};

package/src/log.ts

@@ -0,0 +1,19 @@
+const debug: (message: string) => void =
+  // On Node.js, console.debug is just an alias to console.log, so we handle debug level ourselves
+  process.env["DEBUG"] === "true" ? console.debug : () => {};
+
+const info: (message: string) => void = console.info;
+
+const error: (message: string) => void = console.error;
+
+export interface Logger {
+  debug: (message: string) => void;
+  info: (message: string) => void;
+  error: (message: string) => void;
+}
+
+export const logger: Logger = {
+  debug,
+  info,
+  error
+};

package/src/readline.ts

@@ -0,0 +1,39 @@
+import { keyInSelect, BasicOptions } from "readline-sync";
+
+// Inspired by https://github.com/anseki/readline-sync/issues/60#issuecomment-324533678
+// Pagination avoids very long lists to scroll though, as well as the hard limit at 35 items for keyInSelect
+export const keyInSelectPaginated = (items: string[], query?: any, options?: BasicOptions | undefined): number => {
+  if (items.length === 0) {
+    return -1;
+  }
+
+  const maxItemsPerPage = 10;
+  const maxPageIndex = Math.ceil(items.length / maxItemsPerPage) - 1;
+
+  let pageIndex = 0;
+  while (true) {
+    const pageItems = [];
+    let indexPrev = -1;
+    let indexNext = -1;
+    if (pageIndex > 0) {
+      pageItems.push(`(PREVIOUS ${maxItemsPerPage} items)`);
+      indexPrev = pageItems.length - 1;
+    }
+    pageItems.push(...items.slice(pageIndex * maxItemsPerPage, (pageIndex + 1) * maxItemsPerPage));
+    if (pageIndex < maxPageIndex) {
+      pageItems.push(
+        `(NEXT ${pageIndex < maxPageIndex - 1 ? maxItemsPerPage : items.length - maxItemsPerPage * (pageIndex + 1)} item(s))`
+      );
+      indexNext = pageItems.length - 1;
+    }
+    console.log("\x1B[2J"); // clear screen
+    const index = keyInSelect(pageItems, query, options);
+    if (indexPrev !== -1 && index === indexPrev) {
+      pageIndex--;
+    } else if (indexNext !== -1 && index === indexNext) {
+      pageIndex++;
+    } else {
+      return index === -1 ? index : index + pageIndex * maxItemsPerPage - (indexPrev === -1 ? 0 : 1);
+    }
+  }
+};

package/src/run.ts

@@ -0,0 +1,67 @@
+import { logger } from "./log";
+import { versions } from "./dependencies";
+import { RunJavaProcessOptions, runJavaProcess } from "./java";
+
+export interface RunSimulationOptions extends RunJavaProcessOptions {
+  simulation: string;
+  bundleFile: string;
+  resourcesFolder: string;
+  resultsFolder: string;
+  memory?: number;
+  runParameters: Record<string, string>;
+}
+
+export interface RunRecorderOptions extends RunJavaProcessOptions {
+  sourcesFolder: string;
+  typescript: boolean;
+  resourcesFolder: string;
+}
+
+export const runSimulation = async (options: RunSimulationOptions): Promise<void> => {
+  logger.info(`Running a Gatling simulation with options:
+ - simulation: ${options.simulation}
+ - bundleFile: ${options.bundleFile}
+ - resourcesFolder: ${options.resourcesFolder}
+ - resultsFolder: ${options.resultsFolder}`);
+
+  const additionalClasspathElements = [options.resourcesFolder];
+  const jitTuningArgs = ["-XX:JVMCINativeLibraryThreadFraction=0.8", "-Dgraal.MethodInlineBailoutLimit=500"];
+  const memoryArgs = options.memory !== undefined ? [`-Xms${options.memory}M`, `-Xmx${options.memory}M`] : [];
+  const javaArgs = [
+    ...Object.entries(options.runParameters).map(([key, value]) => `-D${key}=${value}`),
+    `-Dgatling.js.bundle.filePath=${options.bundleFile}`,
+    `-Dgatling.js.simulation=${options.simulation}`,
+    ...jitTuningArgs,
+    ...memoryArgs
+  ];
+  const simulationArgs = [
+    "--results-folder",
+    options.resultsFolder,
+    "--simulation",
+    "io.gatling.js.JsSimulation",
+    "--launcher",
+    "gatling-js-cli",
+    "--build-tool-version",
+    versions.gatling.jsAdapter
+  ];
+
+  return runJavaProcess(options, "io.gatling.app.Gatling", additionalClasspathElements, javaArgs, simulationArgs);
+};
+
+export const runRecorder = async (options: RunRecorderOptions): Promise<void> => {
+  logger.info(`Running the Gatling Recorder with options:
+ - sourcesFolder: ${options.sourcesFolder}
+ - resourcesFolder: ${options.resourcesFolder}
+ - typescript: ${options.typescript}`);
+
+  const recorderArgs = [
+    "--simulations-folder",
+    options.sourcesFolder,
+    "--resources-folder",
+    options.resourcesFolder,
+    "--format",
+    options.typescript ? "typescript" : "javascript"
+  ];
+
+  return runJavaProcess(options, "io.gatling.recorder.GatlingRecorder", [], [], recorderArgs);
+};

package/src/simulations.ts

@@ -0,0 +1,29 @@
+import fs from "fs/promises";
+
+export interface SimulationFile {
+  path: string;
+  name: string;
+  type: "javascript" | "typescript";
+}
+
+export const findSimulations = async (sourcesFolder: string): Promise<Array<SimulationFile>> => {
+  const children = await fs.readdir(sourcesFolder, { recursive: false });
+  const simulations = children
+    .filter((path) => path.endsWith(".gatling.js") || path.endsWith(".gatling.ts"))
+    .map(
+      (path): SimulationFile => ({
+        path,
+        name: path.slice(0, -11),
+        type: path.endsWith(".ts") ? "typescript" : "javascript"
+      })
+    );
+  const duplicates = simulations.filter(
+    (value, index) => simulations.findIndex((other) => other.name === value.name) !== index
+  );
+  if (duplicates.length > 0) {
+    throw Error(
+      `Found ambiguous simulation name(s) ${duplicates.map((s) => s.name)}: found as both *.gatling.js and *.gatling.ts file(s)`
+    );
+  }
+  return simulations;
+};

package/target/commands/build.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+declare const _default: (program: Command) => void;
+export default _default;

package/target/commands/build.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const options_1 = require("./options");
+const simulations_1 = require("../simulations");
+const bundle_1 = require("../bundle");
+exports.default = (program) => {
+    program
+        .command("build")
+        .description("Build Gatling simulations")
+        .addOption(options_1.sourcesFolderOption)
+        .addOption(options_1.bundleFileOption)
+        .addOption(options_1.typescriptOption)
+        .action(async (options) => {
+        const sourcesFolder = (0, options_1.sourcesFolderOptionValue)(options);
+        const bundleFile = (0, options_1.bundleFileOptionValue)(options);
+        const simulations = await (0, simulations_1.findSimulations)(sourcesFolder);
+        const typescript = (0, options_1.typescriptOptionValueWithDefaults)(options, simulations);
+        await (0, bundle_1.bundle)({ sourcesFolder, bundleFile, typescript, simulations });
+    });
+};

package/target/commands/enterpriseDeploy.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+declare const _default: (program: Command) => void;
+export default _default;

package/target/commands/enterpriseDeploy.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const options_1 = require("./options");
+const simulations_1 = require("../simulations");
+const dependencies_1 = require("../dependencies");
+const bundle_1 = require("../bundle");
+const enterprise_1 = require("../enterprise");
+exports.default = (program) => {
+    program
+        .command("enterprise-deploy")
+        .description("Deploy a package and configured simulations")
+        .addOption(options_1.sourcesFolderOption)
+        .addOption(options_1.resourcesFolderOption)
+        .addOption(options_1.bundleFileOption)
+        .addOption(options_1.resultsFolderOption)
+        .addOption(options_1.typescriptOption)
+        .addOption(options_1.gatlingHomeOption)
+        // Base
+        .addOption(options_1.urlOption)
+        .addOption(options_1.apiTokenOption)
+        // Plugin configuration
+        .addOption(options_1.controlPlaneUrlOption)
+        .addOption(options_1.nonInteractiveOption)
+        // Descriptor file
+        .addOption(options_1.packageDescriptorFilenameOption)
+        // Deployment info
+        .addOption(options_1.packageFileOption)
+        .action(async (options) => {
+        const sourcesFolder = (0, options_1.sourcesFolderOptionValue)(options);
+        const simulations = await (0, simulations_1.findSimulations)(sourcesFolder);
+        const typescript = (0, options_1.typescriptOptionValueWithDefaults)(options, simulations);
+        const resourcesFolder = (0, options_1.resourcesFolderOptionValue)(options);
+        const bundleFile = (0, options_1.bundleFileOptionValue)(options);
+        const resultsFolder = (0, options_1.resultsFolderOptionValue)(options);
+        const gatlingHome = (0, options_1.gatlingHomeOptionValueWithDefaults)(options);
+        const url = (0, options_1.urlOptionValue)(options);
+        const apiToken = (0, options_1.apiTokenOptionValue)(options);
+        const controlPlaneUrl = (0, options_1.controlPlaneUrlOptionValue)(options);
+        const nonInteractive = (0, options_1.nonInteractiveOptionValue)(options);
+        const packageDescriptorFilename = (0, options_1.packageDescriptorFilenameOptionValue)(options);
+        const packageFile = (0, options_1.packageFileOptionValue)(options);
+        const { graalvmHome, jvmClasspath } = await (0, dependencies_1.installGatlingJs)({ gatlingHome });
+        await (0, bundle_1.bundle)({ sourcesFolder, bundleFile, typescript, simulations });
+        await (0, enterprise_1.enterprisePackage)({ bundleFile, resourcesFolder, packageFile, simulations });
+        await (0, enterprise_1.enterpriseDeploy)({
+            graalvmHome,
+            jvmClasspath,
+            bundleFile,
+            resourcesFolder,
+            resultsFolder,
+            url,
+            apiToken,
+            controlPlaneUrl,
+            nonInteractive,
+            packageDescriptorFilename,
+            packageFile
+        });
+    });
+};

package/target/commands/enterprisePackage.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+declare const _default: (program: Command) => void;
+export default _default;

package/target/commands/enterprisePackage.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const options_1 = require("./options");
+const simulations_1 = require("../simulations");
+const bundle_1 = require("../bundle");
+const enterprise_1 = require("../enterprise");
+exports.default = (program) => {
+    program
+        .command("enterprise-package")
+        .description("Build Gatling simulations and package them for Gatling Enterprise")
+        .addOption(options_1.sourcesFolderOption)
+        .addOption(options_1.resourcesFolderOption)
+        .addOption(options_1.bundleFileOption)
+        .addOption(options_1.packageFileOption)
+        .addOption(options_1.typescriptOption)
+        .action(async (options) => {
+        const sourcesFolder = (0, options_1.sourcesFolderOptionValue)(options);
+        const resourcesFolder = (0, options_1.resourcesFolderOptionValue)(options);
+        const bundleFile = (0, options_1.bundleFileOptionValue)(options);
+        const packageFile = (0, options_1.packageFileOptionValue)(options);
+        const simulations = await (0, simulations_1.findSimulations)(sourcesFolder);
+        const typescript = (0, options_1.typescriptOptionValueWithDefaults)(options, simulations);
+        await (0, bundle_1.bundle)({ sourcesFolder, bundleFile, typescript, simulations });
+        await (0, enterprise_1.enterprisePackage)({ bundleFile, resourcesFolder, packageFile, simulations });
+    });
+};

package/target/commands/enterpriseStart.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+declare const _default: (program: Command) => void;
+export default _default;

package/target/commands/enterpriseStart.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const options_1 = require("./options");
+const simulations_1 = require("../simulations");
+const dependencies_1 = require("../dependencies");
+const bundle_1 = require("../bundle");
+const enterprise_1 = require("../enterprise");
+exports.default = (program) => {
+    program
+        .command("enterprise-start")
+        .description("Start a simulation deployed with `enterprise-deploy`")
+        .addOption(options_1.sourcesFolderOption)
+        .addOption(options_1.resourcesFolderOption)
+        .addOption(options_1.bundleFileOption)
+        .addOption(options_1.resultsFolderOption)
+        .addOption(options_1.typescriptOption)
+        .addOption(options_1.gatlingHomeOption)
+        // Base
+        .addOption(options_1.urlOption)
+        .addOption(options_1.apiTokenOption)
+        // Plugin configuration
+        .addOption(options_1.controlPlaneUrlOption)
+        .addOption(options_1.nonInteractiveOption)
+        // Descriptor file
+        .addOption(options_1.packageDescriptorFilenameOption)
+        // Deployment info
+        .addOption(options_1.packageFileOption)
+        // Start
+        .addOption(options_1.enterpriseSimulationOption)
+        .addOption(options_1.runTitleOption)
+        .addOption(options_1.runDescriptionOption)
+        .addOption(options_1.waitForRunEndOption)
+        .action(async (options) => {
+        const sourcesFolder = (0, options_1.sourcesFolderOptionValue)(options);
+        const simulations = await (0, simulations_1.findSimulations)(sourcesFolder);
+        const typescript = (0, options_1.typescriptOptionValueWithDefaults)(options, simulations);
+        const resourcesFolder = (0, options_1.resourcesFolderOptionValue)(options);
+        const bundleFile = (0, options_1.bundleFileOptionValue)(options);
+        const resultsFolder = (0, options_1.resultsFolderOptionValue)(options);
+        const gatlingHome = (0, options_1.gatlingHomeOptionValueWithDefaults)(options);
+        const url = (0, options_1.urlOptionValue)(options);
+        const apiToken = (0, options_1.apiTokenOptionValue)(options);
+        const controlPlaneUrl = (0, options_1.controlPlaneUrlOptionValue)(options);
+        const nonInteractive = (0, options_1.nonInteractiveOptionValue)(options);
+        const packageDescriptorFilename = (0, options_1.packageDescriptorFilenameOptionValue)(options);
+        const packageFile = (0, options_1.packageFileOptionValue)(options);
+        const enterpriseSimulation = (0, options_1.enterpriseSimulationOptionValue)(options);
+        const runTitle = (0, options_1.runTitleOptionValue)(options);
+        const runDescription = (0, options_1.runDescriptionOptionValue)(options);
+        const waitForRunEnd = (0, options_1.waitForRunEndOptionValue)(options);
+        if ((0, options_1.nonInteractiveOptionValue)(options) && enterpriseSimulation === undefined) {
+            throw new Error(`No simulation specified when using non-interactive mode`);
+        }
+        const { graalvmHome, jvmClasspath } = await (0, dependencies_1.installGatlingJs)({ gatlingHome });
+        await (0, bundle_1.bundle)({ sourcesFolder, bundleFile, typescript, simulations });
+        await (0, enterprise_1.enterprisePackage)({ bundleFile, resourcesFolder, packageFile, simulations });
+        await (0, enterprise_1.enterpriseStart)({
+            graalvmHome,
+            jvmClasspath,
+            bundleFile,
+            resourcesFolder,
+            resultsFolder,
+            url,
+            apiToken,
+            controlPlaneUrl,
+            nonInteractive,
+            packageDescriptorFilename,
+            packageFile,
+            enterpriseSimulation,
+            runTitle,
+            runDescription,
+            waitForRunEnd
+        });
+    });
+};

package/target/commands/index.d.ts

@@ -0,0 +1,2 @@
+import { Command } from "commander";
+export declare const program: Command;

package/target/commands/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.program = void 0;
+const commander_1 = require("commander");
+const install_1 = __importDefault(require("./install"));
+const build_1 = __importDefault(require("./build"));
+const runOnly_1 = __importDefault(require("./runOnly"));
+const run_1 = __importDefault(require("./run"));
+const recorder_1 = __importDefault(require("./recorder"));
+const enterprisePackage_1 = __importDefault(require("./enterprisePackage"));
+const enterpriseDeploy_1 = __importDefault(require("./enterpriseDeploy"));
+const enterpriseStart_1 = __importDefault(require("./enterpriseStart"));
+const dependencies_1 = require("../dependencies");
+exports.program = new commander_1.Command()
+    .name("gatling-js-cli")
+    .version(dependencies_1.versions.gatling.jsAdapter)
+    .description("The Gatling Javascript run & packaging tool");
+(0, install_1.default)(exports.program);
+(0, build_1.default)(exports.program);
+(0, runOnly_1.default)(exports.program);
+(0, run_1.default)(exports.program);
+(0, recorder_1.default)(exports.program);
+(0, enterprisePackage_1.default)(exports.program);
+(0, enterpriseDeploy_1.default)(exports.program);
+(0, enterpriseStart_1.default)(exports.program);

package/target/commands/install.d.ts

@@ -0,0 +1,3 @@
+import { Command } from "commander";
+declare const _default: (program: Command) => void;
+export default _default;

package/target/commands/install.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const options_1 = require("./options");
+const dependencies_1 = require("../dependencies");
+const log_1 = require("../log");
+exports.default = (program) => {
+    program
+        .command("install")
+        .description("Install all required components and dependencies for Gatling")
+        .addOption(options_1.gatlingHomeOption)
+        .action(async (options) => {
+        const gatlingHome = (0, options_1.gatlingHomeOptionValueWithDefaults)(options);
+        const { graalvmHome, coursierBinary, jvmClasspath } = await (0, dependencies_1.installGatlingJs)({ gatlingHome });
+        log_1.logger.info(`graalvmHome=${graalvmHome}`);
+        log_1.logger.info(`coursierBinary=${coursierBinary}`);
+        log_1.logger.info(`jvmClasspath=${jvmClasspath}`);
+    });
+};

package/target/commands/options.d.ts

@@ -0,0 +1,46 @@
+import { Option, Argument } from "commander";
+import { SimulationFile } from "../simulations";
+export declare const gatlingHomeOption: Option;
+export declare const gatlingHomeOptionValueWithDefaults: (options: any) => string;
+export declare const sourcesFolderOption: Option;
+export declare const sourcesFolderOptionValue: (options: any) => string;
+export declare const simulationOption: Option;
+export declare const simulationOptionValueWithDefaults: (options: any, simulationsFound: SimulationFile[], interactive: boolean) => string;
+export declare const simulationMandatoryOption: Option;
+export declare const simulationMandatoryOptionValue: (options: any) => string;
+export declare const bundleFileOption: Option;
+export declare const bundleFileOptionValue: (options: any) => string;
+export declare const packageFileOption: Option;
+export declare const packageFileOptionValue: (options: any) => string;
+export declare const resourcesFolderOption: Option;
+export declare const resourcesFolderOptionValue: (options: any) => string;
+export declare const resultsFolderOption: Option;
+export declare const resultsFolderOptionValue: (options: any) => string;
+export declare const typescriptOption: Option;
+export declare const typescriptOptionValueWithDefaults: (options: any, simulationsFound: SimulationFile[]) => boolean;
+export declare const graalvmHomeMandatoryOption: Option;
+export declare const graalvmHomeMandatoryOptionValue: (options: any) => string;
+export declare const jvmClasspathMandatoryOption: Option;
+export declare const jvmClasspathMandatoryOptionValue: (options: any) => string;
+export declare const memoryOption: Option;
+export declare const memoryOptionValue: (options: any) => number | undefined;
+export declare const nonInteractiveOption: Option;
+export declare const nonInteractiveOptionValue: (options: any) => boolean;
+export declare const runParametersArgument: Argument;
+export declare const parseRunParametersArgument: (args: string[]) => Record<string, string>;
+export declare const urlOption: Option;
+export declare const urlOptionValue: (options: any) => string;
+export declare const apiTokenOption: Option;
+export declare const apiTokenOptionValue: (options: any) => string | undefined;
+export declare const controlPlaneUrlOption: Option;
+export declare const controlPlaneUrlOptionValue: (options: any) => string | undefined;
+export declare const packageDescriptorFilenameOption: Option;
+export declare const packageDescriptorFilenameOptionValue: (options: any) => string;
+export declare const enterpriseSimulationOption: Option;
+export declare const enterpriseSimulationOptionValue: (options: any) => string | undefined;
+export declare const runTitleOption: Option;
+export declare const runTitleOptionValue: (options: any) => string | undefined;
+export declare const runDescriptionOption: Option;
+export declare const runDescriptionOptionValue: (options: any) => string | undefined;
+export declare const waitForRunEndOption: Option;
+export declare const waitForRunEndOptionValue: (options: any) => boolean;