Skip to content

Commit

Permalink
basic setup to use global protractor and run tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Carl Banbury committed Apr 11, 2015
0 parents commit 4ca4426
Show file tree
Hide file tree
Showing 15 changed files with 385 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
npm-debug.log
tmp
13 changes: 13 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"curly": true,
"eqeqeq": true,
"immed": true,
"latedef": true,
"newcap": true,
"noarg": true,
"sub": true,
"undef": true,
"boss": true,
"eqnull": true,
"node": true
}
73 changes: 73 additions & 0 deletions Gruntfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/*
* grunt-simple-protractor
*
*
* Copyright (c) 2015 Carl Banbury
* Licensed under the MIT license.
*/

'use strict';

module.exports = function(grunt) {

// Project configuration.
grunt.initConfig({
jshint: {
all: [
'Gruntfile.js',
'tasks/*.js',
'<%= nodeunit.tests %>'
],
options: {
jshintrc: '.jshintrc'
}
},

// Before generating any new files, remove any previously-created files.
clean: {
tests: ['tmp']
},

// Configuration to be run (and then tested).
simple_protractor: {
default_options: {
options: {
},
files: {
'tmp/default_options': ['test/fixtures/testing', 'test/fixtures/123']
}
},
custom_options: {
options: {
separator: ': ',
punctuation: ' !!!'
},
files: {
'tmp/custom_options': ['test/fixtures/testing', 'test/fixtures/123']
}
}
},

// Unit tests.
nodeunit: {
tests: ['test/*_test.js']
}

});

// Actually load this plugin's task(s).
grunt.loadTasks('tasks');

// These plugins provide necessary tasks.
grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-contrib-nodeunit');

// Whenever the "test" task is run, first clean the "tmp" dir, then run this
// plugin's task(s), then test the result.
grunt.registerTask('test', ['clean', 'simple_protractor', 'nodeunit']);

// By default, lint and run all tests.
grunt.registerTask('default', ['jshint', 'test']);

};
22 changes: 22 additions & 0 deletions LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2015 Carl Banbury

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
89 changes: 89 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# grunt-simple-protractor

> Start webdriver manager, start a local test server and run protractor
## Getting Started
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-simple-protractor --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-simple-protractor');
```

## The "simple_protractor" task

### Overview
In your project's Gruntfile, add a section named `simple_protractor` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
simple_protractor: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
```

### Options

#### options.separator
Type: `String`
Default value: `', '`

A string value that is used to do something with whatever.

#### options.punctuation
Type: `String`
Default value: `'.'`

A string value that is used to do something else with whatever else.

### Usage Examples

#### Default Options
In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`

```js
grunt.initConfig({
simple_protractor: {
options: {},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
});
```

#### Custom Options
In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`

```js
grunt.initConfig({
simple_protractor: {
options: {
separator: ': ',
punctuation: ' !!!',
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
});
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_
6 changes: 6 additions & 0 deletions examples/basic/conf.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
'use strict';

exports.config = {
seleniumAddress: 'http://localhost:4444/wd/hub',
specs: ['spec.js']
};
16 changes: 16 additions & 0 deletions examples/basic/gruntfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
'use strict';

module.exports = function(grunt) {
grunt.loadTasks('../../tasks');

grunt.initConfig({
simple_protractor: {
options: {
configFile: 'conf.js'
},
all: {}
}
});

grunt.registerTask('default', ['simple_protractor']);
};
9 changes: 9 additions & 0 deletions examples/basic/spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
'use strict';

describe('Protractor Demo App', function() {
it('should have a title', function() {
browser.get('http://juliemr.github.io/protractor-demo/');

expect(browser.getTitle()).toEqual('Super Calculator');
});
});
41 changes: 41 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"name": "grunt-simple-protractor",
"description": "Start webdriver manager, start a local test server and run protractor",
"version": "0.0.1",
"homepage": "",
"author": {
"name": "Carl Banbury",
"email": "[email protected]"
},
"repository": {
"type": "git",
"url": "null"
},
"bugs": {
"url": ""
},
"licenses": [
{
"type": "MIT",
"url": "/blob/master/LICENSE-MIT"
}
],
"engines": {
"node": ">= 0.8.0"
},
"scripts": {
"test": "grunt test"
},
"devDependencies": {
"grunt": "~0.4.5",
"grunt-contrib-clean": "^0.5.0",
"grunt-contrib-jshint": "^0.9.2",
"grunt-contrib-nodeunit": "^0.3.3"
},
"peerDependencies": {
"grunt": "~0.4.5"
},
"keywords": [
"gruntplugin"
]
}
61 changes: 61 additions & 0 deletions tasks/webdriver_protractor.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* grunt-simple-protractor
*
*
* Copyright (c) 2015 Carl Banbury
* Licensed under the MIT license.
*/

'use strict';
var spawn = require('child_process').spawn;
var spawnSync = require('child_process').spawnSync;

module.exports = function(grunt) {
grunt.registerMultiTask('simple_protractor', 'Start selenium webdriver, local server and run protractor tests', function() {
var done = this.async();
var options = this.options({});

var webdriverBin = options.webdriver_bin || 'webdriver-manager';
var protractorBin = options.protractor_bin || 'protractor';
var configFile = options.config_file || 'conf.js';

var update = spawnSync(webdriverBin, ['update'], {stdio: 'pipe'});
var webdriver = spawn(webdriverBin, ['start']);
var protractor;
var pid;

webdriver.stderr.on('data', function(data) {
if (data.toString().search('WARN') > -1) {
return grunt.fail.warn(data.toString());
}

if (data.toString().search('ERROR') > -1) {
return grunt.fail.warn(data.toString());
}

// run protactor once the webdriver is running
if (data.toString().search('INFO - Started SocketListener') > -1) {
protractor = spawn(protractorBin, [configFile], {stdio: 'inherit'});

protractor.on('close', function(code) {
process.kill(webdriver.pid);
process.kill(pid);

if (code !== 0) {
return grunt.fail.warn(data.toString());
}

return done(code);
});
}
});

webdriver.stdout.on('data', function(data) {

// grab the pid from log so we can cleanly exit
if (data.toString().search('seleniumProcess.pid') > -1) {
pid = +data.toString().split(': ').pop();
}
});
});
};
1 change: 1 addition & 0 deletions test/expected/custom_options
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Testing: 1 2 3 !!!
1 change: 1 addition & 0 deletions test/expected/default_options
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Testing, 1 2 3.
1 change: 1 addition & 0 deletions test/fixtures/123
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1 2 3
1 change: 1 addition & 0 deletions test/fixtures/testing
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Testing
Loading

0 comments on commit 4ca4426

Please sign in to comment.