Add the silent option to tests

Author: leeyi45

lib/buildtools/src/commands/__tests__/testing.test.ts

@@ -1,9 +1,10 @@
 import pathlib from 'path';
+import { Command } from '@commander-js/extra-typings';
 import { describe, expect, test, vi } from 'vitest';
 import { testMocksDir } from '../../__tests__/fixtures.js';
 import * as runner from '../../testing/runner.js';
 import * as configs from '../../testing/utils.js';
-import { getTestCommand } from '../testing.js';
+import { getTestCommand, silentOption } from '../testing.js';
 import { getCommandRunner } from './testingUtils.js';
 
 vi.spyOn(process, 'cwd').mockReturnValue(testMocksDir);
@@ -29,7 +30,15 @@ describe('Test regular test command', () => {
 
     await expect(runCommand('--project', projectPath, filterPath)).commandSuccess();
     expect(configs.getTestConfiguration).toHaveBeenCalledExactlyOnceWith(projectPath, false);
-    expect(runner.runVitest).toHaveBeenCalledExactlyOnceWith('test', [filterPath], [mockConfig.config], { allowOnly: expect.any(Boolean) });
+    expect(runner.runVitest).toHaveBeenCalledExactlyOnceWith(
+      'test',
+      [filterPath],
+      [mockConfig.config],
+      {
+        allowOnly: expect.any(Boolean),
+        silent: 'passed-only'
+      }
+    );
   });
 
   test('Providing both the project directory but no patterns', async () => {
@@ -47,7 +56,15 @@ describe('Test regular test command', () => {
 
     await expect(runCommand('--project', projectPath)).commandSuccess();
     expect(configs.getTestConfiguration).toHaveBeenCalledExactlyOnceWith(projectPath, false);
-    expect(runner.runVitest).toHaveBeenCalledExactlyOnceWith('test', [], [mockConfig.config], { allowOnly: expect.any(Boolean) });
+    expect(runner.runVitest).toHaveBeenCalledExactlyOnceWith(
+      'test',
+      [],
+      [mockConfig.config],
+      {
+        allowOnly: expect.any(Boolean),
+        silent: 'passed-only'
+      }
+    );
   });
 
   test('Expect command to exit with no issues if no tests were found', async () => {
@@ -81,7 +98,10 @@ describe('Test regular test command', () => {
       'test',
       [],
       [mockConfig.config],
-      { allowOnly: false }
+      {
+        allowOnly: false,
+        silent: 'passed-only'
+      }
     );
   });
 
@@ -103,10 +123,63 @@ describe('Test regular test command', () => {
         'test',
         [],
         [mockConfig.config],
-        { allowOnly: false }
+        {
+          allowOnly: false,
+          silent: 'passed-only'
+        }
       );
     } finally {
       vi.unstubAllEnvs();
     }
   });
 });
+
+describe('Test silent option', () => {
+  const runCommand = (...args: string[]) => new Promise<undefined | boolean | 'passed-only'>(
+    (resolve, reject) => {
+      const command = new Command()
+        .exitOverride()
+        .addOption(silentOption)
+        .action(option => {
+          resolve(option.silent);
+        });
+
+      try {
+        command.parse(args, { from: 'user' });
+      } catch (error) {
+        reject(error);
+      }
+    }
+  );
+
+  test('running command without option', async () => {
+    const value = await runCommand();
+    expect(value).toEqual('passed-only');
+  });
+
+  test('running command with without value', async () => {
+    const value = await runCommand('--silent');
+    expect(value).toEqual(true);
+  });
+
+  test('running command with \'true\'', async () => {
+    const value = await runCommand('--silent', 'true');
+    expect(value).toEqual(true);
+  });
+
+  test('running command with \'false\'', async () => {
+    const value = await runCommand('--silent', 'false');
+    expect(value).toEqual(false);
+  });
+
+  test('running command with \'passed-only\'', async () => {
+    const value = await runCommand('--silent', 'passed-only');
+    expect(value).toEqual('passed-only');
+  });
+
+  test('running command with invalid option', () => {
+    return expect(runCommand('--silent', 'unknown'))
+      .rejects
+      .toThrowError('Invalid value for silent: unknown');
+  });
+});

lib/buildtools/src/commands/testing.ts

@@ -1,5 +1,5 @@
 import pathlib from 'path';
-import { Command, Option } from '@commander-js/extra-typings';
+import { Command, InvalidOptionArgumentError, Option } from '@commander-js/extra-typings';
 import { gitRoot } from '@sourceacademy/modules-repotools/getGitRoot';
 import chalk from 'chalk';
 import type { VitestRunMode } from 'vitest/node';
@@ -13,14 +13,32 @@ const vitestModeOption = new Option('--mode <mode>', 'Vitest Run Mode. See https
 
 const watchOption = new Option('-w, --watch', 'Run tests in watch mode');
 const updateOption = new Option('-u, --update', 'Update snapshots');
-const coverageOption = new Option('--coverage');
+const coverageOption = new Option('--coverage', 'Run coverage testing');
+
+export const silentOption = new Option('--silent [option]', 'Silent mode')
+  .choices(['passed-only', 'false', 'true'] as const)
+  .argParser(value => {
+    switch (value) {
+      case 'passed-only':
+        return 'passed-only';
+      case 'false':
+        return false;
+      case 'true':
+      case undefined:
+        return true;
+      default:
+        throw new InvalidOptionArgumentError(`Invalid value for silent: ${value}`);
+    }
+  })
+  .default('passed-only');
 
 export const getTestCommand = () => new Command('test')
   .description('Run test for the specific bundle or tab at the specified directory.')
   .addOption(vitestModeOption)
   .addOption(watchOption)
   .addOption(updateOption)
   .addOption(coverageOption)
+  .addOption(silentOption)
   .option('--no-allow-only', 'Allow the use of .only in tests', !process.env.CI)
   .option('-p, --project <directory>', 'Path to the directory that is the root of your test project')
   .argument('[patterns...]', 'Test patterns to filter by.')
@@ -55,6 +73,7 @@ export const getTestAllCommand = () => new Command('testall')
   .addOption(watchOption)
   .addOption(updateOption)
   .addOption(coverageOption)
+  .addOption(silentOption)
   .option('--no-allow-only', 'Allow the use of .only in tests', !process.env.CI)
   .action(async (patterns, { mode, ...options }) => {
     const configs = await getAllTestConfigurations(!!options.watch);

lib/buildtools/src/testing/runner.ts

@@ -7,6 +7,7 @@ interface RunVitestBoolOptions {
   coverage?: boolean;
   update?: boolean;
   allowOnly?: boolean;
+  silent?: boolean | 'passed-only';
 }
 
 function getIncludes({ test }: TestProjectInlineConfiguration) {
@@ -43,6 +44,7 @@ export async function runVitest(mode: VitestRunMode, filters: string[], projects
       },
       allowOnly: !!options.allowOnly,
       watch: !!options.watch,
+      silent: options.silent
     };
 
     const finalConfig = mergeConfig(

vitest.config.js

@@ -56,6 +56,6 @@ export default defineConfig({
         `${import.meta.dirname}/lib/buildtools/src/build/docs/drawdown.ts`
       ]
     },
-    silent: 'passed-only',
+    silent: 'passed-only'
   }
 });