Gathering detailed insights and metrics for @browserstack/testcafe-browser-provider-browserstack
Gathering detailed insights and metrics for @browserstack/testcafe-browser-provider-browserstack
Installations
npm install @browserstack/testcafe-browser-provider-browserstackReleases
Unable to fetch releases
Developer
browserstack
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
>=8.0.0
Typescript Support
No
Node Version
12.14.1
NPM Version
6.13.4
Statistics
1 Stars
54 Commits
4 Forks
3 Watching
10 Branches
10 Contributors
Updated on 21 Jun 2023
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
149,484
Last day
-18.2%
9
Compared to previous day
Last week
-17.9%
46
Compared to previous week
Last month
305%
162
Compared to previous month
Last year
-39.7%
12,184
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
13
Versions
testcafe-browser-provider-browserstack
This plugin integrates TestCafe with the BrowserStack Testing Cloud.
Install
Step 1: Clone the repo
1git clone https://github.com/browserstack/testcafe-browser-provider-browserstack.git
Step 2: Go into the directory
1cd testcafe-browser-provider-browserstack
Step 3: Install the dependencies
1npm install (use lts version to avoid breaking changes)
Step 4: Gulp build the module
1./node_modules/.bin/gulp build
Step 5: Link the package globally, for consumption by testcafe
1npm link
Usage
Before using this plugin, save the BrowserStack username and access key to environment variables BROWSERSTACK_USERNAME and BROWSERSTACK_ACCESS_KEY.
Project name and build name will be displayed in BrowserStack if you set the environment variables BROWSERSTACK_PROJECT_NAME and BROWSERSTACK_BUILD_ID.
If you have troubles starting multiple browsers at once, or get browserstack-local related errors like #27,
try setting the BROWSERSTACK_PARALLEL_RUNS environment variable to the number of browsers you want to run simultaneously, or to 1 if you want to run just one browser.
You can determine the available browser aliases by running
1testcafe -b browserstack
If you run tests from the command line, use the alias when specifying browsers:
1testcafe "browserstack:Chrome@53.0:Windows 10" "path/to/test/file.js"
When you use API, pass the alias to the browsers() method:
1testCafe 2 .createRunner() 3 .src('path/to/test/file.js') 4 .browsers('browserstack:Chrome@53.0:Windows 10') 5 .run();
Tip: you can skip version (@53.0) or/and OS name (:Windows 10).
BrowserStack Proxy Options
Proxy options can be passed via environment variables.
BROWSERSTACK_PROXY- a string that specifies a proxy for the BrowserStack local binary. It should have the following structure:user:pass@proxyHostName:port,BROWSERSTACK_LOCAL_PROXY- a string that specifies a proxy for the local web server. It should have the following structure:user:pass@proxyHostName:port,BROWSERSTACK_FORCE_PROXY- if it's not empty, forces all traffic of BrowserStack local binary to go through the proxy,BROWSERSTACK_FORCE_LOCAL- if it's not empty, forces all traffic of BrowserStack local binary to go through the local machineBROWSERSTACK_NO_LOCAL- If it's not empty, forces all traffic of BrowserStack to go over public internet
Example:
1export BROWSERSTACK_PROXY="user:p@ssw0rd@proxy.com:8080" 2export BROWSERSTACK_LOCAL_PROXY="admin:12345678@192.168.0.2:8080" 3export BROWSERSTACK_FORCE_PROXY="1" 4export BROWSERSTACK_FORCE_LOCAL="1" 5testcafe browserstack:chrome test.js
Other BrowserStackLocal Options
This plugin also allows you to specify the following BrowserStackLocal options via environment variables:
| Option | Environment Variable |
|---|---|
| binarypath | BROWSERSTACK_BINARY_PATH |
| logFile | BROWSERSTACK_LOGFILE |
| verbose | BROWSERSTACK_VERBOSE |
Example:
1export BROWSERSTACK_BINARY_PATH="~/BrowserStack/BrowserStackLocal" 2export BROWSERSTACK_LOGFILE="~/BrowserStack/logs.txt" 3export BROWSERSTACK_VERBOSE="1" 4testcafe browserstack:chrome test.js
BrowserStack JS Testing and BrowserStack Automate
BrowserStack offers two APIs for browser testing:
JS testing supports more types of devices (compare: JS Testing Devices vs Automate Devices), while Automate allows for much longer tests (2 hours vs 30 minutes) and provides some additional features (like the window resizing functionality).
TestCafe uses the JS Testing API by default. In order to use BrowserStack Automate,
set the BROWSERSTACK_USE_AUTOMATE environment variable to 1.
Example:
1export BROWSERSTACK_USE_AUTOMATE="1" 2testcafe browserstack:chrome test.js
Setting Display Resolution
To set the display resolution, use the BROWSERSTACK_DISPLAY_RESOLUTION environment variable.
Valid resolutions can be found here.
Remember that this only sets the display resolution and does not resize the browser window. You'll still need to use TestCafe's window resizing API to do so.
Example:
1export BROWSERSTACK_DISPLAY_RESOLUTION="1024x768" 2testcafe browserstack:chrome test.js
Specifying Chrome Command Line Arguments
To set Chrome command line arguments, use the BROWSERSTACK_CHROME_ARGS environment variable. You can specify multiple arguments by joining them with the space symbol. This option works only if the BrowserStack Automate API is enabled.
Examples:
1export BROWSERSTACK_USE_AUTOMATE="1" 2export BROWSERSTACK_CHROME_ARGS="--autoplay-policy=no-user-gesture-required" 3testcafe browserstack:chrome test.js
1export BROWSERSTACK_USE_AUTOMATE="1" 2export BROWSERSTACK_CHROME_ARGS="--start-maximized --autoplay-policy=no-user-gesture-required" 3testcafe browserstack:chrome test.js
Other BrowserStack Options
BrowserStack Automate allows you to provide options for its internal Selenium Grid in the form of key-value pairs called capabilities.
To specify BrowserStack capabilities via the TestCafe BrowserStack provider, use environment variables. This provider supports the following capabilities:
| Capability | Environment Variable |
|---|---|
browserstack.debug | BROWSERSTACK_DEBUG |
browserstack.console | BROWSERSTACK_CONSOLE |
browserstack.networkLogs | BROWSERSTACK_NETWORK_LOGS |
browserstack.video | BROWSERSTACK_VIDEO |
browserstack.timezone | BROWSERSTACK_TIMEZONE |
Refer to the BrowserStack documentation for information about the values you can specify.
Example
1export BROWSERSTACK_DEBUG="true" 2export BROWSERSTACK_TIMEZONE="UTC" 3testcafe browserstack:chrome test.js
Exceeding the Parallel Test Limit
When you run tests in multiple browsers or concurrently, you may exceed the maximum number of parallel tests available for your account.
Assume your plan allows 2 parallel tests, and you run one of the following commands:
1testcafe 'browserstack:ie@11.0:Windows 10' 'browserstack:chrome@59.0:Windows 10' 'browserstack:safari@9.1:OS X El Capitan' tests/acceptance/
1testcafe browserstack:ie@11.0:Windows 10 -c3 tests/acceptance/
In this instance, BrowserStack will refuse to provide all the required machines and TestCafe will throw an error:
1Unable to establish one or more of the specified browser connections.
To keep within your account limitations, you can run tests sequentially (or in batches), like in the following bash script (credits to @maoberlehner for this example):
1browsers=( "browserstack:ie@10.0:Windows 8" "browserstack:ie@11.0:Windows 10" "browserstack:edge@15.0:Windows 10" "browserstack:edge@14.0:Windows 10" "browserstack:firefox@54.0:Windows 10" "browserstack:firefox@55.0:Windows 10" "browserstack:chrome@59.0:Windows 10" "browserstack:chrome@60.0:Windows 10" "browserstack:opera@46.0:Windows 10" "browserstack:opera@47.0:Windows 10" "browserstack:safari@9.1:OS X El Capitan" "browserstack:safari@10.1:OS X Sierra" ) 2 3for i in "${browsers[@]}" 4do 5 ./node_modules/.bin/testcafe "${i}" tests/acceptance/ 6done
Author
Developer Express Inc. (https://devexpress.com)
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
GitHub workflow tokens follow principle of least privilege
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/Semgrep.yml:22
- Info: topLevel 'contents' permission set to 'read': .github/workflows/Semgrep.yml:16
- Info: no jobLevel write permissions found
Reason
all dependencies are pinned
Details
- Info: 2 out of 2 GitHub-owned GitHubAction dependencies pinned
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
56 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-897m-rjf5-jp39
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-w7q9-p3jq-fmhm
- Warn: Project is vulnerable to: GHSA-xvf7-4v9q-58w6
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
- Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
- Warn: Project is vulnerable to: GHSA-x565-32qp-m3vf
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-hw46-vg6w-88fj
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-884p-74jh-xrg2
- Warn: Project is vulnerable to: GHSA-j7fq-p9q7-5wfv
- Warn: Project is vulnerable to: GHSA-mgfv-m47x-4wqp
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
4.5
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More