executor to run magellan test on browserstack
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test/src
.babelrc
.eslintrc
.gitignore
.istanbul.yml
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

magellan-browserstack-executor

Build Status License: MIT codecov

Executor for Magellan to run Nightwatchjs tests in Browserstack environment.

PLEASE NOTE: Executor is only supported by magellan version 10.0.0 or higher.

What does this executor do

  1. It manages Browserstack Local if you test needs it
  2. It talks Pancake so that the desiredCapabilities shrinks down to a string, which makes your browser selection an easy work
  3. It runs nightwatch test by forking it as magellan child process

How To Use

Please follow the steps

  1. npm install testarmada-magellan-browserstack-executor --save
  2. Add following env variables to your bash system
export BROWSERSTACK_ACCESS_KEY=${YOUR_BROWSERSTACK_ACCESSKEY}
export BROWSERSTACK_USER=${YOUR_BROWSERSTACK_USERNAME}
  1. Add following block to your magellan.json (if there isn't a magellan.json please create one under your folder root)
"executors": [
   "testarmada-magellan-browserstack-executor"
]
  1. ./node_modules/.bin/magellan --help to see if you can see the following content printed out
 Executor-specific (testarmada-magellan-browserstack-executor)
  --bs_browser=browsername             Run tests in chrome, firefox, etc (default: phantomjs).
  --bs_browsers=b1,b2,..               Run multiple browsers in parallel.
  --bs_list_browsers                   List the available browsers configured (Something else integrated).
  --bs_create_tunnel                   Create secure tunnel in browserstack local mode.
  --bs_tunnel_id=testtunnel123123      Use an existing secure tunnel (exclusive with --bs_create_tunnel).
  --bs_enable_more_logs                Enable visual and network logs.
  --bs_app=bs://<hashed app-id>        App id generated by browserstack when app has been uploaded to browserstack.

Congratulations, you're all set.

License

Documentation in this project is licensed under Creative Commons Attribution 4.0 International License. Full details available at https://creativecommons.org/licenses/by/4.0