forked from kubernetes-retired/contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
nag-flake-issues.go
139 lines (114 loc) · 4.02 KB
/
nag-flake-issues.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
/*
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 (
"time"
"github.com/golang/glog"
"github.com/google/go-github/github"
"github.com/spf13/cobra"
"k8s.io/contrib/mungegithub/features"
mgh "k8s.io/contrib/mungegithub/github"
c "k8s.io/contrib/mungegithub/mungers/matchers/comment"
"k8s.io/contrib/mungegithub/mungers/mungerutil"
)
const (
flakeNagNotifyName = "FLAKE-PING"
// defaultTimePeriod is priority/P1 (to get a human to prioritize)
defaultTimePeriod = 4 * 24 * time.Hour
)
var (
pinger = c.NewPinger(flakeNagNotifyName).
SetDescription("This flaky-test issue would love to have more attention.")
// Only include priorities that you care about. Others won't be pinged
timePeriods = map[string]time.Duration{
"priority/P0": 2 * 24 * time.Hour,
"priority/P1": 8 * 24 * time.Hour,
"priority/P2": time.Duration(1<<63 - 1),
"priority/P3": time.Duration(1<<63 - 1),
}
)
// NagFlakeIssues pings assignees on flaky-test issues
type NagFlakeIssues struct{}
var _ Munger = &NagFlakeIssues{}
func init() {
n := &NagFlakeIssues{}
RegisterMungerOrDie(n)
RegisterStaleComments(n)
}
// Name is the name usable in --pr-mungers
func (NagFlakeIssues) Name() string { return "nag-flake-issues" }
// RequiredFeatures is a slice of 'features' that must be provided
func (NagFlakeIssues) RequiredFeatures() []string { return []string{} }
// Initialize will initialize the munger
func (NagFlakeIssues) Initialize(config *mgh.Config, features *features.Features) error {
return nil
}
// EachLoop is called at the start of every munge loop
func (NagFlakeIssues) EachLoop() error { return nil }
// AddFlags will add any request flags to the cobra `cmd`
func (NagFlakeIssues) AddFlags(cmd *cobra.Command, config *mgh.Config) {
}
// findTimePeriod returns how often we should ping based on priority
func findTimePeriod(labels []github.Label) time.Duration {
priorities := mgh.GetLabelsWithPrefix(labels, "priority/")
if len(priorities) == 0 {
return defaultTimePeriod
}
// If we have multiple priority labels (shouldn't happen), use the first one
period, ok := timePeriods[priorities[0]]
if !ok {
return defaultTimePeriod
}
return period
}
// Munge is the workhorse the will actually make updates to the PR
func (NagFlakeIssues) Munge(obj *mgh.MungeObject) {
if obj.IsPR() || !obj.HasLabel("kind/flake") {
return
}
comments, err := obj.ListComments()
if err != nil {
glog.Error(err)
return
}
// Use the pinger to notify assignees:
// - Set time period based on configuration (at the top of this file)
// - Mention list of assignees as an argument
// - Start the ping timer after the last HumanActor comment
// How often should we ping
period := findTimePeriod(obj.Issue.Labels)
// Who are we pinging
who := mungerutil.GetIssueUsers(obj.Issue).Assignees.Mention().Join()
if who == "" {
return
}
// When does the pinger start
startDate := c.LastComment(comments, c.HumanActor(), obj.Issue.CreatedAt)
// Get a notification if it's time to ping.
notif := pinger.SetTimePeriod(period).PingNotification(
comments,
who,
startDate,
)
if notif != nil {
obj.WriteComment(notif.String())
}
}
// StaleComments returns a slice of stale comments
func (NagFlakeIssues) StaleComments(obj *mgh.MungeObject, comments []*github.IssueComment) []*github.IssueComment {
// Remove all pings written before the last human actor comment
return c.FilterComments(comments, c.And([]c.Matcher{
c.MungerNotificationName(flakeNagNotifyName),
c.CreatedBefore(*c.LastComment(comments, c.HumanActor(), &time.Time{})),
}))
}