sauce-connect-launcher

A library to download and launch Sauce Connect.

npm install sauce-connect-launcher
1 053 downloads in the last day
5 312 downloads in the last week
26 525 downloads in the last month

sauce-connect-launcher

Build Status

A library to download and launch Sauce Connect.

Installation

npm install sauce-connect-launcher

Usage


var sauceConnectLauncher = require('sauce-connect-launcher'),
    options = {
        username: 'bermi',
        accessKey: '12345678-1234-1234-1234-1234567890ab',
        verbose: false,
        logfile: null, //optionally change sauce connect logfile location
        tunnelIdentifier: null, // optionally identity the tunnel for concurrent tunnels
        fastFailRexegps: null, // an array or comma-separated list of regexes whose matches will not go through the tunnel
        directDomains: null, // an array or comma-separated list of domains that will not go through the tunnel
        logger: console.log
    };

sauceConnectLauncher(options, function (err, sauceConnectProcess) {
    console.log("Started Sauce Connect Process");
    sauceConnectProcess.close(function () {
        console.log("Closed Sauce Connect process");
    });
});

Credentials

You can also pass the credentials as SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables.

You can also create a user.json file in your current working directory with the username and key

user.json

{"username": "bermi", "accessKey": "12345678-1234-1234-1234-1234567890ab"}

Development

Clone the repository and run

make setup

You will be prompted for Sauce Labs credentials (used for testing). Run

make dev

to start the watcher.

Testing

npm test

or

make test

Changelog

v0.3.0

  • Support Sauce Connect 4.0
  • Use os.tmpdir() for readyfile

License

(The MIT License)

Copyright (c) 2013 Bermi Ferrer <bermi@bermilabs.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you