Karma-Sauce2-Launcher
This is forked and updated version of the Karma-Sauce-Launcher
Installation
Install karma-sauce2-launcher
as a devDependency
in your package.json:
npm install karma-sauce2-launcher --save-dev
Usage
Run your unit tests on Sauce Labs' browser cloud!
This launcher is dependant on the changes made in Karma Pull Request 2793 Prior to acceptance you will need to make the following changes to the Karma package:
/node_modules/karma/lib/browsers.js
add this.allResults = []
below line 68
replace line 213 this.onResult{...}
with
this { if resultlength thisallResults = result return result if this return thislastResult emitter }
This launcher is typically used in CI to run your unit tests across many browsers and platforms on Sauce Labs. It is expected that you are already familiar with Karma when configuring this launcher, so if you are new to Karma, head over to the Karma website.
Adding karma-sauce-launcher to an existing Karma config
To configure karma-sauce2-launcher, you need to add two properties to your top-level Karma config, sauceLabs
and customLaunchers
, set the browsers
array to use Sauce Labs browsers, and add the sauceLabs
reporter.
The sauceLabs
object defines global properties for each browser/platform while the customLaunchers
object configures individual browsers. The sauceLabs
reporter allows your tests results to be properly displayed on https://saucelabs.com. Here is a sample Karma config to get the launcher running:
Note: this config assumes that process.env.SAUCE_USERNAME
and process.env.SAUCE_ACCESS_KEY
are set.
module { // Example set of browsers to run on Sauce Labs // Check out https://saucelabs.com/platforms for all browser/platform combinations var customLaunchers = sl_chrome: base: 'SauceLabs' browserName: 'chrome' platform: 'Windows 7' version: '35' sl_firefox: base: 'SauceLabs' browserName: 'firefox' version: '30' sl_ios_safari: base: 'SauceLabs' browserName: 'iphone' platform: 'OS X 10.9' version: '7.1' sl_ie_11: base: 'SauceLabs' browserName: 'internet explorer' platform: 'Windows 8.1' version: '11' config}
sauceLabs
config properties are shared across all browsers
username
Type: String
Default: process.env.SAUCE_USERNAME
Your Sauce Labs username (if you don't have an account, you can sign up here).
accessKey
Type: String
Default: process.env.SAUCE_ACCESS_KEY
Your Sauce Labs access key which you will see on your account page.
startConnect
Type: Boolean
Default: true
If true
, Sauce Connect will be started automatically. Set this to false
if you are launching tests locally and want to start Sauce Connect via a binary or the Mac app in the background to improve test speed.
connectOptions
Type: Object
Default:
username: 'yourUsername' accessKey: 'yourAccessKey' tunnelIdentifier: 'autoGeneratedTunnelID'
Options to send to Sauce Connect. Check here for all available options.
build
Type: String
Default: One of the following environment variables:
process.env.BUILD_NUMBER
process.env.BUILD_TAG
process.env.CI_BUILD_NUMBER
process.env.CI_BUILD_TAG
process.env.TRAVIS_BUILD_NUMBER
process.env.CIRCLE_BUILD_NUM
process.env.DRONE_BUILD_NUMBER
ID of the build currently running. This should be set by your CI.
testName
Type: String
Default: 'Karma test'
Name of the unit test group you are running.
tunnelIdentifier
Type: String
Sauce Connect can proxy multiple sessions, this is an id of a session.
tags
Type: Array of Strings
Tags to use for filtering jobs in your Sauce Labs account.
recordVideo
Type: Boolean
Default: false
Set to true
if you want to record a video of your Karma session.
recordScreenshots
Type: Boolean
Default: true
Set to false
if you don't want to record screenshots.
public
Type: String
Default: null
Control who can view job details. Available visibility levels are documented on the SauceLabs website.
customData
Type: Object
Default: {}
Send arbitrary data alongside your tests. See the SauceLabs documentation for more details.
customLaunchers
config properties
The customLaunchers
object has browser names as keys and configs as values. Documented below are the different properties which you can configure for each browser/platform combo.
Note: You can learn about the available browser/platform combos on the Sauce Labs platforms page, platforms configurator page and REST API page.
base
Type: String
Required: true
This defines the base configuration for the launcher. In this case it should always be SauceLabs
so that browsers can use the base Sauce Labs config defined at the root sauceLabs
property.
browserName
Type: String
Required: true
Name of the browser.
version
Type: String
Default: Latest browser version for all browsers except Chrome which defaults to '27'
Version of the browser to use.
platform
Type: String
Default: 'Linux'
for Firefox/Chrome, 'Windows 7'
for IE/Safari
Name of platform to run browser on.
deviceOrientation
Type: String
Default: 'portrait'
Accepted values: 'portrait' || 'landscape'
Set this string if your unit tests need to run on a particular mobile device orientation for Android Browser or iOS Safari.
Behind the scenes
This launcher uses Sauce Connect in the background. If you are interested in security or want to see the system requirements, head over to the documentation.