githubmirror/components

scripts/run-component-tests.mts
165 строк6 KB
Ruslan Lekhman
build: convert approve-api-golden and run-component-tests scripts to .mts to support updated chalk (#31966)
02 окт 2025, 11:09
02 окт 2025, 11:093cbe5a0
#!/usr/bin/env node

/**
 * Script that simplifies the workflow of running unit tests for a component
 * using Bazel. Here are a few examples:
 *
 *   node ./scripts/run-component-tests all               | Runs tests for all components
 *   node ./scripts/run-component-tests button            | Runs Material button tests
 *   node ./scripts/run-component-tests overlay           | Runs CDK overlay tests
 *   node ./scripts/run-component-tests src/cdk/a11y      | Runs CDK a11y tests
 *   node ./scripts/run-component-tests a11y overlay      | Runs CDK a11y and overlay tests
 *
 * Supported command line flags:
 *
 *   --debug      | If specified, no browser will be launched.
 *   --firefox    | Instead of Chrome being used for tests, Firefox will be used.
 *   --no-watch   | Watch mode is enabled by default. This flag opts-out to standard Bazel.
 */

import chalk from 'chalk';
import {join, relative} from 'path';
import sh from 'shelljs';
import yargs from 'yargs';
import {guessPackageName, convertPathToPosix} from './util.mjs';

const args = process.argv.slice(2);

// Path to the directory that contains all packages.
const packagesDir = join(process.cwd(), 'src/');

// ShellJS should exit if any command fails.
sh.set('-e');

interface CliArgs {
  components: string[];
  debug: boolean;
  firefox: boolean;
  watch: boolean;
}

// Extracts the supported command line options.
const parser = yargs(args)
  .command('* <components..>', 'Run tests for specified components', args =>
    args.positional('components', {type: 'string', array: true}),
  )
  .option('debug', {
    alias: 'local',
    type: 'boolean',
    description: 'Whether test should run in debug mode. You can manually connect a browser then.',
  })
  .option('firefox', {
    type: 'boolean',
    description: 'Whether browser tests should run within Firefox.',
  })
  .option('watch', {
    type: 'boolean',
    default: true,
    description: 'Whether tests should be re-run automatically upon changes.',
  })
  .strict();

const {components, debug, firefox, watch} = parser.parseSync() as unknown as CliArgs;

// Whether tests for all components should be run.
const all = components.length === 1 && components[0] === 'all';

// We can only run a single target with "--debug". Running multiple targets within the
// same Karma server is not possible since each test target runs isolated from the others.
if (debug && (components.length > 1 || all)) {
  console.error(
    chalk.red(
      'Unable to run multiple components tests in debug mode. ' +
        'Only one component at a time can be run with "--debug"',
    ),
  );
  process.exit(1);
}

const browserName = firefox ? 'firefox' : 'chromium';
const bazelBinary = `pnpm -s ${watch ? 'ibazel' : 'bazel'}`;

// If `all` has been specified as component, we run tests for all components
// in the repository. The `--firefox` flag can be still specified.
if (all) {
  // `ibazel` doesn't allow us to filter tests and build targets as it only allows
  // a subset of Bazel flags to be passed through. We temporarily always use `bazel`
  // instead of ibazel until https://github.com/bazelbuild/bazel-watcher/pull/382 lands.
  if (watch) {
    console.warn(chalk.yellow('Unable to run all component tests in watch mode.'));
    console.warn(chalk.yellow('Tests will be run in non-watch mode..'));
  }
  sh.exec(
    `pnpm -s bazel test --test_tag_filters=-e2e,browser:${browserName} ` +
      `--build_tag_filters=browser:${browserName} --build_tests_only //src/...`,
  );
} else {
  // Exit if no component has been specified.
  if (!components.length) {
    console.error(
      chalk.red(
        'No component specified. Please either specify individual components, or pass "all" ' +
          'in order to run tests for all components.',
      ),
    );
    console.info(chalk.yellow('Below are a few examples of how the script can be run:'));
    console.info(chalk.yellow(` - pnpm test all`));
    console.info(chalk.yellow(` - pnpm test cdk/overlay material/stepper`));
    console.info(chalk.yellow(` - pnpm test button toolbar`));
    process.exit(1);
  }

  const bazelAction = debug ? 'run' : 'test';
  const testLabels = components.map(
    t => `${getBazelPackageOfComponentName(t)}:${getTargetName(t)}`,
  );

  // Runs Bazel for the determined test labels.
  sh.exec(`${bazelBinary} ${bazelAction} ${testLabels.join(' ')}`);
}
/**
 * Gets the Bazel package label for the specified component name. Throws if
 * the component could not be resolved to a Bazel package.
 */
function getBazelPackageOfComponentName(name: string) {
  // Before guessing any Bazel package, we test if the name contains the
  // package name already. If so, we just use that for Bazel package.
  const targetName =
    convertPathToBazelLabel(name) || convertPathToBazelLabel(join(packagesDir, name));
  if (targetName !== null) {
    return targetName;
  }
  // If the name does not contain an explicit package name, try to guess it.
  const guess = guessPackageName(name, packagesDir);
  const guessLabel = guess.result ? convertPathToBazelLabel(join(packagesDir, guess.result)) : null;

  if (guessLabel) {
    return guessLabel;
  }

  console.error(
    chalk.red(
      `Could not find test target for specified component: ` +
        `${chalk.yellow(name)}. Looked in packages: \n${guess.attempts.join('\n')}`,
    ),
  );
  process.exit(1);
}

/** Converts a path to a Bazel label. */
function convertPathToBazelLabel(name: string) {
  if (sh.test('-d', name)) {
    return `//${convertPathToPosix(relative(process.cwd(), name))}`;
  }
  return null;
}

/** Gets the name of the target that should be run. */
function getTargetName(packageName: string) {
  // Schematics don't have _debug and browser targets.
  if (packageName && packageName.endsWith('schematics')) {
    return 'unit_tests';
  }

  return `unit_tests_${debug ? 'debug' : browserName}`;
}