chore: restructure to add sub commands to cli (#475)

* chore: restructure to add sub commands to cli

* remove snapshot and keep test local

* address review comments

* add quiet exit code back

Author: vigneshshanmugam

__tests__/cli.test.ts

@@ -29,6 +29,16 @@ import { devices } from 'playwright-chromium';
 import { Server } from './utils/server';
 import { megabitsToBytes, DEFAULT_NETWORK_CONDITIONS } from '../src/helpers';
 
+const safeParse = (chunks: string[]) => {
+  return chunks.map(data => {
+    try {
+      return JSON.parse(data);
+    } catch (e) {
+      throw `Error ${e} could not parse data '${data}'`;
+    }
+  });
+};
+
 describe('CLI', () => {
   let server: Server;
   let serverParams: { url: string };
@@ -178,23 +188,20 @@ describe('CLI', () => {
       .run();
     await cli.waitFor('journey/end');
 
-    const screenshotRef = cli
-      .buffer()
-      .map(data => JSON.parse(data))
-      .find(({ type }) => type === 'step/screenshot_ref');
+    const data = safeParse(cli.buffer());
+    const screenshotRef = data.find(
+      ({ type }) => type === 'step/screenshot_ref'
+    );
     expect(screenshotRef).toBeDefined();
 
-    const networkData = cli
-      .buffer()
-      .map(data => JSON.parse(data))
-      .find(({ type }) => type === 'journey/network_info');
+    const networkData = data.find(
+      ({ type }) => type === 'journey/network_info'
+    );
     expect(networkData).toBeDefined();
 
-    const traceData = cli
-      .buffer()
-      .map(data => JSON.parse(data))
-      .find(({ type }) => type === 'step/metrics');
+    const traceData = data.find(({ type }) => type === 'step/metrics');
     expect(traceData).toBeDefined();
+
     expect(await cli.exitCode).toBe(0);
   }, 30000);
 
@@ -226,13 +233,7 @@ describe('CLI', () => {
       ])
       .run();
     await cli.waitFor('journey/end');
-    const data = cli.buffer().map(data => {
-      try {
-        return JSON.parse(data);
-      } catch (e) {
-        throw `Error ${e} could not parse data '${data}'`;
-      }
-    });
+    const data = safeParse(cli.buffer());
     const screenshotRef = data.find(
       ({ type }) => type === 'step/screenshot_ref'
     );

__tests__/index.test.ts

@@ -25,8 +25,6 @@
 
 import fs from 'fs';
 import { run, journey } from '../src/index';
-import { runner } from '../src/core';
-import { RunOptions } from '../src/core/runner';
 import { generateTempPath } from '../src/helpers';
 
 describe('Run', () => {
@@ -54,28 +52,4 @@ describe('Run', () => {
       {},
     ]);
   });
-
-  it('calls runner with proper options', async () => {
-    const runnerSpy = jest
-      .spyOn(runner, 'run')
-      .mockImplementation(() => Promise.resolve({}));
-
-    const options: RunOptions = {
-      environment: 'debug',
-      params: {
-        foo: 'bar',
-      },
-      screenshots: 'on',
-      filmstrips: false,
-      trace: false,
-      dryRun: true,
-      match: 'check*',
-      network: true,
-      pauseOnError: true,
-      quietExitCode: true,
-      reporter: 'json',
-    };
-    await run(options);
-    expect(runnerSpy.mock.calls[0][0]).toEqual(options);
-  });
 });

__tests__/options.test.ts

@@ -0,0 +1,75 @@
+/**
+ * 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 { CliArgs } from '../src/common_types';
+import { normalizeOptions } from '../src/options';
+import { join } from 'path';
+
+describe('options', () => {
+  it('normalize', async () => {
+    const cliArgs: CliArgs = {
+      params: {
+        foo: 'bar',
+      },
+      headless: true,
+      sandbox: false,
+      screenshots: 'on',
+      dryRun: true,
+      match: 'check*',
+      pauseOnError: true,
+      config: join(__dirname, 'fixtures', 'synthetics.config.ts'),
+    };
+    expect(normalizeOptions({})).toMatchObject({
+      environment: 'test',
+      params: {},
+    });
+    expect(normalizeOptions(cliArgs)).toMatchObject({
+      dryRun: true,
+      environment: 'test',
+      match: 'check*',
+      params: {
+        foo: 'bar',
+        url: 'non-dev',
+      },
+      pauseOnError: true,
+      playwrightOptions: {
+        chromiumSandbox: false,
+        defaultBrowserType: 'chromium',
+        deviceScaleFactor: 4.5,
+        hasTouch: true,
+        headless: true,
+        ignoreHTTPSErrors: undefined,
+        isMobile: true,
+        userAgent:
+          'Mozilla/5.0 (Linux; Android 8.0.0; SM-G965U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4595.0 Mobile Safari/537.36',
+        viewport: {
+          height: 658,
+          width: 320,
+        },
+      },
+      screenshots: 'on',
+    });
+  });
+});