@elastic/synthetics 1.0.0-beta.30 → 1.0.0-beta.33

package/src/cli.ts

@@ -29,19 +29,37 @@ import { program, Option } from 'commander';
 import { cwd } from 'process';
 import { CliArgs, PushOptions } from './common_types';
 import { reporters } from './reporters';
-import { normalizeOptions, parseThrottling } from './options';
+import {
+  normalizeOptions,
+  parseThrottling,
+  getCommonCommandOpts,
+} from './options';
 import { loadTestFiles } from './loader';
 import { run } from './';
 import { runner } from './core';
 import { SyntheticsLocations } from './dsl/monitor';
-import { push } from './push';
+import {
+  push,
+  loadSettings,
+  validateSettings,
+  catchIncorrectSettings,
+} from './push';
+import {
+  formatLocations,
+  getLocations,
+  renderLocations,
+  LocationCmdOptions,
+} from './locations';
 import { resolve } from 'path';
 import { Generator } from './generator';
 import { error } from './helpers';
+import { LocationsMap } from './locations/public-locations';
 
 /* eslint-disable-next-line @typescript-eslint/no-var-requires */
 const { name, version } = require('../package.json');
 
+const { params, pattern, tags, match, playwrightOpts } = getCommonCommandOpts();
+
 program
   .name(`npx ${name}`)
   .usage('[options] [dir] [files] file')
@@ -49,20 +67,15 @@ program
     '-c, --config <path>',
     'configuration path (default: synthetics.config.js)'
   )
-  .option(
-    '-p, --params <jsonstring>',
-    'JSON object that gets injected to all journeys',
-    JSON.parse
-  )
+  .addOption(pattern)
+  .addOption(tags)
+  .addOption(match)
+  .addOption(params)
   .addOption(
     new Option('--reporter <value>', `output repoter format`).choices(
       Object.keys(reporters)
     )
   )
-  .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')
@@ -81,14 +94,6 @@ program
     '--dry-run',
     "don't actually execute anything, report only registered journeys"
   )
-  .option(
-    '--tags <name...>',
-    'run only journeys with a tag that matches the glob'
-  )
-  .option(
-    '--match <name>',
-    'run only journeys with a name or tag that matches the glob'
-  )
   .option(
     '--outfd <fd>',
     'specify a file descriptor for logs. Default is stdout',
@@ -117,11 +122,7 @@ program
     {}
   )
   .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
-  )
+  .addOption(playwrightOpts)
   .version(version)
   .description('Run synthetic tests')
   .action(async (cliArgs: CliArgs) => {
@@ -149,19 +150,11 @@ program
 program
   .command('push')
   .description(
-    'Push journeys in the current directory to create monitors within the Kibana monitor management UI'
+    'Push all journeys in the current directory to create monitors within the Kibana monitor management UI'
   )
-  .option(
-    '--pattern <pattern>',
-    'RegExp file patterns to push inside current directory'
-  )
-  .option(
-    '--tags <name...>',
-    'push only journeys with a tag that matches the glob'
-  )
-  .option(
-    '--match <name>',
-    'push only journeys with a name or tag that matches the glob'
+  .requiredOption(
+    '--auth <auth>',
+    'API key used for Kibana authentication(https://www.elastic.co/guide/en/kibana/master/api-keys.html).'
   )
   .option(
     '--schedule <time-in-minutes>',
@@ -174,35 +167,37 @@ program
       'default list of locations from which your monitors will run.'
     ).choices(SyntheticsLocations)
   )
-  .requiredOption(
-    '--project <project-id>',
-    'id that will be used for logically grouping monitors'
+  .option(
+    '--private-locations <locations...>',
+    'default list of private locations from which your monitors will run.'
   )
-  .requiredOption('--url <url>', 'kibana URL to upload the monitors')
-  .requiredOption(
-    '--auth <auth>',
-    'API key used for Kibana authentication(https://www.elastic.co/guide/en/kibana/master/api-keys.html).'
+  .option('--url <url>', 'Kibana URL to upload the monitors')
+  .option(
+    '--project <id>',
+    'id that will be used for logically grouping monitors'
   )
   .option(
     '--space <space>',
-    'the target Kibana spaces for the pushed monitors — spaces help you organise pushed monitors.',
-    'default'
+    'the target Kibana spaces for the pushed monitors — spaces help you organise pushed monitors.'
   )
+  .addOption(pattern)
+  .addOption(tags)
+  .addOption(match)
+  .addOption(params)
+  .addOption(playwrightOpts)
   .action(async (cmdOpts: PushOptions) => {
     try {
+      const settings = await loadSettings();
       await loadTestFiles({ inline: false }, [cwd()]);
-      const options = normalizeOptions({ ...program.opts(), ...cmdOpts });
-      if (!options.schedule) {
-        throw error(`Set default schedule in minutes for all monitors via '--schedule <time-in-minutes>' OR
-  configure via Synthetics config file under 'monitors.schedule' field.`);
-      }
-
-      if (!options.locations) {
-        throw error(`Set default location for all monitors via CLI as '--locations <locations...>' OR
-  configure via Synthetics config file under 'monitors.locations' field.`);
-      }
+      const options = normalizeOptions({
+        ...program.opts(),
+        ...settings,
+        ...cmdOpts,
+      }) as PushOptions;
+      validateSettings(options);
+      await catchIncorrectSettings(settings, options);
       const monitors = runner.buildMonitors(options);
-      await push(monitors, cmdOpts);
+      await push(monitors, options);
     } catch (e) {
       e && console.error(e);
       process.exit(1);
@@ -211,9 +206,9 @@ program
 
 // Init command
 program
-  .command('init <project-dir>')
-  .description('Initalize Elastic synthetics project')
-  .action(async (dir: string) => {
+  .command('init [dir]')
+  .description('Initialize Elastic synthetics project')
+  .action(async (dir = '') => {
     try {
       const generator = await new Generator(resolve(process.cwd(), dir));
       await generator.setup();
@@ -223,4 +218,29 @@ program
     }
   });
 
+// Locations command
+program
+  .command('locations')
+  .description(
+    `List all locations to run the synthetics monitors. Pass optional '--url' and '--auth' to list private locations.`
+  )
+  .option('--url <url>', 'Kibana URL to fetch all public and private locations')
+  .option(
+    '--auth <auth>',
+    'API key used for Kibana authentication(https://www.elastic.co/guide/en/kibana/master/api-keys.html).'
+  )
+  .action(async (cmdOpts: LocationCmdOptions) => {
+    try {
+      let locations = Object.keys(LocationsMap);
+      if (cmdOpts.auth && cmdOpts.url) {
+        const allLocations = await getLocations(cmdOpts);
+        locations = formatLocations(allLocations);
+      }
+      renderLocations(locations);
+    } catch (e) {
+      e && error(e);
+      process.exit(1);
+    }
+  });
+
 program.parse(process.argv);

package/src/common_types.ts

@@ -30,6 +30,7 @@ import {
   ChromiumBrowser,
   ChromiumBrowserContext,
   Page,
+  APIRequestContext,
 } from 'playwright-chromium';
 import { Step } from './dsl';
 import { BuiltInReporterName, ReporterInstance } from './reporters';
@@ -62,6 +63,7 @@ export type Driver = {
   context: ChromiumBrowserContext;
   page: Page;
   client: CDPSession;
+  request: APIRequestContext;
 };
 
 export type TraceOutput = {
@@ -210,6 +212,7 @@ type BaseArgs = {
   throttling?: ThrottlingOptions;
   schedule?: MonitorConfig['schedule'];
   locations?: MonitorConfig['locations'];
+  privateLocations?: MonitorConfig['privateLocations'];
 };
 
 export type CliArgs = BaseArgs & {
@@ -245,6 +248,7 @@ export type PushOptions = {
   space: string;
   schedule?: MonitorConfig['schedule'];
   locations?: MonitorConfig['locations'];
+  privateLocations?: MonitorConfig['privateLocations'];
 };
 
 export type PlaywrightOptions = LaunchOptions & BrowserContextOptions;

package/src/core/expect.ts

@@ -28,6 +28,8 @@ import type {
   AsymmetricMatcher,
   MatcherState,
   ExpectedAssertionsErrors,
+  Inverse,
+  PromiseMatchers,
 } from 'expect/build/types';
 
 // Copied source code from expect/build/types.d.ts
@@ -61,99 +63,122 @@ declare global {
       /**
        * If you know how to test something, `.not` lets you test its opposite.
        */
-      not: Matchers<R>;
+      not: Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Use resolves to unwrap the value of a fulfilled promise so any other
        * matcher can be chained. If the promise is rejected the assertion fails.
        */
-      resolves: Matchers<Promise<R>>;
+      resolves: Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Unwraps the reason of a rejected promise so any other matcher can be chained.
        * If the promise is fulfilled the assertion fails.
        */
-      rejects: Matchers<Promise<R>>;
+      rejects: Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Checks that a value is what you expect. It uses `===` to check strict equality.
        * Don't use `toBe` with floating-point numbers.
        */
-      toBe(expected: unknown): R;
+      toBe(
+        expected: unknown
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Using exact equality with floating point numbers is a bad idea.
        * Rounding means that intuitive things fail.
        * The default for numDigits is 2.
        */
-      toBeCloseTo(expected: number, numDigits?: number): R;
+      toBeCloseTo(
+        expected: number,
+        numDigits?: number
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Ensure that a variable is not undefined.
        */
-      toBeDefined(): R;
+      toBeDefined(): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * When you don't care what a value is, you just want to
        * ensure a value is false in a boolean context.
        */
-      toBeFalsy(): R;
+      toBeFalsy(): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * For comparing floating point numbers.
        */
-      toBeGreaterThan(expected: number | bigint): R;
+      toBeGreaterThan(
+        expected: number | bigint
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * For comparing floating point numbers.
        */
-      toBeGreaterThanOrEqual(expected: number | bigint): R;
+      toBeGreaterThanOrEqual(
+        expected: number | bigint
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Ensure that an object is an instance of a class.
        * This matcher uses `instanceof` underneath.
        */
       /* eslint-disable-next-line */
-      toBeInstanceOf(expected: Function): R;
+      toBeInstanceOf(
+        expected: unknown
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * For comparing floating point numbers.
        */
-      toBeLessThan(expected: number | bigint): R;
+      toBeLessThan(
+        expected: number | bigint
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * For comparing floating point numbers.
        */
-      toBeLessThanOrEqual(expected: number | bigint): R;
+      toBeLessThanOrEqual(
+        expected: number | bigint
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * This is the same as `.toBe(null)` but the error messages are a bit nicer.
        * So use `.toBeNull()` when you want to check that something is null.
        */
-      toBeNull(): R;
+      toBeNull(): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Use when you don't care what a value is, you just want to ensure a value
        * is true in a boolean context. In JavaScript, there are six falsy values:
        * `false`, `0`, `''`, `null`, `undefined`, and `NaN`. Everything else is truthy.
        */
-      toBeTruthy(): R;
+      toBeTruthy(): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Used to check that a variable is undefined.
        */
-      toBeUndefined(): R;
+      toBeUndefined(): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Used to check that a variable is NaN.
        */
-      toBeNaN(): R;
+      toBeNaN(): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Used when you want to check that an item is in a list.
        * For testing the items in the list, this uses `===`, a strict equality check.
        */
-      toContain(expected: unknown): R;
+      toContain(
+        expected: unknown
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Used when you want to check that an item is in a list.
        * For testing the items in the list, this  matcher recursively checks the
        * equality of all fields, rather than checking for object identity.
        */
-      toContainEqual(expected: unknown): R;
+      toContainEqual(
+        expected: unknown
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Used when you want to check that two objects have the same value.
        * This matcher recursively checks the equality of all fields, rather than checking for object identity.
        */
-      toEqual(expected: unknown): R;
+      toEqual(
+        expected: unknown
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Used to check that an object has a `.length` property
        * and it is set to a certain numeric value.
        */
-      toHaveLength(expected: number): R;
+      toHaveLength(
+        expected: number
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Use to check if property at provided reference keyPath exists for an object.
        * For checking deeply nested properties in an object you may use dot notation or an array containing
@@ -167,19 +192,28 @@ declare global {
        *
        * expect(houseForSale).toHaveProperty('kitchen.area', 20);
        */
-      toHaveProperty(keyPath: string | Array<string>, value?: unknown): R;
+      toHaveProperty(
+        keyPath: string | Array<string>,
+        value?: unknown
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Check that a string matches a regular expression.
        */
-      toMatch(expected: string | RegExp): R;
+      toMatch(
+        expected: string | RegExp
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Used to check that a JavaScript object matches a subset of the properties of an object
        */
-      toMatchObject(expected: Record<string, unknown> | Array<unknown>): R;
+      toMatchObject(
+        expected: Record<string, unknown> | Array<unknown>
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
       /**
        * Use to test that objects have the same types as well as structure.
        */
-      toStrictEqual(expected: unknown): R;
+      toStrictEqual(
+        expected: unknown
+      ): Matchers<R> & Inverse<Matchers<R>> & PromiseMatchers;
     }
   }
 }

package/src/core/gatherer.ts

@@ -23,7 +23,12 @@
  *
  */
 
-import { chromium, ChromiumBrowser, BrowserContext } from 'playwright-chromium';
+import {
+  chromium,
+  ChromiumBrowser,
+  BrowserContext,
+  request as apiRequest,
+} from 'playwright-chromium';
 import { PluginManager } from '../plugins';
 import { log } from './logger';
 import { Driver, NetworkConditions, RunOptions } from '../common_types';
@@ -61,7 +66,8 @@ export class Gatherer {
 
     const page = await context.newPage();
     const client = await context.newCDPSession(page);
-    return { browser: Gatherer.browser, context, page, client };
+    const request = await apiRequest.newContext({ ...playwrightOptions });
+    return { browser: Gatherer.browser, context, page, client, request };
   }
 
   static async getUserAgent(userAgent?: string) {
@@ -114,6 +120,7 @@ export class Gatherer {
   }
 
   static async dispose(driver: Driver) {
+    await driver.request.dispose();
     await driver.context.close();
   }
 

package/src/core/runner.ts

@@ -24,7 +24,7 @@
  */
 
 import { join } from 'path';
-import { rm } from 'fs/promises';
+import { mkdir, rm, writeFile } from 'fs/promises';
 import { Journey } from '../dsl/journey';
 import { Step } from '../dsl/step';
 import { reporters, Reporter } from '../reporters';
@@ -34,8 +34,6 @@ import {
   getTimestamp,
   runParallel,
   generateUniqueId,
-  mkdirAsync,
-  writeFileAsync,
 } from '../helpers';
 import {
   HooksCallback,
@@ -87,7 +85,7 @@ export default class Runner {
      * For each journey we create the screenshots folder for
      * caching all screenshots and clear them at end of each journey
      */
-    await mkdirAsync(this.screenshotPath, { recursive: true });
+    await mkdir(this.screenshotPath, { recursive: true });
     return {
       start,
       params: options.params,
@@ -116,7 +114,7 @@ export default class Runner {
         timestamp: getTimestamp(),
         data: buffer.toString('base64'),
       };
-      await writeFileAsync(
+      await writeFile(
         join(Runner.screenshotPath, fileName),
         JSON.stringify(screenshot)
       );
@@ -381,7 +379,7 @@ export default class Runner {
     /**
      * Set up the directory for caching screenshots
      */
-    await mkdirAsync(CACHE_PATH, { recursive: true });
+    await mkdir(CACHE_PATH, { recursive: true });
   }
 
   buildMonitors(options: RunOptions) {
@@ -393,6 +391,7 @@ export default class Runner {
       throttling: options.throttling,
       schedule: options.schedule,
       locations: options.locations,
+      privateLocations: options.privateLocations,
       params: options.params,
       playwrightOptions: options.playwrightOptions,
     });

package/src/dsl/journey.ts

@@ -23,7 +23,13 @@
  *
  */
 
-import { Browser, Page, BrowserContext, CDPSession } from 'playwright-chromium';
+import {
+  Browser,
+  Page,
+  BrowserContext,
+  CDPSession,
+  APIRequestContext,
+} from 'playwright-chromium';
 import micromatch, { isMatch } from 'micromatch';
 import { Step } from './step';
 import { VoidCallback, HooksCallback, Params, Location } from '../common_types';
@@ -43,6 +49,7 @@ export type JourneyCallback = (options: {
   browser: Browser;
   client: CDPSession;
   params: Params;
+  request: APIRequestContext;
 }) => void;
 
 export class Journey {

package/src/dsl/monitor.ts

@@ -31,7 +31,7 @@ import {
   Params,
   PlaywrightOptions,
 } from '../common_types';
-import { LocationsMap } from './locations';
+import { LocationsMap } from '../locations/public-locations';
 
 export type SyntheticsLocationsType = keyof typeof LocationsMap;
 export const SyntheticsLocations = Object.keys(
@@ -45,6 +45,7 @@ export type MonitorConfig = {
   schedule?: number;
   enabled?: boolean;
   locations?: SyntheticsLocationsType[];
+  privateLocations?: string[];
   throttling?: ThrottlingOptions;
   screenshot?: ScreenshotOptions;
   params?: Params;