@rstest/core 0.7.2 → 0.7.4

package/dist/worker.d.ts

@@ -13,11 +13,7 @@ declare function addSerializer(plugin: Plugin_2): void;
 
 declare type AfterAllListener = (ctx: SuiteContext) => MaybePromise<void>;
 
-declare type AfterEachListener = (params: {
-    task: {
-        result: Readonly<TestResult>;
-    };
-}) => MaybePromise<void>;
+declare type AfterEachListener = (ctx: TestContext) => MaybePromise<void>;
 
 declare interface Assertion<T = any> extends VitestAssertion<Chai.Assertion, T>, JestAssertion<T>, Matchers<T> {
     	/**
@@ -246,7 +242,7 @@ declare type AsyncExpectationResult = Promise<SyncExpectationResult>;
 
 declare type BeforeAllListener = (ctx: SuiteContext) => MaybePromise<void | AfterAllListener>;
 
-declare type BeforeEachListener = () => MaybePromise<void | AfterEachListener>;
+declare type BeforeEachListener = (ctx: TestContext) => MaybePromise<void | AfterEachListener>;
 
 declare interface BranchMapping {
     loc: Range_2;
@@ -319,6 +315,59 @@ declare interface Constructable {
     	new (...args: any[]): any;
 }
 
+/**
+ * Base class for writing content
+ */
+declare class ContentWriter {
+    /**
+     * returns the colorized version of a string. Typically,
+     * content writers that write to files will return the
+     * same string and ones writing to a tty will wrap it in
+     * appropriate escape sequences.
+     */
+    colorize(str: string, clazz?: string): string;
+    /**
+     * writes a string appended with a newline to the destination
+     */
+    println(str: string): void;
+    /**
+     * closes this content writer. Should be called after all writes are complete.
+     */
+    close(): void;
+}
+
+declare interface Context {
+    data: any;
+    dir: string;
+    sourceFinder(filepath: string): string;
+    watermarks: Watermarks;
+    writer: FileWriter;
+    /**
+     * returns the coverage class given a coverage
+     * types and a percentage value.
+     */
+    classForPercent(type: keyof Watermarks, value: number): string;
+    /**
+     * returns the source code for the specified file path or throws if
+     * the source could not be found.
+     */
+    getSource(filepath: string): string;
+    getTree(summarizer?: Summarizers): Tree;
+    /**
+     * returns a full visitor given a partial one.
+     */
+    getVisitor<N extends Node_2 = Node_2>(visitor: Partial<Visitor<N>>): Visitor<N>;
+    /**
+     * returns a FileWriter implementation for reporting use. Also available
+     * as the `writer` property on the context.
+     */
+    getWriter(): FileWriter;
+    /**
+     * returns an XML writer for the supplied content writer
+     */
+    getXmlWriter(contentWriter: ContentWriter): XmlWriter;
+}
+
 declare class CounterMap<K> extends DefaultMap<K, number> {
     	constructor();
     	// compat for jest-image-snapshot https://github.com/vitest-dev/vitest/issues/7322
@@ -378,7 +427,7 @@ declare type CoverageOptions = {
      * The reporters to use for coverage collection.
      * @default ['text', 'html', 'clover', 'json']
      */
-    reporters?: (keyof ReportOptions | ReportWithOptions)[];
+    reporters?: (keyof ReportOptions | ReportWithOptions | ReportBase)[];
     /**
      * The directory to store coverage reports.
      * @default './coverage'
@@ -497,12 +546,13 @@ declare class DefaultReporter implements Reporter {
     onTestCaseResult(): void;
     onUserConsoleLog(log: UserConsoleLog): void;
     onExit(): Promise<void>;
-    onTestRunEnd({ results, testResults, duration, getSourcemap, snapshotSummary, filterRerunTestPaths, }: {
+    onTestRunEnd({ results, testResults, duration, getSourcemap, snapshotSummary, filterRerunTestPaths, unhandledErrors, }: {
         results: TestFileResult[];
         testResults: TestResult[];
         duration: Duration;
         snapshotSummary: SnapshotSummary;
         getSourcemap: GetSourcemap;
+        unhandledErrors?: Error[];
         filterRerunTestPaths?: string[];
     }): Promise<void>;
 }
@@ -680,6 +730,29 @@ declare interface FileOptions {
     file: string;
 }
 
+/**
+ * utility for writing files under a specific directory
+ */
+declare class FileWriter {
+    constructor(baseDir: string);
+    static startCapture(): void;
+    static stopCapture(): void;
+    static getOutput(): string;
+    static resetOutput(): void;
+    /**
+     * returns a FileWriter that is rooted at the supplied subdirectory
+     */
+    writeForDir(subdir: string): FileWriter;
+    /**
+     * copies a file from a source directory to a destination name
+     */
+    copyFile(source: string, dest: string, header?: string): void;
+    /**
+     * returns a content writer for writing content to the supplied file.
+     */
+    writeFile(file: string | null): ContentWriter;
+}
+
 declare type Fixture<T, K extends keyof T, ExtraContext = object> = ((...args: any) => any) extends T[K] ? T[K] extends any ? FixtureFn<T, K, Omit<ExtraContext, Exclude<keyof T, K>>> : never : T[K] | (T[K] extends any ? FixtureFn<T, K, Omit<ExtraContext, Exclude<keyof T, K>>> : never);
 
 declare type FixtureFn<T, K extends keyof T, ExtraContext> = (context: Omit<T, K> & ExtraContext, use: Use<T[K]>) => Promise<void>;
@@ -1213,7 +1286,12 @@ declare interface LinkMapper {
     assetPath(node: Node_2, name: string): string;
 }
 
-declare interface Location_2 {
+declare type Location_2 = {
+    line: number;
+    column: number;
+};
+
+declare interface Location_3 {
     line: number;
     column: number;
 }
@@ -1579,10 +1657,11 @@ declare interface Node_2 {
     visit(visitor: Visitor, state: any): void;
 }
 
-declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool' | 'projects' | 'coverage' | 'setupFiles' | 'exclude'>> & Partial<Pick<RstestConfig, OptionalKeys>> & {
+declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool' | 'projects' | 'coverage' | 'setupFiles' | 'globalSetup' | 'exclude'>> & Partial<Pick<RstestConfig, OptionalKeys>> & {
     pool: RstestPoolOptions;
     coverage: NormalizedCoverageOptions;
     setupFiles: string[];
+    globalSetup: string[];
     exclude: {
         patterns: string[];
         override?: boolean;
@@ -1605,8 +1684,9 @@ declare type NormalizedFixtures = Record<string, NormalizedFixture>;
 
 declare type NormalizedProcedure<T extends Procedure> = (...args: Parameters<T>) => ReturnType<T>;
 
-declare type NormalizedProjectConfig = Required<Omit<NormalizedConfig, OptionalKeys | 'projects' | 'reporters' | 'pool' | 'setupFiles'>> & Pick<NormalizedConfig, OptionalKeys> & {
+declare type NormalizedProjectConfig = Required<Omit<NormalizedConfig, OptionalKeys | 'projects' | 'reporters' | 'pool' | 'setupFiles' | 'globalSetup'>> & Pick<NormalizedConfig, OptionalKeys> & {
     setupFiles: string[];
+    globalSetup: string[];
 };
 
 declare interface OldPlugin {
@@ -1614,17 +1694,9 @@ declare interface OldPlugin {
     	test: Test;
 }
 
-declare type OnTestFailedHandler = (params: {
-    task: {
-        result: Readonly<TestResult>;
-    };
-}) => MaybePromise<void>;
+declare type OnTestFailedHandler = (ctx: TestContext) => MaybePromise<void>;
 
-declare type OnTestFinishedHandler = (params: {
-    task: {
-        result: Readonly<TestResult>;
-    };
-}) => MaybePromise<void>;
+declare type OnTestFinishedHandler = (ctx: TestContext) => MaybePromise<void>;
 
 declare type OptionalKeys = 'testNamePattern' | 'plugins' | 'source' | 'resolve' | 'output' | 'performance' | 'tools' | 'dev' | 'onConsoleLog' | 'chaiConfig' | 'resolveSnapshotPath';
 
@@ -1697,6 +1769,7 @@ declare type ProjectContext = {
     outputModule: boolean;
     configFilePath?: string;
     normalizedConfig: NormalizedProjectConfig;
+    _globalSetups: boolean;
 };
 
 declare interface ProjectOptions {
@@ -1714,8 +1787,8 @@ declare type PromisifyAssertion<T> = Promisify<Assertion<T>>;
 declare type PromisifyAssertion_2<T> = Promisify_2<Assertion_2<T>>;
 
 declare interface Range_2 {
-    start: Location_2;
-    end: Location_2;
+    start: Location_3;
+    end: Location_3;
 }
 
 declare interface RawMatcherFn<
@@ -1733,11 +1806,24 @@ declare interface RawSnapshotInfo {
 
 declare type Refs = Array<unknown>;
 
+declare class ReportBase {
+    constructor(options?: Partial<ReportBaseOptions>);
+    execute(context: Context): void;
+}
+
+declare interface ReportBaseOptions {
+    summarizer: Summarizers;
+}
+
 declare interface Reporter {
     /**
      * Called before test file run.
      */
     onTestFileStart?: (test: TestFileInfo) => void;
+    /**
+     * Called after tests in file collected.
+     */
+    onTestFileReady?: (test: TestFileInfo) => void;
     /**
      * Called when the test file has finished running.
      */
@@ -1763,11 +1849,12 @@ declare interface Reporter {
     /**
      * Called after all tests have finished running.
      */
-    onTestRunEnd?: ({ results, testResults, duration, getSourcemap, snapshotSummary, }: {
+    onTestRunEnd?: ({ results, testResults, duration, getSourcemap, snapshotSummary, unhandledErrors, }: {
         results: TestFileResult[];
         testResults: TestResult[];
         duration: Duration;
         getSourcemap: GetSourcemap;
+        unhandledErrors?: Error[];
         snapshotSummary: SnapshotSummary;
         filterRerunTestPaths?: string[];
     }) => MaybePromise<void>;
@@ -1864,6 +1951,12 @@ declare interface RstestConfig {
      * Path to setup files. They will be run before each test file.
      */
     setupFiles?: string[] | string;
+    /**
+     * Path to global setup files, relative to project root.
+     * A global setup file can either export named functions `setup` and `teardown`
+     * or a `default` function that returns a teardown function.
+     */
+    globalSetup?: string[] | string;
     /**
      * Retry the test specific number of times if it fails.
      * @default 0
@@ -2009,6 +2102,10 @@ declare interface RstestConfig {
      * chai configuration options
      */
     chaiConfig?: ChaiConfig;
+    /**
+     * Include `location` property in `TestInfo` received by reporters
+     */
+    includeTaskLocation?: boolean;
     plugins?: RsbuildConfig['plugins'];
     source?: Pick<NonNullable<RsbuildConfig['source']>, 'define' | 'tsconfigPath' | 'decorators' | 'include' | 'exclude'>;
     performance?: Pick<NonNullable<RsbuildConfig['performance']>, 'bundleAnalyze'>;
@@ -2095,11 +2192,12 @@ declare type RunningModules = Map<string, {
     results: TestResult[];
 }>;
 
-declare type RuntimeConfig = Pick<RstestContext['normalizedConfig'], 'testTimeout' | 'testNamePattern' | 'globals' | 'passWithNoTests' | 'retry' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'unstubEnvs' | 'unstubGlobals' | 'maxConcurrency' | 'printConsoleTrace' | 'disableConsoleIntercept' | 'testEnvironment' | 'isolate' | 'hookTimeout' | 'coverage' | 'snapshotFormat' | 'env' | 'logHeapUsage' | 'bail' | 'chaiConfig'>;
+declare type RuntimeConfig = Pick<RstestContext['normalizedConfig'], 'testTimeout' | 'testNamePattern' | 'globals' | 'passWithNoTests' | 'retry' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'unstubEnvs' | 'unstubGlobals' | 'maxConcurrency' | 'printConsoleTrace' | 'disableConsoleIntercept' | 'testEnvironment' | 'isolate' | 'hookTimeout' | 'coverage' | 'snapshotFormat' | 'env' | 'logHeapUsage' | 'bail' | 'chaiConfig' | 'includeTaskLocation'>;
 
 /** Runtime to Server */
 declare type RuntimeRPC = {
     onTestFileStart: (test: TestFileInfo) => Promise<void>;
+    onTestFileReady: (test: TestFileInfo) => Promise<void>;
     getAssetsByEntry: () => Promise<{
         assetFiles: Record<string, string>;
         sourceMaps: Record<string, string>;
@@ -2322,6 +2420,8 @@ declare type SuiteContext = {
     filepath: TestPath;
 };
 
+declare type Summarizers = "flat" | "nested" | "pkg" | "defaultSummarizer";
+
 declare interface SyncExpectationResult {
     	pass: boolean;
     	message: () => string;
@@ -2389,11 +2489,14 @@ declare type TestCase = TestCaseInfo & {
     only?: boolean;
     onFinished: OnTestFinishedHandler[];
     onFailed: OnTestFailedHandler[];
-    type: 'case';
     /**
      * Store promises (from async expects) to wait for them before finishing the test
      */
     promises?: Promise<any>[];
+    /**
+     * Store stack trace error created when test is registered, used for trace original position
+     */
+    stackTraceError: Error;
     /**
      * Result of the task. if `expect.soft()` failed multiple times or `retry` was triggered.
      */
@@ -2408,9 +2511,21 @@ declare type TestCaseInfo = {
     parentNames?: string[];
     project: string;
     startTime?: number;
+    /** Only included when `includeTaskLocation` config is enabled */
+    location?: Location_2;
+    type: 'case';
 };
 
 declare type TestContext = {
+    /**
+     * Metadata of the current test
+     */
+    task: {
+        /** Test name provided by user */
+        name: string;
+        /** Result of the current test, undefined if the test is not run yet */
+        result?: TestResult;
+    };
     expect: RstestExpect;
     onTestFinished: RunnerAPI['onTestFinished'];
     onTestFailed: RunnerAPI['onTestFailed'];
@@ -2430,6 +2545,7 @@ declare interface TesterContext {
 
 declare type TestFileInfo = {
     testPath: TestPath;
+    tests: TestInfo[];
 };
 
 declare type TestFileResult = TestResult & {
@@ -2442,6 +2558,10 @@ declare type TestFn<ExtraContext = object> = (description: string, fn?: TestCall
 
 declare type TestForFn<ExtraContext = object> = <T>(cases: readonly T[]) => (description: string, fn?: (param: T, context: TestContext & ExtraContext) => MaybePromise<void>, timeout?: number) => void;
 
+declare type TestInfo = TestCaseInfo | (TestSuiteInfo & {
+    tests: TestInfo[];
+});
+
 /** The test file original path */
 declare type TestPath = string;
 
@@ -2485,8 +2605,7 @@ declare type TestSuite = TestSuiteInfo & {
     concurrent?: boolean;
     sequential?: boolean;
     /** nested cases and suite could in a suite */
-    tests: (TestSuite | TestCase)[];
-    type: 'suite';
+    tests: Test_2[];
     afterAllListeners?: AfterAllListener[];
     beforeAllListeners?: BeforeAllListener[];
     afterEachListeners?: AfterEachListener[];
@@ -2499,6 +2618,9 @@ declare type TestSuiteInfo = {
     parentNames?: string[];
     testPath: TestPath;
     project: string;
+    type: 'suite';
+    /** Only included when `includeTaskLocation` config is enabled */
+    location?: Location_2;
 };
 
 declare type TextLcovOptions = ProjectOptions;
@@ -2544,6 +2666,11 @@ declare class TraceMap implements SourceMap {
     constructor(map: Ro<SourceMapInput>, mapUrl?: string | null);
 }
 
+declare interface Tree<N extends Node_2 = Node_2> {
+    getRoot(): N;
+    visit(visitor: Partial<Visitor<N>>, state: any): void;
+}
+
 declare interface UncheckedSnapshot {
     	filePath: string;
     	keys: Array<string>;
@@ -2576,6 +2703,15 @@ declare type VitestAssertion<
 	T
 > = { [K in keyof A] : A[K] extends Chai.Assertion ? Assertion<T> : A[K] extends (...args: any[]) => any ? A[K] : VitestAssertion<A[K], T> } & ((type: string, message?: string) => Assertion);
 
+declare type Watermark = [number, number];
+
+declare interface Watermarks {
+    statements: Watermark;
+    functions: Watermark;
+    branches: Watermark;
+    lines: Watermark;
+}
+
 declare type WithAsymmetricMatcher<T> = T | AsymmetricMatcher<unknown>;
 
 declare type WorkerContext = {
@@ -2591,4 +2727,24 @@ declare type XInput = {
     x_google_ignoreList?: SourceMapV3['ignoreList'];
 };
 
+declare interface XmlWriter {
+    indent(str: string): string;
+    /**
+     * writes the opening XML tag with the supplied attributes
+     */
+    openTag(name: string, attrs?: any): void;
+    /**
+     * closes an open XML tag.
+     */
+    closeTag(name: string): void;
+    /**
+     * writes a tag and its value opening and closing it at the same time
+     */
+    inlineTag(name: string, attrs?: any, content?: string): void;
+    /**
+     * closes all open tags and ends the document
+     */
+    closeAll(): void;
+}
+
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rstest/core",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "description": "The Rsbuild-based test tool.",
   "bugs": {
     "url": "https://github.com/web-infra-dev/rstest/issues"
@@ -60,10 +60,11 @@
     "@jridgewell/trace-mapping": "0.3.31",
     "@microsoft/api-extractor": "^7.53.3",
     "@rslib/core": "0.18.3",
-    "@sinonjs/fake-timers": "^14.0.0",
+    "@sinonjs/fake-timers": "^15.0.0",
     "@types/babel__code-frame": "^7.0.6",
     "@types/istanbul-reports": "^3.0.4",
     "@types/istanbul-lib-coverage": "^2.0.6",
+    "@types/istanbul-lib-report": "^3.0.3",
     "@types/jsdom": "^21.1.7",
     "@types/sinonjs__fake-timers": "^8.1.5",
     "@types/source-map-support": "^0.5.10",