To help you get started, we've collected the most common ways that testcafe-browser-tools is being used within popular public projects.

DevExpress / testcafe / src / browser / provider / index.ts View on Github

private async _ensureBrowserWindowDescriptor (browserId: string): Promise {
        if (this._getWindowDescriptor(browserId))
            return;

        await this._ensureLocalBrowserInfo(browserId);

        // NOTE: delay to ensure the window finished the opening
        await this.plugin.waitForConnectionReady(browserId);
        await delay(BROWSER_OPENING_DELAY);

        if (this.localBrowsersInfo[browserId])
            this.localBrowsersInfo[browserId].windowDescriptor = await browserTools.findWindow(browserId);
    }

View more ways to use testcafe-browser-tools

testcafe-browser-tools

TestСafe Browser Tools is an utility library for performing platform-dependent actions on browser windows. Working with browsers is specific for each operating system and requires native code to deal with. In order to provide painless and simple installation, this package encapsulates pre-built binaries for all supported platforms and JS-wrappers around them. This helps end-users avoid running post-npm-install build actions.

Build Process

To build native binaries from source files, execute the gulp task corresponding to your operating system:

'buildWin'
'buildMac'
'buildLinux'

Important note: The application for a particular platform must be built on a machine with the same platform. Since this package can be used on old OS version such as NodeJS 16 docker container, it is important to build binaries on the old OS version for the binaries to contain corresponding dependencies(for example glibc-2.31 for node16 docker image).

The bin directory contains pre-built native binaries. Consider using them if your contribution does not affect the native modules.

Install

$ npm install testcafe-browser-tools

API Reference

Important note: To identify the web browser window, most of the provided functions use its title. This title matches the web page's document.title in most of the browsers. However, Microsoft Edge truncates the window title to the hostname if document.title contains only a URL ( e.g. document.title = 'https://localhost:1337/page' gives localhost in the window title).

So, you need to add some characters before the URL in order to bring it to the window title:

document.title = 'title: ' + document.location.toString()

For API reference, see the API document.

Testing

To run automated tests:

$ npm test

Since the module functionality depends on browsers available on a testing machine and you cannot predict expected returned values for some functions, the automated tests cover only a part of the functionality. To test all the functions provided by the module, use the playground. To run it, execute the gulp task corresponding to your operating system:

$ gulp runPlaygroundWin
$ gulp runPlaygroundMac
$ gulp runPlaygroundLinux

This will open the Playground web page at https://localhost:1334/, where you can manually check if the functions work correctly.

Author

Developer Express Inc.(https://devexpress.com)