Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rochejul/gulp-angular-protractor
Gulp plugin to run protractor tests
https://github.com/rochejul/gulp-angular-protractor
angular gulp-plugins javascript protractor protractor-tests testing
Last synced: 11 days ago
JSON representation
Gulp plugin to run protractor tests
- Host: GitHub
- URL: https://github.com/rochejul/gulp-angular-protractor
- Owner: rochejul
- License: mit
- Created: 2015-01-05T08:15:42.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-12-17T20:03:58.000Z (almost 6 years ago)
- Last Synced: 2024-10-20T11:27:26.158Z (19 days ago)
- Topics: angular, gulp-plugins, javascript, protractor, protractor-tests, testing
- Language: JavaScript
- Homepage:
- Size: 221 KB
- Stars: 25
- Watchers: 10
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# gulp-angular-protractor
[](https://travis-ci.org/rochejul/gulp-angular-protractor)[](https://david-dm.org/rochejul/gulp-angular-protractor)
[](https://david-dm.org/rochejul/gulp-angular-protractor#info=devDependencies)
[](https://snyk.io/test/github/rochejul/gulp-angular-protractor)
[](https://nodei.co/npm/gulp-angular-protractor/)
[](https://nodei.co/npm/gulp-angular-protractor/)
> Gulp plugin to run protractor tests with automatic launch and stop of the WebDriver server
## Install
```sh
$ npm install --save-dev gulp-angular-protractor
```
## Side dependencies
You should declare what expected version of protractor and webdriver manager you want to use:
```json
{
"name": "example-gulp-protractor",
"version": "0.0.1",
"description": "",
"scripts": {
"gulp": "node node_modules/gulp/bin/gulp.js",
"test": "npm run gulp protractor"
},
"devDependencies": {
"gulp": "latest",
"gulp-angular-protractor": "latest",
"protractor": "4.0.11",
"webdriver-manager": "10.2.8"
}
}
```
Be carefull: some protractor and webdriver dependencies version required:
- Some specific node version
- Some specific npm version
- Some specific browser version
- ...
## Usage
```js
var gulp = require('gulp');
var angularProtractor = require('gulp-angular-protractor');
gulp.src(['./src/tests/*.js'])
.pipe(angularProtractor({
'configFile': 'test/protractor.config.js',
'args': ['--baseUrl', 'http://127.0.0.1:8000'],
'autoStartStopServer': true,
'debug': true
}))
.on('error', function(e) { throw e })
```
## Full example
```js
/*jshint node: true, camelcase: false*/
/*global require: true*/
'use strict';
var gulp = require('gulp'),
gulpProtractorAngular = require('gulp-angular-protractor');
// Setting up the test task
gulp.task('protractor', function(callback) {
gulp
.src(['example_spec.js'])
.pipe(gulpProtractorAngular({
'configFile': 'protractor.conf.js',
'debug': false,
'autoStartStopServer': true
}))
.on('error', function(e) {
console.log(e);
})
.on('end', callback);
});
```
## API
### angularProtractor(options)
#### options
#### options.autoStartStopServer
Type: `Boolean`
Default: `true`
If true, the plugin will update the WebDriver, launch the WebDriver server before launching tests and stop it at the end automatically
#### 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.
#### options.verbose
Type: `Boolean`
Default: `true`
#### options.protractorModulePath
Type: `String`
Default: `undefined`
If you want to use another protractor version instead the default one
### options.webDriverUpdate
Type: `Object`
Default: `undefined`
### options.webDriverUpdate.skip
Type: `Boolean`
Default: `false`
### options.webDriverUpdate.browsers
Type: `Array`
Default: `['chrome']`
List of browsers to update the webdriver
### options.webDriverUpdate.args
Type: `Array`
Default: `[]`
Additional arguments to pass for the update of the webdriver
### options.webDriverStart
Type: `Object`
Default: `undefined`
### options.webDriverStart.args
Type: `Array`
Default: `[]`
Additional arguments to pass for the start of the webdriver
## License
MIT © [Julien Roche](https://github.com/rochejul)