@jawis/jates/TestListController.d.ts

Jate server

import { Waiter } from "state-waiter";
import { ClientComProv, TestAnalytics, TestFrameworkProv } from "./internal";
export type TestListControllerProv = {
    onRunAllTests: () => void;
    onRunCurrentSelection: () => void;
};
export type TestListControllerDeps = {
    testFramework: TestFrameworkProv;
    ta: TestAnalytics;
    setTestExecutionList: (ids: string[]) => void;
    onError: (error: unknown) => void;
} & Pick<ClientComProv, "onTestSelectionReady">;
type States = "idle" | "fetching" | "stopping" | "done";
type Events = never;
/**
 * - Re-form test queue, based on events from the user.
 * - Sort test cases by execution time.
 * - Send test selection structure to client, and ask TEC to execute the tests.
 *
 * Test selection structure
 *  - Defines which tests the client presents to the user.
 *  - Defines a prioritisation of the tests. E.g. sorted by exec time.
 *  - Contains unselected tests as last level.
 *  - It's ok to have the client present tests, that aren't going to execute. The user might be
 *      interested in seeing the unselected tests.
 *
 * Test execution list
 *  - A subset of the selection structure. The tests that will execute.
 *
 * choice:
 *  - TEC guarantees not to send results, that are not in the test list. So we call tec.setTestList in same
 *      tick as sending new test selection structure to the client. And the client is guranteed only ever to
 *      receive test results in that list. The price is, that TEC drops the test result of the currently executing test.
 *      small price for a conceptually simple management of test list switches.
 *  - Otherwise we would have to filter tests, the client doesn't understand. Or give the client a list of all tests, so
 *      it can filter tests not in the selection structure. Maybe that's no problem, after all.
 */
export declare class TestListController implements TestListControllerProv {
    private deps;
    waiter: Waiter<States, Events>;
    /**
     *
     */
    constructor(deps: TestListControllerDeps);
    /**
     *
     */
    onRunAllTests: () => void;
    /**
     *
     */
    onRunCurrentSelection: () => void;
    /**
     *
     */
    private onFetchDone;
}
export {};