forked from kubernetes-retired/contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cherrypick-queue.go
345 lines (303 loc) · 9.53 KB
/
cherrypick-queue.go
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
/*
Copyright 2015 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package mungers
import (
"encoding/json"
"fmt"
"net/http"
"sort"
"sync"
"time"
"k8s.io/contrib/mungegithub/features"
"k8s.io/contrib/mungegithub/github"
"github.com/golang/glog"
"github.com/spf13/cobra"
)
const (
cpCandidateLabel = "cherrypick-candidate"
cpApprovedLabel = "cherrypick-approved"
)
var (
_ = fmt.Print
maxTime = time.Unix(1<<63-62135596801, 999999999) // http://stackoverflow.com/questions/25065055/what-is-the-maximum-time-time-in-go
)
type rawReadyInfo struct {
Number int
Title string
SHA string
}
type cherrypickStatus struct {
statusPullRequest
ExtraInfo []string
}
type queueData struct {
MergedAndApproved []cherrypickStatus
Merged []cherrypickStatus
Unmerged []cherrypickStatus
}
// CherrypickQueue will merge PR which meet a set of requirements.
type CherrypickQueue struct {
sync.Mutex
lastMergedAndApproved map[int]*github.MungeObject // info from the last run of the munger
lastMerged map[int]*github.MungeObject // info from the last run of the munger
lastUnmerged map[int]*github.MungeObject // info from the last run of the munger
mergedAndApproved map[int]*github.MungeObject // info from the current run of the munger
merged map[int]*github.MungeObject // info from the current run of the munger
unmerged map[int]*github.MungeObject // info from the current run of the munger
}
func init() {
RegisterMungerOrDie(&CherrypickQueue{})
}
// Name is the name usable in --pr-mungers
func (c *CherrypickQueue) Name() string { return "cherrypick-queue" }
// RequiredFeatures is a slice of 'features' that must be provided
func (c *CherrypickQueue) RequiredFeatures() []string { return []string{} }
// Initialize will initialize the munger
func (c *CherrypickQueue) Initialize(config *github.Config, features *features.Features) error {
c.Lock()
defer c.Unlock()
if len(config.Address) > 0 {
if len(config.WWWRoot) > 0 {
http.Handle("/", http.FileServer(http.Dir(config.WWWRoot)))
}
http.HandleFunc("/queue", c.serveQueue)
http.HandleFunc("/raw", c.serveRaw)
http.HandleFunc("/queue-info", c.serveQueueInfo)
config.ServeDebugStats("/stats")
go http.ListenAndServe(config.Address, nil)
}
c.lastMergedAndApproved = map[int]*github.MungeObject{}
c.lastMerged = map[int]*github.MungeObject{}
c.lastUnmerged = map[int]*github.MungeObject{}
c.mergedAndApproved = map[int]*github.MungeObject{}
c.merged = map[int]*github.MungeObject{}
c.unmerged = map[int]*github.MungeObject{}
return nil
}
// EachLoop is called at the start of every munge loop
func (c *CherrypickQueue) EachLoop() error {
c.Lock()
defer c.Unlock()
c.lastMergedAndApproved = c.mergedAndApproved
c.lastMerged = c.merged
c.lastUnmerged = c.unmerged
c.mergedAndApproved = map[int]*github.MungeObject{}
c.merged = map[int]*github.MungeObject{}
c.unmerged = map[int]*github.MungeObject{}
return nil
}
// AddFlags will add any request flags to the cobra `cmd`
func (c *CherrypickQueue) AddFlags(cmd *cobra.Command, config *github.Config) {}
// Munge is the workhorse the will actually make updates to the PR
func (c *CherrypickQueue) Munge(obj *github.MungeObject) {
if !obj.HasLabel(cpCandidateLabel) {
return
}
if !obj.IsPR() {
return
}
// This will cache the PR and events so when we try to view the queue we don't
// hit github while trying to load the page
obj.GetPR()
num := *obj.Issue.Number
c.Lock()
merged, _ := obj.IsMerged()
if merged {
if obj.HasLabel(cpApprovedLabel) {
c.mergedAndApproved[num] = obj
} else {
c.merged[num] = obj
}
} else {
c.unmerged[num] = obj
}
c.Unlock()
return
}
func mergeTime(obj *github.MungeObject) time.Time {
t := obj.MergedAt()
if t == nil {
t = &maxTime
}
return *t
}
type cpQueueSorter []*github.MungeObject
func (s cpQueueSorter) Len() int { return len(s) }
func (s cpQueueSorter) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
// PLEASE PLEASE PLEASE update serveQueueInfo() if you update this.
func (s cpQueueSorter) Less(i, j int) bool {
a := s[i]
b := s[j]
// Sort first based on release milestone
aDue := a.ReleaseMilestoneDue()
bDue := b.ReleaseMilestoneDue()
if aDue.Before(bDue) {
return true
} else if aDue.After(bDue) {
return false
}
// Then sort by the order in which they were merged
aTime := mergeTime(a)
bTime := mergeTime(b)
if aTime.Before(bTime) {
return true
} else if aTime.After(bTime) {
return false
}
// Then show those which have been approved
aApproved := a.HasLabel(cpApprovedLabel)
bApproved := b.HasLabel(cpApprovedLabel)
if aApproved && !bApproved {
return true
} else if !aApproved && bApproved {
return false
}
// Sort by LGTM as humans are likely to want to approve
// those first. After it merges the above check will win
// and LGTM won't matter
aLGTM := a.HasLabel(lgtmLabel)
bLGTM := b.HasLabel(lgtmLabel)
if aLGTM && !bLGTM {
return true
} else if !aLGTM && bLGTM {
return false
}
// And finally by issue number, just so there is some consistency
return *a.Issue.Number < *b.Issue.Number
}
// c.Lock() better held!!!
func (c *CherrypickQueue) orderedQueue(queue map[int]*github.MungeObject) []int {
objs := []*github.MungeObject{}
for _, obj := range queue {
objs = append(objs, obj)
}
sort.Sort(cpQueueSorter(objs))
var ordered []int
for _, obj := range objs {
ordered = append(ordered, *obj.Issue.Number)
}
return ordered
}
// getCurrentQueue returns the merger of the lastQueue and the currentQueue.
func (c *CherrypickQueue) getMergedQueue(last map[int]*github.MungeObject, current map[int]*github.MungeObject) map[int]*github.MungeObject {
c.Lock()
defer c.Unlock()
out := map[int]*github.MungeObject{}
for i, v := range last {
out[i] = v
}
for i, v := range current {
out[i] = v
}
return out
}
func (c *CherrypickQueue) serveRaw(res http.ResponseWriter, req *http.Request) {
queue := c.getMergedQueue(c.lastMergedAndApproved, c.mergedAndApproved)
keyOrder := c.orderedQueue(queue)
sortedQueue := []rawReadyInfo{}
for _, key := range keyOrder {
obj := queue[key]
sha := obj.MergeCommit()
if sha == nil {
empty := "UnknownSHA"
sha = &empty
}
rri := rawReadyInfo{
Number: *obj.Issue.Number,
Title: *obj.Issue.Title,
SHA: *sha,
}
sortedQueue = append(sortedQueue, rri)
}
data, err := json.Marshal(sortedQueue)
if err != nil {
res.Header().Set("Content-type", "text/plain")
res.WriteHeader(http.StatusInternalServerError)
glog.Errorf("Unable to Marshal Status: %v: %v", data, err)
return
}
res.Header().Set("Content-type", "application/json")
res.WriteHeader(http.StatusOK)
res.Write(data)
}
func (c *CherrypickQueue) getQueueData(last, current map[int]*github.MungeObject) []cherrypickStatus {
out := []cherrypickStatus{}
queue := c.getMergedQueue(last, current)
keyOrder := c.orderedQueue(queue)
for _, key := range keyOrder {
obj := queue[key]
cps := cherrypickStatus{
statusPullRequest: *objToStatusPullRequest(obj),
}
if obj.HasLabel(cpApprovedLabel) {
cps.ExtraInfo = append(cps.ExtraInfo, cpApprovedLabel)
}
milestone := obj.ReleaseMilestone()
if milestone != "" {
cps.ExtraInfo = append(cps.ExtraInfo, milestone)
}
merged, _ := obj.IsMerged()
if !merged && obj.HasLabel(lgtmLabel) {
// Don't bother showing LGTM for merged things
// it's just a distraction at that point
cps.ExtraInfo = append(cps.ExtraInfo, lgtmLabel)
}
out = append(out, cps)
}
return out
}
func (c *CherrypickQueue) serveQueue(res http.ResponseWriter, req *http.Request) {
outData := queueData{}
outData.MergedAndApproved = c.getQueueData(c.lastMergedAndApproved, c.mergedAndApproved)
outData.Merged = c.getQueueData(c.lastMerged, c.merged)
outData.Unmerged = c.getQueueData(c.lastUnmerged, c.unmerged)
data, err := json.Marshal(outData)
if err != nil {
res.Header().Set("Content-type", "text/plain")
res.WriteHeader(http.StatusInternalServerError)
glog.Errorf("Unable to Marshal Status: %v: %v", data, err)
return
}
res.Header().Set("Content-type", "application/json")
res.WriteHeader(http.StatusOK)
res.Write(data)
}
func (c *CherrypickQueue) serveQueueInfo(res http.ResponseWriter, req *http.Request) {
res.Header().Set("Content-type", "text/plain")
res.WriteHeader(http.StatusOK)
res.Write([]byte(`The cherrypick queue is sorted by the following. If there is a tie in any test the next test will be used.
<ol>
<li>Milestone Due Date
<ul>
<li>Release milestones must be of the form vX.Y</li>
<li>PRs without a milestone are considered after PRs with a milestone</li>
</ul>
</li>
<li>Labeld with "` + cpApprovedLabel + `"
<ul>
<li>PRs with the "` + cpApprovedLabel + `" label come before those without</li>
</ul>
</li>
<li>Merge Time
<ul>
<li>The earlier a PR was merged the earlier it is in the list</li>
<li>PRs which have not merged are considered 'after' any merged PR</li>
</ul>
</li>
<li>Labeld with "` + lgtmLabel + `"
<ul>
<li>PRs with the "` + lgtmLabel + `" label come before those without</li>
</ul>
<li>PR number</li>
</ol> `))
}