Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdehaan/grunt-blueprint-test-runner
API Blueprint and Protractor test runner for grunt
https://github.com/pdehaan/grunt-blueprint-test-runner
Last synced: 15 days ago
JSON representation
API Blueprint and Protractor test runner for grunt
- Host: GitHub
- URL: https://github.com/pdehaan/grunt-blueprint-test-runner
- Owner: pdehaan
- License: mit
- Created: 2014-11-09T22:07:41.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-11T23:49:48.000Z (about 10 years ago)
- Last Synced: 2024-10-31T13:13:54.993Z (2 months ago)
- Size: 96.7 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-blueprint-test-runner
> API Blueprint and Protractor Test Runner.
A Grunt plugin for running Angular.js functional tests combining [Drakov](https://github.com/Aconex/drakov) and [Protractor](https://github.com/angular/protractor).
## Getting Started
This plugin requires Grunt `~0.4.5`
```shell
npm install grunt-blueprint-test-runner --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-blueprint-test-runner');
```
## The "blueprint_test_runner" task
### Overview
In your project's Gruntfile, add a section named `blueprint-test-runner` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
blueprint_test_runner: {
your_target: {
drakov: {
sourceFiles: 'path/to/blueprint/files/**/*.md',
serverPort: 3000,
staticPaths: 'path/to/static/files'
},
protractor: {
suites: {
test-suite1: 'path/to/specs/**.js'
}
}
}
}
});
```
**NOTE:** The plugin defaults to running the tests with selenium + phantomjs. *See example below to run with chromedriver.*
### Usage Examples
#### Default Options
This is an example of a minimum configuration config.
The `sourceFiles` property is required in the `drakov` object below. `suites` is also required to have entries like the example below.
```js
grunt.initConfig({
blueprint_test_runner: {
your_target: {
drakov: {
sourceFiles: 'path/to/blueprint/files/**/*.md',
},
protractor: {
suites: {
test-suite1: 'path/to/specs/**.js'
}
}
}
}
});
```
#### Specifying browserName when running with Selenium standalone
You can specify the browser to run with Selenenium, simply add `browserName: ` inside your target properties.
```js
grunt.initConfig({
blueprint_test_runner: {
your_target: {
browserName: 'firefox',
...
}
}
});
```
#### Running with the chromedriver
This is an example of a minimum configuration config.
Instead of running with selenium and phantomjs, simply add `chromeDriver: true` inside your target properties.
```js
grunt.initConfig({
blueprint_test_runner: {
your_target: {
chromeDriver: true,
drakov: {
sourceFiles: 'path/to/blueprint/files/**/*.md',
},
protractor: {
suites: {
test-suite1: 'path/to/specs/**.js'
}
}
}
}
});
```
#### Configuration with additional protractor properties
There are some defaults configured for running protractor. You can as a minimum just include `specs` or `suites`.
If you require additions to the protractor configuration, these are passed directly from the `protractor` property in your target configuration.
See
```js
grunt.initConfig({
blueprint_test_runner: {
your_target: {
drakov: {
sourceFiles: 'path/to/blueprint/files/**/*.md',
serverPort: 3000,
staticPaths: 'path/to/static/files'
},
protractor: {
specs: [
'path/to/some/specs/**/*.js'
]
params: {
foo: function() {
return 'bar';
}
}
}
}
}
});
```
#### Configuration with additional Drakov properties
This is an example of all the extra properties for Drakov including server port and a basic static route.
The `sourceFiles` property is required in the `drakov` object below.
```js
grunt.initConfig({
blueprint_test_runner: {
your_target: {
drakov: {
sourceFiles: 'path/to/blueprint/files/**/*.md',
serverPort: 3000,
staticPaths: 'path/to/static/files'
},
protractor: {
suites: {
test-suite1: 'path/to/specs/**.js'
}
}
}
}
});
```
`staticPaths` can also take a path with a mount point, i.e. `staticPaths: 'path/to/static/files=/url/mnt'`. This will mount the files at the url base path of `/url/mnt`.
You can also provide multiple paths/mounts by substituting the value with an array.
For example:
```js
...
staticPaths: [
'path/to/static/files',
'another/path/to/static/files=/mnt/me/here'
]
...
```