v1.8.1 (2020-1-23)

Bug Fixes

• TestCafe now starts correctly when unsupported browsers are installed in the system (#4661)
• t.getBrowserConsoleMessages now returns a list of recorded console messages instead of undefined (#4662)

What’s Changed

• Update browser tools (v2.0.8); Bump version (v1.8.1-alpha.1) (#4670) @AndreyBelym
• Fix 'getBrowserConsoleMessages returns undefined' (close #4662) (#4664) @miherlosev

v1.8.0 (2020-1-17)

🌟 Support for the New Microsoft Edge

TestCafe v1.8.0 supports the new Microsoft Edge based on Chromium. The new Edge is available under the same alias: edge.

testcafe edge test.js

await runner
    .src('test.js')
    .browsers('edge')
    .run();

Supported Edge's features include headless mode, mobile device emulation, and video recording.

Bug Fixes

• Fixed an error thrown when the webpage creates a Proxy (testcafe-hammerhead/#2206) by @link89
• Event handlers are no longer cleared after the document.open function call (testcafe-hammerhead/#1881)

What’s Changed

• Support Edge 79; Bump version (v1.8.0-rc.1) (#4650) @AlexKamaev
• 'window.close' tracking (#4625) @miherlosev
• Improve waiting for the last command result (#4598) @miherlosev
• CreateTempProfile for Microsoft Edge Chromium Beta (#4633) @AlexKamaev
• [docs] Fix a wrong example in 'Wait mechanisms' (#4637) @VasilyStrelyaev
• [docs] Add the 'How it works' article (#4626) @VasilyStrelyaev
• [docs] Update the year in the license (#4627) @VasilyStrelyaev
• Update Bowser, add the "Electron" user agent case (#4609) @Farfurix
• Rename 'pageId' term to 'windowId' (close #4586) (#4608) @miherlosev
• [docs] Fix filterHidden docs example (#4611) @mattmanske
• [docs] Update the A-Z index (#4605) @VasilyStrelyaev
• Rewrite the browser/connection/remotes-queue.js file to TypeScript (#4607) @miherlosev
• Improve error handling in IPC utils (#4591) @AndreyBelym
• Progress bar display is fixed (#4596) @Dmitry-Ostashev
• Add the --experimental-compiler-service flag (#4590) @AndreyBelym
• [Multi window mode]: Browser console messages (#4578) @miherlosev

v1.7.1 (2019-12-19)

Bug Fixes

• Status bar has been redesigned to fit the debug panel into small screens and emulated mobile devices (#2510)
• Added timestamp to requests logged with RequestLogger (#3738)
• t.typeText now fires the beforeInput event (#4486)
• The t.hover action can now be detected with the jQuery :hover pseudoselector (#4493)
• Object.assign now merges Symbol properties on tested pages correctly (testcafe-hammerhead/#2189)

What’s Changed

• Bump version (v1.7.1-rc.1); Allow creating branches in the core repo (#4581) @AndreyBelym
• [pull] master from DevExpress:master (#11) @pull
• [docs] Add info about publishing reports on Azure (#4534) @VasilyStrelyaev
• [docs] Updated roadmap (#4580) @kirovboris
• [docs] Add custom method's returnDOMNodes description (#4538) @VasilyStrelyaev
• [docs] Add an example and FAQ entry about dynamic IDs (closes #4007) (#4532) @VasilyStrelyaev
• Implement reporter OnTestRunActionDone/Start methods (closes #4507) (#4547) @AlexKamaev
• fire beforeInput (closes #4486 after hh is published) (#4506) @AlexKamaev
• [docs] Update the No Response bot message (#4577) @AlexSkorkin
• Command processing life cycle in multiple window mode (#4485) @miherlosev
• [docs] Add new contributors to README.md (#4573) @Marketionist
• [docs] Fixed code example (#4572) @kirovboris
• [docs] Fixed code styling in examples for User Roles (#4570) @Marketionist
• [WIP]test PR but can be merged (#4559) @AlexKamaev
• Implement IPC transport (#4533) @AndreyBelym
• Status bar redesigned (closes #2510) (#4490) @Dmitry-Ostashev
• [docs] Corrections (#4539) @VasilyStrelyaev
• [docs] Add flags to BitBucket examples (#4525) @VasilyStrelyaev
• [docs] Add troubleshooting info about Chromium flags in Docker (#4517) @VasilyStrelyaev
• [docs] Add description for request's timestamp parameters (#4519) @VasilyStrelyaev
• add 'timestamp' for the logged request (close #3738) (#4514) @miherlosev

v1.5.0 (2019-9-12)

Enhancements

⚙️ Page Caching Can be Disabled (#3780)

TestCafe may be unable to log in to the tested website correctly if the web server uses caching for authentication pages or pages to which users are redirected after login. See the User Roles topic for details.

If tests fail unexpectedly after authentication, disable page caching in TestCafe.

Use the fixture.disablePageCaching and test.disablePageCaching methods to disable caching during a particular fixture or test.

fixture
    .disablePageCaching `My fixture`
    .page `https://example.com`;

test
    .disablePageCaching
    ('My test', async t => { /* ... */ });

To disable page caching during the entire test run, use either of the following options:

• the --disable-page-caching command line flag

  testcafe chrome my-tests --disable-page-caching

• the disablePageCaching option in the runner.run method

  runner.run({ disablePageCaching: true });

• the disablePageCaching configuration file property

  {
      "disablePageCaching": true
  }

If tests run correctly without page caching, we recommend that you adjust the server settings to disable caching for authentication pages and pages to which the server redirects from them.

Bug Fixes

• Fixed an error that occured when a selector matched an <svg> element (#3684)
• Fixed an issue when the reporter configuration file option was not applied (#4234)
• Fixed a warning message about invalid tsconfig.json file (#4154)
• LiveRunner.stop() now closes the browsers (#4107)
• Quarantined tests now re-run correctly in live mode (#4093)
• Fixed a bug when client scripts were not injected in live mode when it re-executed tests (#4183)
• form.elements.length now returns the correct value for forms with file inputs (testcafe-hammerhead/#2034)
• Fixed a bug when images were not displayed in inputs with the image type (testcafe-hammerhead/#2116)
• Fixed an AngularJS compatibility issue that caused a TypeError (testcafe-hammerhead/#2099)
• TestCafe now works correctly with servers that use JSZip to unpack uploaded files (testcafe-hammerhead/#2115)

v1.4.2 (2019-8-28)

Bug Fixes

• Added support for pages that reference ES6 modules (testcafe-hammerhead/#1725)
• Events are now emulated correctly if the mouse pointer does not move during scrolling (#3564)
• Fixed a Capacitor.js compatibility issue (testcafe-hammerhead/#2094)
• Fixed Node.js TLS warning suppression (testcafe-hammerhead/PR#2109)
• Fixed a warning about injecting duplicated scripts (#4116)
• Fixed a bug when information messages were printed in stderr (#3873)

v1.4.1 (2019-8-15)

Bug Fixes

• Drag now works correctly in Chrome Mobile on Android and Chrome device emulator with touch screens (#3948)
• Live Mode no longer fails when it restarts tests that import other modules on Node.js v12 (#4052)
• TestCafe now types into inputs wrapped in label elements correctly (#4068)
• test.clientScripts no longer override fixture.clientScripts (#4122)

v1.4.0 (2019-8-7)

Enhancements

⚙️ Inject Scripts Into Tested Pages (#1739)

TestCafe now allows you to inject scripts into pages visited during the tests. Use this feature to add helper functions, mock browser API or import modules.

To add client scripts to all tests, specify them in the command line, API or configuration file. Use the following options:

• the --cs (--client-scripts) command line argument

  testcafe chrome test.js --client-scripts=mockDate.js,assets/react-helpers.js

• the runner.clientScripts API method

  runner.clientScripts('mockDate.js', 'scripts/react-helpers.js');

• the clientScripts configuration file property

  {
      "clientScripts": ["mockDate.js", "scripts/react-helpers.js"]
  }

If you need to add scripts to individual fixtures or tests, use the fixture.clientScripts and test.clientScripts methods in test code.

fixture `My fixture`
    .page `http://example.com`
    .clientScripts('mockDate.js', 'scripts/react-helpers.js');

test
    ('My test', async t => { /* ... */ })
    .clientScripts('mockDate.js', 'scripts/react-helpers.js');

TestCafe also allows you to inject scripts into specific pages.

fixture `My fixture`
    .clientScripts({
        page: 'https://myapp.com/page/',
        path: 'scripts/vue-helpers.js'
    });

This is helpful when you need to override the browser API on particular pages and use the default behavior everywhere else.

You can specify the scripts to inject as follows:

• pass the path to a JavaScript file to inject its content:

  fixture `My fixture`
      .clientScripts({ path: 'assets/jquery.js' });

• use the module name to inject a module:

  fixture `My fixture`
      .clientScripts({ module: 'async' });

  TestCafe searches for the module's entry point with Node.js mechanisms and injects its content. Note that the browser must be able to execute this module.

• pass the code you need to inject:

  fixture `My fixture`
      .clientScripts({ content: 'Geolocation.prototype.getCurrentPosition = () => new Positon(0, 0);' });

For more information, see Inject Scripts into Tested Pages.

Bug Fixes

• The browser no longer displays 404 errors after the test submits a form (#3560
• TestCafe can now download files when testing in headless mode (#3127)
• TypeScript no longer throws an error when fixture or fixture.page uses a tag function (#4042)
• The load event now correctly fires for cached images (testcafe-hammerhead/#1959)
• TestCafe can now read resources from asar archives (testcafe-hammerhead/#2033)
• Fixed a bug when testcafe-hammerhead event listeners were called twice (testcafe-hammerhead/#2062)

v1.3.3 (2019-7-17)

Bug Fixes

• TestCafe now throws an error if the specified TypeScript configuration file does not exist (#3991)
• TypeScript compilation time has been reduced for a large number of files (#4010)
• Expressions with the += operator are now expanded only when required (testcafe-hammerhead/#2029)
• Parentheses around the await expression are now preserved in the processed scripts (testcafe-hammerhead/#2072)
• Fixed a compatibility issue with Firefox 68 that prevented text selection (testcafe-hammerhead/#2071)

v1.3.2 (2019-7-11)

⚙️ Package dependencies have been upgraded to avoid CVEs found in the 'lodash' package

Bug Fixes

• TestCafe no longer hangs when a disconnected browser reconnects to the network (#3929)

v1.3.1 (2019-7-5)

This release fixes an issue caused by tsconfig.json auto-detection.

Breaking Changes

💥 TypeScript Configuration File Location is Required to Apply the Custom Compiler Settings (#3983)

Version 1.3.0 introduced support for custom TypeScript configuration files where you can provide the compiler options. This feature included automatic detection of these configuration files. If the directory from which you run tests contained a tsconfig.json file, TestCafe would apply it by default.

However, this behavior caused troubles for users who have already had tsconfig.json files with conflicting settings in their projects. TestCafe attempted to apply these configurations, which resulted in issues with test compilation.

In v1.3.1, we have disabled tsconfig.json auto-detection. Now you must explicitly specify the tsconfig.json file location to apply the compiler settings. You can do it in one of the following ways:

• the --ts-config-path command line parameter,

  testcafe chrome my-tests --ts-config-path /Users/s.johnson/testcafe/tsconfig.json

• the runner.tsConfigPath API method,

  runner.tsConfigPath('/Users/s.johnson/testcafe/tsconfig.json');

• the tsConfigPath configuration file property.

  {
      "tsConfigPath": "/Users/s.johnson/testcafe/tsconfig.json"
  }

We strongly recommend that you upgrade to v1.3.1. We apologize for any inconvenience.

v1.2.1 (2019-6-10)

Bug Fixes

• Fixed a Chrome 75 compatibility issue when t.typeText typed each character at the beginning of the input (#3865)
• Fixed a bug when a test with an unhandled promise rejection passed (#3787)
• The native dialog handler is now applied when a role redirects to the login page (#2969)

v1.2.0 (2019-5-28)

Enhancements

⚙️ Custom Reporters Can Now Handle Test Start (#3715) by @Ivan-Katovich

We have added an optional reportTestStart method to reporter API. This method fires each time a test starts. You can override it to output information about the started test:

async reportTestStart (name, meta) {
    this.write(`Starting test: ${name} (${meta.severity})`)
        .newline();
}

This method also enables better integration with third-party reporter frameworks. For instance, allure requires that you perform some actions (namely, specify the test steps) before a test starts. Now you can do this in the reportTestStart method in a custom reporter.

See the reportTestStart method description in Reporter Methods.

Bug Fixes

• Fixed a regression that prevented non-responsive browsers from restarting (#3781)
• Fixed an issue when t.click triggered the click event twice (#3645)
• Fixed a regression that prevented TestCafe from checking checkbox inputs with t.click (#3482)
• TestCafe TypeScript definitions no longer cause the Cannot find namespace 'NodeJS' error (#3719)
• TestCafe no longer removes the Authorization header when Fetch API is used (testcafe-hammerhead/#2020)
• TestCafe now provides correct values for the form.elements.length property (testcafe-hammerhead/#2009)
• Fixed the Invariant Violation React error caused by TestCafe Hammerhead (testcafe-hammerhead/#2000)
• Fixed a regression that disabled the IE=edge meta tag (testcafe-hammerhead/#1963)
• Fixed an issue that prevented t.setFilesToUpload from raising the change event on some file inputs (testcafe-hammerhead/#2007)

v1.1.4 (2019-5-6)

Bug Fixes

• Roles now work when navigation to the login URL does not trigger page reload (#2195)
• TestCafe no longer emits the touchmove events when it simulates clicks on Android devices (#3465)
• t.takeElementScreenshot now works if the display has custom color correction (#2918)
• Fixed a regression that prevented t.typeText from working within iframes in IE 11 (#3724)
• TestCafe now displays the correct error message when a browser is disconnected (#3711)
• URLs that contain authentication credentials are now processed correctly (testcafe-hammerhead/#1990)
• TestCafe no longer breaks async functions inside constructors (testcafe-hammerhead/#2002)

v1.1.3 (2019-4-18)

• TestCafe now shows a warning when the t.resizeWindow action is used during video recording (#3513)
• Debugging in the Docker image can now be enabled with the --inspect and --inspect-brk flags (#3646)
• You can now use the --window-width flag to set the emulated window width for headless Chrome (#3456)
• TestCafe now shows the correct error message when an iframe is not visible (#3681)
• The Unlock Page button no longer throws an error when clicked (#3652)
• The change event for a file input is no longer emulated unless the t.setFilesToUpload method changes the input value (testcafe-hammerhead/#1844)
• The upload native dialog is no longer shown in Firefox after a click is simulated (testcafe-hammerhead/#1984)
• The style attribute and the HTMLElement.style property values are now synchronized (testcafe-hammerhead/#1922)

v1.1.2 (2019-4-10)

Bug Fixes

• TestCafe now captures full-size screenshots on macOS systems with a Retina display (#3541)
• The referrer property is now encoded correctly (testcafe-hammerhead/#1953)

v1.1.1 (2019-4-4)

Bug Fixes

• TestCafe no longer crashes if the tested page contains many cross-domain iframes (testcafe-hammerhead/#1885)
• TestCafe now displays a more concise message when it cannot find and run Chrome or Firefox (#3534)
• TestCafe no longer creates temporary video files in the concurrency mode (#3508)
• The --no-sandbox and --disable-dev-shm-usage flags are now applied automatically when TestCafe runs in a Docker container (#3531)
• In live mode, TestCafe now hides the spinner when it displays a message or if test compilation has failed (#3451 and (#3452))
• TypeScript definitions for t.expect().contains have been fixed to support different types (#3537)
• The keyPress event simulation now works properly on Android (#2236)
• Salesforce Lightning Experience components are now rendered correctly (testcafe-hammerhead/#1874)

v1.1.0 (2019-2-28)

Enhancements

⚙️ TypeScript 3 Support (#3401)

TypeScript test files can now use new syntax features introduced in TypeScript 3.0 and TypeScript 3.3.

⚙️ Enhanced TypeScript Definitions for Client Functions (#3431) by @vitalics

The updated type definitions allow TypeScript compiler to determine client function's return value type. Static typing now warns you when you call wrong methods for the return value.

const getFoo = ClientFunction(() => 42);
const foo    = await getFoo();
foo.match(/foo/);

Prior to v1.1.0, an error occurred during test execution:

$ testcafe chrome tests.ts
 Running tests in:
 - Chrome 72.0.3626 / Windows 10.0.0
 Fixture 1
 √ Test 1
 √ Test 2
 ...
 × Test N
   1) TypeError: foo.match is not a function

With v1.1.0, the TypeScript compiler throws an error before test are started:

$ testcafe chrome tests.ts
  ERROR Cannot prepare tests due to an error.
  Error: TypeScript compilation failed.

  tests.ts (4, 2): Property 'match' does not exist on type 'number'.

Bug Fixes

• TestCafe no longer ignores test and fixture metadata filters specified in the configuration file (#3443) by @NanjoW
• TestCafe no longer resolves placeholders to null in video path patterns (#3455)
• Fixed the KeyboardEvent's key property emulation for Safari (#3282)
• TestCafe can now capture element screenshots after a long page scrolling (#3292)
• The compilation time of TypeScript tests no longer degrades for a large number of files (#3475)
• Reach Router can now navigate correctly when tested with TestCafe (testcafe-hammerhead/#1863)
• TestCafe now correctly handles websites that use the WebKitMutationObserver class (testcafe-hammerhead/#1912)
• TestCafe now processes ECMAScript modules in <script> tags (testcafe-hammerhead/#1725)

v1.0.1 (2019-2-15)

⚙️ Package dependencies have been upgraded to avoid CVEs found in the 'lodash' package

Bug Fixes

• TestCafe no longer hangs when CLI argument validation failed in live mode (#3402)
• TestCafe no longer fails with the ERR_STREAM_WRITE_AFTER_END error after restarting tests in live mode (#3322)
• Now TestCafe doesn't ignore video and encoding options specified in a configuration file (#3415)
• Now you can specify only tests in TestCafe CLI if browsers are specified in a configuration file (#3421)
• Live mode: TestCafe no longer stops test execution in multiple browsers if tests do not contain actions (#3410)
• Now TestCafe correctly handles the data-parsley-multiple attribute (testcafe-hammerhead/#1845)
• Now TestCafe allows passing the headers option of the fetch function as an Array (testcafe-hammerhead/#1898)
• No error occurs when page scripts pass a number as an argument to the window.open function (testcafe-hammerhead/#1908)
• Now TestCafe correctly processes rewritten stylesheets (testcafe-hammerhead/#1919)
• TestCafe correctly processes sourcemaps in stylesheets now (testcafe-hammerhead/#1907)

v1.0.0 (2018-2-7)

Breaking Changes

💥 Test Syntax Validation Disabled: All Input Files Are Executed

Previous versions performed test syntax validation within input script files before executing them. Only files that contained the fixture and test directives were executed.

Starting with v1.0.0, input script files are never validated. This means that TestCafe executes all the scripts you specify as test sources. If you use Glob patterns to specify input test files, please recheck these patterns to avoid unintended file matches.

The --disable-test-syntax-validation command line flag and the disableTestSyntaxValidation option for the runner.run API method that disabled test syntax validation were removed in v1.0.0.

What Has Improved

You can now load tests dynamically without additional customization. The following example illustrates how tests can be imported from an external library.

external-lib.js

export default function runFixture(name, url) {
    fixture(name)
        .page(url);

    test(`${url} test`, async t => {
        // ...
    });
}

test.js

import runFixture from './external-lib';

const fixtureName = 'My fixture';
const url = 'https://testPage';

runFixture(fixtureName, url);

💥 Programming Interface: Multiple Method Calls Prohibited

Previous versions allowed you to call the runner.src, runner.browsers and runner.reporter methods several times to specify multiple test files, browsers or reporters.

const stream = fs.createWriteStream('report.json');

runner
    .src('/home/user/tests/fixture1.js')
    .src('fixture5.js')
    .browsers('chrome')
    .browsers('firefox:headless')
    .reporter('minimal')
    .reporter('json', stream);

Starting with v1.0.0, pass arrays to these methods to specify multiple values.

To use a reporter that writes to a file, add a { name, output } object to an array (see the runner.reporter description for details).

runner
    .src(['/home/user/tests/fixture1.js', 'fixture5.js'])
    .browsers(['chrome', 'firefox:headless'])
    .reporter(['minimal', { name: 'json', output: 'report.json' }]);

What Has Improved

This change was necessary to implement the configuration file in a way that is consistent with the API and command line interface.

💥 Custom Request Hooks: Asynchronous API

Request hook methods became asynchronous in TestCafe v1.0.0.

If the onRequest or onResponse method in your custom hook returns a Promise, TestCafe now waits for this Promise to resolve.

This does not necessarily leads to unexpected behavior, but still be aware of possible side effects.

Since the onRequest and onResponse methods are now asynchronous, add the async keyword to their declarations.

import { RequestHook } from 'testcafe';

class MyRequestHook extends RequestHook {
    constructor (requestFilterRules, responseEventConfigureOpts) {
        super(requestFilterRules, responseEventConfigureOpts);
        // ...
    }

    async onRequest (event) {
        // ...
    }

    async onResponse (event) {
        // ...
    }
}

What Has Improved

You can call asynchronous fs functions, invoke a child_process, or perform asynchronous network requests (to a database or any other server) from inside the hooks.

💥 Custom Reporter Plugins: Asynchronous API

TestCafe v1.0.0 also introduces asynchronous API for reporter plugins.

Similarly to request hooks, if any of the custom reporter's methods (reportTaskStart, reportFixtureStart, reportTestDone or reportTaskDone) returns a Promise, this Promise is now awaited.

Side effects may show up in certain cases.

Since the reporter methods are now asynchronous, add the async keyword to their declarations.

async reportTaskStart (startTime, userAgents, testCount) {
    // ...
},

async reportFixtureStart (name, path, meta) {
    // ...
},

async reportTestDone (name, testRunInfo, meta) {
    // ...
},

async reportTaskDone (endTime, passed, warnings, result) {
    // ...
}

What Has Improved

Reporters can call asynchronous fs functions, invoke a child_process, or perform asynchronous network requests (to send an email, use REST API, connect to a database, etc).

Enhancements

⚙️ Video Recording (#2151)

You can now record videos of test runs in Google Chrome and Mozilla Firefox. To enable video recording, install the FFmpeg library and then do one of the following:

• specify the --video command line flag,

  testcafe chrome test.js --video artifacts/videos/

• call the runner.video API method,

  runner.video('artifacts/videos/');

• specify the videoPath configuration file property (configuration file is also a new feature, see below).

  {
      "videoPath": "artifacts/videos/"
  }

TestCafe records all tests and saves each recording in a separate file. You can change this behavior in video options. You can also customize video encoding parameters.

⚙️ Configuration File (#3131)

TestCafe now allows you to store its settings in the .testcaferc.json configuration file (with support for JSON5 syntax).

{
    "browsers": "chrome",
    "src": ["/home/user/auth-tests/fixture-1.js", "/home/user/mobile-tests/"],
    "reporter": {
        "name": "xunit",
        "output": "reports/report.xml"
    },
    "screenshotPath": "/home/user/tests/screenshots/",
    "takeScreenshotsOnFails": true,
    "videoPath": "/home/user/tests/videos/",
    "pageLoadTimeout": 1000,
    "hostname": "host.mycorp.com"
    // and more
}

Keep the configuration file in the project's root directory from which you run TestCafe.

Settings you specify when you launch tests from the command line and programming interfaces override settings from .testcaferc.json.

See Configuration File for more information.

⚙️ Live Mode (#3215)

We have integrated the testcafe-live module into our main code so you can now use the new live mode.

Live mode keeps the TestCafe process and browsers opened the whole time you are working on tests. Changes you make in code immediately restart the tests. That is, live mode allows you to see test results instantly. See How Live Mode Works.

Use the -L (--live) flag to enable live mode from the command line interface.

testcafe chrome tests/test.js -L

In the API, create a live mode runner with the testcafe.createLiveModeRunner function and use it instead of a regular test runner.

const createTestCafe = require('testcafe');
let testcafe         = null;

createTestCafe('localhost', 1337, 1338)
    .then(tc => {
        testcafe         = tc;
        const liveRunner = testcafe.createLiveModeRunner();
        return liveRunner
            .src('tests/test.js')
            .browsers('chrome')
            .run();
    })
    .then(() => {
        testcafe.close();
    });

⚙️ Custom Reporter API Enhancements (Part of #2753; Pull Request)

• You can now access warnings that appeared during the test run from the reportTestDone method. Use the warnings property of the testRunInfo object.

  async reportTestDone (name, testRunInfo, meta) {
      const warnings    = testRunInfo.warnings;
      const hasWarnings = !!warnings.length;
  
      if(hasWarnings) {
          this.newline()
              .write('Warnings:');
  
          warnings.forEach(warning => {
              this.newline()
                  .write(warning);
          });
      }
  }

• The reportTaskDone method now receives the result parameter that contains information about the number of passed, failed, and skipped tests.

  async reportTaskDone (endTime, passed, warnings, result) {
      this.write(`Testing finished!`)
          .newline()
          .write(`Passed: ${result.passedCount}`)
          .newline()
          .write(`Failed: ${result.failedCount}`)
          .newline();
          .write(`Skipped: ${result.skippedCount}`)
          .newline();
  }

⚙️ Typings for Programming Interface (#3341) by @infctr

TestCafe programming interface now features TypeScript typings.

⚙️ Programming Interface: Simpler API to Write Reports to a File

You no longer need to use fs.createWriteStream to create a stream that writes a report to a file. You can now pass the file name as the runner.reporter parameter.

runnner.reporter('json', 'reports/report.json');

Bug Fixes

• The test runner no longer hangs when a custom reporter implementation uses synchronous callbacks (#3209)
• Fixture hooks for two adjacent fixtures are now executed in the correct order (#3298)
• Iframes no longer throw an error after a document.open call in IE and Edge (#3343)
• TestCafe no longer triggers a click event when you disable a button with a span element inside (#2902)
• Fixed a bug that led to errors in certain cases (#3189)
• We have improved the status panel design and adaptivity (#3073)
• Redirects through several pages in iframes now work correctly (testcafe-hammerhead/#1825)
• TestCafe can now correctly work with pages that override HTMLElement.classList in IE11 (testcafe-hammerhead/#1890)

v0.23.3 (2018-12-19)

Bug Fixes

• Remote browsers now start after tests are compiled (#3219) by @link89
• The TestCafe Docker image now includes version tags (#2315)
• Tests now fail with a meaningful error if no fixture is defined (#2913)
• Tests now resume correctly after a long waiting (#3070)
• TestCafe now throws a meaningful exception when taking screenshots in a browser that does not support it (#2878)
• Events are now simulated in the correct order when focusing an element after another element was focused on the changed event (#3098)
• The Invalid calling object exception is no longer thrown in IE11 (testcafe-hammerhead/#1846)
• The JSON parse error is no longer thrown when sending an XHR request (testcafe-hammerhead/#1839)
• Overridden functions now have the right prototype in an iframe without src (testcafe-hammerhead/#1824)
• gulp-testcafe now correctly closes Chrome after tests are finished (testcafe-hammerhead/#1826)
• Saving the window prototype to a property now works correctly (testcafe-hammerhead/#1828)
• Hammerhead is now retained after document.close in Firefox (testcafe-hammerhead/#1821)

v0.23.2 (2018-11-12)

Bug Fixes

• TestCafe no longer posts internal messages to the browser console (#3099)
• The TestCafe process no longer terminates before the report is written to a file (#2502)

v0.23.1 (2018-11-7)

Enhancements

⚙️ Select Tests and Fixtures to Run by Their Metadata (#2527) by @NickCis

You can now run only those tests or fixtures whose metadata contains a specific set of values.

Use the --test-meta flag to specify values to look for in test metadata.

testcafe chrome my-tests --test-meta device=mobile,env=production

To select fixtures by their metadata, use the --fixture-meta flag.

testcafe chrome my-tests --fixture-meta subsystem=payments,type=regression

In the API, test and fixture metadata is now passed to the runner.filter method in the testMeta and fixtureMeta parameters. Use this metadata to decide whether to run the current test.

runner.filter((testName, fixtureName, fixturePath, testMeta, fixtureMeta) => {
    return testMeta.mobile === 'true' &&
        fixtureMeta.env === 'staging';
});

⚙️ Run Dynamically Loaded Tests (#2074)

You can now run tests imported from external libraries or generated dynamically even if the .js file you provide to TestCafe does not contain any tests.

Previously, this was not possible because TestCafe required test files to contain the fixture and test directives. Now you can bypass this check. To do this, provide the --disable-test-syntax-validation command line flag.

testcafe safari test.js --disable-test-syntax-validation

In the API, use the disableTestSyntaxValidation option.

runner.run({ disableTestSyntaxValidation: true })

Bug Fixes

• Touch events are now simulated with correct touch properties (touches, targetTouches, changedTouches) (#2856)
• Google Chrome now closes correctly on macOS after tests are finished (#2860)
• Internal attribute and node changes no longer provoke MutationObserver notifications (testcafe-hammerhead/#1769)
• The ECONNABORTED error is no longer raised (testcafe-hammerhead/#1744)
• Websites that use Location.ancestorOrigins are now proxied correctly (testcafe-hammerhead/#1342)

v0.23.0 (2018-10-18)

Enhancements

⚙️ Stop Test Run After the First Test Fail (#1323)

You can now configure TestCafe to stop the entire test run after the first test fail. This saves your time when you fix problems with your tests one by one.

Specify the --sf flag to enable this feature when you run tests from the command line.

testcafe chrome my-tests --sf

In the API, use the stopOnFirstFail option.

runner.run({ stopOnFirstFail: true })

⚙️ View the JavaScript Errors' Stack Traces in Reports (#2043)

Now when a JavaScript error occurs on the tested webpage, the test run report includes a stack trace for this error (only if the --skip-js-errors option is disabled).

⚙️ Browsers are Automatically Restarted When They Stop Responding (#1815)

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.

Bug Fixes

• An error message about an unawaited call to an async function is no longer displayed when an uncaught error occurs (#2557)
• A request hook is no longer added multiple times when a filter rule is used (#2650)
• Screenshot links in test run reports now contain paths specified by the --screenshot-pattern option (#2726)
• Assertion chains no longer produce unhandled promise rejections (#2852)
• The moment loader now works correctly in the Jest environment (#2500)
• TestCafe no longer hangs if the screenshot directory contains forbidden symbols (#681)
• The --ssl option's parameters are now parsed correctly (#2924)
• TestCafe now throws a meaningful error if an assertion method is missing (#1063)
• TestCafe no longer hangs when it clicks a custom element (#2861)
• TestCafe now performs keyboard navigation between radio buttons/groups in a way that matches the native browser behavior (#2067, #2045)
• The fetch method can now be used with data URLs (#2865)
• The switchToIframe function no longer throws an error (#2956)
• TestCafe can now scroll through fixed elements when the action has custom offsets (#2978)
• You can now specify the current directory or its parent directories as the base path to store screenshots (#2975)
• Tests no longer hang up when you try to debug in headless browsers (#2846)
• The removeEventListener function now works correctly when an object is passed as its third argument (testcafe-hammerhead/#1737)
• Hammerhead no longer adds the event property to a null contentWindow in IE11 (testcafe-hammerhead/#1684)
• The browser no longer resets connection with the server for no reason (testcafe-hammerhead/#1647)
• Hammerhead now stringifies values correctly before outputting them to the console (testcafe-hammerhead/#1750)
• A document fragment from the top window can now be correctly appended to an iframe (testcafe-hammerhead/#912)
• Lifecycle callbacks that result from the document.registerElement method are no longer called twice (testcafe-hammerhead/#695)

v0.21.1 (2018-8-8)

Bug fixes

• The RequestLogger.clear method no longer raises an error if it is called during a long running request (#2688)
• TestCafe now uses native methods to work with the fetch request (#2686)
• A URL now resolves correctly for elements in a document.implementation instance (testcafe-hammerhead/#1673)
• Response header names specified via the respond function are lower-cased now (testcafe-hammerhead/#1704)
• The cookie domain validation rule on the client side has been fixed (testcafe-hammerhead/#1702)

v0.21.0 (2018-8-2)

Enhancements

⚙️ Test Web Pages Served Over HTTPS (#1985)

Some browser features (like Service Workers, Geolocation API, ApplePaySession, or SubtleCrypto) require a secure origin. This means that the website should use the HTTPS protocol.

Starting with v0.21.0, TestCafe can serve proxied web pages over HTTPS. This allows you to test pages that require a secure origin.

To enable HTTPS when you use TestCafe through the command line, specify the --ssl flag followed by the HTTPS server options. The most commonly used options are described in the TLS topic in the Node.js documentation.

testcafe --ssl pfx=path/to/file.pfx;rejectUnauthorized=true;...

When you use a programming API, pass the HTTPS server options to the createTestCafe method.

'use strict';

const createTestCafe        = require('testcafe');
const selfSignedSertificate = require('openssl-self-signed-certificate');
let runner                  = null;

const sslOptions = {
    key:  selfSignedSertificate.key,
    cert: selfSignedSertificate.cert
};

createTestCafe('localhost', 1337, 1338, sslOptions)
    .then(testcafe => {
        runner = testcafe.createRunner();
    })
    .then(() => {
        return runner
            .src('test.js')

            // Browsers restrict self-signed certificate usage unless you
            // explicitly set a flag specific to each browser.
            // For Chrome, this is '--allow-insecure-localhost'.
            .browsers('chrome --allow-insecure-localhost')
            .run();
    });

See Connect to TestCafe Server over HTTPS for more information.

⚙️ Construct Screenshot Paths with Patterns (#2152)

You can now use patterns to construct paths to screenshots. TestCafe provides a number of placeholders you can include in the path, for example, ${DATE}, ${TIME}, ${USERAGENT}, etc. For a complete list, refer to the command line --screenshot-path-pattern flag description.

You specify a screenshot path pattern when you run tests. Each time TestCafe takes a screenshot, it substitutes the placeholders with actual values and saves the screenshot to the resulting path.

The following example shows how to specify a screenshot path pattern through the command line:

testcafe all test.js -s screenshots -p "${DATE}_${TIME}/test-${TEST_INDEX}/${USERAGENT}/${FILE_INDEX}.png"

When you use a programming API, pass the screenshot path pattern to the runner.screenshots method.

runner.screenshots('reports/screenshots/', true, '${TEST_INDEX}/${OS}/${BROWSER}-v${BROWSER_VERSION}/${FILE_INDEX}.png');

⚙️ Add Info About Screenshots and Quarantine Attempts to Custom Reports (#2216)

Custom reporters can now access screenshots' data and the history of quarantine attempts (if the test run in the quarantine mode).

The following information about screenshots is now available:

• the path to the screenshot file,
• the path to the thumbnail image,
• the browser's user agent,
• the quarantine attempt number (if the screenshot was taken in the quarantine mode),
• whether the screenshot was taken because the test failed.

If the test was run in the quarantine mode, you can also determine which attempts failed and passed.

Refer to the reportTestDone method description for details on how to access this information.

Bug Fixes

• HTML5 drag events are no longer simulated if event.preventDefault is called for the mousedown event (#2529)
• File upload no longer causes an exception when there are several file inputs on the page (#2642)
• File upload now works with inputs that have the required attribute (#2509)
• The load event listener is no longer triggered when added to an image (testcafe-hammerhead/#1688)

v0.20.5 (2018-7-18)

Bug fixes

• The buttons property was added to the MouseEvent instance (#2056)
• Response headers were converted to lowercase (#2534)
• Updated flow definitions (#2053)
• An AttributesWrapper instance is now updated when the the element's property specifies the disabled attribute (#2539)
• TestCafe no longer hangs when it redirects from a tested page to the 'about:error' page with a hash (#2371)
• TestCafe now reports a warning for a mocked request if CORS validation failed (#2482)
• Prevented situations when a request logger tries to stringify a body that is not logged (#2555)
• The Selector API now reports NaN instead of integer when type validation fails (#2470)
• Enabled noImplicitAny and disabled skipLibCheck in the TypeScript compiler (#2497)
• Pages with rel=prefetch links no longer hang during test execution (#2528)
• Fixed the TypeError: this.res.setHeader is not a function error in Firefox (#2438)
• The formtarget attribute was overridden (testcafe-hammerhead/#1513)
• fetch.toString() now equals function fetch() { [native code] } (testcafe-hammerhead/#1662)

v0.20.4 (2018-6-25)

Enhancements

TestCafe now takes screenshots using browsers' debug protocols (#2492)

Bug fixes

• fetch requests are now correctly proxied in a specific case (testcafe-hammerhead/#1613)
• Resources responding with 304 HTTP status code and with the 'content-length: ' header are proxied correctly now (testcafe-hammerhead/#1602)
• The transfer argument of window.postMessage is passed correctly now (testcafe-hammerhead/#1535)
• Incorrect focus events order in IE has been fixed (#2072)

v0.20.3 (2018-6-6)

Enhancements

⚙️ Add TS definitions to the Docker image (#2481)

Bug fixes

• Selection in a contenteditable div now works properly in a specific scenario (#2365)
• A collision related to several moment-duration-format package versions is now fixed (#1750)
• TestCafe now reports a warning when saving several screenshots at the same path (#2213)
• A regression related to wrongly processed document.write in IE11 is now fixed (#2469)
• An out of memory crash on calling console methods is now fixed (testcafe-hammerhead/#1546)
• Click action for an element with 1px height or width works properly now (#2020)
• Touch emulation for the latest Google Chrome was fixed (#2448)

v0.20.2 (2018-5-24)

⚙️ Package dependencies have been upgraded to avoid CVEs reported by Node Security Platform

Bug fixes

• Enabled the screenshot and window resizing functionalities in the concurrency mode for Firefox and Chrome on macOS #2095

v0.20.1 (2018-6-21)

⚙️ Typescript definitions for new features from v0.20.0 have been added (#2428)

Bug fixes

• Now sites with the overridden Element.prototype.matches method work properly #2241
• window.Blob now returns a correct result when Array of ArrayBuffer is passed as a parameter (testcafe-hammerhead/#1599)
• Firefox Shield popup is not shown during test execution now (#2421)

v0.19.1 (2018-3-13)

Backward compatibility with the legacy test syntax has been restored (#2210)

Bug Fixes

• The document.all property is now overridden (testcafe-hammerhead/#1046)
• Proxying properties in async class methods is now supported (testcafe-hammerhead/#1510)
• Fixed wrong proxying of a localStorage check in WebWorkers (testcafe-hammerhead/#1510)
• Function wrappers no longer break is-defined checks (testcafe-hammerhead/#1496)

v0.19.0 (2018-3-1)

TestCafe Live: See instant feedback when working on tests (#1624)

We have prepared a new tool for rapid test development.

TestCafe Live provides a service that keeps the TestCafe process and browsers opened the whole time you are working on tests. Changes you make in code immediately restart the tests. That is, TestCafe Live allows you to see test results instantly.

For more information, see TestCafe Live.

Enhancements

⚙️ Taking Screenshots of Individual Page Elements (#1496)

We have added the t.takeElementScreenshot action that allows you to take a screenshot of an individual page element.

import { Selector } from 'testcafe';

fixture `My fixture`
    .page `http://devexpress.github.io/testcafe/example/`;

test('Take a screenshot of a fieldset', async t => {
    await t
        .click('#reusing-js-code')
        .click('#continuous-integration-embedding')
        .takeElementScreenshot(Selector('fieldset').nth(1), 'my-fixture/important-features.png');
});

This action provides additional customization that allows you to position the center of the screenshot or crop it. For more information, see the documentation.

Note that if the screenshot directory is not specified with the runner.screenshots API method or the screenshots command line option, the t.takeElementScreenshot action will be ignored.

⚙️ Filtering Elements by Their Visibility (#1018)

You can now filter the selector's matching set to leave only visible or hidden elements. To do this, use the filterVisible and filterHidden methods.

import { Selector } from 'testcafe';

fixture `My fixture`
    .page `http://devexpress.github.io/testcafe/example/`;

test('Filter visible and hidden elements', async t => {
    const inputs        = Selector('input');
    const hiddenInput   = inputs.filterHidden();
    const visibleInputs = inputs.filterVisible();

    await t
        .expect(hiddenInput.count).eql(1)
        .expect(visibleInputs.count).eql(11);
});

⚙️ Finding Elements by the Exact Matching Text (#1292)

The current selector's withText method looks for elements whose text content contains the specified string. With this release, we have added the withExactText method that performs search by strict match.

import { Selector } from 'testcafe';

fixture `My fixture`
    .page `http://devexpress.github.io/testcafe/example/`;

test('Search by exact text', async t => {
    const labels       = Selector('label');
    const winLabel     = labels.withExactText('Windows');
    const reusingLabel = labels.withText('JavaScript');

    await t
        .expect(winLabel.exists).ok()
        .expect(reusingLabel.exists).ok();
});

⚙️ Using Decorators in TypeScript Code (#2117) by @pietrovich

TestCafe now allows you to use decorators when writing tests in TypeScript.

Note that decorators are still an experimental feature in TypeScript.

Bug Fixes

• TestCafe can now scroll a webpage when body has a scroll bar (#1940)
• Firefox no longer hangs with a dialog asking to set it as the default browser (#1926)
• Legacy API no longer freezes because of an unexpected error (#1790)
• Click on an element that was hidden and then recreated on timeout now works correctly (#1994)
• TestCafe now correctly finds browsers in headless mode on macOS when tests are executing concurrently (#2035)
• When roles are switched using the preserverUrl flag, the local storage now restores correctly (#2015)
• TestCafe progress bar is no longer visible on screenshots (#2076)
• Window manipulations now wait for page loading (#2000)
• All toolbars are now hidden when taking screenshots (#1445)
• TestCafe now works normally with the latest version of CucumberJS (#2107)
• Fixed an error connected to file permissions on Ubuntu (#2144)
• Browser manipulations can now be executed step-by-step (#2150)
• Fixed a bug where a page wouldn't load because of an error in generateCallExpression (testcafe-hammerhead/#1389)
• Now the overridden Blob constructor doesn't process data unnecessarily (testcafe-hammerhead/#1359)
• Now the target attribute is not set for a button after a click on it (testcafe-hammerhead/#1437)
• The sandbox, target and style attributes are now cleaned up (testcafe-hammerhead/#1448)
• A RangeError with the message Maximum call stack size exceeded is no longer raised (testcafe-hammerhead/#1452)
• A script error is no longer raised on pages that contain a beforeunload handler (testcafe-hammerhead/#1419)
• Fixed wrong overridding of an event object (testcafe-hammerhead/#1445)
• Illegal invocation error is no longer raised when calling the FileListWrapper.item method (testcafe-hammerhead/#1446) by @javiercbk
• A script error is no longer raised when Node.nextSibling is null (testcafe-hammerhead/#1469)
• The isShadowUIElement check is now performed for Node.nextSibling when a node is not an element (testcafe-hammerhead/#1465)
• The toString function is now overridden for anchor elements (testcafe-hammerhead/#1483)