Skip to content

Commit 9b9671a

Browse files
geofffranksgeofffranks
authored
Ignore more deprecated code warnings, use golang's format for deprecation notices (#93)
1 parent 8078909 commit 9b9671a

24 files changed

+247
-105
lines changed

‎client.go‎

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -140,19 +140,19 @@ type ExternalActualLRPClient interface {
140140
// Returns all ActualLRPs matching the given ActualLRPFilter
141141
ActualLRPs(lager.Logger, string, models.ActualLRPFilter) ([]*models.ActualLRP, error)
142142

143-
// DEPRECATED
144143
// Returns all ActualLRPGroups matching the given ActualLRPFilter
145144
//lint:ignore SA1019 - deprecated function returning deprecated data
145+
// Deprecated: use ActualLRPs instead
146146
ActualLRPGroups(lager.Logger, string, models.ActualLRPFilter) ([]*models.ActualLRPGroup, error)
147147

148-
// DEPRECATED
149148
// Returns all ActualLRPGroups that have the given process guid
150149
//lint:ignore SA1019 - deprecated function returning deprecated data
150+
// Deprecated: use ActualLRPs instead
151151
ActualLRPGroupsByProcessGuid(logger lager.Logger, traceID string, processGuid string) ([]*models.ActualLRPGroup, error)
152152

153-
// DEPRECATED
154153
// Returns the ActualLRPGroup with the given process guid and instance index
155154
//lint:ignore SA1019 - deprecated function returning deprecated data
155+
// Deprecated: use ActualLRPs instead
156156
ActualLRPGroupByProcessGuidAndIndex(logger lager.Logger, traceID string, processGuid string, index int) (*models.ActualLRPGroup, error)
157157

158158
// Shuts down the ActualLRP matching the given ActualLRPKey, but does not modify the desired state
@@ -192,13 +192,13 @@ type ExternalDesiredLRPClient interface {
192192
The ExternalEventClient is used to subscribe to groups of Events.
193193
*/
194194
type ExternalEventClient interface {
195-
// DEPRECATED
195+
// Deprecated: use SubscribeToInstanceEvents instead
196196
SubscribeToEvents(logger lager.Logger) (events.EventSource, error)
197197

198198
SubscribeToInstanceEvents(logger lager.Logger) (events.EventSource, error)
199199
SubscribeToTaskEvents(logger lager.Logger) (events.EventSource, error)
200200

201-
// DEPRECATED
201+
// Deprecated: use SubscribeToInstanceEventsByCellID instead
202202
SubscribeToEventsByCellID(logger lager.Logger, cellId string) (events.EventSource, error)
203203

204204
SubscribeToInstanceEventsByCellID(logger lager.Logger, cellId string) (events.EventSource, error)
@@ -374,16 +374,12 @@ func (c *client) ActualLRPs(logger lager.Logger, traceID string, filter models.A
374374
return response.ActualLrps, response.Error.ToError()
375375
}
376376

377-
// DEPRECATED
378-
//
379-
//lint:ignore SA1019 - deprecated function returning deprecated data
377+
// Deprecated: use ActualLRPs instead
380378
func (c *client) ActualLRPGroups(logger lager.Logger, traceID string, filter models.ActualLRPFilter) ([]*models.ActualLRPGroup, error) {
381-
//lint:ignore SA1019 - deprecated function returning deprecated data
382379
request := models.ActualLRPGroupsRequest{
383380
Domain: filter.Domain,
384381
CellId: filter.CellID,
385382
}
386-
//lint:ignore SA1019 - deprecated function returning deprecated data
387383
response := models.ActualLRPGroupsResponse{}
388384
err := c.doRequest(logger, traceID, ActualLRPGroupsRoute_r0, nil, nil, &request, &response)
389385
if err != nil {
@@ -393,15 +389,11 @@ func (c *client) ActualLRPGroups(logger lager.Logger, traceID string, filter mod
393389
return response.ActualLrpGroups, response.Error.ToError()
394390
}
395391

396-
// DEPRECATED
397-
//
398-
//lint:ignore SA1019 - deprecated function returning deprecated data
392+
// Deprecated: use ActaulLRPs instead
399393
func (c *client) ActualLRPGroupsByProcessGuid(logger lager.Logger, traceID string, processGuid string) ([]*models.ActualLRPGroup, error) {
400-
//lint:ignore SA1019 - deprecated function returning deprecated data
401394
request := models.ActualLRPGroupsByProcessGuidRequest{
402395
ProcessGuid: processGuid,
403396
}
404-
//lint:ignore SA1019 - deprecated function returning deprecated data
405397
response := models.ActualLRPGroupsResponse{}
406398
err := c.doRequest(logger, traceID, ActualLRPGroupsByProcessGuidRoute_r0, nil, nil, &request, &response)
407399
if err != nil {
@@ -411,16 +403,12 @@ func (c *client) ActualLRPGroupsByProcessGuid(logger lager.Logger, traceID strin
411403
return response.ActualLrpGroups, response.Error.ToError()
412404
}
413405

414-
// DEPRECATED
415-
//
416-
//lint:ignore SA1019 - deprecated function returning deprecated data
406+
// Deprecated: use ActaulLRPs instead
417407
func (c *client) ActualLRPGroupByProcessGuidAndIndex(logger lager.Logger, traceID string, processGuid string, index int) (*models.ActualLRPGroup, error) {
418-
//lint:ignore SA1019 - deprecated function returning deprecated data
419408
request := models.ActualLRPGroupByProcessGuidAndIndexRequest{
420409
ProcessGuid: processGuid,
421410
Index: int32(index),
422411
}
423-
//lint:ignore SA1019 - deprecated function returning deprecated data
424412
response := models.ActualLRPGroupResponse{}
425413
err := c.doRequest(logger, traceID, ActualLRPGroupByProcessGuidAndIndexRoute_r0, nil, nil, &request, &response)
426414
if err != nil {
@@ -813,9 +801,8 @@ func (c *client) DeleteTask(logger lager.Logger, traceID string, taskGuid string
813801
return c.doTaskLifecycleRequest(logger, traceID, route, &request)
814802
}
815803

816-
// DEPRECATED
804+
// Deprecated: use CancelTask instead
817805
func (c *client) FailTask(logger lager.Logger, traceID string, taskGuid string, failureReason string) error {
818-
//lint:ignore SA1019 - deprecated function returning deprecated data
819806
request := models.FailTaskRequest{
820807
TaskGuid: taskGuid,
821808
FailureReason: failureReason,
@@ -878,7 +865,7 @@ func (c *client) subscribeToEvents(route string, cellId string) (events.EventSou
878865
return events.NewEventSource(eventSource), nil
879866
}
880867

881-
// DEPRECATED
868+
// Deprecated: use SubscribeToInstanceEvents instead
882869
func (c *client) SubscribeToEvents(logger lager.Logger) (events.EventSource, error) {
883870
return c.subscribeToEvents(LRPGroupEventStreamRoute_r1, "")
884871
}
@@ -891,7 +878,7 @@ func (c *client) SubscribeToTaskEvents(logger lager.Logger) (events.EventSource,
891878
return c.subscribeToEvents(TaskEventStreamRoute_r1, "")
892879
}
893880

894-
// DEPRECATED
881+
// Deprecated: use SubscribeToInstanceEventsByCellID instead
895882
func (c *client) SubscribeToEventsByCellID(logger lager.Logger, cellId string) (events.EventSource, error) {
896883
return c.subscribeToEvents(LRPGroupEventStreamRoute_r1, cellId)
897884
}

‎controllers/actual_lrp_lifecycle_controller_test.go‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,9 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
150150
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
151151
changedEvent, ok := event.(*models.ActualLRPChangedEvent)
152152
Expect(ok).To(BeTrue())
153+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
153154
Expect(changedEvent.Before).To(Equal(actualLRP.ToActualLRPGroup()))
155+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
154156
Expect(changedEvent.After).To(Equal(afterActualLRP.ToActualLRPGroup()))
155157
})
156158

@@ -317,10 +319,14 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
317319
err = controller.StartActualLRP(ctx, logger, &actualLRPKey, &afterInstanceKey, &netInfo, internalRoutes, metricTags, routable, availabilityZone)
318320
Eventually(actualHub.EmitCallCount).Should(Equal(2))
319321

322+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
320323
Expect(actualHub.EmitArgsForCall(0)).To(Equal(models.NewActualLRPCreatedEvent(
324+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
321325
afterActualLRP.ToActualLRPGroup(),
322326
)))
327+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
323328
Expect(actualHub.EmitArgsForCall(1)).To(Equal(models.NewActualLRPRemovedEvent(
329+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
324330
suspect.ToActualLRPGroup(),
325331
)))
326332
})
@@ -350,10 +356,14 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
350356
err = controller.StartActualLRP(ctx, logger, &actualLRPKey, &afterInstanceKey, &netInfo, internalRoutes, metricTags, routable, availabilityZone)
351357
Eventually(actualHub.EmitCallCount).Should(Equal(2))
352358

359+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
353360
Expect(actualHub.EmitArgsForCall(0)).To(Equal(models.NewActualLRPCreatedEvent(
361+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
354362
afterActualLRP.ToActualLRPGroup(),
355363
)))
364+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
356365
Expect(actualHub.EmitArgsForCall(1)).To(Equal(models.NewActualLRPRemovedEvent(
366+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
357367
suspect.ToActualLRPGroup(),
358368
)))
359369
})
@@ -469,12 +479,17 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
469479

470480
Eventually(actualHub.EmitCallCount).Should(Equal(2))
471481

482+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
472483
Expect(actualHub.EmitArgsForCall(0)).To(Equal(models.NewActualLRPChangedEvent(
484+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
473485
actualLRP.ToActualLRPGroup(),
486+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
474487
afterActualLRP.ToActualLRPGroup(),
475488
)))
476489

490+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
477491
Expect(actualHub.EmitArgsForCall(1)).To(Equal(models.NewActualLRPRemovedEvent(
492+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
478493
evacuating.ToActualLRPGroup(),
479494
)))
480495
})
@@ -503,6 +518,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
503518
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
504519
createdEvent, ok := event.(*models.ActualLRPCreatedEvent)
505520
Expect(ok).To(BeTrue())
521+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
506522
Expect(createdEvent.ActualLrpGroup).To(Equal(afterActualLRP.ToActualLRPGroup()))
507523
})
508524

@@ -526,7 +542,9 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
526542
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
527543
changedEvent, ok := event.(*models.ActualLRPChangedEvent)
528544
Expect(ok).To(BeTrue())
545+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
529546
Expect(changedEvent.Before).To(Equal(actualLRP.ToActualLRPGroup()))
547+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
530548
Expect(changedEvent.After).To(Equal(afterActualLRP.ToActualLRPGroup()))
531549
})
532550
})
@@ -547,7 +565,9 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
547565
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
548566
changedEvent, ok := event.(*models.ActualLRPChangedEvent)
549567
Expect(ok).To(BeTrue())
568+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
550569
Expect(changedEvent.Before).To(Equal(actualLRP.ToActualLRPGroup()))
570+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
551571
Expect(changedEvent.After).To(Equal(afterActualLRP.ToActualLRPGroup()))
552572
})
553573
})
@@ -661,8 +681,10 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
661681
},
662682
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
663683
&models.ActualLRPChangedEvent{
684+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
664685
Before: actualLRP.ToActualLRPGroup(),
665-
After: afterActualLRP.ToActualLRPGroup(),
686+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
687+
After: afterActualLRP.ToActualLRPGroup(),
666688
}))
667689
})
668690

@@ -845,6 +867,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
845867
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
846868
removedEvent, ok := event.(*models.ActualLRPRemovedEvent)
847869
Expect(ok).To(BeTrue())
870+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
848871
Expect(removedEvent.ActualLrpGroup).To(Equal(actualLRP.ToActualLRPGroup()))
849872
})
850873

@@ -929,7 +952,9 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
929952
Expect(event).To(BeAssignableToTypeOf(createdEvent))
930953
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
931954
createdEvent = event.(*models.ActualLRPChangedEvent)
955+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
932956
Expect(createdEvent.Before).To(Equal(actualLRP.ToActualLRPGroup()))
957+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
933958
Expect(createdEvent.After).To(Equal(replacementLRP.ToActualLRPGroup()))
934959
})
935960

@@ -973,6 +998,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
973998
Expect(event).To(BeAssignableToTypeOf(createdEvent))
974999
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
9751000
createdEvent = event.(*models.ActualLRPCreatedEvent)
1001+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
9761002
Expect(createdEvent.ActualLrpGroup).To(Equal(replacementLRP.ToActualLRPGroup()))
9771003

9781004
event = actualHub.EmitArgsForCall(1)
@@ -981,6 +1007,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
9811007
Expect(event).To(BeAssignableToTypeOf(removedEvent))
9821008
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
9831009
removedEvent = event.(*models.ActualLRPRemovedEvent)
1010+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
9841011
Expect(removedEvent.ActualLrpGroup).To(Equal(actualLRP.ToActualLRPGroup()))
9851012
})
9861013

@@ -1058,8 +1085,11 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
10581085
err = controller.FailActualLRP(ctx, logger, &actualLRPKey, errorMessage)
10591086
Eventually(actualHub.EmitCallCount).Should(Equal(1))
10601087
event := actualHub.EmitArgsForCall(0)
1088+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
10611089
Expect(event).To(Equal(models.NewActualLRPChangedEvent(
1090+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
10621091
actualLRP.ToActualLRPGroup(),
1092+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
10631093
afterActualLRP.ToActualLRPGroup(),
10641094
)))
10651095
})
@@ -1194,6 +1224,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
11941224
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
11951225
removedEvent, ok := event.(*models.ActualLRPRemovedEvent)
11961226
Expect(ok).To(BeTrue())
1227+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
11971228
Expect(removedEvent.ActualLrpGroup).To(Equal(actualLRP.ToActualLRPGroup()))
11981229
})
11991230

@@ -1367,6 +1398,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
13671398
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
13681399
removedEvent, ok := event.(*models.ActualLRPRemovedEvent)
13691400
Expect(ok).To(BeTrue())
1401+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
13701402
Expect(removedEvent.ActualLrpGroup).To(Equal(actualLRP.ToActualLRPGroup()))
13711403
})
13721404

@@ -1429,6 +1461,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
14291461
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
14301462
removedEvent, ok := event.(*models.ActualLRPRemovedEvent)
14311463
Expect(ok).To(BeTrue())
1464+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
14321465
Expect(removedEvent.ActualLrpGroup).To(Equal(actualLRP.ToActualLRPGroup()))
14331466
})
14341467

@@ -1517,6 +1550,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
15171550
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
15181551
removedEvent, ok := event.(*models.ActualLRPRemovedEvent)
15191552
Expect(ok).To(BeTrue())
1553+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
15201554
Expect(removedEvent.ActualLrpGroup).To(Equal(actualLRP.ToActualLRPGroup()))
15211555
})
15221556

@@ -1600,6 +1634,7 @@ var _ = Describe("ActualLRP Lifecycle Controller", func() {
16001634
//lint:ignore SA1019 - calling deprecated model while unit testing deprecated method
16011635
removedEvent, ok := event.(*models.ActualLRPRemovedEvent)
16021636
Expect(ok).To(BeTrue())
1637+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
16031638
Expect(removedEvent.ActualLrpGroup).To(Equal(actualLRP.ToActualLRPGroup()))
16041639
})
16051640

‎controllers/evacuation_controller_test.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1197,8 +1197,11 @@ var _ = Describe("Evacuation Controller", func() {
11971197
Expect(ce.ActualLrpGroup).To(Equal(&models.ActualLRPGroup{Evacuating: afterActual}))
11981198

11991199
event = actualHub.EmitArgsForCall(1)
1200+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
12001201
Expect(event).To(Equal(models.NewActualLRPChangedEvent(
1202+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
12011203
actual.ToActualLRPGroup(),
1204+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
12021205
ordinary.ToActualLRPGroup(),
12031206
)))
12041207
})

‎controllers/lrp_convergence_controller.go‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ func (h *LRPConvergenceController) ConvergeLRPs(ctx context.Context) {
165165
return
166166
}
167167

168+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
168169
go h.actualHub.Emit(models.NewActualLRPCreatedEvent(lrp.ToActualLRPGroup()))
169170
go h.actualLRPInstanceHub.Emit(models.NewActualLRPInstanceCreatedEvent(lrp, traceId))
170171

@@ -184,6 +185,7 @@ func (h *LRPConvergenceController) ConvergeLRPs(ctx context.Context) {
184185
return
185186
} else if !after.Equal(before) {
186187
logger.Info("emitting-changed-event", lager.Data{"before": before, "after": after})
188+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
187189
go h.actualHub.Emit(models.NewActualLRPChangedEvent(before.ToActualLRPGroup(), after.ToActualLRPGroup()))
188190
go func() {
189191
h.actualLRPInstanceHub.Emit(models.NewActualLRPInstanceCreatedEvent(after, traceId))
@@ -266,6 +268,7 @@ func (h *LRPConvergenceController) ConvergeLRPs(ctx context.Context) {
266268
return
267269
}
268270
if removedLRP != nil {
271+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
269272
go h.actualHub.Emit(models.NewActualLRPRemovedEvent(removedLRP.ToActualLRPGroup()))
270273
go h.actualLRPInstanceHub.Emit(models.NewActualLRPInstanceRemovedEvent(removedLRP, traceId))
271274

@@ -284,6 +287,7 @@ func (h *LRPConvergenceController) ConvergeLRPs(ctx context.Context) {
284287
return
285288
}
286289

290+
//lint:ignore SA1019 - still need to emit these events until the ActaulLRPGroup api is deleted
287291
go h.actualHub.Emit(models.NewActualLRPRemovedEvent(suspectLRP.ToActualLRPGroup()))
288292
go h.actualLRPInstanceHub.Emit(models.NewActualLRPInstanceRemovedEvent(suspectLRP, traceId))
289293
})

0 commit comments

Comments
 (0)