test: allow optional test options (#6603)

web-infra-dev · May 22, 2024 · 5b632e4 · 5b632e4 · rspack-bot · May 22, 2024
1 parent 25edcdc
commit 5b632e4
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 38 deletions.
diff --git a/packages/rspack-test-tools/etc/api.md b/packages/rspack-test-tools/etc/api.md
@@ -180,6 +180,7 @@ export function describeByWalk(testFile: string, createCase: (name: string, src:
     source?: string;
     dist?: string;
     absoluteDist?: boolean;
+    describe?: jest.Describe;
 }): void;
 
 // @public (undocumented)
@@ -449,7 +450,7 @@ export interface IBasicProcessorOptions<T extends ECompilerType> {
 }
 
 // @public (undocumented)
-export interface IBuiltinProcessorOptions<T extends ECompilerType> extends Omit<ISnapshotProcessorOptions<T>, "defaultOptions" | "runable"> {
+export interface IBuiltinProcessorOptions<T extends ECompilerType> extends Omit<ISnapshotProcessorOptions<T>, "runable"> {
 }
 
 // @public (undocumented)
@@ -469,7 +470,7 @@ export interface ICompareOptions {
 }
 
 // @public (undocumented)
-export interface IConfigProcessorOptions<T extends ECompilerType> extends Omit<IMultiTaskProcessorOptions<T>, "defaultOptions" | "overrideOptions" | "findBundle"> {
+export interface IConfigProcessorOptions<T extends ECompilerType> extends IMultiTaskProcessorOptions<T> {
 }
 
 // @public (undocumented)
@@ -487,7 +488,7 @@ export interface IDefaultsConfigProcessorOptions<T extends ECompilerType> {
 }
 
 // @public (undocumented)
-export interface IDiagnosticProcessorOptions<T extends ECompilerType> extends Omit<IBasicProcessorOptions<T>, "defaultOptions" | "runable"> {
+export interface IDiagnosticProcessorOptions<T extends ECompilerType> extends Omit<IBasicProcessorOptions<T>, "runable"> {
     // (undocumented)
     snapshot: string;
 }
@@ -593,11 +594,11 @@ export interface IFormatCodeOptions {
 }
 
 // @public (undocumented)
-export interface IHashProcessorOptions<T extends ECompilerType> extends Omit<IMultiTaskProcessorOptions<T>, "defaultOptions" | "overrideOptions" | "runable"> {
+export interface IHashProcessorOptions<T extends ECompilerType> extends Omit<IMultiTaskProcessorOptions<T>, "runable"> {
 }
 
 // @public (undocumented)
-export interface IHookProcessorOptions<T extends ECompilerType> extends Omit<ISnapshotProcessorOptions<T>, "defaultOptions"> {
+export interface IHookProcessorOptions<T extends ECompilerType> extends ISnapshotProcessorOptions<T> {
     // (undocumented)
     check?: (context: ITestContext) => Promise<void>;
     // (undocumented)
@@ -607,7 +608,7 @@ export interface IHookProcessorOptions<T extends ECompilerType> extends Omit<ISn
 }
 
 // @public (undocumented)
-export interface IHotProcessorOptions<T extends ECompilerType> extends Omit<IBasicProcessorOptions<T>, "defaultOptions" | "overrideOptions" | "runable" | "findBundle"> {
+export interface IHotProcessorOptions<T extends ECompilerType> extends Omit<IBasicProcessorOptions<T>, "runable"> {
     // (undocumented)
     target: TCompilerOptions<T>["target"];
 }
@@ -681,7 +682,7 @@ export interface IStatsAPIProcessorOptions<T extends ECompilerType> {
 }
 
 // @public (undocumented)
-export interface IStatsProcessorOptions<T extends ECompilerType> extends Omit<IMultiTaskProcessorOptions<T>, "defaultOptions" | "overrideOptions" | "runable"> {
+export interface IStatsProcessorOptions<T extends ECompilerType> extends Omit<IMultiTaskProcessorOptions<T>, "runable"> {
 }
 
 // @public (undocumented)
@@ -844,7 +845,7 @@ export interface ITestRunner {
 }
 
 // @public (undocumented)
-export interface IWatchProcessorOptions<T extends ECompilerType> extends Omit<IMultiTaskProcessorOptions<T>, "overrideOptinos" | "findBundle"> {
+export interface IWatchProcessorOptions<T extends ECompilerType> extends IMultiTaskProcessorOptions<T> {
     // (undocumented)
     experiments?: TRspackExperiments;
     // (undocumented)

diff --git a/packages/rspack-test-tools/src/helper/directory.ts b/packages/rspack-test-tools/src/helper/directory.ts
@@ -17,11 +17,13 @@ export function describeByWalk(
 		source?: string;
 		dist?: string;
 		absoluteDist?: boolean;
+		describe?: jest.Describe;
 	} = {}
 ) {
+	const describeFn = options.describe || describe;
 	const testBasename = path
 		.basename(testFile)
-		.replace(/\.(diff|hot)?test\.js/, "");
+		.replace(/\.(diff|hot)?test\.(j|t)s/, "");
 	const testId = testBasename.charAt(0).toLowerCase() + testBasename.slice(1);
 	const sourceBase =
 		options.source || path.join(path.dirname(testFile), `${testId}Cases`);
@@ -51,7 +53,7 @@ export function describeByWalk(
 					const name = escapeSep(
 						path.join(testId, caseName).split(".").shift()!
 					);
-					describe(name, () => {
+					describeFn(name, () => {
 						let source = path.join(sourceBase, caseName);
 						let dist = "";
 						if (absoluteDist) {
@@ -70,7 +72,7 @@ export function describeByWalk(
 			});
 	}
 
-	describe(testId, () => {
+	describeFn(testId, () => {
 		describeDirectory("", level);
 	});
 }
diff --git a/packages/rspack-test-tools/src/processor/builtin.ts b/packages/rspack-test-tools/src/processor/builtin.ts
@@ -6,7 +6,7 @@ import { ECompilerType, ITestContext, TCompilerOptions } from "../type";
 import { ISnapshotProcessorOptions, SnapshotProcessor } from "./snapshot";
 
 export interface IBuiltinProcessorOptions<T extends ECompilerType>
-	extends Omit<ISnapshotProcessorOptions<T>, "defaultOptions" | "runable"> {}
+	extends Omit<ISnapshotProcessorOptions<T>, "runable"> {}
 
 export class BuiltinProcessor<
 	T extends ECompilerType

diff --git a/packages/rspack-test-tools/src/processor/config.ts b/packages/rspack-test-tools/src/processor/config.ts
@@ -6,10 +6,7 @@ import { ECompilerType, ITestContext, TCompilerOptions } from "../type";
 import { IMultiTaskProcessorOptions, MultiTaskProcessor } from "./multi";
 
 export interface IConfigProcessorOptions<T extends ECompilerType>
-	extends Omit<
-		IMultiTaskProcessorOptions<T>,
-		"defaultOptions" | "overrideOptions" | "findBundle"
-	> {}
+	extends IMultiTaskProcessorOptions<T> {}
 
 export class ConfigProcessor<
 	T extends ECompilerType

diff --git a/packages/rspack-test-tools/src/processor/diagnostic.ts b/packages/rspack-test-tools/src/processor/diagnostic.ts
@@ -24,7 +24,7 @@ declare var global: {
 };
 
 export interface IDiagnosticProcessorOptions<T extends ECompilerType>
-	extends Omit<IBasicProcessorOptions<T>, "defaultOptions" | "runable"> {
+	extends Omit<IBasicProcessorOptions<T>, "runable"> {
 	snapshot: string;
 }
 

diff --git a/packages/rspack-test-tools/src/processor/hash.ts b/packages/rspack-test-tools/src/processor/hash.ts
@@ -7,10 +7,7 @@ import {
 import { IMultiTaskProcessorOptions, MultiTaskProcessor } from "./multi";
 
 export interface IHashProcessorOptions<T extends ECompilerType>
-	extends Omit<
-		IMultiTaskProcessorOptions<T>,
-		"defaultOptions" | "overrideOptions" | "runable"
-	> {}
+	extends Omit<IMultiTaskProcessorOptions<T>, "runable"> {}
 
 const REG_ERROR_CASE = /error$/;
 

diff --git a/packages/rspack-test-tools/src/processor/hook.ts b/packages/rspack-test-tools/src/processor/hook.ts
@@ -176,7 +176,7 @@ export class HookCasesContext extends TestContext {
 }
 
 export interface IHookProcessorOptions<T extends ECompilerType>
-	extends Omit<ISnapshotProcessorOptions<T>, "defaultOptions"> {
+	extends ISnapshotProcessorOptions<T> {
 	options?: (context: ITestContext) => TCompilerOptions<T>;
 	compiler?: (context: ITestContext, compiler: TCompiler<T>) => Promise<void>;
 	check?: (context: ITestContext) => Promise<void>;

diff --git a/packages/rspack-test-tools/src/processor/hot.ts b/packages/rspack-test-tools/src/processor/hot.ts
@@ -12,10 +12,7 @@ import {
 import { BasicProcessor, IBasicProcessorOptions } from "./basic";
 
 export interface IHotProcessorOptions<T extends ECompilerType>
-	extends Omit<
-		IBasicProcessorOptions<T>,
-		"defaultOptions" | "overrideOptions" | "runable" | "findBundle"
-	> {
+	extends Omit<IBasicProcessorOptions<T>, "runable"> {
 	target: TCompilerOptions<T>["target"];
 }
 

diff --git a/packages/rspack-test-tools/src/processor/stats.ts b/packages/rspack-test-tools/src/processor/stats.ts
@@ -15,10 +15,7 @@ import {
 import { IMultiTaskProcessorOptions, MultiTaskProcessor } from "./multi";
 
 export interface IStatsProcessorOptions<T extends ECompilerType>
-	extends Omit<
-		IMultiTaskProcessorOptions<T>,
-		"defaultOptions" | "overrideOptions" | "runable"
-	> {}
+	extends Omit<IMultiTaskProcessorOptions<T>, "runable"> {}
 
 const REG_ERROR_CASE = /error$/;
 const quoteMeta = (str: string) => {

diff --git a/packages/rspack-test-tools/src/processor/treeshaking.ts b/packages/rspack-test-tools/src/processor/treeshaking.ts
@@ -3,10 +3,7 @@ import { BuiltinProcessor } from "./builtin";
 import { ISnapshotProcessorOptions, SnapshotProcessor } from "./snapshot";
 
 export interface ITreeShakingProcessorOptions<T extends ECompilerType>
-	extends Omit<
-		ISnapshotProcessorOptions<T>,
-		"defaultOptions" | "overrideOptions" | "runable"
-	> {}
+	extends Omit<ISnapshotProcessorOptions<T>, "runable"> {}
 
 export class TreeShakingProcessor<
 	T extends ECompilerType

diff --git a/packages/rspack-test-tools/src/processor/watch.ts b/packages/rspack-test-tools/src/processor/watch.ts
@@ -21,10 +21,7 @@ type TRspackExperiments = TCompilerOptions<ECompilerType>["experiments"];
 type TRspackOptimization = TCompilerOptions<ECompilerType>["optimization"];
 
 export interface IWatchProcessorOptions<T extends ECompilerType>
-	extends Omit<
-		IMultiTaskProcessorOptions<T>,
-		"overrideOptinos" | "findBundle"
-	> {
+	extends IMultiTaskProcessorOptions<T> {
 	stepName: string;
 	tempDir: string;
 	experiments?: TRspackExperiments;
suite	result
modernjs	✅ success
_selftest	✅ success
nx	✅ success
rspress	✅ success
rsbuild	✅ success
compat	✅ success
examples	✅ success
Name	Base (2024-05-22 c7db90a)	Current	Change
10000_development-mode + exec	2.66 s ± 36 ms	2.55 s ± 32 ms	-4.19 %
10000_development-mode_hmr + exec	740 ms ± 16 ms	697 ms ± 8 ms	-5.78 %
10000_production-mode + exec	2.57 s ± 28 ms	2.44 s ± 14 ms	-5.36 %
arco-pro_development-mode + exec	2.54 s ± 37 ms	2.38 s ± 69 ms	-6.31 %
arco-pro_development-mode_hmr + exec	438 ms ± 3.2 ms	438 ms ± 1.7 ms	-0.10 %
arco-pro_development-mode_hmr_intercept-plugin + exec	447 ms ± 2.1 ms	447 ms ± 1.6 ms	+0.02 %
arco-pro_development-mode_intercept-plugin + exec	3.37 s ± 73 ms	3.14 s ± 76 ms	-6.91 %
arco-pro_production-mode + exec	4.1 s ± 66 ms	3.89 s ± 96 ms	-5.08 %
arco-pro_production-mode_intercept-plugin + exec	4.95 s ± 75 ms	4.63 s ± 101 ms	-6.36 %
threejs_development-mode_10x + exec	2 s ± 17 ms	1.95 s ± 24 ms	-2.95 %
threejs_development-mode_10x_hmr + exec	785 ms ± 7.1 ms	770 ms ± 5.8 ms	-1.91 %
threejs_production-mode_10x + exec	5.33 s ± 36 ms	5.12 s ± 57 ms	-3.90 %