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
|
#!/usr/bin/env ruby
# frozen_string_literal: true
require 'gitlab'
require 'optparse'
require_relative 'api/create_merge_request_note'
require_relative 'api/commit_merge_requests'
class GenerateMessageToRunE2ePipeline
NOTE_PATTERN = /<!-- Run e2e warning begin -->[\s\S]+<!-- Run e2e warning end -->/
def initialize(options)
@options = options
@project = @options.fetch(:project)
# If api_token is nil, it's set to '' to allow unauthenticated requests (for forks).
api_token = @options.fetch(:api_token, '')
warn "No API token given." if api_token.empty?
@client = ::Gitlab.client(
endpoint: options.fetch(:endpoint),
private_token: api_token
)
end
def execute
return unless qa_tests_folders?
add_note_to_mr unless existing_note
end
private
attr_reader :project, :client, :options
def qa_tests_folders?
return unless File.exist?(env('ENV_FILE'))
qa_tests_line = File.open(env('ENV_FILE')).detect { |line| line.include?("QA_TESTS=") }
qa_tests_match = qa_tests_line&.match(/'([\s\S]+)'/)
qa_tests_match && !qa_tests_match[1].include?('_spec.rb') # rubocop:disable Rails/NegateInclude
end
def add_note_to_mr
CreateMergeRequestNote.new(
options.merge(merge_request: merge_request)
).execute(content)
end
def match?(body)
body.match?(NOTE_PATTERN)
end
def existing_note
@note ||= client.merge_request_comments(project, merge_request.iid).auto_paginate.detect do |note|
match?(note.body)
end
end
def merge_request
@merge_request ||= CommitMergeRequests.new(
options.merge(sha: ENV['CI_MERGE_REQUEST_SOURCE_BRANCH_SHA'])
).execute.first
end
def content
<<~MARKDOWN
<!-- Run e2e warning begin -->
@#{author_username} Some end-to-end (E2E) tests should run based on the stage label.
Please start the `trigger-omnibus-and-follow-up-e2e` job in the `qa` stage and ensure tests in the `follow-up-e2e:package-and-test-ee` pipeline
pass **before this MR is merged**.
(E2E tests are computationally intensive and don't run automatically for every push/rebase, so we ask you to run this job manually at least once.)
To run all E2E tests, apply the ~"pipeline:run-all-e2e" label and run a new pipeline.
E2E test jobs are allowed to fail due to [flakiness](https://about.gitlab.com/handbook/engineering/quality/quality-engineering/test-metrics-dashboards/#package-and-test).
See current failures at the latest [pipeline triage issue](https://gitlab.com/gitlab-org/quality/pipeline-triage/-/issues).
Once done, apply the ✅ emoji on this comment.
For any questions or help, reach out on the internal #quality Slack channel.
<!-- Run e2e warning end -->
MARKDOWN
end
def author_username
merge_request&.author&.username
end
def env(name)
return unless ENV[name] && !ENV[name].strip.empty?
ENV[name]
end
end
if $PROGRAM_NAME == __FILE__
OptionParser.new do |opts|
opts.on("-h", "--help", "Prints this help") do
puts opts
exit
end
end.parse!
GenerateMessageToRunE2ePipeline.new(API::DEFAULT_OPTIONS).execute
end
|
