Refactor test script for improved readability and modularity #1956
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,162 +10,139 @@ const tscPath = new URL( | |
| import.meta.url, | ||
| ); | ||
|
|
||
| const normalizeLineEndings = (text: string) => text.replace(/\r\n?/g, "\n"); | ||
|
|
||
| const getFiles = (folder: URL) => { | ||
| try { | ||
| return fs.readdirSync(folder); | ||
| } catch { | ||
| return []; | ||
| } | ||
| }; | ||
|
|
||
| const readFileContent = (filePath: URL) => { | ||
| try { | ||
| return normalizeLineEndings(fs.readFileSync(filePath, "utf-8")); | ||
| } catch { | ||
| return null; | ||
| } | ||
| }; | ||
|
|
||
| const compareToBaselines = (baselineFolder: URL, outputFolder: URL) => { | ||
| const files = new Set([ | ||
| ...getFiles(baselineFolder), | ||
| ...getFiles(outputFolder), | ||
| ]); | ||
|
|
||
| for (const file of files) { | ||
| if (file.startsWith(".")) continue; | ||
|
|
||
| const baselinePath = new URL(file, baselineFolder); | ||
| const outputPath = new URL(file, outputFolder); | ||
|
|
||
| const isBaselineFile = | ||
| fs.existsSync(baselinePath) && fs.statSync(baselinePath).isFile(); | ||
|
There was a problem hiding this comment. It's actually advised to not call https://nodejs.org/docs/latest/api/fs.html#fsexistspath-callback
|
||
| const isOutputFile = | ||
| fs.existsSync(outputPath) && fs.statSync(outputPath).isFile(); | ||
|
|
||
| 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.`); | ||
| printUnifiedDiff(baseline ?? "", generated ?? ""); | ||
| return false; | ||
| } | ||
| continue; | ||
| } | ||
|
|
||
| if (fs.existsSync(baselinePath) || fs.existsSync(outputPath)) { | ||
|
There was a problem hiding this comment. This is not same as detecting directory? |
||
| if ( | ||
| !compareToBaselines( | ||
| new URL(`${file}/`, baselineFolder), | ||
| new URL(`${file}/`, outputFolder), | ||
| ) | ||
| ) { | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| return true; | ||
| }; | ||
|
|
||
| const compileGeneratedFiles = (lib: string[] | 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 ${fileArgs}`, | ||
| ); | ||
|
There was a problem hiding this comment. Skipping this would hide the actual error which would make debugging harder. |
||
| } catch { | ||
| console.error(`Test failed: could not compile '${files.join(", ")}'.`); | ||
| return false; | ||
| } | ||
| return true; | ||
| }; | ||
|
|
||
| const test = () => { | ||
| 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"], | ||
| ], | ||
| ["es5", ["sharedworker.generated.d.ts"]], | ||
| [ | ||
| "es6", | ||
| ["sharedworker.generated.d.ts", "sharedworker.iterable.generated.d.ts"], | ||
| ], | ||
| [ | ||
| "es2018", | ||
| [ | ||
| "sharedworker.generated.d.ts", | ||
| "sharedworker.asynciterable.generated.d.ts", | ||
| ], | ||
| ], | ||
| ["es5", ["serviceworker.generated.d.ts"]], | ||
| [ | ||
| "es6", | ||
| ["serviceworker.generated.d.ts", "serviceworker.iterable.generated.d.ts"], | ||
| ], | ||
| [ | ||
| "es2018", | ||
| [ | ||
| "serviceworker.generated.d.ts", | ||
| "serviceworker.asynciterable.generated.d.ts", | ||
| ], | ||
| ], | ||
| ["es5", ["audioworklet.generated.d.ts"]], | ||
| [ | ||
| "es6", | ||
| ["audioworklet.generated.d.ts", "audioworklet.iterable.generated.d.ts"], | ||
| ], | ||
| [ | ||
| "es2018", | ||
| [ | ||
| "audioworklet.generated.d.ts", | ||
| "audioworklet.asynciterable.generated.d.ts", | ||
| ], | ||
| ], | ||
| ]; | ||
|
|
||
| if ( | ||
| compareToBaselines(baselineFolder, outputFolder) && | ||
| compileSets.every(([lib, files]) => compileGeneratedFiles(lib, ...files)) | ||
| ) { | ||
| console.log("All tests passed."); | ||
| process.exit(0); | ||
| } | ||
| process.exit(1); | ||
| }; | ||
|
|
||
| test(); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We already stat the file before calling this and thus doesn't expect any error here. Thus we should skip try-catch here to see actual failures if happens.