@elastic/synthetics 1.0.0-beta.8 → 1.0.0

package/dist/generator/index.js

@@ -0,0 +1,241 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Generator = exports.CONFIG_PATH = exports.REGULAR_FILES_PATH = void 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.
+ *
+ */
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const colors_1 = require("kleur/colors");
+const path_1 = require("path");
+// @ts-ignore-next-line: has no exported member 'Input'
+const enquirer_1 = require("enquirer");
+const helpers_1 = require("../helpers");
+const utils_1 = require("./utils");
+const locations_1 = require("../locations");
+const monitor_1 = require("../dsl/monitor");
+// Templates that are required for setting up new synthetics project
+const templateDir = (0, path_1.join)(__dirname, '..', '..', 'templates');
+// exported for testing
+exports.REGULAR_FILES_PATH = [
+    'journeys/example.journey.ts',
+    'journeys/advanced-example-helpers.ts',
+    'journeys/advanced-example.journey.ts',
+    'lightweight/heartbeat.yml',
+    '.github/workflows/run-synthetics.yml',
+    'README.md',
+];
+exports.CONFIG_PATH = 'synthetics.config.ts';
+class Generator {
+    projectDir;
+    pkgManager = 'npm';
+    constructor(projectDir) {
+        this.projectDir = projectDir;
+    }
+    async directory() {
+        (0, helpers_1.progress)(`Initializing Synthetics project in '${(0, path_1.relative)(process.cwd(), this.projectDir) || '.'}'`);
+        if (!(0, fs_1.existsSync)(this.projectDir)) {
+            await (0, promises_1.mkdir)(this.projectDir);
+        }
+    }
+    async questions() {
+        if (process.env.TEST_QUESTIONS) {
+            return JSON.parse(process.env.TEST_QUESTIONS);
+        }
+        const { onCloud } = await (0, enquirer_1.prompt)({
+            type: 'confirm',
+            name: 'onCloud',
+            initial: 'y',
+            message: 'Do you use Elastic Cloud',
+        });
+        const url = await new enquirer_1.Input({
+            header: onCloud
+                ? (0, colors_1.yellow)('Get cloud.id from your deployment https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html')
+                : '',
+            message: onCloud
+                ? 'What is your cloud.id'
+                : 'What is the url of your Kibana instance',
+            name: 'url',
+            required: true,
+            result(value) {
+                return onCloud ? (0, utils_1.cloudIDToKibanaURL)(value) : value;
+            },
+        }).run();
+        const auth = await new enquirer_1.Input({
+            name: 'auth',
+            header: (0, colors_1.yellow)(`Generate API key from Kibana ${(0, helpers_1.getMonitorManagementURL)(url)}`),
+            required: true,
+            message: 'What is your API key',
+        }).run();
+        const allLocations = await (0, locations_1.getLocations)({ url, auth });
+        const locChoices = (0, locations_1.formatLocations)(allLocations);
+        if (locChoices.length === 0) {
+            throw 'Follow the docs to set up your first private locations - https://www.elastic.co/guide/en/observability/current/uptime-set-up-choose-agent.html#private-locations';
+        }
+        const monitorQues = [
+            {
+                type: 'select',
+                name: 'locations',
+                hint: '(Use <space> to select, <return> to submit)',
+                message: 'Select the locations where you want to run monitors',
+                choices: locChoices,
+                multiple: true,
+                validate(value) {
+                    return value.length === 0 ? `Select at least one option.` : true;
+                },
+            },
+            {
+                type: 'select',
+                name: 'schedule',
+                message: 'Set default schedule in minutes for all monitors',
+                initial: 3,
+                choices: monitor_1.ALLOWED_SCHEDULES.map(String),
+                required: true,
+                result(value) {
+                    return Number(value);
+                },
+            },
+            {
+                type: 'input',
+                name: 'id',
+                message: 'Choose project id to logically group monitors',
+                initial: (0, path_1.basename)(this.projectDir),
+            },
+            {
+                type: 'input',
+                name: 'space',
+                message: 'Choose the target Kibana space',
+                initial: 'default',
+            },
+        ];
+        // Split and group private and public locations from the answered list.
+        const answers = await (0, enquirer_1.prompt)(monitorQues);
+        const { locations, privateLocations } = (0, locations_1.groupLocations)(answers.locations);
+        return { ...answers, url, locations, privateLocations };
+    }
+    async files(answers) {
+        const fileMap = new Map();
+        // Setup Synthetics config file
+        fileMap.set(exports.CONFIG_PATH, (0, utils_1.replaceTemplates)(await (0, promises_1.readFile)((0, path_1.join)(templateDir, exports.CONFIG_PATH), 'utf-8'), answers));
+        // Setup non-templated files
+        Promise.all(exports.REGULAR_FILES_PATH.map(async (file) => {
+            fileMap.set(file, await (0, promises_1.readFile)((0, path_1.join)(templateDir, file), 'utf-8'));
+        })).catch(e => {
+            throw e;
+        });
+        // Create files
+        for (const [relativePath, content] of fileMap) {
+            await this.createFile(relativePath, content);
+        }
+    }
+    async createFile(relativePath, content, override = false) {
+        const absolutePath = (0, path_1.join)(this.projectDir, relativePath);
+        if (!override && (0, fs_1.existsSync)(absolutePath)) {
+            const { override } = await (0, enquirer_1.prompt)({
+                type: 'confirm',
+                name: 'override',
+                message: `File ${relativePath} already exists. Override it?`,
+                initial: false,
+            });
+            if (!override)
+                return;
+        }
+        (0, helpers_1.progress)(`Writing ${(0, path_1.relative)(process.cwd(), absolutePath)}.`);
+        await (0, promises_1.mkdir)((0, path_1.dirname)(absolutePath), { recursive: true });
+        await (0, promises_1.writeFile)(absolutePath, content, 'utf-8');
+    }
+    async package() {
+        this.pkgManager = await (0, utils_1.getPackageManager)(this.projectDir);
+        const commands = new Map();
+        commands.set(`Setting up project using ${this.pkgManager == 'yarn' ? 'Yarn' : 'NPM'}`, this.pkgManager == 'yarn' ? 'yarn init -y' : 'npm init -y');
+        const pkgName = '@elastic/synthetics';
+        commands.set(`Installing @elastic/synthetics library`, this.pkgManager == 'yarn'
+            ? `yarn add -dev ${pkgName} --silent`
+            : `npm i -d ${pkgName} --quiet`);
+        // Execute commands
+        for (const [name, command] of commands) {
+            (0, helpers_1.progress)(`${name}...`);
+            (0, child_process_1.execSync)(command, {
+                stdio: 'inherit',
+                cwd: this.projectDir,
+            });
+        }
+    }
+    async patchPkgJSON() {
+        const filename = 'package.json';
+        const pkgJSON = JSON.parse(await (0, promises_1.readFile)((0, path_1.join)(this.projectDir, filename), 'utf-8'));
+        if (!pkgJSON.scripts) {
+            pkgJSON.scripts = {};
+        }
+        // Add test command
+        if (!pkgJSON.scripts.test) {
+            pkgJSON.scripts.test = 'npx @elastic/synthetics journeys';
+        }
+        // Add push command
+        if (!pkgJSON.scripts.push) {
+            pkgJSON.scripts.push = 'npx @elastic/synthetics push';
+        }
+        await this.createFile(filename, JSON.stringify(pkgJSON, null, 2) + '\n', true);
+    }
+    async patchGitIgnore() {
+        const gitIgnorePath = (0, path_1.join)(this.projectDir, '.gitignore');
+        let gitIgnore = '';
+        if ((0, fs_1.existsSync)(gitIgnorePath)) {
+            const contents = await (0, promises_1.readFile)(gitIgnorePath, 'utf-8');
+            gitIgnore += contents.trimEnd() + '\n';
+        }
+        if (!gitIgnore.includes('node_modules')) {
+            gitIgnore += 'node_modules/\n';
+        }
+        if (!gitIgnore.includes('.synthetics')) {
+            gitIgnore += '.synthetics/\n';
+        }
+        await (0, promises_1.writeFile)(gitIgnorePath, gitIgnore, 'utf-8');
+    }
+    banner() {
+        (0, helpers_1.write)((0, colors_1.bold)(`
+All set, you can run below commands inside: ${this.projectDir}:
+
+  Run synthetic tests: ${(0, colors_1.cyan)((0, utils_1.runCommand)(this.pkgManager, 'test'))}
+
+  Push monitors to Kibana: ${(0, colors_1.cyan)('SYNTHETICS_API_KEY=<value> ' + (0, utils_1.runCommand)(this.pkgManager, 'push'))}
+
+  ${(0, colors_1.yellow)('Make sure to configure the SYNTHETICS_API_KEY before pushing monitors to Kibana.')}
+
+Visit https://www.elastic.co/guide/en/observability/current/synthetic-run-tests.html to learn more.
+    `));
+    }
+    async setup() {
+        await this.directory();
+        const answers = await this.questions();
+        await this.package();
+        await this.files(answers);
+        await this.patchPkgJSON();
+        await this.patchGitIgnore();
+        this.banner();
+    }
+}
+exports.Generator = Generator;
+//# sourceMappingURL=index.js.map

package/dist/generator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generator/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,iDAAyC;AACzC,2BAAgC;AAChC,0CAAyD;AACzD,yCAAkD;AAClD,+BAAyD;AACzD,uDAAuD;AACvD,uCAAyC;AACzC,wCAIoB;AACpB,mCAKiB;AACjB,4CAA6E;AAC7E,4CAAmD;AAGnD,oEAAoE;AACpE,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;AAQ7D,uBAAuB;AACV,QAAA,kBAAkB,GAAG;IAChC,6BAA6B;IAC7B,sCAAsC;IACtC,sCAAsC;IACtC,2BAA2B;IAC3B,sCAAsC;IACtC,WAAW;CACZ,CAAC;AACW,QAAA,WAAW,GAAG,sBAAsB,CAAC;AAElD,MAAa,SAAS;IAED;IADnB,UAAU,GAAG,KAAK,CAAC;IACnB,YAAmB,UAAkB;QAAlB,eAAU,GAAV,UAAU,CAAQ;IAAG,CAAC;IAEzC,KAAK,CAAC,SAAS;QACb,IAAA,kBAAQ,EACN,uCACE,IAAA,eAAQ,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,GAC9C,GAAG,CACJ,CAAC;QACF,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAChC,MAAM,IAAA,gBAAK,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC9B;IACH,CAAC;IAED,KAAK,CAAC,SAAS;QACb,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;SAC/C;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAA,iBAAM,EAAsB;YACpD,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,0BAA0B;SACpC,CAAC,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,IAAI,gBAAK,CAAC;YAC1B,MAAM,EAAE,OAAO;gBACb,CAAC,CAAC,IAAA,eAAM,EACJ,kGAAkG,CACnG;gBACH,CAAC,CAAC,EAAE;YACN,OAAO,EAAE,OAAO;gBACd,CAAC,CAAC,uBAAuB;gBACzB,CAAC,CAAC,yCAAyC;YAC7C,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,IAAI;YACd,MAAM,CAAC,KAAK;gBACV,OAAO,OAAO,CAAC,CAAC,CAAC,IAAA,0BAAkB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACrD,CAAC;SACF,CAAC,CAAC,GAAG,EAAE,CAAC;QAET,MAAM,IAAI,GAAG,MAAM,IAAI,gBAAK,CAAC;YAC3B,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,IAAA,eAAM,EACZ,gCAAgC,IAAA,iCAAuB,EAAC,GAAG,CAAC,EAAE,CAC/D;YACD,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,sBAAsB;SAChC,CAAC,CAAC,GAAG,EAAE,CAAC;QAET,MAAM,YAAY,GAAG,MAAM,IAAA,wBAAY,EAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,MAAM,UAAU,GAAG,IAAA,2BAAe,EAAC,YAAY,CAAC,CAAC;QACjD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,MAAM,kKAAkK,CAAC;SAC1K;QAED,MAAM,WAAW,GAAG;YAClB;gBACE,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,6CAA6C;gBACnD,OAAO,EAAE,qDAAqD;gBAC9D,OAAO,EAAE,UAAU;gBACnB,QAAQ,EAAE,IAAI;gBACd,QAAQ,CAAC,KAAK;oBACZ,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC,IAAI,CAAC;gBACnE,CAAC;aACF;YACD;gBACE,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,kDAAkD;gBAC3D,OAAO,EAAE,CAAC;gBACV,OAAO,EAAE,2BAAiB,CAAC,GAAG,CAAC,MAAM,CAAC;gBACtC,QAAQ,EAAE,IAAI;gBACd,MAAM,CAAC,KAAK;oBACV,OAAO,MAAM,CAAC,KAAK,CAAQ,CAAC;gBAC9B,CAAC;aACF;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,+CAA+C;gBACxD,OAAO,EAAE,IAAA,eAAQ,EAAC,IAAI,CAAC,UAAU,CAAC;aACnC;YACD;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,gCAAgC;gBACzC,OAAO,EAAE,SAAS;aACnB;SACF,CAAC;QAEF,uEAAuE;QACvE,MAAM,OAAO,GAAG,MAAM,IAAA,iBAAM,EAAgB,WAAW,CAAC,CAAC;QACzD,MAAM,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,IAAA,0BAAc,EAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1E,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC1D,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAsB;QAChC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE1C,+BAA+B;QAC/B,OAAO,CAAC,GAAG,CACT,mBAAW,EACX,IAAA,wBAAgB,EACd,MAAM,IAAA,mBAAQ,EAAC,IAAA,WAAI,EAAC,WAAW,EAAE,mBAAW,CAAC,EAAE,OAAO,CAAC,EACvD,OAAO,CACR,CACF,CAAC;QAEF,4BAA4B;QAC5B,OAAO,CAAC,GAAG,CACT,0BAAkB,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YAClC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,IAAA,mBAAQ,EAAC,IAAA,WAAI,EAAC,WAAW,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;QACtE,CAAC,CAAC,CACH,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;YACV,MAAM,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;QAEH,eAAe;QACf,KAAK,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,OAAO,EAAE;YAC7C,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;SAC9C;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,OAAe,EAAE,QAAQ,GAAG,KAAK;QACtE,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAEzD,IAAI,CAAC,QAAQ,IAAI,IAAA,eAAU,EAAC,YAAY,CAAC,EAAE;YACzC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAA,iBAAM,EAAwB;gBACvD,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,QAAQ,YAAY,+BAA+B;gBAC5D,OAAO,EAAE,KAAK;aACf,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ;gBAAE,OAAO;SACvB;QAED,IAAA,kBAAQ,EAAC,WAAW,IAAA,eAAQ,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC;QAC9D,MAAM,IAAA,gBAAK,EAAC,IAAA,cAAO,EAAC,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxD,MAAM,IAAA,oBAAS,EAAC,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,UAAU,GAAG,MAAM,IAAA,yBAAiB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC3C,QAAQ,CAAC,GAAG,CACV,4BAA4B,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,EACxE,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAC3D,CAAC;QAEF,MAAM,OAAO,GAAG,qBAAqB,CAAC;QACtC,QAAQ,CAAC,GAAG,CACV,wCAAwC,EACxC,IAAI,CAAC,UAAU,IAAI,MAAM;YACvB,CAAC,CAAC,iBAAiB,OAAO,WAAW;YACrC,CAAC,CAAC,YAAY,OAAO,UAAU,CAClC,CAAC;QAEF,mBAAmB;QACnB,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,QAAQ,EAAE;YACtC,IAAA,kBAAQ,EAAC,GAAG,IAAI,KAAK,CAAC,CAAC;YACvB,IAAA,wBAAQ,EAAC,OAAO,EAAE;gBAChB,KAAK,EAAE,SAAS;gBAChB,GAAG,EAAE,IAAI,CAAC,UAAU;aACrB,CAAC,CAAC;SACJ;IACH,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,QAAQ,GAAG,cAAc,CAAC;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CACxB,MAAM,IAAA,mBAAQ,EAAC,IAAA,WAAI,EAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CACzD,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACpB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;SACtB;QACD,mBAAmB;QACnB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE;YACzB,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,kCAAkC,CAAC;SAC3D;QACD,mBAAmB;QACnB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE;YACzB,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,8BAA8B,CAAC;SACvD;QAED,MAAM,IAAI,CAAC,UAAU,CACnB,QAAQ,EACR,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,EACvC,IAAI,CACL,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAC1D,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,IAAI,IAAA,eAAU,EAAC,aAAa,CAAC,EAAE;YAC7B,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAQ,EAAC,aAAa,EAAE,OAAO,CAAC,CAAC;YACxD,SAAS,IAAI,QAAQ,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;SACxC;QACD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;YACvC,SAAS,IAAI,iBAAiB,CAAC;SAChC;QACD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;YACtC,SAAS,IAAI,gBAAgB,CAAC;SAC/B;QACD,MAAM,IAAA,oBAAS,EAAC,aAAa,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,MAAM;QACJ,IAAA,eAAQ,EACN,IAAA,aAAI,EAAC;8CACmC,IAAI,CAAC,UAAU;;yBAEpC,IAAA,aAAI,EAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;;6BAErC,IAAA,aAAI,EAC7B,6BAA6B,GAAG,IAAA,kBAAU,EAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CACpE;;IAEC,IAAA,eAAM,EACN,kFAAkF,CACnF;;;KAGE,CAAC,CACD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1B,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1B,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;CACF;AAjPD,8BAiPC"}

package/dist/{reporters/reporter.js → generator/utils.d.ts}

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * MIT License
  *
@@ -23,5 +22,8 @@
  * THE SOFTWARE.
  *
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=reporter.js.map
+export declare function getPackageManager(dir: string): Promise<"yarn" | "npm">;
+export declare function runCommand(pkgManager: string, command: string): string;
+export declare function replaceTemplates(input: string, values: Record<string, any>): string;
+export declare function cloudIDToKibanaURL(id: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/generator/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/generator/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAKH,wBAAsB,iBAAiB,CAAC,GAAG,EAAE,MAAM,2BAKlD;AAED,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAK7D;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,UAoB1E;AAED,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,UAmB5C"}

package/dist/generator/utils.js

@@ -0,0 +1,84 @@
+"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.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cloudIDToKibanaURL = exports.replaceTemplates = exports.runCommand = exports.getPackageManager = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+async function getPackageManager(dir) {
+    if ((0, fs_1.existsSync)((0, path_1.join)(dir, 'yarn.lock'))) {
+        return 'yarn';
+    }
+    return 'npm';
+}
+exports.getPackageManager = getPackageManager;
+function runCommand(pkgManager, command) {
+    if (pkgManager === 'yarn') {
+        return `yarn ${command}`;
+    }
+    return `npm run ${command}`;
+}
+exports.runCommand = runCommand;
+function replaceTemplates(input, values) {
+    for (const key in values) {
+        const finalValue = values[key];
+        input = input.replace(new RegExp(`'{{` + key + `}}'`, 'g'), () => {
+            if (Array.isArray(finalValue)) {
+                return String(finalValue)
+                    .split(',')
+                    .filter(Boolean)
+                    .map(f => `'${f}'`);
+            }
+            if (typeof finalValue == 'number') {
+                return Number(finalValue);
+            }
+            if (typeof finalValue == 'string') {
+                return `'${finalValue}'`;
+            }
+            return finalValue;
+        });
+    }
+    return input;
+}
+exports.replaceTemplates = replaceTemplates;
+function cloudIDToKibanaURL(id) {
+    const ID_SEPARATOR = ':';
+    const VALUE_SEPARATOR = '$';
+    // Ignore values before the separator
+    const index = id.lastIndexOf(ID_SEPARATOR);
+    if (index >= 0) {
+        id = id.substring(index + 1);
+    }
+    // Decode the base64 string
+    const decoded = Buffer.from(id, 'base64').toString();
+    const words = decoded.split(VALUE_SEPARATOR);
+    // construct the kibana and ES urls from decoded value
+    const [host, port = '443'] = words[0].split(ID_SEPARATOR);
+    const [kibanaId, kibanaPort = port] = words[2].split(ID_SEPARATOR);
+    const kibanaURL = `https://${kibanaId}.${host}:${kibanaPort}`;
+    return kibanaURL;
+}
+exports.cloudIDToKibanaURL = cloudIDToKibanaURL;
+//# sourceMappingURL=utils.js.map

package/dist/generator/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/generator/utils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;AAEH,2BAAgC;AAChC,+BAA4B;AAErB,KAAK,UAAU,iBAAiB,CAAC,GAAW;IACjD,IAAI,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE;QACtC,OAAO,MAAM,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AALD,8CAKC;AAED,SAAgB,UAAU,CAAC,UAAkB,EAAE,OAAe;IAC5D,IAAI,UAAU,KAAK,MAAM,EAAE;QACzB,OAAO,QAAQ,OAAO,EAAE,CAAC;KAC1B;IACD,OAAO,WAAW,OAAO,EAAE,CAAC;AAC9B,CAAC;AALD,gCAKC;AAED,SAAgB,gBAAgB,CAAC,KAAa,EAAE,MAA2B;IACzE,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;QACxB,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/B,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,KAAK,GAAG,GAAG,GAAG,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE;YAC/D,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBAC7B,OAAO,MAAM,CAAC,UAAU,CAAC;qBACtB,KAAK,CAAC,GAAG,CAAC;qBACV,MAAM,CAAC,OAAO,CAAC;qBACf,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACvB;YACD,IAAI,OAAO,UAAU,IAAI,QAAQ,EAAE;gBACjC,OAAO,MAAM,CAAC,UAAU,CAAC,CAAC;aAC3B;YACD,IAAI,OAAO,UAAU,IAAI,QAAQ,EAAE;gBACjC,OAAO,IAAI,UAAU,GAAG,CAAC;aAC1B;YACD,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AApBD,4CAoBC;AAED,SAAgB,kBAAkB,CAAC,EAAU;IAC3C,MAAM,YAAY,GAAG,GAAG,CAAC;IACzB,MAAM,eAAe,GAAG,GAAG,CAAC;IAC5B,qCAAqC;IACrC,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAC3C,IAAI,KAAK,IAAI,CAAC,EAAE;QACd,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;KAC9B;IAED,2BAA2B;IAC3B,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;IACrD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7C,sDAAsD;IACtD,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1D,MAAM,CAAC,QAAQ,EAAE,UAAU,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACnE,MAAM,SAAS,GAAG,WAAW,QAAQ,IAAI,IAAI,IAAI,UAAU,EAAE,CAAC;IAE9D,OAAO,SAAS,CAAC;AACnB,CAAC;AAnBD,gDAmBC"}

package/dist/helpers.d.ts

@@ -22,18 +22,13 @@
  * THE SOFTWARE.
  *
  */
-/// <reference types="node" />
-import fs from 'fs';
-import { HooksArgs, HooksCallback } from './common_types';
-export declare const readFileAsync: typeof fs.readFile.__promisify__;
-export declare const writeFileAsync: typeof fs.writeFile.__promisify__;
-export declare const rmdirAsync: typeof fs.rmdir.__promisify__;
-export declare const mkdirAsync: typeof fs.mkdir.__promisify__;
+import { HooksArgs, HooksCallback, NetworkConditions, Location, ThrottlingOptions } from './common_types';
 export declare function noop(): void;
 export declare function indent(lines: string, tab?: string): string;
 export declare const symbols: {
     warning: string;
     skipped: string;
+    progress: string;
     succeeded: string;
     failed: string;
 };
@@ -89,11 +84,17 @@ export declare function totalist(dir: string, callback: (relPath: string, absPat
 export declare function findPWLogsIndexes(msgOrStack: string): [number, number];
 export declare function rewriteErrorMessage(message: string, start: number): string;
 export declare function rewriteErrorStack(stack: string, indexes: [number, number]): string;
-export declare function formatError(error: Error): {
-    name: string;
+export declare function formatError(error: Error | any): {
     message: string;
+    name: string;
     stack: string;
 };
+/**
+ * All the settings that are related to the Synthetics is stored
+ * under this directory
+ * Examples: Screenshots, Project setup
+ */
+export declare const SYNTHETICS_PATH: string;
 /**
  * Synthetics cache path that is based on the process id to make sure
  * each process does not modify the caching layer used by other process
@@ -101,4 +102,30 @@ export declare function formatError(error: Error): {
  */
 export declare const CACHE_PATH: string;
 export declare function getDurationInUs(duration: number): number;
+export declare function megabitsToBytes(megabytes: number): number;
+export declare const DEFAULT_THROTTLING_OPTIONS: ThrottlingOptions;
+/**
+ * Transforms the CLI throttling arguments in to format
+ * expected by Chrome devtools protocol NetworkConditions
+ */
+export declare function getNetworkConditions(throttlingOpts: ThrottlingOptions): NetworkConditions;
+export declare const THROTTLING_WARNING_MSG = "Throttling may not be active when the tests run - see\nhttps://github.com/elastic/synthetics/blob/main/docs/throttling.md for more details";
+export declare function wrapFnWithLocation<A extends unknown[], R>(func: (location: Location, ...args: A) => R): (...args: A) => R;
+export declare function safeNDJSONParse(data: string | string[]): any[];
+export declare function write(message: string, live?: boolean): void;
+export declare function progress(message: string): void;
+export declare function liveProgress(promise: Promise<any>, message: string): Promise<any>;
+export declare function apiProgress(message: string, live?: boolean): void;
+export declare function error(message: string): void;
+export declare function done(message: string): void;
+export declare function warn(message: string): void;
+export declare function removeTrailingSlash(url: string): string;
+export declare function getMonitorManagementURL(url: any): string;
+/**
+ * Matches tests based on the provided args. Proitize tags over match
+ * - tags pattern that matches only tags
+ * - match pattern that matches both name and tags
+ */
+export declare function isMatch(tags: Array<string>, name: string, tagsPattern?: Array<string>, matchPattern?: string): boolean;
+export declare function tagsMatch(tags: any, pattern: any): boolean;
 //# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;AAKH,OAAO,EAAE,MAAM,IAAI,CAAC;AAGpB,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAK1D,eAAO,MAAM,aAAa,kCAAyB,CAAC;AACpD,eAAO,MAAM,cAAc,mCAA0B,CAAC;AACtD,eAAO,MAAM,UAAU,+BAAsB,CAAC;AAC9C,eAAO,MAAM,UAAU,+BAAsB,CAAC;AAI9C,wBAAgB,IAAI,SAAK;AAEzB,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAQ,UAEhD;AAOD,eAAO,MAAM,OAAO;;;;;CAKnB,CAAC;AAEF,wBAAgB,gBAAgB,WAE/B;AAED,wBAAgB,gBAAgB,WAE/B;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,WAGrC;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,UAE5C;AAMD,wBAAgB,YAAY,WAE3B;AAED;;GAEG;AACH,wBAAgB,GAAG,WAElB;AAED;;GAEG;AACH,wBAAsB,WAAW,CAC/B,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,EAC/B,IAAI,EAAE,SAAS,mBAIhB;AAED,wBAAgB,cAAc,CAAC,GAAG,KAAA,kBAMjC;AAED,wBAAgB,WAAW,CAAC,IAAI,KAAA,WAE/B;AAED,wBAAgB,MAAM,CAAC,QAAQ,KAAA,WAE9B;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,WAAW,KAAA,EAAE,GAAG,KAAA,OAiBvD;AAED;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAC5B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,GAAG,EACnD,GAAG,SAAK,iBAeT;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAiBtE;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAKjE;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,UAiBzE;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK;;;;EAWvC;AAGD;;;;GAIG;AACH,eAAO,MAAM,UAAU,QAAmD,CAAC;AAE3E,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,UAE/C"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AASH,OAAO,EACL,SAAS,EACT,aAAa,EACb,iBAAiB,EACjB,QAAQ,EACR,iBAAiB,EAClB,MAAM,gBAAgB,CAAC;AAKxB,wBAAgB,IAAI,SAAK;AAEzB,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAQ,UAEhD;AAOD,eAAO,MAAM,OAAO;;;;;;CAMnB,CAAC;AAEF,wBAAgB,gBAAgB,WAE/B;AAED,wBAAgB,gBAAgB,WAE/B;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,WAGrC;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,UAE5C;AAMD,wBAAgB,YAAY,WAE3B;AAED;;GAEG;AACH,wBAAgB,GAAG,WAElB;AAED;;GAEG;AACH,wBAAsB,WAAW,CAC/B,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,EAC/B,IAAI,EAAE,SAAS,mBAIhB;AAED,wBAAgB,cAAc,CAAC,GAAG,KAAA,kBAMjC;AAED,wBAAgB,WAAW,CAAC,IAAI,KAAA,WAE/B;AAED,wBAAgB,MAAM,CAAC,QAAQ,KAAA,WAE9B;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,WAAW,KAAA,EAAE,GAAG,KAAA,OAiBvD;AAED;;;;;;GAMG;AACH,wBAAsB,QAAQ,CAC5B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,GAAG,EACnD,GAAG,SAAK,iBAeT;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAiBtE;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAKjE;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,UAiBzE;AAKD,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,GAAG;;;;EAmB7C;AAGD;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAA2B,CAAC;AACxD;;;;GAIG;AACH,eAAO,MAAM,UAAU,QAAgD,CAAC;AAExE,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,UAE/C;AAED,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,UAEhD;AAED,eAAO,MAAM,0BAA0B,EAAE,iBAIxC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,cAAc,EAAE,iBAAiB,GAChC,iBAAiB,CAOnB;AAED,eAAO,MAAM,sBAAsB,+IACiD,CAAC;AAMrF,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EACvD,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GAC1C,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,CAwBnB;AAGD,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,SActD;AAGD,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,QAEpD;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,QAEvC;AAED,wBAAsB,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM,gBASxE;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,UAAQ,QAExD;AAED,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,QAEpC;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,QAEnC;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,QAEnC;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,UAE9C;AAED,wBAAgB,uBAAuB,CAAC,GAAG,KAAA,UAE1C;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,EACnB,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAC3B,YAAY,CAAC,EAAE,MAAM,WAWtB;AAED,wBAAgB,SAAS,CAAC,IAAI,KAAA,EAAE,OAAO,KAAA,WAGtC"}