SuiteContext

An instance of SuiteContext is passed to each suite function in order to interact with the test runner. However, the SuiteContext constructor is not exposed as part of the API.

The absolute path of the test file that created the current suite. If a test file imports additional modules that generate suites, the imported suites will return the path of the root test file.

The name of the suite and each of its ancestors, separated by >.

The name of the suite.

Can be used to abort test subtasks when the test has been aborted.

Indicates whether the suite and all of its subtests have passed.

The attempt number of the suite. This value is zero-based, so the first attempt is 0, the second attempt is 1, and so on. This property is useful in conjunction with the --test-rerun-failures option to determine the attempt number of the current run.

context.diagnostic(message): void

Output a diagnostic message. This is typically used for logging information about the current suite or its tests.

test.describe('my suite', (suite) => {
  suite.diagnostic('Suite diagnostic message');
});

context.log(message, data?): void

Write a log message to the output. The resulting 'test:log' event is emitted immediately, in the order that the tests execute.

test.describe('my suite', (suite) => {
  suite.log('Suite log message');
});