Package Exports

saucelabs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (saucelabs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Trophy bot

Node Sauce Labs

Wrapper around the Sauce Labs REST APIs for Node.js.

Install

To install the package run:

npm install saucelabs

Options

user

Your Sauce Labs username.

Type: string
Default: process.env.SAUCE_USERNAME

key

Your Sauce Labs access key.

Type: string
Default: process.env.SAUCE_ACCESS_KEY

region

Your Sauce Labs datacenter region. The following regions are available: us-west-1 (short us), eu-central-1 (short eu).

Type: string
Default: us

headless

If set to true you are accessing the headless Sauce instances (this discards the region option).

Type: boolean
Default: false

Usage

All accessible API commands with descriptions can be found here.

As CLI Tool

This package if installed globally can be used as CLI tool to access the API from the command line:

$ npm install -g saucelabs
...
$ sl listJobs $SAUCE_USERNAME --limit 5 --region eu
{ jobs:
   [ { id: '19dab74f8fd848518f8d2c2cee3a6fbd' },
     { id: 'dc08ca0c7fa14eee909a093d11567328' },
     { id: '5bc6f70c777b4ae3bf7909a40f5ee41b' },
     { id: 'f40fe7b044754eaaa5f5a130406549b5' },
     { id: 'd1553f71f910402893f1e82a4dcb6ca6' } ] }

You can find all available commands and options with description by calling:

sl --help
# show description for specific command
sl listJobs --help

As NPM Package

The following example shows how to access details of the last job you were running with your account that is being exposed as environment variables as SAUCE_USERNAME and SAUCE_ACCESS_KEY.

import SauceLabs from 'saucelabs';

(async () => {
    const myAccount = new SauceLabs();

    // get job details of last run job
    const job = await user.listJobs(
        process.env.SAUCE_USERNAME,
        { limit: 1, full: true }
    );

    console.log(job);
    /**
     * outputs:
     * { jobs:
        [ { browser_short_version: '72',
            video_url:
             'https://assets.saucelabs.com/jobs/dc08ca0c7fa14eee909a093d11567328/video.flv',
            creation_time: 1551711453,
            'custom-data': null,
            browser_version: '72.0.3626.81',
            owner: '<username-redacted>',
            id: 'dc08ca0c7fa14eee909a093d11567328',
            record_screenshots: true,
            record_video: true,
            build: null,
            passed: null,
            public: 'team',
            end_time: 1551711471,
            status: 'complete',
            log_url:
             'https://assets.saucelabs.com/jobs/dc08ca0c7fa14eee909a093d11567328/selenium-server.log',
            start_time: 1551711454,
            proxied: false,
            modification_time: 1551711471,
            tags: [],
            name: null,
            commands_not_successful: 1,
            consolidated_status: 'complete',
            manual: false,
            assigned_tunnel_id: null,
            error: null,
            os: 'Windows 2008',
            breakpointed: null,
            browser: 'googlechrome' } ] }
     */
})

Test

To run the test suite, first invoke the following command within the repo, installing the development dependencies:

npm install

Then run the tests:

npm test