angular/packages/compiler-cli/test/compliance/test_helpers/test_runner.ts

/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */
import {FileSystem} from '../../../src/ngtsc/file_system';

import {checkErrors, checkNoUnexpectedErrors} from './check_errors';
import {checkExpectations} from './check_expectations';
import {checkTypeDeclarations} from './check_type_declarations';
import {CompileResult, initMockTestFileSystem} from './compile_test';
import {
  CompilationMode,
  ComplianceTest,
  Expectation,
  getAllComplianceTests,
} from './get_compliance_tests';

function transformExpectation(expectation: Expectation, isLocalCompilation: boolean): void {
  expectation.files = expectation.files.map((pair) => ({
    expected: pair.expected,
    generated: pair.generated,
  }));

  if (isLocalCompilation) {
    expectation.files = expectation.files.map((pair) => ({
      expected: getFilenameForLocalCompilation(pair.expected),
      generated: pair.generated,
    }));
  }
}

/** Adds a '.local' pre-extension, e.g., basic_full.js -> basic_full.local.js */
function getFilenameForLocalCompilation(fileName: string): string {
  return fileName.replace(/\.([cm]?js)$/, '.local.$1');
}

/**
 * Set up jasmine specs for each of the compliance tests.
 *
 * @param type A description of the type of tests being run.
 * @param compileFn The function that will do the compilation of the source files
 * @param options Extra options. Currently the only option is the flag `isLocalCompilation` which
 *     indicates whether we are testing in local compilation mode.
 */
export function runTests(
  type: CompilationMode,
  compileFn: (fs: FileSystem, test: ComplianceTest) => CompileResult,
  options: {
    isLocalCompilation?: boolean;
    emitDeclarationOnly?: boolean;
    skipMappingChecks?: boolean;
  } = {},
) {
  describe(`compliance tests (${type})`, () => {
    let counter = 0;
    for (const test of getAllComplianceTests()) {
      if (!test.compilationModeFilter.includes(type)) {
        continue;
      }
      if (test.skipForTemplatePipeline) {
        continue;
      }

      describe(`[${test.relativePath}]/${counter++}`, () => {
        const itFn = test.focusTest ? fit : test.excludeTest ? xit : it;
        itFn(test.description, () => {
          if (type === 'linked compile' && test.compilerOptions?.['target'] === 'ES5') {
            throw new Error(
              `The "${type}" scenario does not support ES5 output.\n` +
                `Did you mean to set \`"compilationModeFilter": ["full compile"]\` in "${test.relativePath}"?`,
            );
          }

          const fs = initMockTestFileSystem(test.realTestPath);
          const {errors, emittedFiles} = compileFn(fs, test);
          for (const expectation of test.expectations) {
            transformExpectation(expectation, !!options.isLocalCompilation);
            if (expectation.expectedErrors.length > 0) {
              checkErrors(
                test.relativePath,
                expectation.failureMessage,
                expectation.expectedErrors,
                errors,
              );
            } else if (!!options.emitDeclarationOnly) {
              checkNoUnexpectedErrors(test.relativePath, errors);
              checkTypeDeclarations(fs, emittedFiles);
            } else {
              checkNoUnexpectedErrors(test.relativePath, errors);
              checkExpectations(
                fs,
                test.relativePath,
                expectation.failureMessage,
                expectation.files,
                expectation.extraChecks,
                options.skipMappingChecks,
              );
            }
          }
        });
      });
    }
  });
}