com.dev9.sauce

Class SauceREST

java.lang.Object

com.dev9.sauce.SauceREST

public class SauceREST
extends Object

Used to access the Sauce Labs rest API. Based on Sauce Labs code, on github: https://github.com/saucelabs/saucerest-java.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accessKey
protected String	username

Constructor Summary

Constructors

Constructor and Description
SauceREST(String username, String accessKey) Constructs a SauceREST object with all necessary authentication information.

Method Summary

Modifier and Type	Method and Description
org.json.simple.JSONObject	deleteTunnel(String tunnelId)
org.json.simple.JSONObject	getAccountDetails() Returns details for a given Sauce Labs account, including minutes used.
org.json.simple.JSONArray	getAllJobs() Gets a list of all jobs ever for the user, not just current jobs.
org.json.simple.JSONArray	getAllTunnels()
org.json.simple.JSONObject	getJobStatus(String jobId) Returns status details for a given job, including pass/fail and all tags.
org.json.simple.JSONArray	getSauceBrowsers() Gets a list of all currently supported browser/os combinations.
org.json.simple.JSONObject	getSauceStatus() Not currently supported by Sauce Labs, but will one day return status of Sauce Labs services.
org.json.simple.JSONObject	getTunnelStatus(String tunnelId)
org.json.simple.JSONObject	getUsageData() Returns detailed usage data for the Sauce Labs account, including minutes used on a daily basis.
boolean	isTunnelPresent() Verifies that one or more tunnels exist (but does not check tunnel state).
org.json.simple.JSONObject	jobFailed(String jobId) Marks a job as failed; will appear as such in jobs list in Sauce Labs.
org.json.simple.JSONObject	jobPassed(String jobId) Marks a job as passed; will appear as such in jobs list in Sauce Labs.
Object	sendRestRequest(SauceRESTRequest request) Send a request to Sauce Labs configured using a SauceRESTRequest object.
org.json.simple.JSONObject	stopJob(String jobId) Stop a currently running job.
org.json.simple.JSONObject	updateJob(String jobId, String jsonKey, Object jsonValue) Updates a job in Sauce Labs with an arbitrary JSON key/value pair.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

username

protected String username

accessKey

protected String accessKey

Constructor Detail

SauceREST

public SauceREST(String username,
                 String accessKey)

Constructs a SauceREST object with all necessary authentication information.

Parameters:

username - A Sauce Labs user name.

accessKey - The Sauce Labs key corresponding to the user name.

Method Detail

getAccountDetails

public org.json.simple.JSONObject getAccountDetails()

Returns details for a given Sauce Labs account, including minutes used.

Returns:

the result of the request

getUsageData

public org.json.simple.JSONObject getUsageData()

Returns detailed usage data for the Sauce Labs account, including minutes used on a daily basis.

Returns:

the result of the request

getAllJobs

public org.json.simple.JSONArray getAllJobs()

Gets a list of all jobs ever for the user, not just current jobs.

Returns:

the result of the request

getJobStatus

public org.json.simple.JSONObject getJobStatus(String jobId)

Returns status details for a given job, including pass/fail and all tags.

Parameters:

jobId - The session id for a Sauce job.

Returns:

the result of the request

jobPassed

public org.json.simple.JSONObject jobPassed(String jobId)

Marks a job as passed; will appear as such in jobs list in Sauce Labs.

Parameters:

jobId - The session id for the Sauce Job that passed.

Returns:

the result of the request

jobFailed

public org.json.simple.JSONObject jobFailed(String jobId)

Marks a job as failed; will appear as such in jobs list in Sauce Labs.

Parameters:

jobId - The session id for the Sauce Job that failed.

Returns:

the result of the request

updateJob

public org.json.simple.JSONObject updateJob(String jobId,
                                            String jsonKey,
                                            Object jsonValue)

Updates a job in Sauce Labs with an arbitrary JSON key/value pair. Note that Sauce Labs will not accept arbitrary values; see documentation on their site.

Parameters:

jobId - The session id for the Sauce job to update.

jsonKey - A String key for the json object.

jsonValue - A value for the json object (discrete, a list, or a map, for instance).

Returns:

the result of the request

stopJob

public org.json.simple.JSONObject stopJob(String jobId)

Stop a currently running job. Should not be necessary to use in parallel-webtest.

Parameters:

jobId - The session id for the Sauce job to update.

Returns:

the result of the request

isTunnelPresent

public boolean isTunnelPresent()

Verifies that one or more tunnels exist (but does not check tunnel state).

Returns:

true if tunnel is present

getAllTunnels

public org.json.simple.JSONArray getAllTunnels()

getTunnelStatus

public org.json.simple.JSONObject getTunnelStatus(String tunnelId)

deleteTunnel

public org.json.simple.JSONObject deleteTunnel(String tunnelId)

getSauceStatus

public org.json.simple.JSONObject getSauceStatus()

Not currently supported by Sauce Labs, but will one day return status of Sauce Labs services.

Returns:

the result of the request

getSauceBrowsers

public org.json.simple.JSONArray getSauceBrowsers()

Gets a list of all currently supported browser/os combinations.

Returns:

the result of the request

sendRestRequest

public Object sendRestRequest(SauceRESTRequest request)

Send a request to Sauce Labs configured using a SauceRESTRequest object.

Parameters:

request - An object containing all details for the REST request.

Returns:

the result of the request