2018-03-17 18:26:18 +05:30
|
|
|
# Page objects in GitLab QA
|
|
|
|
|
|
|
|
In GitLab QA we are using a known pattern, called _Page Objects_.
|
|
|
|
|
2019-12-21 20:55:43 +05:30
|
|
|
This means that we have built an abstraction for all pages in GitLab that we use
|
2018-03-17 18:26:18 +05:30
|
|
|
to drive GitLab QA scenarios. Whenever we do something on a page, like filling
|
|
|
|
in a form, or clicking a button, we do that only through a page object
|
|
|
|
associated with this area of GitLab.
|
|
|
|
|
|
|
|
For example, when GitLab QA test harness signs in into GitLab, it needs to fill
|
|
|
|
in a user login and user password. In order to do that, we have a class, called
|
|
|
|
`Page::Main::Login` and `sign_in_using_credentials` methods, that is the only
|
|
|
|
piece of the code, that has knowledge about `user_login` and `user_password`
|
|
|
|
fields.
|
|
|
|
|
|
|
|
## Why do we need that?
|
|
|
|
|
|
|
|
We need page objects, because we need to reduce duplication and avoid problems
|
|
|
|
whenever someone changes some selectors in GitLab's source code.
|
|
|
|
|
|
|
|
Imagine that we have a hundred specs in GitLab QA, and we need to sign into
|
|
|
|
GitLab each time, before we make assertions. Without a page object one would
|
|
|
|
need to rely on volatile helpers or invoke Capybara methods directly. Imagine
|
|
|
|
invoking `fill_in :user_login` in every `*_spec.rb` file / test example.
|
|
|
|
|
|
|
|
When someone later changes `t.text_field :login` in the view associated with
|
|
|
|
this page to `t.text_field :username` it will generate a different field
|
|
|
|
identifier, what would effectively break all tests.
|
|
|
|
|
2019-10-12 21:52:04 +05:30
|
|
|
Because we are using `Page::Main::Login.perform(&:sign_in_using_credentials)`
|
2018-03-17 18:26:18 +05:30
|
|
|
everywhere, when we want to sign into GitLab, the page object is the single
|
|
|
|
source of truth, and we will need to update `fill_in :user_login`
|
|
|
|
to `fill_in :user_username` only in a one place.
|
|
|
|
|
|
|
|
## What problems did we have in the past?
|
|
|
|
|
|
|
|
We do not run QA tests for every commit, because of performance reasons, and
|
|
|
|
the time it would take to build packages and test everything.
|
|
|
|
|
|
|
|
That is why when someone changes `t.text_field :login` to
|
|
|
|
`t.text_field :username` in the _new session_ view we won't know about this
|
|
|
|
change until our GitLab QA nightly pipeline fails, or until someone triggers
|
2019-12-04 20:38:33 +05:30
|
|
|
`package-and-qa-manual` action in their merge request.
|
2018-03-17 18:26:18 +05:30
|
|
|
|
|
|
|
Obviously such a change would break all tests. We call this problem a _fragile
|
|
|
|
tests problem_.
|
|
|
|
|
|
|
|
In order to make GitLab QA more reliable and robust, we had to solve this
|
|
|
|
problem by introducing coupling between GitLab CE / EE views and GitLab QA.
|
|
|
|
|
|
|
|
## How did we solve fragile tests problem?
|
|
|
|
|
|
|
|
Currently, when you add a new `Page::Base` derived class, you will also need to
|
|
|
|
define all selectors that your page objects depends on.
|
|
|
|
|
|
|
|
Whenever you push your code to CE / EE repository, `qa:selectors` sanity test
|
|
|
|
job is going to be run as a part of a CI pipeline.
|
|
|
|
|
|
|
|
This test is going to validate all page objects that we have implemented in
|
|
|
|
`qa/page` directory. When it fails, you will be notified about missing
|
|
|
|
or invalid views / selectors definition.
|
|
|
|
|
|
|
|
## How to properly implement a page object?
|
|
|
|
|
|
|
|
We have built a DSL to define coupling between a page object and GitLab views
|
|
|
|
it is actually implemented by. See an example below.
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
module Page
|
|
|
|
module Main
|
|
|
|
class Login < Page::Base
|
|
|
|
view 'app/views/devise/passwords/edit.html.haml' do
|
2018-12-13 13:39:08 +05:30
|
|
|
element :password_field
|
|
|
|
element :password_confirmation
|
|
|
|
element :change_password_button
|
2018-03-17 18:26:18 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
view 'app/views/devise/sessions/_new_base.html.haml' do
|
2018-12-13 13:39:08 +05:30
|
|
|
element :login_field
|
|
|
|
element :password_field
|
|
|
|
element :sign_in_button
|
2018-03-17 18:26:18 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
# ...
|
2019-09-30 21:07:59 +05:30
|
|
|
end
|
2018-03-17 18:26:18 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
```
|
|
|
|
|
2019-09-04 21:01:54 +05:30
|
|
|
### Defining Elements
|
|
|
|
|
|
|
|
The `view` DSL method will correspond to the rails View, partial, or vue component that renders the elements.
|
2018-12-13 13:39:08 +05:30
|
|
|
|
|
|
|
The `element` DSL method in turn declares an element for which a corresponding
|
2019-09-30 21:07:59 +05:30
|
|
|
`data-qa-selector=element_name_snaked` data attribute will need to be added to the view file.
|
2018-12-13 13:39:08 +05:30
|
|
|
|
|
|
|
You can also define a value (String or Regexp) to match to the actual view
|
|
|
|
code but **this is deprecated** in favor of the above method for two reasons:
|
|
|
|
|
|
|
|
- Consistency: there is only one way to define an element
|
2019-09-30 21:07:59 +05:30
|
|
|
- Separation of concerns: QA uses dedicated `data-qa-*` attributes instead of reusing code
|
2018-12-13 13:39:08 +05:30
|
|
|
or classes used by other components (e.g. `js-*` classes etc.)
|
2018-03-17 18:26:18 +05:30
|
|
|
|
|
|
|
```ruby
|
|
|
|
view 'app/views/my/view.html.haml' do
|
2019-09-30 21:07:59 +05:30
|
|
|
|
|
|
|
### Good ###
|
2019-10-12 21:52:04 +05:30
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
# Implicitly require the CSS selector `[data-qa-selector="logout_button"]` to be present in the view
|
2018-12-13 13:39:08 +05:30
|
|
|
element :logout_button
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
### Bad ###
|
|
|
|
|
2018-12-13 13:39:08 +05:30
|
|
|
## This is deprecated and forbidden by the `QA/ElementWithPattern` RuboCop cop.
|
2018-03-17 18:26:18 +05:30
|
|
|
# Require `f.submit "Sign in"` to be present in `my/view.html.haml
|
2018-12-13 13:39:08 +05:30
|
|
|
element :my_button, 'f.submit "Sign in"' # rubocop:disable QA/ElementWithPattern
|
2018-03-17 18:26:18 +05:30
|
|
|
|
2018-12-13 13:39:08 +05:30
|
|
|
## This is deprecated and forbidden by the `QA/ElementWithPattern` RuboCop cop.
|
2018-03-17 18:26:18 +05:30
|
|
|
# Match every line in `my/view.html.haml` against
|
|
|
|
# `/link_to .* "My Profile"/` regexp.
|
2018-12-13 13:39:08 +05:30
|
|
|
element :profile_link, /link_to .* "My Profile"/ # rubocop:disable QA/ElementWithPattern
|
2018-03-17 18:26:18 +05:30
|
|
|
end
|
|
|
|
```
|
|
|
|
|
2019-09-04 21:01:54 +05:30
|
|
|
### Adding Elements to a View
|
|
|
|
|
|
|
|
Given the following elements...
|
|
|
|
|
|
|
|
```ruby
|
|
|
|
view 'app/views/my/view.html.haml' do
|
|
|
|
element :login_field
|
|
|
|
element :password_field
|
|
|
|
element :sign_in_button
|
|
|
|
end
|
|
|
|
```
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
To add these elements to the view, you must change the rails View, partial, or vue component by adding a `data-qa-selector` attribute
|
2019-09-04 21:01:54 +05:30
|
|
|
for each element defined.
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
In our case, `data-qa-selector="login_field"`, `data-qa-selector="password_field"` and `data-qa-selector="sign_in_button"`
|
2019-09-04 21:01:54 +05:30
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
**app/views/my/view.html.haml**
|
2019-09-04 21:01:54 +05:30
|
|
|
|
|
|
|
```haml
|
2019-09-30 21:07:59 +05:30
|
|
|
= f.text_field :login, class: "form-control top", autofocus: "autofocus", autocapitalize: "off", autocorrect: "off", required: true, title: "This field is required.", data: { qa_selector: 'login_field' }
|
|
|
|
= f.password_field :password, class: "form-control bottom", required: true, title: "This field is required.", data: { qa_selector: 'password_field' }
|
|
|
|
= f.submit "Sign in", class: "btn btn-success", data: { qa_selector: 'sign_in_button' }
|
2019-09-04 21:01:54 +05:30
|
|
|
```
|
|
|
|
|
|
|
|
Things to note:
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
- The name of the element and the qa_selector must match and be snake_cased
|
2019-09-04 21:01:54 +05:30
|
|
|
- If the element appears on the page unconditionally, add `required: true` to the element. See
|
2019-09-30 21:07:59 +05:30
|
|
|
[Dynamic element validation](dynamic_element_validation.md)
|
2019-10-12 21:52:04 +05:30
|
|
|
- You may see `.qa-selector` classes in existing Page Objects. We should prefer the [`data-qa-selector`](#data-qa-selector-vs-qa-selector)
|
2019-09-30 21:07:59 +05:30
|
|
|
method of definition over the `.qa-selector` CSS class
|
|
|
|
|
|
|
|
### `data-qa-selector` vs `.qa-selector`
|
|
|
|
|
|
|
|
> Introduced in GitLab 12.1
|
|
|
|
|
|
|
|
There are two supported methods of defining elements within a view.
|
|
|
|
|
|
|
|
1. `data-qa-selector` attribute
|
|
|
|
1. `.qa-selector` class
|
|
|
|
|
|
|
|
Any existing `.qa-selector` class should be considered deprecated
|
|
|
|
and we should prefer the `data-qa-selector` method of definition.
|
2019-09-04 21:01:54 +05:30
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
### Exceptions
|
|
|
|
|
|
|
|
In some cases it might not be possible or worthwhile to add a selector.
|
|
|
|
|
|
|
|
Some UI components use external libraries, including some maintained by third parties.
|
|
|
|
Even if a library is maintained by GitLab, the selector sanity test only runs
|
|
|
|
on code within the GitLab project, so it's not possible to specify the path for
|
|
|
|
the view for code in a library.
|
|
|
|
|
|
|
|
In such rare cases it's reasonable to use CSS selectors in page object methods,
|
|
|
|
with a comment explaining why an `element` can't be added.
|
|
|
|
|
2018-03-17 18:26:18 +05:30
|
|
|
## Running the test locally
|
|
|
|
|
|
|
|
During development, you can run the `qa:selectors` test by running
|
|
|
|
|
|
|
|
```shell
|
|
|
|
bin/qa Test::Sanity::Selectors
|
|
|
|
```
|
|
|
|
|
|
|
|
from within the `qa` directory.
|
|
|
|
|
|
|
|
## Where to ask for help?
|
|
|
|
|
2018-10-15 14:42:47 +05:30
|
|
|
If you need more information, ask for help on `#quality` channel on Slack
|
|
|
|
(internal, GitLab Team only).
|
2018-03-17 18:26:18 +05:30
|
|
|
|
|
|
|
If you are not a Team Member, and you still need help to contribute, please
|
2018-12-13 13:39:08 +05:30
|
|
|
open an issue in GitLab CE issue tracker with the `~QA` label.
|