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
|
#!/usr/bin/env ruby
# frozen_string_literal: true
require 'optparse'
require 'json'
require_relative 'api/commit_merge_requests'
require_relative 'api/create_issue'
require_relative 'api/create_issue_discussion'
require_relative 'api/pipeline_failed_jobs'
class CreatePipelineFailureIncident
DEFAULT_OPTIONS = {
project: nil,
incident_json_file: 'incident.json'
}.freeze
DEFAULT_LABELS = ['Engineering Productivity', 'master-broken::undetermined'].freeze
def initialize(options)
@project = options.delete(:project)
@api_token = options.delete(:api_token)
end
def execute
payload = {
issue_type: 'incident',
title: title,
description: description,
labels: incident_labels
}
payload[:assignee_ids] = assignee_ids if stable_branch_incident?
CreateIssue.new(project: project, api_token: api_token).execute(payload).tap do |incident|
CreateIssueDiscussion.new(project: project, api_token: api_token)
.execute(issue_iid: incident.iid, body: "## Root Cause Analysis")
CreateIssueDiscussion.new(project: project, api_token: api_token)
.execute(issue_iid: incident.iid, body: "## Investigation Steps")
end
end
private
attr_reader :project, :api_token
def stable_branch_incident?
ENV['CI_COMMIT_REF_NAME'] =~ /^[\d-]+-stable(-ee)?$/
end
def failed_jobs
@failed_jobs ||= PipelineFailedJobs.new(API::DEFAULT_OPTIONS.merge(exclude_allowed_to_fail_jobs: true)).execute
end
def merge_request
@merge_request ||= CommitMergeRequests.new(
API::DEFAULT_OPTIONS.merge(sha: ENV['CI_COMMIT_SHA'])
).execute.first
end
def now
@now ||= Time.now.utc
end
def title
@title ||= begin
full_title = "#{now.strftime('%A %F %R UTC')} - `#{ENV['CI_PROJECT_PATH']}` " \
"broken `#{ENV['CI_COMMIT_REF_NAME']}` with #{failed_jobs.map(&:name).join(', ')}"
if full_title.size >= 255
"#{full_title[...252]}..." # max title length is 255, and we add an elipsis
else
full_title
end
end
end
def description
return broken_stable_description_content if stable_branch_incident?
broken_master_description_content
end
def broken_master_description_content
<<~MARKDOWN
## #{project_link} pipeline #{pipeline_link} failed
**Branch: #{branch_link}**
**Commit: #{commit_link}**
**Triggered by** #{triggered_by_link} • **Source:** #{source} • **Duration:** #{pipeline_duration} minutes
**Failed jobs (#{failed_jobs.size}):**
#{failed_jobs_list}
### General guidelines
Follow the [Broken `master` handbook guide](https://about.gitlab.com/handbook/engineering/workflow/#broken-master).
### Investigation
**Be sure to fill the `Timeline` for this incident.**
1. If the failure is new, and looks like a potential flaky failure, you can retry the failing job.
Make sure to mention the retry in the `Timeline` and leave a link to the retried job.
1. If the failure looks like a broken `master`, communicate the broken `master` in Slack using the "Broadcast Master Broken" workflow:
- Click the Shortcut lightning bolt icon in the `#master-broken` channel and select "Broadcast Master Broken".
- Click "Continue the broadcast" after the automated message in `#master-broken`.
### Pre-resolution
If you believe that there's an easy resolution by either:
- Reverting a particular merge request.
- Making a quick fix (for example, one line or a few similar simple changes in a few lines).
You can create a merge request, assign to any available maintainer, and ping people that were involved/related to the introduction of the failure.
Additionally, a message can be posted in `#backend_maintainers` or `#frontend_maintainers` to get a maintainer take a look at the fix ASAP.
In both cases, make sure to add the ~"pipeline:expedite" label, and `master:broken` or `master:foss-broken` label, to speed up the `master`-fixing pipelines.
### Resolution
Follow [the Resolution steps from the handbook](https://about.gitlab.com/handbook/engineering/workflow/#responsibilities-of-the-resolution-dri).
MARKDOWN
end
def broken_stable_description_content
<<~MARKDOWN
## #{project_link} pipeline #{pipeline_link} failed
**Branch: #{branch_link}**
**Commit: #{commit_link}**
**Merge Request: #{merge_request_link}**
**Triggered by** #{triggered_by_link} • **Source:** #{source} • **Duration:** #{pipeline_duration} minutes
**Failed jobs (#{failed_jobs.size}):**
#{failed_jobs_list}
### General guidelines
A broken stable branch prevents patch releases from being built.
Fixing the pipeline is a priority to prevent any delays in releases.
The process in the [Broken `master` handbook guide](https://about.gitlab.com/handbook/engineering/workflow/#broken-master) can be referenced since much of that process also applies here.
### Investigation
**Be sure to fill the `Timeline` for this incident.**
1. If the failure is new, and looks like a potential flaky failure, you can retry the failing job.
Make sure to mention the retry in the `Timeline` and leave a link to the retried job.
1. Search for similar master-broken issues in https://gitlab.com/gitlab-org/quality/engineering-productivity/master-broken-incidents/-/issues
1. If one exists, ask the DRI of the master-broken issue to cherry-pick any resulting merge requests into the stable branch
@gitlab-org/release/managers if the merge request author or maintainer is not available, this can be escalated using the dev-on-call process in the [#dev-escalation slack channel](https://gitlab.slack.com/archives/CLKLMSUR4).
### Pre-resolution
If you believe that there's an easy resolution by either:
- Reverting a particular merge request.
- Making a quick fix (for example, one line or a few similar simple changes in a few lines).
You can create a merge request, assign to any available maintainer, and ping people that were involved/related to the introduction of the failure.
Additionally, a message can be posted in `#backend_maintainers` or `#frontend_maintainers` to get a maintainer take a look at the fix ASAP.
- Cherry picking a change that was used to fix a similar master-broken issue.
### Resolution
Add a comment to this issue describing how this incident could have been prevented earlier in the Merge Request pipeline (rather than the merge commit pipeline).
MARKDOWN
end
def incident_labels
return ['release-blocker'] if stable_branch_incident?
master_broken_label =
if ENV['CI_PROJECT_NAME'] == 'gitlab-foss'
'master:foss-broken'
else
'master:broken'
end
DEFAULT_LABELS.dup << master_broken_label
end
def assignee_ids
ids = [ENV['GITLAB_USER_ID'].to_i]
ids << merge_request['author']['id'].to_i if merge_request
ids
end
def pipeline_link
"[##{ENV['CI_PIPELINE_ID']}](#{ENV['CI_PIPELINE_URL']})"
end
def branch_link
"[`#{ENV['CI_COMMIT_REF_NAME']}`](#{ENV['CI_PROJECT_URL']}/-/commits/#{ENV['CI_COMMIT_REF_NAME']})"
end
def pipeline_duration
((Time.now - Time.parse(ENV['CI_PIPELINE_CREATED_AT'])) / 60.to_f).round(2)
end
def commit_link
"[#{ENV['CI_COMMIT_TITLE']}](#{ENV['CI_PROJECT_URL']}/-/commit/#{ENV['CI_COMMIT_SHA']})"
end
def merge_request_link
return 'N/A' unless merge_request
"[#{merge_request['title']}](#{merge_request['web_url']})"
end
def source
"`#{ENV['CI_PIPELINE_SOURCE']}`"
end
def project_link
"[#{ENV['CI_PROJECT_PATH']}](#{ENV['CI_PROJECT_URL']})"
end
def triggered_by_link
"[#{ENV['GITLAB_USER_NAME']}](#{ENV['CI_SERVER_URL']}/#{ENV['GITLAB_USER_LOGIN']})"
end
def failed_jobs_list_for_title
failed_jobs.map(&:name).join(', ')
end
def failed_jobs_list
failed_jobs.map { |job| "- [#{job.name}](#{job.web_url})" }.join("\n")
end
end
if $PROGRAM_NAME == __FILE__
options = CreatePipelineFailureIncident::DEFAULT_OPTIONS.dup
OptionParser.new do |opts|
opts.on("-p", "--project PROJECT", String, "Project where to create the incident (defaults to "\
"`#{CreatePipelineFailureIncident::DEFAULT_OPTIONS[:project]}`)") do |value|
options[:project] = value
end
opts.on("-f", "--incident-json-file file_path", String, "Path to a file where to save the incident JSON data "\
"(defaults to `#{CreatePipelineFailureIncident::DEFAULT_OPTIONS[:incident_json_file]}`)") do |value|
options[:incident_json_file] = value
end
opts.on("-t", "--api-token API_TOKEN", String, "A valid Project token with the `Reporter` role and `api` scope "\
"to create the incident") do |value|
options[:api_token] = value
end
opts.on("-h", "--help", "Prints this help") do
puts opts
exit
end
end.parse!
incident_json_file = options.delete(:incident_json_file)
CreatePipelineFailureIncident.new(options).execute.tap do |incident|
File.write(incident_json_file, JSON.pretty_generate(incident.to_h)) if incident_json_file
end
end
|