digdug/CrossBrowserTestingTunnel

Inheritance

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

new (require("digdug/CrossBrowserTestingTunnel"))()

A CrossBrowserTesting tunnel.

This tunnel requires some non-standard configuration options (vs the other tunnels):

  1. The capabilities must include the username, API key, browser_api_name, and os_api_name properties
  2. The Intern proxyUrl must use 'local' instead of 'localhost'

An Intern config using this tunnel might be look like:

define({
    proxyUrl: 'http://local:9000',

    tunnel: 'CrossBrowserTesting',

    environments: [
        {
            browserName: 'chrome',
            os_api_name: 'Win10',
            browser_api_name: 'Chrome52'
        }
    ]

    // Other Intern config options...
});

Source

CrossBrowserTestingTunnel.js, line 15

All Properties

Property Defined by
apiKey: string

The CrossBrowserTesting API key.

 digdug/CrossBrowserTestingTunnel
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
environmentUrl

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

 digdug/CrossBrowserTestingTunnel
executable: string

The executable to spawn in order to create a tunnel.

 digdug/Tunnel
extraCapabilities: string
(readonly)

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

 digdug/Tunnel
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
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
username: string

The CrossBrowserTesting username.

 digdug/CrossBrowserTestingTunnel
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
_postDownloadFile()

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
getEnvironments()

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
downloadprogress

Part of the tunnel has been downloaded from the server.

 digdug/Tunnel
status

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

 digdug/Tunnel
stderr

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

 digdug/Tunnel
stdout

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

 digdug/Tunnel

Properties

apiKey: string

The CrossBrowserTesting API key. This will be initialized with the value of the CBT_APIKEY environment variable.

Defaults to

'the value of the CBT_APIKEY environment variable'

Source

CrossBrowserTestingTunnel.js, line 65

environmentUrl

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

Source

CrossBrowserTestingTunnel.js, line 79

username: string

The CrossBrowserTesting username. This will be initialized with the value of the CBT_USERNAME environment variable.

Defaults to

'the value of the CBT_USERNAME environment variable'

Source

CrossBrowserTestingTunnel.js, line 74