summaryrefslogtreecommitdiff
path: root/danger/qa_selector/Dangerfile
blob: a20e626c694d1fde0e533f5db933994df306bf24 (plain)
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
# frozen_string_literal: true

def filter_changed_lines(files)
  lines = []
  files.each do |file|
    qa_selector_changed_lines = helper.changed_lines(file).select { |line| line =~ /qa_selector|data-qa-selector/ }
    next unless qa_selector_changed_lines.any?

    lines += ["file `#{file}`:", qa_selector_changed_lines]
  end
  lines
end

changed_code_files = helper.changed_files(/\.(vue|haml|js|rb)$/)

return if changed_code_files.empty?

lines_with_qa_selectors = filter_changed_lines(changed_code_files)

return if lines_with_qa_selectors.empty?

markdown(<<~MARKDOWN)
  ## QA Selectors

MARKDOWN

if lines_with_qa_selectors.any?
  markdown(<<~MARKDOWN)
    The following changed lines in this MR contain QA selectors:

    * #{lines_with_qa_selectors.join("\n* ")}

    Please ensure `e2e:package-and-test` job is run and the tests 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 QA selectors. Please ensure `e2e:package-and-test` job is run."
end