gulp-protractor
Version:
A helper for protactor and gulp
155 lines (101 loc) • 4.77 kB
Markdown
# gulp-protractor [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url]
> Run your [angular protractor](https://github.com/angular/protractor) tests with [gulp](https://github.com/wearefractal/gulp)
## Usage
First, install `gulp-protractor` as a development dependency:
```shell
npm install --save-dev gulp-protractor
```
Then, add it to your `gulpfile.js`:
```javascript
var protractor = require("gulp-protractor").protractor;
gulp.src(["./src/tests/*.js"])
.pipe(protractor({
configFile: "test/protractor.config.js",
args: [
'--baseUrl', 'http://127.0.0.1:8000',
'--suite', 'login',
'--params.environment', 'test'
]
}))
.on('error', function(e) { throw e })
```
### Protractor Webdriver
You have to update and start a standalone selenium server. [Please read the offical instructions](https://github.com/angular/protractor#appendix-a-setting-up-a-standalone-selenium-server).
You can also ensure that the driver is installed by using the `webdriver_update` task. Have a look at the example folder.
You have 2 options to start the selenium server.
The first one is to let Protractor handle it automatically, including stopping it once your tests are done.
To do that, simply point to the selenium jar in the protractor config file (you will need to update the version number accordingly) instead of the address:
```javascript
// The file path to the selenium server jar ()
seleniumServerJar: './node_modules/protractor/node_modules/webdriver-manager/selenium/selenium-server-standalone-3.2.0.jar',
// seleniumAddress: 'http://localhost:4444/wd/hub',
```
The second option is to let the gulp task handle it with the built-in webdriver snippet.
If you decide to start it that way, the task will keep running indefinitely.
```javascript
var webdriver_standalone = require("gulp-protractor").webdriver_standalone;
gulp.task('webdriver_standalone', webdriver_standalone);
```
## API
### protractor(options)
#### options.configFile
Type: `String`
Default: `null`
The path to your protractor config
#### options.args
Type: `Array`
Default: `[]`
Arguments get passed directly to the protractor call [Read the docs for more information](https://github.com/angular/protractor/blob/master/docs/getting-started.md#setup-and-config)
#### options.debug
Type: `Boolean`
Default: `false`
Enables Protractor's [debug mode](https://github.com/angular/protractor/blob/master/docs/debugging.md), which can be used to pause tests during execution and to view stack traces.
### webdriver_update_specific(options)
#### options.webDriverManagerArgs
Type: `Array`
Default: `[]`
```javascript
// Download and update the selenium driver
var webdriver_update = require('gulp-protractor').webdriver_update_specific;
// Downloads the selenium webdriver - stupid solution to pass extra args like ignore_ssl
gulp.task('webdriver_update', webdriver_update({
webdriverManagerArgs: ['--ignore_ssl']
}));
```
## Running Protractor without a plugin
If you want to avoid using a plugin at all, here are gulp tasks which install the webdriver and start protractor:
First install the protractor package:
```npm install --save-dev protractor```
Then add these tasks to your ```gulpfile.js```:
```javascript
// gulpfile.js should be in workspace root for this example
var gulp = require('gulp');
var path = require('path');
var child_process = require('child_process');
function getProtractorBinary(binaryName){
var winExt = /^win/.test(process.platform)? '.cmd' : '';
var protractorBin = path.join('node_modules', '.bin', binaryName);
return path.join(protractorBin, winExt);
}
gulp.task('protractor-install', function(done){
child_process.spawn(getProtractorBinary('webdriver-manager'), ['update'], {
stdio: 'inherit'
}).once('close', done);
});
gulp.task('protractor-run', function (done) {
var argv = process.argv.slice(3); // forward args to protractor
child_process.spawn(getProtractorBinary('protractor'), argv, {
stdio: 'inherit'
}).once('close', done);
});
```
You can add command line arguments for protractor behind the gulp task:
```gulp protractor-run --specs=runOnlyThisFile.js```
## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License)
[npm-url]: https://npmjs.org/package/gulp-protractor
[npm-image]: https://badge.fury.io/js/gulp-protractor.png
[travis-url]: http://travis-ci.org/mllrsohn/gulp-protractor
[travis-image]: https://secure.travis-ci.org/mllrsohn/gulp-protractor.png?branch=master
[depstat-url]: https://david-dm.org/mllrsohn/gulp-protractor
[depstat-image]: https://david-dm.org/mllrsohn/gulp-protractor.png