fix: do not read configuration files unless a --config parameter is passed [Closes #407] (#426)

Author: lucasfcosta

__tests__/cli.test.ts

@@ -40,19 +40,73 @@ describe('CLI', () => {
 
   const FIXTURES_DIR = join(__dirname, 'fixtures');
 
-  it('runs inline tests', async () => {
-    const cli = new CLIMock()
-      .stdin(
-        `step('check h2', async () => {
-        await page.goto(params.url, { timeout: 1500 });
-        const sel = await page.waitForSelector('h2.synthetics', { timeout: 1500 });
-        expect(await sel.textContent()).toBe("Synthetics test page");
-      })`
-      )
-      .args(['--inline', '--params', JSON.stringify(serverParams)])
-      .run();
-    await cli.waitFor('Journey: inline');
-    expect(await cli.exitCode).toBe(0);
+  describe('for inline tests', () => {
+    it('runs inline tests', async () => {
+      const cli = new CLIMock()
+        .stdin(
+          `step('check h2', async () => {
+          await page.goto(params.url, { timeout: 1500 });
+          const sel = await page.waitForSelector('h2.synthetics', { timeout: 1500 });
+          expect(await sel.textContent()).toBe("Synthetics test page");
+        })`
+        )
+        .args(['--inline', '--params', JSON.stringify(serverParams)])
+        .run();
+      await cli.waitFor('Journey: inline');
+      expect(await cli.exitCode).toBe(0);
+    });
+
+    it('does not load a configuration file without a config param', async () => {
+      // jest by default sets NODE_ENV to `test`
+      const original = process.env['NODE_ENV'];
+      const output = async () => {
+        const cli = new CLIMock()
+          .stdin(`step('fake step', async () => {})`)
+          .args(['--reporter', 'json', '--inline'])
+          .run({ cwd: FIXTURES_DIR });
+        await cli.waitFor('journey/start');
+        expect(await cli.exitCode).toBe(0);
+        return cli.output();
+      };
+
+      expect(JSON.parse(await output()).payload).not.toMatchObject({
+        params: { url: 'non-dev' },
+      });
+      process.env['NODE_ENV'] = 'development';
+      expect(JSON.parse(await output()).payload).not.toMatchObject({
+        params: { url: 'dev' },
+      });
+      process.env['NODE_ENV'] = original;
+    });
+
+    it('loads a configuration file when passing a config param', async () => {
+      // jest by default sets NODE_ENV to `test`
+      const original = process.env['NODE_ENV'];
+      const output = async () => {
+        const cli = new CLIMock()
+          .stdin(`step('fake step', async () => {})`)
+          .args([
+            '--reporter',
+            'json',
+            '--inline',
+            '--config',
+            join(FIXTURES_DIR, 'synthetics.config.ts'),
+          ])
+          .run({ cwd: FIXTURES_DIR });
+        await cli.waitFor('journey/start');
+        expect(await cli.exitCode).toBe(0);
+        return cli.output();
+      };
+
+      expect(JSON.parse(await output()).payload).toMatchObject({
+        params: { url: 'non-dev' },
+      });
+      process.env['NODE_ENV'] = 'development';
+      expect(JSON.parse(await output()).payload).toMatchObject({
+        params: { url: 'dev' },
+      });
+      process.env['NODE_ENV'] = original;
+    });
   });
 
   it('run suites and exit with 0', async () => {
@@ -428,9 +482,9 @@ describe('CLI', () => {
           '--config',
           join(FIXTURES_DIR, 'synthetics.config.ts'),
           '--playwright-options',
-          JSON.stringify({ 
+          JSON.stringify({
             ...devices['iPad Pro 11'],
-          })
+          }),
         ])
         .run();
       await cli.waitFor('step/end');
@@ -465,13 +519,14 @@ class CLIMock {
     return this;
   }
 
-  run(): CLIMock {
+  run(spawnOverrides?: { cwd?: string }): CLIMock {
     this.process = spawn(
       'node',
       [join(__dirname, '..', 'dist', 'cli.js'), ...this.cliArgs],
       {
         env: process.env,
         stdio: 'pipe',
+        ...spawnOverrides,
       }
     );
 

src/cli.ts

@@ -126,6 +126,25 @@ async function prepareSuites(inputs: string[]) {
 }
 
 (async () => {
+  /**
+   * Transform `.ts` files out of the box by invoking
+   * the `ts-node` via `transpile-only` mode that compiles
+   * TS files without doing any extensive type checks.
+   *
+   * We must register `ts-node` _before_ loading inline
+   * scripts too because otherwise we will not be able to
+   * require `.ts` configuration files.
+   */
+  /* eslint-disable-next-line @typescript-eslint/no-var-requires */
+  require('ts-node').register({
+    transpileOnly: true,
+    compilerOptions: {
+      esModuleInterop: true,
+      allowJs: true,
+      target: 'es2018',
+    },
+  });
+
   if (options.inline) {
     const source = await readStdin();
     loadInlineScript(source);
@@ -141,20 +160,6 @@ async function prepareSuites(inputs: string[]) {
         throw new Error(`cannot find module '${name}'`);
       }
     }
-    /**
-     * Transform `.ts` files out of the box by invoking
-     * the `ts-node` via `transpile-only` mode that compiles
-     * TS files without doing any extensive type checks
-     */
-    /* eslint-disable-next-line @typescript-eslint/no-var-requires */
-    require('ts-node').register({
-      transpileOnly: true,
-      compilerOptions: {
-        esModuleInterop: true,
-        allowJs: true,
-        target: 'es2018',
-      },
-    });
     /**
      * Handle piped files by reading the STDIN
      * ex: ls example/suites/*.js | npx @elastic/synthetics
@@ -174,7 +179,10 @@ async function prepareSuites(inputs: string[]) {
   /**
    * Validate and handle configs
    */
-  const config = readConfig(environment, options.config);
+  const config =
+    options.config || !options.inline
+      ? readConfig(environment, options.config)
+      : {};
   const params = merge(config.params, options.params || {});
 
   /**
@@ -187,7 +195,7 @@ async function prepareSuites(inputs: string[]) {
       headless: options.headless,
       chromiumSandbox: options.sandbox,
       ignoreHTTPSErrors: options.ignoreHttpsErrors,
-    }
+    },
   ]);
 
   const results = await run({