digdug/TestingBotTunnel

Inheritance

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

new (require("digdug/TestingBotTunnel"))()

A TestingBot tunnel.

All Properties

Property Defined by
apiKey: string

The TestingBot API key.

digdug/TestingBotTunnel
apiSecret: string

The TestingBot API secret.

digdug/TestingBotTunnel
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
directory: string

The directory where the tunnel software will be extracted.

digdug/Tunnel

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

digdug/TestingBotTunnel
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/TestingBotTunnel
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
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/TestingBotTunnel
pathname: string

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

digdug/Tunnel
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
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
useCompression: boolean

Whether or not to use rabbIT compression for the tunnel connection.

digdug/TestingBotTunnel
useJettyProxy: boolean

Whether or not to use the default local Jetty proxy for the tunnel.

digdug/TestingBotTunnel
useSquidProxy: boolean

Whether or not to use the default remote Squid proxy for the VM.

digdug/TestingBotTunnel
useSsl: boolean

Whether or not to re-encrypt data encrypted by self-signed certificates.

digdug/TestingBotTunnel
verbose: boolean

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

digdug/Tunnel

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

apiKey: string

The TestingBot API key.

Defaults to

'the value of the TESTINGBOT_API_KEY environment variable'

apiSecret: string

The TestingBot API secret.

Defaults to

'the value of the TESTINGBOT_API_SECRET environment variable'

environmentUrl

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

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.

logFile: string

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

useCompression: boolean

Whether or not to use rabbIT compression for the tunnel connection.

Defaults to

false

useJettyProxy: boolean

Whether or not to use the default local Jetty proxy for the tunnel.

Defaults to

true

useSquidProxy: boolean

Whether or not to use the default remote Squid proxy for the VM.

Defaults to

true

useSsl: boolean

Whether or not to re-encrypt data encrypted by self-signed certificates.

Defaults to

false