edp-browser-launcher2
v0.4.5
Published
Detect, launch and stop browser versions
Downloads
7
Maintainers
Readme
edp-browser-launcher2
Detect the browser versions available on your system and launch them in an isolated profile for automated testing purposes.
You can launch browsers headlessly (using Xvfb or with PhantomJS) and set the proxy configuration on the fly.
It's a fork of benderjs/browser-launcher2.
Differences from browser-launcher2
- config directory relies on package name
- change plist.parseFile to plist.parse
Supported browsers
The goal for this module is to support all major browsers on every desktop platform.
At the moment, edp-browser-launcher2
supports following browsers on Windows, Unix and OS X:
- Chrome
- Chromium
- Firefox
- IE (Windows only)
- Opera
- Safari
- PhantomJS
Install
npm install edp-browser-launcher2
Example
Browser launch
var launcher = require( 'edp-browser-launcher2' );
launcher( function( err, launch ) {
if ( err ) {
return console.error( err );
}
launch( 'http://cksource.com/', 'chrome', function( err, instance ) {
if ( err ) {
return console.error( err );
}
console.log( 'Instance started with PID:', instance.pid );
instance.on( 'stop', function( code ) {
console.log( 'Instance stopped with exit code:', code );
} );
} );
} );
Outputs:
$ node example/launch.js
Instance started with PID: 12345
Instance stopped with exit code: 0
Browser detection
var launcher = require( '../' );
launcher.detect( function( available ) {
console.log( 'Available browsers:' );
console.dir( available );
} );
Outputs:
$ node example/detect.js
Available browsers:
[ { name: 'chrome',
version: '36.0.1985.125',
type: 'chrome',
command: 'google-chrome' },
{ name: 'chromium',
version: '36.0.1985.125',
type: 'chrome',
command: 'chromium-browser' },
{ name: 'firefox',
version: '31.0',
type: 'firefox',
command: 'firefox' },
{ name: 'phantomjs',
version: '1.9.7',
type: 'phantom',
command: 'phantomjs' },
{ name: 'opera',
version: '12.16',
type: 'opera',
command: 'opera' } ]
API
var launcher = require('edp-browser-launcher2');
launcher([configPath], callback)
Detect available browsers and pass launch
function to the callback.
Parameters:
- String
configPath
- path to a browser configuration file (Optional) - Function
callback(err, launch)
- function called withlaunch
function and errors (if any)
launch(uri, options, callback)
Open given URI in a browser and return an instance of it.
Parameters:
- String
uri
- URI to open in a newly started browser - Object|String
options
- configuration options or name of a browser to launch - String
options.browser
- name of a browser to launch - String
options.version
- version of a browser to launch, if none was given, the highest available version will be launched - Array
options.options
- additional command line options - String
options.proxy
- URI of the proxy server - Boolean
options.noProxy
- set proxy routes to skip over - Boolean
options.headless
- run a browser in a headless mode (only if Xvfb available) - Function
callback(err, instance)
- function fired when started a browserinstance
or an error occurred
launch.browsers
This property contains an array of all known and available browsers.
instance
Browser instance object.
Properties:
- String
command
- command used to start the instance - Array
args
- array of command line arguments used while starting the instance - String
image
- instance's image name - String
processName
- instance's process name - Object
process
- reference to instance's process started with Node'schild_process.spawn
API - Number
pid
- instance's process PID - Stream
stdout
- instance's process STDOUT stream - Stream
stderr
- instance's process STDERR stream
Events:
stop
- fired when instance stops
Methods:
stop(callback)
- stop the instance and fire the callback once stopped
launcher.detect(callback)
Detects all browsers available.
Parameters:
- Function
callback(available)
- function called with array of all recognized browsers
Each browser contains following properties:
name
- name of a browserversion
- browser's versiontype
- type of a browser i.e. browser's familycommand
- command used to launch a browser
launcher.update([configDir], callback)
Updates the browsers cache file (~/.config/browser-launcher/config.json
is no configDir
was given) and creates new profiles for found browsers.
Parameters:
- String
configDir
- path to a directory containing configuration file Optional - Function
callback(err, browsers)
- function called with found browsers and errors (if any)
License
MIT