1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
|
# frozen_string_literal: true
module QA
module Page
module MergeRequest
class Show < Page::Base
include Page::Component::Note
include Page::Component::Issuable::Sidebar
view 'app/assets/javascripts/batch_comments/components/preview_dropdown.vue' do
element 'review-preview-dropdown'
end
view 'app/assets/javascripts/batch_comments/components/review_bar.vue' do
element 'review-bar-content'
end
view 'app/assets/javascripts/batch_comments/components/submit_dropdown.vue' do
element 'submit-review-dropdown'
element 'submit-review-button'
end
view 'app/assets/javascripts/diffs/components/compare_dropdown_layout.vue' do
element 'version-dropdown-content'
end
view 'app/assets/javascripts/diffs/components/compare_versions.vue' do
element 'target-version-dropdown'
element 'file-tree-button'
end
view 'app/assets/javascripts/diffs/components/tree_list.vue' do
element 'file-tree-container'
element 'diff-tree-search'
end
view 'app/assets/javascripts/diffs/components/diff_file_header.vue' do
element 'file-title-container'
element 'options-dropdown-button'
element 'edit-in-ide-button'
end
view 'app/assets/javascripts/vue_shared/components/file_row.vue' do
element 'file-row-name-container'
end
view 'app/assets/javascripts/diffs/components/diff_row.vue' do
element 'left-comment-button'
element 'left-line-number'
end
view 'app/assets/javascripts/notes/components/note_form.vue' do
element 'start-review-button'
element 'comment-now-button'
end
view 'app/views/projects/merge_requests/_code_dropdown.html.haml' do
element 'mr-code-dropdown'
element 'download-email-patches-menu-item'
element 'download-plain-diff-menu-item'
element 'open-in-web-ide-button'
end
view 'app/assets/javascripts/vue_merge_request_widget/components/mr_widget_pipeline.vue' do
element 'pipeline-info-container'
element 'pipeline-id'
end
view 'app/assets/javascripts/vue_merge_request_widget/components/states/mr_widget_failed_to_merge.vue' do
element 'merge-request-failed-refresh-button'
end
view 'app/assets/javascripts/vue_merge_request_widget/components/states/mr_widget_merged.vue' do
element 'cherry-pick-button'
element 'revert-button'
end
view 'app/assets/javascripts/vue_merge_request_widget/components/states/mr_widget_rebase.vue' do
element 'standard-rebase-button'
element 'rebase-message'
end
view 'app/assets/javascripts/vue_merge_request_widget/components/states/ready_to_merge.vue' do
element 'merge-button'
element 'merge-immediately-dropdown'
element 'merge-immediately-button'
element 'merged-status-content'
end
view 'app/assets/javascripts/vue_merge_request_widget/components/states/sha_mismatch.vue' do
element 'head-mismatch-content'
end
view 'app/assets/javascripts/vue_merge_request_widget/components/states/squash_before_merge.vue' do
element 'squash-checkbox'
end
view 'app/assets/javascripts/vue_merge_request_widget/mr_widget_options.vue' do
element 'mr-widget-content'
element 'pipeline-container'
end
view 'app/assets/javascripts/vue_shared/components/markdown/apply_suggestion.vue' do
element 'apply-suggestion-dropdown'
element 'commit-message-field'
element 'commit-with-custom-message-button'
end
view 'app/assets/javascripts/vue_shared/components/markdown/header.vue' do
element 'suggestion-button'
element 'dismiss-suggestion-popover-button'
end
view 'app/assets/javascripts/vue_shared/components/markdown/suggestion_diff_header.vue' do
element 'add-suggestion-batch-button'
element 'applied-badge'
element 'applying-badge'
end
view 'app/views/projects/merge_requests/_description.html.haml' do
element 'description-content'
end
view 'app/views/projects/merge_requests/_mr_title.html.haml' do
element 'edit-title-button'
element 'title-content', required: true
end
view 'app/views/projects/merge_requests/_page.html.haml' do
element 'notes-tab', required: true
element 'commits-tab', required: true
element 'diffs-tab', required: true
end
view 'app/views/shared/_broadcast_message.html.haml' do
element 'broadcast-notification-container'
element 'close-button'
end
view 'app/assets/javascripts/ci/jobs_page/components/job_cells/job_cell.vue' do
element 'fork-icon'
end
view 'app/assets/javascripts/vue_merge_request_widget/components/mr_collapsible_extension.vue' do
element 'mr-collapsible-title'
end
def start_review
click_element('start-review-button')
# After clicking the button, wait for it to disappear
# before moving on to the next part of the test
has_no_element?('start-review-button')
end
def click_target_version_dropdown
click_element('target-version-dropdown')
end
def version_dropdown_content
find_element('version-dropdown-content').text
end
def submit_pending_reviews
# On test environments we have a broadcast message that can cover the buttons
if has_element?('broadcast-notification-container', wait: 5)
within_element('broadcast-notification-container') do
click_element('close-button')
end
end
within_element('review-bar-content') do
click_element('review-preview-dropdown')
end
click_element('submit-review-dropdown')
click_element('submit-review-button')
# After clicking the button, wait for the review bar to disappear
# before moving on to the next part of the test
wait_until(reload: false) do
has_no_element?('review-bar-content')
end
end
def add_comment_to_diff(text)
wait_until(sleep_interval: 5) do
has_css?('a[data-linenumber="1"]')
end
all_elements('left-line-number', minimum: 1).first.hover
click_element('left-comment-button')
click_element('dismiss-suggestion-popover-button') if has_element?('dismiss-suggestion-popover-button',
wait: 1)
fill_element('reply-field', text)
end
def click_discussions_tab
click_element('notes-tab')
wait_for_requests
end
def click_commits_tab
click_element('commits-tab')
end
def click_diffs_tab
# Do not wait for spinner due to https://gitlab.com/gitlab-org/gitlab/-/issues/398584
click_element('diffs-tab', skip_finished_loading_check: true)
end
def click_pipeline_link
click_element('pipeline-id')
end
def edit!
# Click by JS is needed to bypass the Moved MR actions popover
# Change back to regular click_element when moved_mr_sidebar FF is removed
# Rollout issue: https://gitlab.com/gitlab-org/gitlab/-/issues/385460
click_by_javascript(find_element('edit-title-button', skip_finished_loading_check: true))
end
def fast_forward_not_possible?
has_element?('rebase-message')
end
def has_file?(file_name)
open_file_tree
return true if has_element?('file-row-name-container', file_name: file_name)
# Since the file tree uses virtual scrolling, search for file in case it is outside of viewport
search_file_tree(file_name)
has_element?('file-row-name-container', file_name: file_name)
end
def has_no_file?(file_name)
# Since the file tree uses virtual scrolling, search for file to ensure non-existence
search_file_tree(file_name)
has_no_element?('file-row-name-container', file_name: file_name)
end
def search_file_tree(file_name)
open_file_tree
fill_element('diff-tree-search', file_name)
end
def open_file_tree
click_element('file-tree-button') if has_no_element?('file-tree-container', wait: 1)
end
def has_merge_button?
refresh
has_element?('merge-button')
end
def has_no_merge_button?
refresh
has_no_element?('merge-button')
end
RSpec::Matchers.define :have_merge_button do
match(&:has_merge_button?)
match_when_negated(&:has_no_merge_button?)
end
def has_pipeline_status?(text)
# Pipelines can be slow, so we wait a bit longer than the usual 10 seconds
wait_until(max_duration: 120, sleep_interval: 5, reload: true) do
has_element?('pipeline-info-container', text: text, wait: 15)
end
end
def has_title?(title)
has_element?('title-content', text: title)
end
def has_description?(description)
has_element?('description-content', text: description)
end
def mark_to_squash
# Refresh page if commit arrived after loading the MR page
wait_until(reload: true, message: 'Wait for MR to be unblocked') do
has_no_element?('head-mismatch-content', wait: 1)
end
# The squash checkbox is enabled via JS
wait_until(reload: false) do
!find_element('squash-checkbox', visible: false).disabled?
end
check_element('squash-checkbox', true)
end
def merge!
try_to_merge!
finished_loading?
raise "Merge did not appear to be successful" unless merged?
end
def merge_when_pipeline_succeeds!
wait_until_ready_to_merge
click_element('merge-button', text: 'Merge when pipeline succeeds')
end
def merged?
# Reloads the page at this point to avoid the problem of the merge status failing to update
# That's the transient UX issue this test is checking for, so if the MR is merged but the UI still shows the
# status as unmerged, the test will fail.
# Revisit after merge page re-architect is done https://gitlab.com/groups/gitlab-org/-/epics/5598
# To remove page refresh logic if possible
# We don't raise on failure because this method is used as a predicate matcher
retry_until(max_attempts: 3, reload: true, raise_on_failure: false) do
has_element?('merged-status-content', text: /The changes were merged into|Changes merged into/, wait: 20)
end
end
RSpec::Matchers.define :be_mergeable do
match do |page|
page.has_element?('merge-button', disabled: false)
end
match_when_negated do |page|
page.has_no_element?('merge-button', disabled: false)
end
end
# Waits up 10 seconds and returns false if the Revert button is not enabled
def revertible?
has_element?('revert-button', disabled: false, wait: 10)
end
# Waits up 60 seconds and raises an error if unable to merge.
#
# If a state is encountered in which a user would typically refresh the page, this will refresh the page and
# then check again if it's ready to merge. For example, it will refresh if a new change was pushed and the page
# needs to be refreshed to show the change.
#
# @param [Boolean] transient_test true if the current test is a transient test (default: false)
def wait_until_ready_to_merge(transient_test: false)
wait_until(message: "Waiting for ready to merge", sleep_interval: 1) do
# changes in mr are rendered async, because of that mr can sometimes show no changes and there will be no
# merge button, in such case we must retry loop otherwise find_element will raise ElementNotFound error
next false unless has_element?('merge-button', wait: 1)
break true unless find_element('merge-button').disabled?
# If the widget shows "Merge blocked: new changes were just added" we can refresh the page and check again
next false if has_element?('head-mismatch-content', wait: 1)
# Stop waiting if we're in a transient test. By this point we're in an unexpected state and should let the
# test fail so we can investigate. If we're not in a transient test we keep trying until we reach timeout.
next true unless transient_test
QA::Runtime::Logger.debug("MR widget text: #{mr_widget_text}")
false
end
end
def rebase!
# The rebase button is disabled on load
wait_until do
has_element?('standard-rebase-button')
end
# The rebase button is enabled via JS
wait_until(reload: false) do
!find_element('standard-rebase-button').disabled?
end
click_element('standard-rebase-button')
end
def merge_immediately!
retry_until(reload: true, sleep_interval: 1, max_attempts: 12) do
if has_element?('merge-immediately-dropdown')
click_element('merge-immediately-dropdown', skip_finished_loading_check: true)
click_element('merge-immediately-button', skip_finished_loading_check: true)
else
click_element('merge-button', skip_finished_loading_check: true)
end
merged?
end
end
def try_to_merge!
# Revisit after merge page re-architect is done https://gitlab.com/gitlab-org/gitlab/-/issues/300042
# To remove page refresh logic if possible
wait_until_ready_to_merge
wait_until { !find_element('merge-button').text.include?('when pipeline succeeds') } # rubocop:disable Rails/NegateInclude
click_element('merge-button')
end
def view_email_patches
# Click by JS is needed to bypass the Moved MR actions popover
# Change back to regular click_element when moved_mr_sidebar FF is removed
# Rollout issue: https://gitlab.com/gitlab-org/gitlab/-/issues/385460
click_by_javascript(find_element('mr-code-dropdown'))
visit_link_in_element('download-email-patches-menu-item')
end
def view_plain_diff
# Click by JS is needed to bypass the Moved MR actions popover
# Change back to regular click_element when moved_mr_sidebar FF is removed
# Rollout issue: https://gitlab.com/gitlab-org/gitlab/-/issues/385460
click_by_javascript(find_element('mr-code-dropdown'))
visit_link_in_element('download-plain-diff-menu-item')
end
def wait_for_merge_request_error_message
wait_until(max_duration: 30, reload: false) do
has_element?('merge-request-failed-refresh-button')
end
end
def click_open_in_web_ide
# Click by JS is needed to bypass the Moved MR actions popover
# Change back to regular click_element when moved_mr_sidebar FF is removed
# Rollout issue: https://gitlab.com/gitlab-org/gitlab/-/issues/385460
click_by_javascript(find_element('mr-code-dropdown'))
click_element('open-in-web-ide-button')
page.driver.browser.switch_to.window(page.driver.browser.window_handles.last)
wait_for_requests
end
def edit_file_in_web_ide(file_name)
within_element('file-title-container', file_name: file_name) do
click_element('options-dropdown-button')
click_element('edit-in-ide-button')
end
page.driver.browser.switch_to.window(page.driver.browser.window_handles.last)
end
def add_suggestion_to_diff(suggestion, line)
find("a[data-linenumber='#{line}']").hover
click_element('left-comment-button')
click_element('suggestion-button')
initial_content = find_element('reply-field').value
fill_element('reply-field', '')
fill_element('reply-field', initial_content.gsub(/(```suggestion:-0\+0\n).*(\n```)/, "\\1#{suggestion}\\2"))
click_element('comment-now-button')
wait_for_requests
end
def apply_suggestion_with_message(message)
all_elements('apply-suggestion-dropdown', minimum: 1).first.click
fill_element('commit-message-field', message)
click_element('commit-with-custom-message-button')
end
def add_suggestion_to_batch
all_elements('add-suggestion-batch-button', minimum: 1).first.click
end
def has_suggestions_applied?(count = 1)
wait_until(reload: false) do
has_no_element?('applying-badge')
end
all_elements('applied-badge', count: count)
end
def cherry_pick!
click_element('cherry-pick-button', Page::Component::CommitModal)
click_element(:submit_commit_button)
end
def revert_change!
# reload page when the revert modal occasionally doesn't appear in ee:large-setup job
# https://gitlab.com/gitlab-org/gitlab/-/issues/386623 (transient issue)
retry_on_exception(reload: true) do
click_element('revert-button', Page::Component::CommitModal)
end
click_element(:submit_commit_button)
end
def mr_widget_text
find_element('mr-widget-content').text
end
def has_fork_icon?
has_element?('fork-icon', skip_finished_loading_check: true)
end
def click_artifacts_dropdown_button
wait_for_requests
within_element('pipeline-container') do
click_element('base-dropdown-toggle')
end
end
def has_artifact_with_name?(name)
has_text?(name)
end
def open_exposed_artifacts_list
within_element('pipeline-container') do
wait_until(reload: false) { has_no_text?('Loading artifacts') }
click_element('mr-collapsible-title')
end
end
def has_exposed_artifact_with_name?(name)
has_link?(name)
end
end
end
end
end
QA::Page::MergeRequest::Show.prepend_mod_with('Page::MergeRequest::Show', namespace: QA)
|