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
|
# frozen_string_literal: true
return if helper.stable_branch?
data_testids = /testid/
deprecated_qa_selectors = /(?=qa_selector|data-qa-selector)|(?!.*\bdata-qa-)(?=class=.*qa-.*|class: .*qa-.*)/
def filter_changed_lines(files, pattern)
files_with_lines = {}
files.each do |file|
next if file.start_with?('spec/', 'ee/spec/', 'qa/')
testid_changed_lines = helper.changed_lines(file).select { |line| line =~ pattern }
next unless testid_changed_lines.any?
files_with_lines[file] = testid_changed_lines
end
files_with_lines
end
changed_code_files = helper.changed_files(/\.(vue|haml|js|rb)$/)
return if changed_code_files.empty?
lines_with_testids = filter_changed_lines(changed_code_files, data_testids)
deprecated_qa_class = filter_changed_lines(changed_code_files, deprecated_qa_selectors)
return if lines_with_testids.empty? && deprecated_qa_class.empty?
if lines_with_testids.any?
markdown(<<~MARKDOWN)
### `testid` selectors
The following changed lines in this MR contain `testid` selectors:
MARKDOWN
lines_with_testids.each do |file, lines|
markdown(<<~MARKDOWN)
#### `#{file}`
```shell
#{lines.join("\n")}
```
MARKDOWN
end
markdown(<<~MARKDOWN)
If the `e2e:test-on-omnibus` job in the `qa` stage has run automatically, please ensure the tests are passing.
If the job has not run, please start the `manual:e2e-test-pipeline-generate` job in the `prepare` stage and ensure the tests in `follow-up:e2e:test-on-omnibus-ee` pipeline are passing.
For the list of known failures please refer to [the latest pipeline triage issue](https://gitlab.com/gitlab-org/quality/pipeline-triage/-/issues).
If your changes are under a feature flag, please check our [Testing with feature flags](https://docs.gitlab.com/ee/development/testing_guide/end_to_end/feature_flags.html#automatic-test-execution-when-a-feature-flag-definition-changes) documentation for instructions.
MARKDOWN
warn "This merge request contains lines with testid selectors. Please ensure `e2e:test-on-omnibus` job is run."
end
if deprecated_qa_class.any?
markdown(<<~MARKDOWN)
### Deprecated `data-qa-selector` selectors
MARKDOWN
markdown(<<~MARKDOWN)
The following lines in this MR contain deprecated `data-qa-selector` selectors:
MARKDOWN
deprecated_qa_class.each do |file, lines|
markdown(<<~MARKDOWN)
#### `#{file}`
```shell
#{lines.join("\n")}
```
MARKDOWN
end
markdown(<<~MARKDOWN)
Please ensure all deprecated data-qa-selector attributes are replaced with data-testid attributes in accordance with our [Testing Guide](https://docs.gitlab.com/ee/development/testing_guide/end_to_end/page_objects.html#data-testid-vs-data-qa-selector).
MARKDOWN
warn "This merge request contains deprecated data-qa-selector attribute. Please use data-testid attribute instead."
end
|
