Theia API Documentation v1.65.0
    Preparing search index...

    Interface TestRun

    A TestRun represents an in-progress or completed test run and provides methods to report the state of individual tests in the run.

    interface TestRun {
        isPersisted: boolean;
        name: undefined | string;
        onDidDispose: Event<void>;
        token: CancellationToken;
        addCoverage(fileCoverage: FileCoverage): void;
        appendOutput(output: string, location?: Location, test?: TestItem): void;
        end(): void;
        enqueued(test: TestItem): void;
        errored(
            test: TestItem,
            message: TestMessage | readonly TestMessage[],
            duration?: number,
        ): void;
        failed(
            test: TestItem,
            message: TestMessage | readonly TestMessage[],
            duration?: number,
        ): void;
        passed(test: TestItem, duration?: number): void;
        skipped(test: TestItem): void;
        started(test: TestItem): void;
    }

    Implemented by

    Index

    Properties

    isPersisted name onDidDispose token

    Methods

    addCoverage appendOutput end enqueued errored failed passed skipped started

    Properties

    isPersisted: boolean

    Whether the test run will be persisted across reloads by the editor.

    name: undefined | string

    The human-readable name of the run. This can be used to disambiguate multiple sets of results in a test run. It is useful if tests are run across multiple platforms, for example.

    onDidDispose: Event<void>

    An event fired when the editor is no longer interested in data associated with the test run.

    token: CancellationToken

    A cancellation token which will be triggered when the test run is canceled from the UI.

    Methods

    • Appends raw output from the test runner. On the user's request, the output will be displayed in a terminal. ANSI escape sequences, such as colors and text styles, are supported. New lines must be given as CRLF (\r\n) rather than LF (\n).

      Parameters

      • output: string

        Output text to append.

      • Optionallocation: Location

        Indicate that the output was logged at the given location.

      • Optionaltest: TestItem

        Test item to associate the output with.

      Returns void

    • Signals the end of the test run. Any tests included in the run whose states have not been updated will have their state reset.

      Returns void

    • Indicates a test has errored. You should pass one or more TestMessages to describe the failure. This differs from the "failed" state in that it indicates a test that couldn't be executed at all, from a compilation error for example.

      Parameters

      • test: TestItem

        Test item to update.

      • message: TestMessage | readonly TestMessage[]

        Messages associated with the test failure.

      • Optionalduration: number

        How long the test took to execute, in milliseconds.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods