This gem helps you seamlessly setup, run and maintain a angularjs e2e test suite using protractor in a rails application.
Make sure you have Nodejs installed and that you do not need to use sudo to install npm packages
Add this line to your application's Gemfile:
gem 'protractor-rails'
And then execute the following command to load dependencies on your machine:
$ rake protractor:install
You can test that everything has been set up correctly using the command below. This command will run protractor's example configuration and test file against the http://angular.org website. If everything starts up ok and runs till the end giving you a summary of test results then you are 'good to go'!
$ rake protractor:example
You can initialize your app with protractor rails by running
$ rake protractor:init
This will generate and template configuration and a dummy example test. Once you have run this you can test that everything has been set up correctly in your local environment by running the following command:
$ rake protractor:spec
This will run a local rails test server, the webdriver selenium server and run protractor against the example_spec.js If everything starts up and runs cleanly you should see the test summary of 1 test 1 pass and 0 failures.
When the rake protractor:init script is run it will create a file spec/javascripts/protractor.conf.js. This file is where you
can configure the tests that should be run. [See Protractor Documentation for more details] (https://github.com/angular/protractor/blob/master/docs/getting-started.md).
In this file you can provide patterns for matching your protractor specs. NB: It is recommended that you use a subdirectory such as spec/javascripts/protractor_specs for easy matching and organization
Example
If I have a directory set up for protractor specs in spec/javascripts/protractor_specs/, my configuration file would look something like the below
// An example configuration file.
exports.config = {
// The address of a running selenium server.
seleniumAddress: 'http://localhost:4444/wd/hub',
// Capabilities to be passed to the webdriver instance.
capabilities: {
'browserName': 'chrome'
},
// If you would like to test against multiple browsers, use the multiCapabilities
// configuration option instead.
multiCapabilities: [{
'browserName': 'firefox'
}, {
'browserName': 'chrome'
}],
// Spec patterns are relative to the current working directly when protractor is called
specs: ['protractor_specs/**/*.js '],
baseUrl: 'http://localhost:4000',
// Options to be passed to Jasmine-node.
jasmineNodeOpts: {
showColors: true,
defaultTimeoutInterval: 30000
},
// Specify a version of Jasmine you wish to use. Default version is v1.3
// Jasmine v2 has many more built-in functions to help with testing,
// such as beforeAll and afterAll.
// Jasmine v2 documentation can be found here:
// http://jasmine.github.io/2.0/introduction.html
framework: 'jasmine2'
};
Once you have setup your tests as above, running rake protractor:spec will pick up new tests and run them for you.
You can specify the binding for the rails server as an environment variable: rake protractor:spec rails_binding=hostname_or_ip.
If you want to organise your tests then you can use suites. Replace the specs: line in the above with the following
suites: {
login: 'protractor_specs/login/*.js',
user: 'protractor_specs/user/*.js'
},
You can run specific test suites by passing in options to the rake task as per the below example.
$ rake protractor:spec -- --suite suite-name
NOTE You must have the -- first otherwise rake will think the arguments are for rake instead of the task
$ DEBUG=true rake protractor:spec
$ rake protractor:spec -- --specs spec-filename
There is a task to reset your database to remove items you have created during your tests. This will also seed your database with any fixtures you might have prepared
$ rake protractor:cleanup
This will reset your test database and load in seeds in db/seeds.rb into your test database only.
There is also a convenience function for running cleanup after you have run your tests ready for the next test run.
$ rake protractor:spec_and_cleanup
You can control verbosity of logging with the following ENV flags:
rake protractor:spec nolog=y # all quietrake protractor:spec nolog_selenium=y # no selenium (just drivers)rake protractor:spec nolog_rails=y # no rails
Integration tests are MUCH faster than testing things yourself but they are MUCH slower than running unit tests or rspec tests. Keep your integration tests to a minimum and test as much as possible with your normal rails test suite.
Contributions, questions, comments, threats or suggestions are welcome.
- Fork it (http://github.com/my-github-username/protractor-rails/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent