Skip to content

Refactor test script for improved readability and modularity #1956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Apr 18, 2025
Merged

Refactor test script for improved readability and modularity #1956

Changes from 8 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
465e347
Refactor test script for improved readability and modularity
Bashamega Mar 31, 2025
74fe737
format
Bashamega Mar 31, 2025
34e146c
chore: add types
Bashamega Mar 31, 2025
d04d009
-
Bashamega Mar 31, 2025
c899c09
-
Bashamega Mar 31, 2025
414add9
-
Bashamega Mar 31, 2025
23e40c5
Switch to function
Bashamega Apr 1, 2025
81e4c8f
fix
Bashamega Apr 1, 2025
4399d1e
Merge branch 'microsoft:main' into patch-3
Bashamega Apr 18, 2025
9e2aba4
-
Bashamega Apr 18, 2025
eaddc8b
-
Bashamega Apr 18, 2025
1291a7a
Update src/test.ts
Bashamega Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 79 additions & 100 deletions src/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,85 +14,68 @@ function normalizeLineEndings(text: string): string {
return text.replace(/\r\n?/g, "\n");
}

function compareToBaselines(baselineFolder: URL, outputFolder: URL) {
let baselineFiles: string[] = [];
function getFiles(folder: URL) {
try {
baselineFiles = fs.readdirSync(baselineFolder);
return fs.readdirSync(folder);
} catch {
// do nothing
return [];
}
}

let outputFiles: string[] = [];
try {
outputFiles = fs.readdirSync(outputFolder);
} catch {
// do nothing
}
function readFileContent(filePath: URL) {
return normalizeLineEndings(fs.readFileSync(filePath, "utf-8"));
}

for (const file of new Set([...baselineFiles, ...outputFiles])) {
if (file.startsWith(".")) {
continue;
}
function compareToBaselines(baselineFolder: URL, outputFolder: URL) {
const files = new Set([
...getFiles(baselineFolder),
...getFiles(outputFolder),
]);

let baselineStats: fs.Stats | undefined;
try {
baselineStats = fs.statSync(new URL(file, baselineFolder));
} catch {
// do nothing
}
for (const file of files) {
if (file.startsWith(".")) continue;

let outputStats: fs.Stats | undefined;
try {
outputStats = fs.statSync(new URL(file, outputFolder));
} catch {
// do nothing
}
const baselinePath = new URL(file, baselineFolder);
const outputPath = new URL(file, outputFolder);

const baseline = baselineStats?.isFile()
? normalizeLineEndings(
fs.readFileSync(new URL(file, baselineFolder)).toString(),
)
: null;
const isBaselineFile =
fs.existsSync(baselinePath) && fs.statSync(baselinePath).isFile();
Copy link
Contributor

@saschanaz saschanaz Apr 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's actually advised to not call exists before other calls, because things can potentially be racy and the file can go away after that call.

https://nodejs.org/docs/latest/api/fs.html#fsexistspath-callback

Using fs.exists() to check for the existence of a file before calling fs.open(), fs.readFile(), or fs.writeFile() is not recommended. Doing so introduces a race condition, since other processes may change the file's state between the two calls. Instead, user code should open/read/write the file directly and handle the error raised if the file does not exist.

const isOutputFile =
fs.existsSync(outputPath) && fs.statSync(outputPath).isFile();

const generated = outputStats?.isFile()
? normalizeLineEndings(
fs.readFileSync(new URL(file, outputFolder)).toString(),
)
: null;
const baseline = isBaselineFile ? readFileContent(baselinePath) : null;
const generated = isOutputFile ? readFileContent(outputPath) : null;

if (baseline !== null || generated !== null) {
if (baseline !== generated) {
console.error(
`Test failed: '${file}' is different from baseline file.`,
);
console.error(`Test failed: '${file}' is different from baseline.`);
printUnifiedDiff(baseline ?? "", generated ?? "");
return false;
}

continue;
}

if (baselineStats?.isDirectory() || outputStats?.isDirectory()) {
const childBaselineFolder = new URL(`${file}/`, baselineFolder);
const childOutputFolder = new URL(`${file}/`, outputFolder);
if (!compareToBaselines(childBaselineFolder, childOutputFolder)) {
if (fs.existsSync(baselinePath)) {
if (
!compareToBaselines(
new URL(`${file}/`, baselineFolder),
new URL(`${file}/`, outputFolder),
)
) {
return false;
}

continue;
}
}
return true;
}

function compileGeneratedFiles(lib: string, ...files: string[]) {
try {
const fileArgs = files
.map((file) => fileURLToPath(new URL(file, outputFolder)))
.join(" ");
child_process.execSync(
`node ${fileURLToPath(
tscPath,
)} --strict --lib ${lib} --types --noEmit ${files
.map((file) => fileURLToPath(new URL(file, outputFolder)))
.join(" ")}`,
`node ${fileURLToPath(tscPath)} --strict --lib ${lib} --types --noEmit ${fileArgs}`,
);
} catch (e: any) {
console.error(`Test failed: could not compile '${files.join(",")}':`);
Expand All @@ -104,62 +87,58 @@ function compileGeneratedFiles(lib: string, ...files: string[]) {
}

function test() {
if (
compareToBaselines(baselineFolder, outputFolder) &&
compileGeneratedFiles("es5", "dom.generated.d.ts") &&
compileGeneratedFiles(
"es6",
"dom.generated.d.ts",
"dom.iterable.generated.d.ts",
) &&
compileGeneratedFiles(
"es2018",
"dom.generated.d.ts",
"dom.asynciterable.generated.d.ts",
) &&
compileGeneratedFiles("es5", "webworker.generated.d.ts") &&
compileGeneratedFiles(
"es6",
"webworker.generated.d.ts",
"webworker.iterable.generated.d.ts",
) &&
compileGeneratedFiles(
const compileSets = [
["es5", ["dom.generated.d.ts"]],
["es6", ["dom.generated.d.ts", "dom.iterable.generated.d.ts"]],
["es2018", ["dom.generated.d.ts", "dom.asynciterable.generated.d.ts"]],
["es5", ["webworker.generated.d.ts"]],
["es6", ["webworker.generated.d.ts", "webworker.iterable.generated.d.ts"]],
[
"es2018",
"webworker.generated.d.ts",
"webworker.asynciterable.generated.d.ts",
) &&
compileGeneratedFiles("es5", "sharedworker.generated.d.ts") &&
compileGeneratedFiles(
["webworker.generated.d.ts", "webworker.asynciterable.generated.d.ts"],
],
["es5", ["sharedworker.generated.d.ts"]],
[
"es6",
"sharedworker.generated.d.ts",
"sharedworker.iterable.generated.d.ts",
) &&
compileGeneratedFiles(
["sharedworker.generated.d.ts", "sharedworker.iterable.generated.d.ts"],
],
[
"es2018",
"sharedworker.generated.d.ts",
"sharedworker.asynciterable.generated.d.ts",
) &&
compileGeneratedFiles("es5", "serviceworker.generated.d.ts") &&
compileGeneratedFiles(
[
"sharedworker.generated.d.ts",
"sharedworker.asynciterable.generated.d.ts",
],
],
["es5", ["serviceworker.generated.d.ts"]],
[
"es6",
"serviceworker.generated.d.ts",
"serviceworker.iterable.generated.d.ts",
) &&
compileGeneratedFiles(
["serviceworker.generated.d.ts", "serviceworker.iterable.generated.d.ts"],
],
[
"es2018",
"serviceworker.generated.d.ts",
"serviceworker.asynciterable.generated.d.ts",
) &&
compileGeneratedFiles("es5", "audioworklet.generated.d.ts") &&
compileGeneratedFiles(
[
"serviceworker.generated.d.ts",
"serviceworker.asynciterable.generated.d.ts",
],
],
["es5", ["audioworklet.generated.d.ts"]],
[
"es6",
"audioworklet.generated.d.ts",
"audioworklet.iterable.generated.d.ts",
) &&
compileGeneratedFiles(
["audioworklet.generated.d.ts", "audioworklet.iterable.generated.d.ts"],
],
[
"es2018",
"audioworklet.generated.d.ts",
"audioworklet.asynciterable.generated.d.ts",
[
"audioworklet.generated.d.ts",
"audioworklet.asynciterable.generated.d.ts",
],
],
];

if (
compareToBaselines(baselineFolder, outputFolder) &&
compileSets.every(([lib, files]) =>
compileGeneratedFiles(lib as string, ...files),
)
) {
console.log("All tests passed.");
Expand Down