Interface ITestRunner

Test runner interface for executing test suites

Since

0.2.0

interface ITestRunner {
    addFilter(filter: ITestFilter): IRemovable;
    addListener(listener: IListener): void;
    addReporter(reporter: IListener): void;
    getMetrics(): IRunnerMetrics;
    getResults(): ITestSummary;
    getRootSuite(): ITestSuite;
    getSuiteResult(suite: ITestSuite): ISuiteResult;
    getTestResult(test: ITestCase): ITestResult;
    removeListener(listener: IListener): void;
    removeReporter(reporter: IListener): void;
    run(): IPromise<void>;
}

Index

Methods

addFilter addListener addReporter getMetrics getResults getRootSuite getSuiteResult getTestResult removeListener removeReporter run

Methods

addFilter

addFilter(filter: ITestFilter): IRemovable
Add a filter to determine which suites and/or tests should be run
Parameters
- filter: ITestFilter
  The filter to add
Returns IRemovable
An object with a remove() method to remove the filter
- Defined in interfaces/runner/ITestRunner.ts:30

addListener

addListener(listener: IListener): void
Add a listener to receive test execution notifications
Parameters
- listener: IListener
  The listener to add
Returns void
- Defined in interfaces/runner/ITestRunner.ts:51

addReporter

addReporter(reporter: IListener): void
Add a reporter to receive test execution notifications (legacy alias for addListener)
Parameters
- reporter: IListener
  The reporter to add
Returns void

Deprecated
Use addListener instead
- Defined in interfaces/runner/ITestRunner.ts:64

getMetrics

getMetrics(): IRunnerMetrics
Get execution monitoring metrics for the current/last run.

The full metrics (execution trace, per-execution samples, per-test wait ratios, timeout hotspots and retry diagnostics) are only collected when the runner was created with the metrics option enabled (see ITestRunnerOptions.metrics). When it was not, the returned object still carries the basic counters and timing totals, the collection based values are empty and message explains that the full metrics were not captured.

Returns IRunnerMetrics
- Defined in interfaces/runner/ITestRunner.ts:96

getResults

getResults(): ITestSummary
Get test results summary

Returns ITestSummary
- Defined in interfaces/runner/ITestRunner.ts:40

getRootSuite

getRootSuite(): ITestSuite
Get the root test suite

Returns ITestSuite
- Defined in interfaces/runner/ITestRunner.ts:45

getSuiteResult

getSuiteResult(suite: ITestSuite): ISuiteResult
Get the execution result for a specific suite
Parameters
- suite: ITestSuite
  The test suite to get the result for
Returns ISuiteResult
The suite result if the suite has been executed, undefined otherwise
- Defined in interfaces/runner/ITestRunner.ts:85

getTestResult

getTestResult(test: ITestCase): ITestResult
Get the execution result for a specific test
Parameters
- test: ITestCase
  The test case to get the result for
Returns ITestResult
The test result if the test has been executed, undefined otherwise
- Defined in interfaces/runner/ITestRunner.ts:78

removeListener

removeListener(listener: IListener): void
Remove a listener
Parameters
- listener: IListener
  The listener to remove
Returns void
- Defined in interfaces/runner/ITestRunner.ts:57

removeReporter

removeReporter(reporter: IListener): void
Remove a reporter (legacy alias for removeListener)
Parameters
- reporter: IListener
  The reporter to remove
Returns void

Deprecated
Use removeListener instead
- Defined in interfaces/runner/ITestRunner.ts:71

run

run(): IPromise<void>
Run all tests in the suite

Returns IPromise<void>
- Defined in interfaces/runner/ITestRunner.ts:35