Commit 8aa66fe6 authored by Richard Macklin's avatar Richard Macklin

Add more links in the Features/Integration testing documentation

- Move the rspec-rails feature spec link to the Features/Integration
  section
- Mention and link to capybara and poltergeist there as well

[ci skip]
parent 4d7b2990
...@@ -116,6 +116,10 @@ Here are some things to keep in mind regarding test performance: ...@@ -116,6 +116,10 @@ Here are some things to keep in mind regarding test performance:
### Features / Integration ### Features / Integration
GitLab uses [rspec-rails feature specs] to test features in a browser
environment. These are [capybara] specs running on the headless [poltergeist]
driver.
- Feature specs live in `spec/features/` and should be named - Feature specs live in `spec/features/` and should be named
`ROLE_ACTION_spec.rb`, such as `user_changes_password_spec.rb`. `ROLE_ACTION_spec.rb`, such as `user_changes_password_spec.rb`.
- Use only one `feature` block per feature spec file. - Use only one `feature` block per feature spec file.
...@@ -123,6 +127,10 @@ Here are some things to keep in mind regarding test performance: ...@@ -123,6 +127,10 @@ Here are some things to keep in mind regarding test performance:
- Avoid scenario titles that add no information, such as "successfully." - Avoid scenario titles that add no information, such as "successfully."
- Avoid scenario titles that repeat the feature title. - Avoid scenario titles that repeat the feature title.
[rspec-rails feature specs]: https://github.com/rspec/rspec-rails#feature-specs
[capybara]: https://github.com/teamcapybara/capybara
[poltergeist]: https://github.com/teampoltergeist/poltergeist
## Spinach (feature) tests ## Spinach (feature) tests
GitLab [moved from Cucumber to Spinach](https://github.com/gitlabhq/gitlabhq/pull/1426) GitLab [moved from Cucumber to Spinach](https://github.com/gitlabhq/gitlabhq/pull/1426)
...@@ -130,9 +138,7 @@ for its feature/integration tests in September 2012. ...@@ -130,9 +138,7 @@ for its feature/integration tests in September 2012.
As of March 2016, we are [trying to avoid adding new Spinach As of March 2016, we are [trying to avoid adding new Spinach
tests](https://gitlab.com/gitlab-org/gitlab-ce/issues/14121) going forward, tests](https://gitlab.com/gitlab-org/gitlab-ce/issues/14121) going forward,
opting for [RSpec feature specs] as [described above](#features-integration). opting for [RSpec feature](#features-integration) specs.
[RSpec feature specs]: https://github.com/rspec/rspec-rails#feature-specs
Adding new Spinach scenarios is acceptable _only if_ the new scenario requires Adding new Spinach scenarios is acceptable _only if_ the new scenario requires
no more than one new `step` definition. If more than that is required, the no more than one new `step` definition. If more than that is required, the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment