airtap-sauce

Sauce Labs browser provider. List and run browsers on Sauce Labs.

Table of Contents

Click to expand

• Usage
  • Programmatic
  • With Airtap
• API
  • Sauce([options])
  • Browser options
• Install
• Big Thanks
• License

Usage

Programmatic

const Sauce = require('airtap-sauce')
const provider = new Sauce()

// Get a list of desired browsers
const wanted = [{ name: 'android', version: '5..latest' }]
const manifests = await provider.manifests(wanted)

// Instantiate a browser
const target = { url: 'http://localhost:3000' }
const browser = provider.browser(manifests[0], target)

await browser.open()

With Airtap

providers:
  - airtap-sauce

browsers:
  - name: android
    version: 5..latest

This provider also exposes platform, capabilities and more properties to match on:

browsers:
  - name: chrome
    version: 69
    platform: mac 10.15

API

Sauce([options])

Constructor. Returns an instance of browser-provider. Options:

• username (string): defaults to process.env.SAUCE_USERNAME
• key (string): defaults to process.env.SAUCE_ACCESS_KEY
• hostname (string): defaults to 'ondemand.saucelabs.com'
• port (number): defaults to 80
• tunnel (object): custom options for sauce-connect-launcher

In Airtap these can be set like so:

providers:
  - airtap-sauce:
      tunnel:
        connectRetries: 10

Browser options

• name (string): name for Sauce Labs job, defaults to browser manifest name
• profile (object, only on Firefox): custom user profile to programmatically configure anything that can be changed in about:config
• capabilities (object): custom Selenium capabilities.

In Airtap these can be set like so:

browsers:
  - name: firefox
    options:
      name: my-custom-job-name
      profile:
        webgl.force-enabled: true

Install

With npm do:

npm install airtap-sauce

Big Thanks

Cross-browser Testing Platform and Open Source ♥ Provided by Sauce Labs.

License

MIT © 2018 Roman Shtylman, Zuul contributors and Airtap contributors