Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-10-13 06:12:30 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-10-13 06:12:30 +0300
commit4ae83df07e37b502c3b2fdbd352328d72f31d1f5 (patch)
treefcb9fef05b1f7cbe21220ba699225c5d16f8a458 /doc/development/testing_guide
parent7f8df3432369ffa9a34c9a2831cad0ca9ca5ed4f (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/testing_guide')
-rw-r--r--doc/development/testing_guide/end_to_end/best_practices.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/doc/development/testing_guide/end_to_end/best_practices.md b/doc/development/testing_guide/end_to_end/best_practices.md
index baa4cddc306..9491c89c2a0 100644
--- a/doc/development/testing_guide/end_to_end/best_practices.md
+++ b/doc/development/testing_guide/end_to_end/best_practices.md
@@ -245,7 +245,11 @@ end
## Prefer `aggregate_failures` when there are back-to-back expectations
-In cases where there must be multiple (back-to-back) expectations within a test case, it is preferable to use `aggregate_failures`.
+See [Prefer aggregate failures when there are multiple expectations](#prefer-aggregate_failures-when-there-are-multiple-expectations)
+
+## Prefer `aggregate_failures` when there are multiple expectations
+
+In cases where there must be multiple expectations within a test case, it is preferable to use `aggregate_failures`.
This allows you to group a set of expectations and see all the failures altogether, rather than having the test being aborted on the first failure.
@@ -270,6 +274,32 @@ Page::Search::Results.perform do |search|
end
```
+Attach the `:aggregate_failures` metadata to the example if multiple expectations are separated by statements.
+
+```ruby
+#=> Good
+it 'searches', :aggregate_failures do
+ Page::Search::Results.perform do |search|
+ expect(search).to have_file_in_project(template[:file_name], project.name)
+
+ search.switch_to_code
+
+ expect(search).to have_file_with_content(template[:file_name], content[0..33])
+ end
+end
+
+#=> Bad
+it 'searches' do
+ Page::Search::Results.perform do |search|
+ expect(search).to have_file_in_project(template[:file_name], project.name)
+
+ search.switch_to_code
+
+ expect(search).to have_file_with_content(template[:file_name], content[0..33])
+ end
+end
+```
+
## Prefer to split tests across multiple files
Our framework includes a couple of parallelization mechanisms that work by executing spec files in parallel.