@elastic/synthetics 1.0.0-beta.22 → 1.0.0-beta.23

package/dist/parse_args.js

@@ -1,103 +0,0 @@
-"use strict";
-/**
- * MIT License
- *
- * Copyright (c) 2020-present, Elastic NV
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- */
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.options = void 0;
-const commander_1 = require("commander");
-const reporters_1 = require("./reporters");
-const helpers_1 = require("./helpers");
-/* eslint-disable-next-line @typescript-eslint/no-var-requires */
-const { name, version } = require('../package.json');
-commander_1.program
-    .name(`npx ${name}`)
-    .usage('[options] [dir] [files] file')
-    .option('-c, --config <path>', 'configuration path (default: synthetics.config.js)')
-    .option('-p, --params <jsonstring>', 'JSON object that gets injected to all journeys', JSON.parse)
-    .addOption(new commander_1.Option('--reporter <value>', `output repoter format`).choices(Object.keys(reporters_1.reporters)))
-    .option('-d, --debug', 'print debug logs info')
-    .option('--pattern <pattern>', 'RegExp file patterns to search inside directory')
-    .option('--inline', 'Run inline journeys from heartbeat')
-    .option('-r, --require <modules...>', 'module(s) to preload')
-    .option('--no-headless', 'run browser in headful mode')
-    .option('--sandbox', 'enable chromium sandboxing', false)
-    .option('--rich-events', 'Mimics a heartbeat run')
-    .option('--capability <features...>', 'Enable capabilities through feature flags')
-    .addOption(new commander_1.Option('--screenshots [flag]', 'take screenshots at end of each step')
-    .choices(['on', 'off', 'only-on-failure'])
-    .default('on'))
-    .option('--dry-run', "don't actually execute anything, report only registered journeys")
-    .option('--match <name>', 'run only journeys with a name or tags that matches the glob')
-    .option('--tags <name...>', 'run only journeys with the given tag(s), or globs')
-    .option('--outfd <fd>', 'specify a file descriptor for logs. Default is stdout', parseInt)
-    .option('--ws-endpoint <endpoint>', 'Browser WebSocket endpoint to connect to')
-    .option('--pause-on-error', 'pause on error until a keypress is made in the console. Useful during development')
-    .option('--ignore-https-errors', 'ignores any HTTPS errors in sites being tested, including ones related to unrecognized certs or signatures. This can be insecure!')
-    .option('--quiet-exit-code', 'always return 0 as an exit code status, regardless of test pass / fail. Only return > 0 exit codes on internal errors where the suite could not be run')
-    .addOption(new commander_1.Option('--throttling <d/u/l>', 'List of options to throttle network conditions for download throughput (d) in megabits/second, upload throughput (u) in megabits/second and latency (l) in milliseconds.').default(helpers_1.DEFAULT_NETWORK_CONDITIONS_ARG))
-    .option('--no-throttling', 'Turns off default network throttling.')
-    .option('--playwright-options <jsonstring>', 'JSON object to pass in custom Playwright options for the agent. Options passed will be merged with Playwright options defined in your synthetics.config.js file. Options defined via --playwright-options take precedence.', JSON.parse)
-    .version(version)
-    .description('Run synthetic tests');
-const command = commander_1.program.parse(process.argv);
-const options = command.opts();
-exports.options = options;
-/**
- * Group all events that can be consumed by heartbeat and
- * eventually by the Synthetics UI.
- */
-if (options.richEvents) {
-    options.reporter = (_a = options.reporter) !== null && _a !== void 0 ? _a : 'json';
-    options.ssblocks = true;
-    options.network = true;
-    options.quietExitCode = true;
-    options.trace = true;
-}
-if (options.capability) {
-    const supportedCapabilities = [
-        'trace',
-        'network',
-        'filmstrips',
-        'metrics',
-        'ssblocks',
-    ];
-    /**
-     * trace - record chrome trace events(LCP, FCP, CLS, etc.) for all journeys
-     * network - capture network information for all journeys
-     * filmstrips - record detailed filmstrips for all journeys
-     * metrics - capture performance metrics (DOM Nodes, Heap size, etc.) for each step
-     * ssblocks - Dedupes the screenshots in to blocks to save storage space
-     */
-    for (const flag of options.capability) {
-        if (supportedCapabilities.includes(flag)) {
-            options[flag] = true;
-        }
-        else {
-            console.warn(`Missing capability "${flag}", current supported capabilities are ${supportedCapabilities.join(', ')}`);
-        }
-    }
-}
-exports.default = command;
-//# sourceMappingURL=parse_args.js.map

package/dist/parse_args.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parse_args.js","sourceRoot":"","sources":["../src/parse_args.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;;AAEH,yCAA4C;AAE5C,2CAAwC;AACxC,uCAA2D;AAE3D,iEAAiE;AACjE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAErD,mBAAO;KACJ,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;KACnB,KAAK,CAAC,8BAA8B,CAAC;KACrC,MAAM,CACL,qBAAqB,EACrB,oDAAoD,CACrD;KACA,MAAM,CACL,2BAA2B,EAC3B,gDAAgD,EAChD,IAAI,CAAC,KAAK,CACX;KACA,SAAS,CACR,IAAI,kBAAM,CAAC,oBAAoB,EAAE,uBAAuB,CAAC,CAAC,OAAO,CAC/D,MAAM,CAAC,IAAI,CAAC,qBAAS,CAAC,CACvB,CACF;KACA,MAAM,CAAC,aAAa,EAAE,uBAAuB,CAAC;KAC9C,MAAM,CACL,qBAAqB,EACrB,iDAAiD,CAClD;KACA,MAAM,CAAC,UAAU,EAAE,oCAAoC,CAAC;KACxD,MAAM,CAAC,4BAA4B,EAAE,sBAAsB,CAAC;KAC5D,MAAM,CAAC,eAAe,EAAE,6BAA6B,CAAC;KACtD,MAAM,CAAC,WAAW,EAAE,4BAA4B,EAAE,KAAK,CAAC;KACxD,MAAM,CAAC,eAAe,EAAE,wBAAwB,CAAC;KACjD,MAAM,CACL,4BAA4B,EAC5B,2CAA2C,CAC5C;KACA,SAAS,CACR,IAAI,kBAAM,CAAC,sBAAsB,EAAE,sCAAsC,CAAC;KACvE,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC;KACzC,OAAO,CAAC,IAAI,CAAC,CACjB;KACA,MAAM,CACL,WAAW,EACX,kEAAkE,CACnE;KACA,MAAM,CACL,gBAAgB,EAChB,6DAA6D,CAC9D;KACA,MAAM,CACL,kBAAkB,EAClB,mDAAmD,CACpD;KACA,MAAM,CACL,cAAc,EACd,uDAAuD,EACvD,QAAQ,CACT;KACA,MAAM,CACL,0BAA0B,EAC1B,0CAA0C,CAC3C;KACA,MAAM,CACL,kBAAkB,EAClB,mFAAmF,CACpF;KACA,MAAM,CACL,uBAAuB,EACvB,mIAAmI,CACpI;KACA,MAAM,CACL,mBAAmB,EACnB,wJAAwJ,CACzJ;KACA,SAAS,CACR,IAAI,kBAAM,CACR,sBAAsB,EACtB,0KAA0K,CAC3K,CAAC,OAAO,CAAC,wCAA8B,CAAC,CAC1C;KACA,MAAM,CAAC,iBAAiB,EAAE,uCAAuC,CAAC;KAClE,MAAM,CAAC,mCAAmC,EAAE,4NAA4N,EAAE,IAAI,CAAC,KAAK,CAAC;KACrR,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,qBAAqB,CAAC,CAAC;AAEtC,MAAM,OAAO,GAAG,mBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAa,CAAC;AA0CjC,0BAAO;AAxChB;;;GAGG;AACH,IAAI,OAAO,CAAC,UAAU,EAAE;IACtB,OAAO,CAAC,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,MAAM,CAAC;IAC9C,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IACxB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IACvB,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;CACtB;AAED,IAAI,OAAO,CAAC,UAAU,EAAE;IACtB,MAAM,qBAAqB,GAAG;QAC5B,OAAO;QACP,SAAS;QACT,YAAY;QACZ,SAAS;QACT,UAAU;KACX,CAAC;IACF;;;;;;OAMG;IACH,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,UAAU,EAAE;QACrC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACxC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;SACtB;aAAM;YACL,OAAO,CAAC,IAAI,CACV,uBAAuB,IAAI,yCAAyC,qBAAqB,CAAC,IAAI,CAC5F,IAAI,CACL,EAAE,CACJ,CAAC;SACH;KACF;CACF;AAGD,kBAAe,OAAO,CAAC"}

package/src/parse_args.ts

@@ -1,158 +0,0 @@
-/**
- * MIT License
- *
- * Copyright (c) 2020-present, Elastic NV
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- */
-
-import { program, Option } from 'commander';
-import { CliArgs } from './common_types';
-import { reporters } from './reporters';
-import { DEFAULT_NETWORK_CONDITIONS_ARG } from './helpers';
-
-/* eslint-disable-next-line @typescript-eslint/no-var-requires */
-const { name, version } = require('../package.json');
-
-program
-  .name(`npx ${name}`)
-  .usage('[options] [dir] [files] file')
-  .option(
-    '-c, --config <path>',
-    'configuration path (default: synthetics.config.js)'
-  )
-  .option(
-    '-p, --params <jsonstring>',
-    'JSON object that gets injected to all journeys',
-    JSON.parse
-  )
-  .addOption(
-    new Option('--reporter <value>', `output repoter format`).choices(
-      Object.keys(reporters)
-    )
-  )
-  .option('-d, --debug', 'print debug logs info')
-  .option(
-    '--pattern <pattern>',
-    'RegExp file patterns to search inside directory'
-  )
-  .option('--inline', 'Run inline journeys from heartbeat')
-  .option('-r, --require <modules...>', 'module(s) to preload')
-  .option('--no-headless', 'run browser in headful mode')
-  .option('--sandbox', 'enable chromium sandboxing', false)
-  .option('--rich-events', 'Mimics a heartbeat run')
-  .option(
-    '--capability <features...>',
-    'Enable capabilities through feature flags'
-  )
-  .addOption(
-    new Option('--screenshots [flag]', 'take screenshots at end of each step')
-      .choices(['on', 'off', 'only-on-failure'])
-      .default('on')
-  )
-  .option(
-    '--dry-run',
-    "don't actually execute anything, report only registered journeys"
-  )
-  .option(
-    '--match <name>',
-    'run only journeys with a name or tags that matches the glob'
-  )
-  .option(
-    '--tags <name...>',
-    'run only journeys with the given tag(s), or globs'
-  )
-  .option(
-    '--outfd <fd>',
-    'specify a file descriptor for logs. Default is stdout',
-    parseInt
-  )
-  .option(
-    '--ws-endpoint <endpoint>',
-    'Browser WebSocket endpoint to connect to'
-  )
-  .option(
-    '--pause-on-error',
-    'pause on error until a keypress is made in the console. Useful during development'
-  )
-  .option(
-    '--ignore-https-errors',
-    'ignores any HTTPS errors in sites being tested, including ones related to unrecognized certs or signatures. This can be insecure!'
-  )
-  .option(
-    '--quiet-exit-code',
-    'always return 0 as an exit code status, regardless of test pass / fail. Only return > 0 exit codes on internal errors where the suite could not be run'
-  )
-  .addOption(
-    new Option(
-      '--throttling <d/u/l>',
-      'List of options to throttle network conditions for download throughput (d) in megabits/second, upload throughput (u) in megabits/second and latency (l) in milliseconds.'
-    ).default(DEFAULT_NETWORK_CONDITIONS_ARG)
-  )
-  .option('--no-throttling', 'Turns off default network throttling.')
-  .option('--playwright-options <jsonstring>', 'JSON object to pass in custom Playwright options for the agent. Options passed will be merged with Playwright options defined in your synthetics.config.js file. Options defined via --playwright-options take precedence.', JSON.parse)
-  .version(version)
-  .description('Run synthetic tests');
-
-const command = program.parse(process.argv);
-const options = command.opts() as CliArgs;
-
-/**
- * Group all events that can be consumed by heartbeat and
- * eventually by the Synthetics UI.
- */
-if (options.richEvents) {
-  options.reporter = options.reporter ?? 'json';
-  options.ssblocks = true;
-  options.network = true;
-  options.quietExitCode = true;
-  options.trace = true;
-}
-
-if (options.capability) {
-  const supportedCapabilities = [
-    'trace',
-    'network',
-    'filmstrips',
-    'metrics',
-    'ssblocks',
-  ];
-  /**
-   * trace - record chrome trace events(LCP, FCP, CLS, etc.) for all journeys
-   * network - capture network information for all journeys
-   * filmstrips - record detailed filmstrips for all journeys
-   * metrics - capture performance metrics (DOM Nodes, Heap size, etc.) for each step
-   * ssblocks - Dedupes the screenshots in to blocks to save storage space
-   */
-  for (const flag of options.capability) {
-    if (supportedCapabilities.includes(flag)) {
-      options[flag] = true;
-    } else {
-      console.warn(
-        `Missing capability "${flag}", current supported capabilities are ${supportedCapabilities.join(
-          ', '
-        )}`
-      );
-    }
-  }
-}
-
-export { options };
-export default command;