9066ca9e92
This commit allows compliance test-cases to be written that specify source-map mappings between the source and generated code. To check a mapping, add a `// SOURCE:` comment to the end of a line: ``` <generated code> // SOURCE: "<source-url>" <source code> ``` The generated code will still be checked, stripped of the `// SOURCE` comment, as normal by the `expectEmit()` helper. In addition, the source-map segments are checked to ensure that there is a mapping from `<generated code>` to `<source code>` found in the file at `<source-url>`. Note: * The source-url should be absolute, with the directory containing the TEST_CASES.json file assumed to be `/`. * Whitespace is important and will be included when comparing the segments. * There is a single space character between each part of the line. * Newlines within a mapping must be escaped since the mapping and comment must all appear on a single line of this file. PR Close #39939
111 lines
4.4 KiB
TypeScript
111 lines
4.4 KiB
TypeScript
/**
|
|
* @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.io/license
|
|
*/
|
|
import {PluginObj, transformSync} from '@babel/core';
|
|
|
|
import {createEs2015LinkerPlugin} from '../../../linker/babel';
|
|
import {AbsoluteFsPath, FileSystem} from '../../../src/ngtsc/file_system';
|
|
import {ConsoleLogger, LogLevel} from '../../../src/ngtsc/logging';
|
|
import {MapAndPath, RawSourceMap, SourceFileLoader} from '../../../src/ngtsc/sourcemaps';
|
|
import {CompileResult, getBuildOutputDirectory} from '../test_helpers/compile_test';
|
|
import {ComplianceTest} from '../test_helpers/get_compliance_tests';
|
|
import {parseGoldenPartial} from '../test_helpers/golden_partials';
|
|
import {runTests} from '../test_helpers/test_runner';
|
|
|
|
runTests('linked compile', linkPartials);
|
|
|
|
/**
|
|
* Link all the partials specified in the given `test`.
|
|
*
|
|
* @param fs The mock file-system to use for linking the partials.
|
|
* @param test The compliance test whose partials will be linked.
|
|
*/
|
|
function linkPartials(fs: FileSystem, test: ComplianceTest): CompileResult {
|
|
const logger = new ConsoleLogger(LogLevel.debug);
|
|
const loader = new SourceFileLoader(fs, logger, {});
|
|
const builtDirectory = getBuildOutputDirectory(fs);
|
|
const linkerPlugin = createEs2015LinkerPlugin({
|
|
// By default we don't render legacy message ids in compliance tests.
|
|
enableI18nLegacyMessageIdFormat: false,
|
|
...test.angularCompilerOptions
|
|
});
|
|
const goldenPartialPath = fs.resolve('/GOLDEN_PARTIAL.js');
|
|
if (!fs.exists(goldenPartialPath)) {
|
|
throw new Error(
|
|
'Golden partial does not exist for this test\n' +
|
|
'Try generating it by running:\n' +
|
|
`bazel run //packages/compiler-cli/test/compliance/test_cases:${
|
|
test.relativePath}.golden.update`);
|
|
}
|
|
const partialFile = fs.readFile(goldenPartialPath);
|
|
const partialFiles = parseGoldenPartial(partialFile);
|
|
|
|
partialFiles.forEach(f => safeWrite(fs, fs.resolve(builtDirectory, f.path), f.content));
|
|
|
|
for (const expectation of test.expectations) {
|
|
for (const {generated: fileName} of expectation.files) {
|
|
const partialPath = fs.resolve(builtDirectory, fileName);
|
|
if (!fs.exists(partialPath)) {
|
|
continue;
|
|
}
|
|
const source = fs.readFile(partialPath);
|
|
const sourceMapPath = fs.resolve(partialPath + '.map');
|
|
const sourceMap =
|
|
fs.exists(sourceMapPath) ? JSON.parse(fs.readFile(sourceMapPath)) : undefined;
|
|
const {linkedSource, linkedSourceMap} =
|
|
applyLinker({fileName, source, sourceMap}, linkerPlugin);
|
|
|
|
if (linkedSourceMap !== undefined) {
|
|
const mapAndPath: MapAndPath = {map: linkedSourceMap, mapPath: sourceMapPath};
|
|
const sourceFile = loader.loadSourceFile(partialPath, linkedSource, mapAndPath);
|
|
safeWrite(fs, sourceMapPath, JSON.stringify(sourceFile.renderFlattenedSourceMap()));
|
|
}
|
|
safeWrite(fs, partialPath, linkedSource);
|
|
}
|
|
}
|
|
return {emittedFiles: [], errors: []};
|
|
}
|
|
|
|
/**
|
|
* Run the file through the Babel linker plugin.
|
|
*
|
|
* It will ignore files that do not have a `.js` extension.
|
|
*
|
|
* @param file The file name and its source to be transformed using the linker.
|
|
* @param linkerPlugin The linker plugin to apply.
|
|
* @returns The file's source content, which has been transformed using the linker if necessary.
|
|
*/
|
|
function applyLinker(
|
|
file: {fileName: string; source: string, sourceMap: RawSourceMap | undefined},
|
|
linkerPlugin: PluginObj): {linkedSource: string, linkedSourceMap: RawSourceMap|undefined} {
|
|
if (!file.fileName.endsWith('.js')) {
|
|
return {linkedSource: file.source, linkedSourceMap: file.sourceMap};
|
|
}
|
|
const result = transformSync(file.source, {
|
|
filename: file.fileName,
|
|
sourceMaps: !!file.sourceMap,
|
|
plugins: [linkerPlugin],
|
|
parserOpts: {sourceType: 'unambiguous'},
|
|
});
|
|
if (result === null) {
|
|
throw fail('Babel transform did not have output');
|
|
}
|
|
if (result.code == null) {
|
|
throw fail('Babel transform result does not have any code');
|
|
}
|
|
return {linkedSource: result.code, linkedSourceMap: result.map || undefined};
|
|
}
|
|
|
|
/**
|
|
* Write the `content` to the `path` on the `fs` file-system, first ensuring that the containing
|
|
* directory exists.
|
|
*/
|
|
function safeWrite(fs: FileSystem, path: AbsoluteFsPath, content: string): void {
|
|
fs.ensureDir(fs.dirname(path));
|
|
fs.writeFile(path, content);
|
|
}
|