Add --quiet-exit-code and make it default --rich-events behavior

__tests__/cli.test.ts

@@ -41,6 +41,15 @@ describe('CLI', () => {
     expect(await cli.exitCode).toBe(1);
   });
 
+  it('runs the suites with --quiet-exit-code, always exiting with 0', async () => {
+    const cli = new CLIMock([
+      join(FIXTURES_DIR, 'error.journey.ts'),
+      '--quiet-exit-code',
+    ]);
+    await cli.waitFor('boom');
+    expect(await cli.exitCode).toBe(0);
+  });
+
   it('produce json output  --json and reporter=json flag', async () => {
     const output = async args => {
       const cli = new CLIMock([join(FIXTURES_DIR, 'fake.journey.ts'), ...args]);
@@ -77,6 +86,7 @@ describe('CLI', () => {
   it('mimick new heartbeat with `--rich-events` flag', async () => {
     const cli = new CLIMock([
       join(FIXTURES_DIR, 'fake.journey.ts'),
+      join(FIXTURES_DIR, 'error.journey.ts'),
       '--rich-events',
     ]);
     await cli.waitFor('journey/end');
@@ -94,7 +104,7 @@ describe('CLI', () => {
     });
 
     expect(await cli.exitCode).toBe(0);
-  });
+  }, 30);
 
   it('override screenshots with `--rich-events` flag', async () => {
     const cli = new CLIMock([

__tests__/index.test.ts

@@ -72,6 +72,7 @@ describe('Run', () => {
       match: 'check*',
       network: true,
       pauseOnError: true,
+      quietExitCode: true,
       reporter: 'json',
     };
     await run(options);

src/cli.ts

@@ -194,12 +194,14 @@ async function prepareSuites(inputs: string[]) {
     ...options,
   });
 
-  /**
-   * Exit with error status if any journey fails
-   */
-  for (const result of Object.values(results)) {
-    if (result.status === 'failed') {
-      process.exit(1);
+  if (!options.quietExitCode) {
+    /**
+     * Exit with error status if any journey fails
+     */
+    for (const result of Object.values(results)) {
+      if (result.status === 'failed') {
+        process.exit(1);
+      }
     }
   }
 })().catch(e => {

src/common_types.ts

@@ -130,6 +130,7 @@ export type CliArgs = {
   dryRun?: boolean;
   network?: boolean;
   pauseOnError?: boolean;
+  quietExitCode?: boolean;
   reporter?: Reporters;
   wsEndpoint?: string;
   sandbox?: boolean;

src/parse_args.ts

@@ -98,6 +98,10 @@ program
     '--pause-on-error',
     'pause on error until a keypress is made in the console. Useful during development'
   )
+  .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'
+  )
   .version(version)
   .description('Run synthetic tests');
 
@@ -112,6 +116,7 @@ if (options.richEvents) {
   options.reporter = options.reporter ?? 'json';
   options.ssblocks = true;
   options.network = true;
+  options.quietExitCode = true;
 }
 
 if (options.capability) {