Skip to content

Commit 55429ee

Browse files
Jiahui-Zhang-20Jiahui-Zhang-20
authored
fix some linting errors (#83)
1 parent 40471f1 commit 55429ee

21 files changed

+138
-107
lines changed

‎cluster_config.go

+6-8
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ func getClusterConfig() (*rest.Config, error) {
5050
if err == nil {
5151
log.Info().Msg("Detected in-cluster configuration")
5252
return config, nil
53+
}
54+
55+
if autoConfig {
56+
log.Warn().Msgf("Could not initialize in-cluster config")
5357
} else {
54-
if autoConfig {
55-
log.Warn().Msgf("Could not initialize in-cluster config")
56-
} else {
57-
return nil, err
58-
}
58+
return nil, err
5959
}
6060
}
6161

@@ -76,13 +76,11 @@ func getClusterConfig() (*rest.Config, error) {
7676

7777
log.Debug().Msgf("Kubeconfig path: %s", kubeconfig)
7878
config, err = clientcmd.BuildConfigFromFlags("", kubeconfig)
79-
8079
if err == nil {
8180
log.Info().Msg("Detected out-of-cluster configuration")
8281
return config, nil
83-
} else {
84-
return nil, err
8582
}
83+
return nil, err
8684
}
8785

8886
if config == nil {

‎crons.go

+14-5
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,17 @@ func runSentryCronsCheckin(ctx context.Context, job *batchv1.Job, eventHandlerTy
5555
// The job just begun so check in to start
5656
if job.Status.Active == 0 && job.Status.Succeeded == 0 && job.Status.Failed == 0 {
5757
// Add the job to the cronJob informer data
58-
checkinJobStarting(ctx, job, cronsMonitorData)
58+
err := checkinJobStarting(ctx, job, cronsMonitorData)
59+
if err != nil {
60+
return
61+
}
5962
} else if job.Status.Active > 0 {
6063
return
6164
} else if job.Status.Failed > 0 || job.Status.Succeeded > 0 {
62-
checkinJobEnding(ctx, job, cronsMonitorData)
65+
err := checkinJobEnding(ctx, job, cronsMonitorData)
66+
if err != nil {
67+
return
68+
}
6369
return // Finished
6470
}
6571
})
@@ -84,14 +90,17 @@ func checkinJobStarting(ctx context.Context, job *batchv1.Job, cronsMonitorData
8490
logger.Debug().Msgf("Checking in at start of job: %s\n", job.Name)
8591

8692
// All containers running in the pod
87-
checkinId := hub.CaptureCheckIn(
93+
checkinID := hub.CaptureCheckIn(
8894
&sentry.CheckIn{
8995
MonitorSlug: cronsMonitorData.MonitorSlug,
9096
Status: sentry.CheckInStatusInProgress,
9197
},
9298
cronsMonitorData.monitorConfig,
9399
)
94-
cronsMonitorData.addJob(job, *checkinId)
100+
err := cronsMonitorData.addJob(job, *checkinID)
101+
if err != nil {
102+
return err
103+
}
95104

96105
return nil
97106
}
@@ -129,7 +138,7 @@ func checkinJobEnding(ctx context.Context, job *batchv1.Job, cronsMonitorData *C
129138
logger.Trace().Msgf("checking in at end of job: %s\n", job.Name)
130139
hub.CaptureCheckIn(
131140
&sentry.CheckIn{
132-
ID: jobData.getCheckinId(),
141+
ID: jobData.getCheckinID(),
133142
MonitorSlug: cronsMonitorData.MonitorSlug,
134143
Status: jobStatus,
135144
},

‎crons_monitor_data.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@ import (
99

1010
// Struct associated with a job
1111
type CronsJobData struct {
12-
CheckinId sentry.EventID
12+
CheckinID sentry.EventID
1313
}
1414

1515
// Constructor for cronsMonitorData
1616
func NewCronsJobData(checkinId sentry.EventID) *CronsJobData {
1717
return &CronsJobData{
18-
CheckinId: checkinId,
18+
CheckinID: checkinId,
1919
}
2020
}
2121

22-
func (j *CronsJobData) getCheckinId() sentry.EventID {
23-
return j.CheckinId
22+
func (j *CronsJobData) getCheckinID() sentry.EventID {
23+
return j.CheckinID
2424
}
2525

2626
// Struct associated with a cronJob
@@ -55,10 +55,10 @@ func NewCronsMonitorData(monitorSlug string, schedule string, completions *int32
5555
}
5656

5757
// Add a job to the crons monitor
58-
func (c *CronsMonitorData) addJob(job *batchv1.Job, checkinId sentry.EventID) error {
58+
func (c *CronsMonitorData) addJob(job *batchv1.Job, checkinID sentry.EventID) error {
5959
c.mutex.Lock()
6060
defer c.mutex.Unlock()
61-
c.JobDatas[job.Name] = NewCronsJobData(checkinId)
61+
c.JobDatas[job.Name] = NewCronsJobData(checkinID)
6262
return nil
6363
}
6464

‎crons_monitor_data_test.go

+16-13
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@ import (
99
)
1010

1111
func TestNewCronsJobData(t *testing.T) {
12-
fakeId := "080181f33ca343f89b0bf55d50abfeee"
12+
fakeID := "080181f33ca343f89b0bf55d50abfeee"
1313

14-
cronsJobData := NewCronsJobData(sentry.EventID(fakeId))
14+
cronsJobData := NewCronsJobData(sentry.EventID(fakeID))
1515
if cronsJobData == nil {
1616
t.Errorf("Failed to create cronsJobData")
1717
return
1818
}
19-
if cronsJobData.CheckinId != sentry.EventID(fakeId) {
19+
if cronsJobData.CheckinID != sentry.EventID(fakeID) {
2020
t.Errorf("The cronsJobData set to incorrect ID")
2121
}
2222
}
2323

2424
func TestGetCheckinId(t *testing.T) {
25-
fakeId := "080181f33ca343f89b0bf55d50abfeee"
25+
fakeID := "080181f33ca343f89b0bf55d50abfeee"
2626

27-
cronsJobData := NewCronsJobData(sentry.EventID(fakeId))
27+
cronsJobData := NewCronsJobData(sentry.EventID(fakeID))
2828
if cronsJobData == nil {
2929
t.Errorf("Failed to create cronsJobData")
3030
return
3131
}
32-
if cronsJobData.getCheckinId() != sentry.EventID(fakeId) {
32+
if cronsJobData.getCheckinID() != sentry.EventID(fakeID) {
3333
t.Errorf("Retrieved incorrect checkin ID")
3434
}
3535
}
@@ -56,7 +56,7 @@ func TestNewCronsMonitorData(t *testing.T) {
5656
}
5757

5858
func TestAddJob(t *testing.T) {
59-
fakeId := "080181f33ca343f89b0bf55d50abfeee"
59+
fakeID := "080181f33ca343f89b0bf55d50abfeee"
6060
fakeMonitorSlug := "cronjob-slug"
6161
fakeSchedule := "* * * * *"
6262
var fakeCompletions int32 = 3
@@ -68,13 +68,16 @@ func TestAddJob(t *testing.T) {
6868
Name: "TestAddJobJob",
6969
},
7070
}
71-
cronsMonitorData.addJob(jobObj, sentry.EventID(fakeId))
71+
err := cronsMonitorData.addJob(jobObj, sentry.EventID(fakeID))
72+
if err != nil {
73+
t.Errorf("Failed to add job")
74+
}
7275

7376
jobData, ok := cronsMonitorData.JobDatas["TestAddJobJob"]
7477
if !ok {
7578
t.Errorf("Failed to add job data")
7679
}
77-
if jobData.CheckinId != sentry.EventID(fakeId) {
80+
if jobData.CheckinID != sentry.EventID(fakeID) {
7881
t.Errorf("Incorrect checkin ID")
7982
}
8083
}
@@ -92,14 +95,14 @@ func TestAddCronsMonitorData(t *testing.T) {
9295
t.Errorf("Failed to create cronsMonitorDataMap")
9396
}
9497

95-
fakeMonitorSlug := "TestAddCronsMonitorDataCronJob"
98+
cronjobName := "TestAddCronsMonitorDataCronJob"
9699
fakeSchedule := "* * * * *"
97100
var fakeCompletions int32 = 3
98-
cronsMonitorData := NewCronsMonitorData(fakeMonitorSlug, fakeSchedule, &fakeCompletions)
101+
cronsMonitorData := NewCronsMonitorData(cronjobName, fakeSchedule, &fakeCompletions)
99102

100-
cronsMetaData.addCronsMonitorData("TestAddCronsMonitorDataCronJob", cronsMonitorData)
103+
cronsMetaData.addCronsMonitorData(cronjobName, cronsMonitorData)
101104

102-
retCronsMonitorData, ok := cronsMetaData.cronsMonitorDataMap["TestAddCronsMonitorDataCronJob"]
105+
retCronsMonitorData, ok := cronsMetaData.cronsMonitorDataMap[cronjobName]
103106
if !ok {
104107
t.Errorf("Failed to add cronsMonitorData to map")
105108
}

‎enhancers.go

+13-13
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func runEnhancers(ctx context.Context, eventObject *v1.Event, kind string, objec
3131

3232
// If an event object is provided, we call the event enhancer
3333
if eventObject != nil {
34-
err = eventEnhancer(ctx, scope, eventObject, sentryEvent)
34+
err = eventEnhancer(scope, eventObject)
3535
if err != nil {
3636
return err
3737
}
@@ -56,7 +56,7 @@ type KindObjectPair struct {
5656
object metav1.Object
5757
}
5858

59-
func eventEnhancer(ctx context.Context, scope *sentry.Scope, object metav1.Object, sentryEvent *sentry.Event) error {
59+
func eventEnhancer(scope *sentry.Scope, object metav1.Object) error {
6060
eventObj, ok := object.(*v1.Event)
6161
if !ok {
6262
return errors.New("failed to cast object to event object")
@@ -90,7 +90,7 @@ func objectEnhancer(ctx context.Context, scope *sentry.Scope, kindObjectPair *Ki
9090
objectTag := fmt.Sprintf("%s/%s", kindObjectPair.kind, kindObjectPair.object.GetName())
9191
ctx, logger := getLoggerWithTag(ctx, "object", objectTag)
9292

93-
var err error = nil
93+
var err error
9494

9595
logger.Trace().Msgf("Current fingerprint: %v", sentryEvent.Fingerprint)
9696

@@ -174,10 +174,10 @@ func podEnhancer(ctx context.Context, scope *sentry.Scope, object metav1.Object,
174174
// Add the pod to the tag
175175
setTagIfNotEmpty(scope, "pod_name", object.GetName())
176176
podObj.ManagedFields = []metav1.ManagedFieldsEntry{}
177-
metadataJson, err := prettyJson(podObj.ObjectMeta)
177+
metadataJSON, err := prettyJSON(podObj.ObjectMeta)
178178
if err == nil {
179179
scope.SetContext(KindPod, sentry.Context{
180-
"Metadata": metadataJson,
180+
"Metadata": metadataJSON,
181181
})
182182
}
183183

@@ -205,10 +205,10 @@ func jobEnhancer(ctx context.Context, scope *sentry.Scope, object metav1.Object,
205205
// Add the job to the tag
206206
setTagIfNotEmpty(scope, "job_name", object.GetName())
207207
jobObj.ManagedFields = []metav1.ManagedFieldsEntry{}
208-
metadataJson, err := prettyJson(jobObj.ObjectMeta)
208+
metadataJSON, err := prettyJSON(jobObj.ObjectMeta)
209209
if err == nil {
210210
scope.SetContext(KindJob, sentry.Context{
211-
"Metadata": metadataJson,
211+
"Metadata": metadataJSON,
212212
})
213213
}
214214

@@ -239,10 +239,10 @@ func cronjobEnhancer(ctx context.Context, scope *sentry.Scope, object metav1.Obj
239239
// Add the cronjob to the tag
240240
setTagIfNotEmpty(scope, "cronjob_name", object.GetName())
241241
cronjobObj.ManagedFields = []metav1.ManagedFieldsEntry{}
242-
metadataJson, err := prettyJson(cronjobObj.ObjectMeta)
242+
metadataJSON, err := prettyJSON(cronjobObj.ObjectMeta)
243243
if err == nil {
244244
scope.SetContext(KindCronjob, sentry.Context{
245-
"Metadata": metadataJson,
245+
"Metadata": metadataJSON,
246246
})
247247
}
248248

@@ -268,10 +268,10 @@ func replicaSetEnhancer(ctx context.Context, scope *sentry.Scope, object metav1.
268268
// Add the replicaset to the tag
269269
setTagIfNotEmpty(scope, "replicaset_name", object.GetName())
270270
replicasetObj.ManagedFields = []metav1.ManagedFieldsEntry{}
271-
metadataJson, err := prettyJson(replicasetObj.ObjectMeta)
271+
metadataJSON, err := prettyJSON(replicasetObj.ObjectMeta)
272272
if err == nil {
273273
scope.SetContext(KindReplicaset, sentry.Context{
274-
"Metadata": metadataJson,
274+
"Metadata": metadataJSON,
275275
})
276276
}
277277

@@ -296,10 +296,10 @@ func deploymentEnhancer(ctx context.Context, scope *sentry.Scope, object metav1.
296296
// Add the deployment to the tag
297297
setTagIfNotEmpty(scope, "deployment_name", object.GetName())
298298
deploymentObj.ManagedFields = []metav1.ManagedFieldsEntry{}
299-
metadataJson, err := prettyJson(deploymentObj.ObjectMeta)
299+
metadataJSON, err := prettyJSON(deploymentObj.ObjectMeta)
300300
if err == nil {
301301
scope.SetContext(KindDeployment, sentry.Context{
302-
"Metadata": metadataJson,
302+
"Metadata": metadataJSON,
303303
})
304304
}
305305

‎enhancers_common.go

+7-4
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ func checkCommonEnhancerPatterns() {
6262
}
6363
}
6464

65-
func matchSinglePattern(ctx context.Context, message string, pattern *commonMsgPattern) (fingerprint []string, matched bool) {
65+
func matchSinglePattern(message string, pattern *commonMsgPattern) (fingerprint []string, matched bool) {
6666
pat := pattern.regex
6767

6868
match := pat.FindStringSubmatch(message)
@@ -89,14 +89,14 @@ func matchSinglePattern(ctx context.Context, message string, pattern *commonMsgP
8989
return fingerprint, true
9090
}
9191

92-
func matchCommonPatterns(ctx context.Context, scope *sentry.Scope, sentryEvent *sentry.Event) error {
92+
func matchCommonPatterns(ctx context.Context, sentryEvent *sentry.Event) error {
9393
logger := zerolog.Ctx(ctx)
9494
message := sentryEvent.Message
9595

9696
logger.Trace().Msgf("Matching against message: %q", message)
9797

9898
for _, pattern := range patternsAll {
99-
fingerprint, matched := matchSinglePattern(ctx, message, pattern)
99+
fingerprint, matched := matchSinglePattern(message, pattern)
100100
if matched {
101101
logger.Trace().Msgf("Pattern match: %v, fingerprint: %v", pattern, fingerprint)
102102
// Ideally we should set the fingerprint on Scope, but there's no easy way right now to get
@@ -122,6 +122,9 @@ func runCommonEnhancer(ctx context.Context, scope *sentry.Scope, sentryEvent *se
122122
}
123123

124124
// Match common message patterns
125-
matchCommonPatterns(ctx, scope, sentryEvent)
125+
err := matchCommonPatterns(ctx, sentryEvent)
126+
if err != nil {
127+
return err
128+
}
126129
return nil
127130
}

‎event_buffer.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const bufferSize = 1000
1515
var mu sync.RWMutex
1616

1717
// TODO: we could have one buffer per namespace
18-
var eventBuffer *ring.Ring = ring.New(bufferSize)
18+
var eventBuffer = ring.New(bufferSize)
1919

2020
func addEventToBuffer(event *v1.Event) {
2121
mu.Lock()

‎informer_cronjobs.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
"k8s.io/client-go/tools/cache"
1212
)
1313

14-
func createCronjobInformer(ctx context.Context, factory informers.SharedInformerFactory, namespace string) (cache.SharedIndexInformer, error) {
14+
func createCronjobInformer(ctx context.Context, factory informers.SharedInformerFactory) (cache.SharedIndexInformer, error) {
1515
logger := zerolog.Ctx(ctx)
1616

1717
logger.Debug().Msgf("Starting cronjob informer\n")

‎informer_deployments.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
"k8s.io/client-go/tools/cache"
99
)
1010

11-
func createDeploymentInformer(ctx context.Context, factory informers.SharedInformerFactory, namespace string) (cache.SharedIndexInformer, error) {
11+
func createDeploymentInformer(ctx context.Context, factory informers.SharedInformerFactory) (cache.SharedIndexInformer, error) {
1212
logger := zerolog.Ctx(ctx)
1313

1414
logger.Debug().Msgf("starting deployment informer\n")

‎informer_jobs.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
"k8s.io/client-go/tools/cache"
1212
)
1313

14-
func createJobInformer(ctx context.Context, factory informers.SharedInformerFactory, namespace string) (cache.SharedIndexInformer, error) {
14+
func createJobInformer(ctx context.Context, factory informers.SharedInformerFactory) (cache.SharedIndexInformer, error) {
1515
logger := zerolog.Ctx(ctx)
1616

1717
logger.Debug().Msgf("starting job informer\n")

‎informer_replicasets.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
"k8s.io/client-go/tools/cache"
1010
)
1111

12-
func createReplicasetInformer(ctx context.Context, factory informers.SharedInformerFactory, namespace string) (cache.SharedIndexInformer, error) {
12+
func createReplicasetInformer(ctx context.Context, factory informers.SharedInformerFactory) (cache.SharedIndexInformer, error) {
1313
logger := zerolog.Ctx(ctx)
1414

1515
logger.Debug().Msgf("starting replicaset informer\n")

‎informers.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,22 @@ func startInformers(ctx context.Context, namespace string) error {
3131
)
3232

3333
// Create the job informer
34-
jobInformer, err = createJobInformer(ctx, factory, namespace)
34+
jobInformer, err = createJobInformer(ctx, factory)
3535
if err != nil {
3636
return err
3737
}
3838
// Create the cronjob informer
39-
cronjobInformer, err = createCronjobInformer(ctx, factory, namespace)
39+
cronjobInformer, err = createCronjobInformer(ctx, factory)
4040
if err != nil {
4141
return err
4242
}
4343
// Create the replicaset informer
44-
replicasetInformer, err = createReplicasetInformer(ctx, factory, namespace)
44+
replicasetInformer, err = createReplicasetInformer(ctx, factory)
4545
if err != nil {
4646
return err
4747
}
4848
// Create the deployment informer
49-
deploymentInformer, err = createDeploymentInformer(ctx, factory, namespace)
49+
deploymentInformer, err = createDeploymentInformer(ctx, factory)
5050
if err != nil {
5151
return err
5252
}

0 commit comments

Comments
 (0)