hermione-tunnel
v1.0.0
Published
Plugin for setting up ssh tunnel while running tests with Hermione
Downloads
7
Readme
hermione-tunnel
Plugin for setting up ssh tunnel while running tests with Hermione.
Installation
npm i hermione-tunnel
Configuration
- host (mandatory)
String
Address of remote host to which tunnel will be established. - ports (mandatory)
Object
Ports range on remote host, port will be picked randomly from this range. If you want to set specific port, min and max values must be the same. - ports.min (mandatory)
Number
Min port number. - ports.max (mandatory)
Number
Max port number. - localport (mandatory)
Number|Function
Available port on local machine. If set toFunction
, it should returnPromise
which will be resolved with the actual port number. If promise is rejected, plugin will fail. - enabled (optional)
Boolean
Determines whether plugin is enabled. If set tofalse
plugin will do nothing. Defaults totrue
. - retries (optional)
Number
of attempts to establish tunnel. Defaults to5
. - protocol (optional)
String
Protocol which will be used in resulting root url. Defaults tohttp
.
Set the configuration to your .hermione.conf.js
plugins: {
'hermione-tunnel': {
host: remote_host_address,
ports: {
min: 8201,
max: 8400
},
localport: 3333,
retries: 3,
protocol: 'https'
}
}