saucelabs

What is saucelabs?

The 'saucelabs' npm package provides a Node.js client for interacting with the Sauce Labs API. Sauce Labs is a cloud-based platform for automated testing of web and mobile applications. This package allows you to manage Sauce Labs resources, such as jobs, tunnels, and assets, programmatically.

What are saucelabs's main functionalities?

Managing Jobs

This feature allows you to manage and retrieve details about your Sauce Labs jobs. The code sample demonstrates how to get details of a specific job using its job ID.

const { SauceLabs } = require('saucelabs');
const saucelabs = new SauceLabs({ user: 'your-username', key: 'your-access-key' });

async function getJobDetails(jobId) {
  const job = await saucelabs.getJob(jobId);
  console.log(job);
}

getJobDetails('your-job-id');

Managing Tunnels

This feature allows you to manage Sauce Connect tunnels. The code sample demonstrates how to list all active tunnels.

const { SauceLabs } = require('saucelabs');
const saucelabs = new SauceLabs({ user: 'your-username', key: 'your-access-key' });

async function getTunnels() {
  const tunnels = await saucelabs.listTunnels();
  console.log(tunnels);
}

getTunnels();

Uploading Assets

This feature allows you to upload assets to a specific job. The code sample demonstrates how to upload a file to a job using its job ID.

const { SauceLabs } = require('saucelabs');
const saucelabs = new SauceLabs({ user: 'your-username', key: 'your-access-key' });

async function uploadAsset(jobId, filePath) {
  const response = await saucelabs.uploadJobAssets(jobId, { files: [filePath] });
  console.log(response);
}

uploadAsset('your-job-id', 'path/to/your/file');

Other packages similar to saucelabs

webdriverio

WebdriverIO is a popular testing utility for Node.js that provides a high-level API for browser automation. It supports multiple browser drivers and services, including Sauce Labs. Compared to the 'saucelabs' package, WebdriverIO offers a more comprehensive solution for writing and running tests, while 'saucelabs' focuses on managing Sauce Labs resources.

selenium-webdriver

Selenium WebDriver is a widely-used tool for browser automation. It provides bindings for multiple programming languages, including JavaScript. While Selenium WebDriver can be used with Sauce Labs for running tests on their cloud infrastructure, it does not provide the same level of resource management capabilities as the 'saucelabs' package.

cypress

Cypress is an end-to-end testing framework that aims to make testing fast, easy, and reliable. It provides a rich API for writing tests and a powerful test runner. While Cypress does not natively integrate with Sauce Labs, it can be configured to run tests on Sauce Labs infrastructure. Compared to 'saucelabs', Cypress focuses more on the testing experience and less on resource management.

README

node-saucelabs -- Node wrapper around the Saucelabs REST API

Download or update node

http://nodejs.org/#download

Install

npm install saucelabs

Authors

• Dan Jenkins (danjenkins)
• Mathieu Sabourin (OniOni)

Writting a script

var sauce = require('saucelabs');

var myAccount = new sauce({
    username: "your-sauce-username",
    password: "your-sauce-api-key",
})

myAccount.getAccountDetails( function (err, res) {
    console.log(res);
    myAccount.getServiceStatus( function (err, res) {
	//Status of the Sauce Labs services
	console.log(res);
	myAccount.getBrowsers( function (err, res) {
	    //List of all browser/os combinations currently supported on Sauce Labs.
	    console.log(res);
	    myAccount.getJobs( function (err, res) {
		//Get a list of all your jobs
		for (k in jobs) {
		    myAccount.showJob(jobs[k].id, function (err, res) {
			var str = res.id +": Status: "+ res.status;
			if (res.error) {
			    str += "\033[31m Error: "+res.error+" \033[0m";
			}
			console.log(str);
		    })
		}
	    })
	})
    })
});

Supported Methods

Rest	Node Wrapper
GET /users/:username Access account details.	getAccountDetails(cb) -> cb(err, res)
GET /:username/limits Access account details	getAccountLimits(cb) -> cb(err, res)
GET /:username/activity Access current account activity.	getUserActivity(cb, start, end) -> cb(err, res)
GET /users/:username/usage Access historical account usage data.	getAccountUsage(cb) -> cb(err, res)
GET /:username/jobs List all job Id's belonging to a given user.	getJobs(cb) -> cb(err, res)
GET /:username/jobs/:id Show the full information for a job given its ID.	showJob(id, cb) -> cb(err, res)
PUT /:username/jobs/:id Changes a pre-existing job.	updateJob(id, data, cb) -> cb(err, res)
PUT /:username/jobs/:id/stop Terminates a running job.	stopJob(id, data, cb) -> cb(err, res)
GET /:username/tunnels Retrieves all running tunnels for a given user.	getActiveTunnels(cb) -> cb(err, res)
GET /:username/tunnels/:id Show the full information for a tunnel given its ID.	getTunnel(id, cb) -> cb(err, res)
DELETE /:username/tunnels/:id Shuts down a tunnel given its ID.	deleteTunnel(id, cb) -> cb(err, res)
GET /info/status Returns the current status of Sauce Labs' services.	getServicesStatus(cb) -> cb(err, res)
GET /info/browsers Returns an array of strings corresponding to all the browsers currently supported on Sauce Labs.	getBrowsers(cb) -> cb(err, res)
GET /info/counter Returns the number of test executed so far on Sauce Labs.	getTestCounter(cb) -> cb(err, res)
POST /users/:id Create a new sub-account, specifying a Sauce Labs service plan.	createSubAccount(data, cb) -> cb(err, res)
POST /users/:id/subscription	...
Make a public link to a private job, no need to login	createPublicLink(job_id, datetime, use_hour, cb) -> cb(err, url) createPublicLink(job_id, datetime, cb) -> cb(err, url) createPublicLink(job_id, cb) -> cb(err, url)

More Documentation

Check out the Sauce REST API for more information

License

saucelabs is licensed under the MIT license.