digdug/SauceLabsTunnel

Inheritance

  1. digdug/SauceLabsTunnel
  2. module:digdug/Tunnel
  3. Object

new (require("digdug/SauceLabsTunnel"))()

A Sauce Labs tunnel. This tunnel uses Sauce Connect 4 on platforms where it is supported, and Sauce Connect 3 on all other platforms.

All Properties

Property Defined by
accessKey: string

The Sauce Labs access key.

digdug/SauceLabsTunnel
architecture: string

The architecture the tunnel will run against.

digdug/Tunnel
auth: string

An HTTP authorization string to use when initiating connections to the tunnel.

digdug/Tunnel
clientUrl: string
(readonly)

The URL that a WebDriver client should used to interact with this service.

digdug/Tunnel
directDomains: Array.<string>

A list of domains that should not be proxied by the tunnel on the remote VM.

digdug/SauceLabsTunnel
directory: string

The directory where the tunnel software will be extracted.

digdug/Tunnel
domainAuthentication: Array.<string>

A list of URLs that require additional HTTP authentication.

digdug/SauceLabsTunnel

The URL of a service that provides a list of environments supported by Sauce Labs.

digdug/SauceLabsTunnel
executable: string

The executable to spawn in order to create a tunnel.

digdug/Tunnel
(readonly)

A map of additional capabilities that need to be sent to the provider when a new session is being created.

digdug/Tunnel
fastFailDomains: Array.<string>

A list of regular expressions corresponding to domains whose connections should fail immediately if the VM attempts to make a connection to them.

digdug/SauceLabsTunnel
hostname: string

The host on which a WebDriver client can access the service provided by the tunnel.

digdug/Tunnel
isDownloaded: string
(readonly)

Whether or not the tunnel software has already been downloaded.

digdug/Tunnel
isRunning: boolean
(readonly)

Whether or not the tunnel is currently running.

digdug/Tunnel
isSharedTunnel: boolean

Allows the tunnel to also be used by sub-accounts of the user that started the tunnel.

digdug/SauceLabsTunnel
isStarting: boolean
(readonly)

Whether or not the tunnel is currently starting up.

digdug/Tunnel
isStopping: boolean
(readonly)

Whether or not the tunnel is currently stopping.

digdug/Tunnel
logFile: string

A filename where additional logs from the tunnel should be output.

digdug/SauceLabsTunnel
logFileSize: number

Specifies the maximum log filesize before rotation, in bytes.

digdug/SauceLabsTunnel
logTrafficStats: number

Log statistics about HTTP traffic every logTrafficStats milliseconds.

digdug/SauceLabsTunnel
pathname: string

The path that a WebDriver client should use to access the service provided by the tunnel.

digdug/Tunnel
pidFile: string

A filename where Sauce Connect stores its process information.

digdug/SauceLabsTunnel
platform: string

The operating system the tunnel will run on.

digdug/Tunnel
port: number

The local port where the WebDriver server should be exposed by the tunnel.

digdug/Tunnel
protocol: string

The protocol (e.g., 'http') that a WebDriver client should use to access the service provided by the tunnel.

digdug/Tunnel
proxy: string

The URL of a proxy server for the tunnel to go through.

digdug/Tunnel
restUrl: string

An alternative URL for the Sauce REST API.

digdug/SauceLabsTunnel
skipSslDomains: Array.<string>

A list of domains that should not have their SSL connections re-encrypted when going through the tunnel.

digdug/SauceLabsTunnel
squidOptions: string

An additional set of options to use with the Squid proxy for the remote VM.

digdug/SauceLabsTunnel
tunnelDomains: Array.<string>

A list of domains that will be proxied by the tunnel on the remote VM.

digdug/SauceLabsTunnel
tunnelId: string

A unique identifier for the newly created tunnel.

digdug/Tunnel
url: string

The URL where the tunnel software can be downloaded.

digdug/Tunnel

Whether or not to use the proxy defined at digdug/Tunnel#proxy for the tunnel connection itself.

digdug/SauceLabsTunnel
username: string

The Sauce Labs username.

digdug/SauceLabsTunnel
verbose: boolean

Whether or not to tell the tunnel to provide verbose logging output.

digdug/Tunnel
vmVersion: string

Overrides the version of the VM created on Sauce Labs.

digdug/SauceLabsTunnel

All Methods

Method Defined by
_makeArgs(): Array.<string>
(protected)

Creates the list of command-line arguments to be passed to the spawned tunnel.

digdug/Tunnel
_makeChild(): Object
(protected)

Creates a newly spawned child process for the tunnel software.

digdug/Tunnel
_makeOptions(): Object
(protected)

Creates the set of options to use when spawning the tunnel process.

digdug/Tunnel

Called with the response after a file download has completed

digdug/Tunnel
_start(): Object
(protected)

This method provides the implementation that actually starts the tunnel and any other logic for emitting events on the Tunnel based on data passed by the tunnel software.

digdug/Tunnel
_stop(): Promise.<void>
(protected)

This method provides the implementation that actually stops the tunnel.

digdug/Tunnel
download(forceDownload: boolean): Promise.<void>

Downloads and extracts the tunnel software if it is not already downloaded.

digdug/Tunnel

Get a list of environments available on the service.

digdug/Tunnel
sendJobState(jobId: string, data: JobState): Promise.<void>

Sends information about a job to the tunnel provider.

digdug/Tunnel
start(): Promise.<void>

Starts the tunnel, automatically downloading dependencies if necessary.

digdug/Tunnel
stop(): Promise.<integer>

Stops the tunnel.

digdug/Tunnel

All Events

Event Defined by

Part of the tunnel has been downloaded from the server.

digdug/Tunnel

Information about the status of the tunnel setup process that is suitable for presentation to end-users.

digdug/Tunnel

A chunk of raw string data output by the tunnel software to stderr.

digdug/Tunnel

A chunk of raw string data output by the tunnel software to stdout.

digdug/Tunnel

Properties

accessKey: string

The Sauce Labs access key.

Defaults to

'the value of the SAUCE_ACCESS_KEY environment variable'

directDomains: Array.<string>

A list of domains that should not be proxied by the tunnel on the remote VM.

domainAuthentication: Array.<string>

A list of URLs that require additional HTTP authentication. Only the hostname, port, and auth are used. This property is only supported by Sauce Connect 4 tunnels.

environmentUrl

The URL of a service that provides a list of environments supported by Sauce Labs.

fastFailDomains: Array.<string>

A list of regular expressions corresponding to domains whose connections should fail immediately if the VM attempts to make a connection to them.

isSharedTunnel: boolean

Allows the tunnel to also be used by sub-accounts of the user that started the tunnel.

Defaults to

false

logFile: string

A filename where additional logs from the tunnel should be output.

logFileSize: number

Specifies the maximum log filesize before rotation, in bytes. This property is only supported by Sauce Connect 3 tunnels.

logTrafficStats: number

Log statistics about HTTP traffic every logTrafficStats milliseconds. This property is only supported by Sauce Connect 4 tunnels.

Defaults to

0

pidFile: string

A filename where Sauce Connect stores its process information.

restUrl: string

An alternative URL for the Sauce REST API. This property is only supported by Sauce Connect 3 tunnels.

skipSslDomains: Array.<string>

A list of domains that should not have their SSL connections re-encrypted when going through the tunnel.

squidOptions: string

An additional set of options to use with the Squid proxy for the remote VM. This property is only supported by Sauce Connect 3 tunnels.

tunnelDomains: Array.<string>

A list of domains that will be proxied by the tunnel on the remote VM.

useProxyForTunnel: boolean

Whether or not to use the proxy defined at digdug/Tunnel#proxy for the tunnel connection itself.

Defaults to

false

username: string

The Sauce Labs username.

Defaults to

'the value of the SAUCE_USERNAME environment variable'

vmVersion: string

Overrides the version of the VM created on Sauce Labs. This property is only supported by Sauce Connect 3 tunnels.