Runner.run Method

Runs tests according to the current configuration. Returns the number of failed tests.

async run(options) → Promise<Number>

Before TestCafe runs tests, it reads settings from the .testcaferc.json configuration file if this file exists. Then it applies settings specified in the programming API. API settings override values from the configuration file in case they differ. TestCafe prints information about every overridden property in the console.

Make sure to keep the browser tab that runs tests active. Do not minimize the browser window. Inactive tabs and minimized browser windows switch to a lower resource consumption mode where tests are not guaranteed to execute correctly.

You can pass the following options to the runner.run function.

After all tests are finished, call the testcafe.close function to stop the TestCafe server.

Related configuration file properties:

• skipJsErrors
• skipUncaughtErrors
• quarantineMode
• debugMode
• debugOnFail
• selectorTimeout
• assertionTimeout
• pageLoadTimeout
• speed
• stopOnFirstFail
• disablePageCaching
• disableScreenshots
• disableMultipleWindows

Example

const createTestCafe = require('testcafe');

const testcafe = await createTestCafe('localhost', 1337, 1338);

try {
    const runner = testcafe.createRunner();

    const failed = await runner.run({
        skipJsErrors: true,
        quarantineMode: true,
        selectorTimeout: 50000,
        assertionTimeout: 7000,
        pageLoadTimeout: 8000,
        speed: 0.1,
        stopOnFirstFail: true
    });

    console.log('Tests failed: ' + failed);
}
finally {
    await testcafe.close();
}

If a browser stops responding while it executes tests, TestCafe restarts the browser and reruns the current test in a new browser instance. If the same problem occurs with this test two more times, the test run finishes and an error is thrown.

When you use a LiveModeRunner, you can call the runner.run method only once. In rare cases when you need multiple live mode sessions to run in parallel, you can create several TestCafe server instances.

Cancel Test Tasks #

You can cancel a promise returned by 'runner.run' to stop an individual test task:

const taskPromise = runner
    .src('tests/fixture1.js')
    .browsers([remoteConnection, 'chrome'])
    .reporter('json')
    .run();

taskPromise.cancel();

You can also cancel all pending tasks at once with the runner.stop method.