Skip to content

Commit d457705

Browse files
committed
app/agent.go: remove token from state file
1 parent 25c2208 commit d457705

File tree

5 files changed

+19
-41
lines changed

5 files changed

+19
-41
lines changed

agent/app/agent.go

+3-4
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ func (agent *ecsAgent) doStart(containerChangeEventStream *eventstream.EventStre
243243

244244
// Initialize the state manager
245245
stateManager, err := agent.newStateManager(taskEngine,
246-
&agent.cfg.Cluster, &agent.containerInstanceARN, &currentEC2InstanceID, &agent.availabilityZone, &agent.registrationToken)
246+
&agent.cfg.Cluster, &agent.containerInstanceARN, &currentEC2InstanceID, &agent.availabilityZone)
247247
if err != nil {
248248
seelog.Criticalf("Error creating state manager: %v", err)
249249
return exitcodes.ExitTerminal
@@ -333,7 +333,7 @@ func (agent *ecsAgent) newTaskEngine(containerChangeEventStream *eventstream.Eve
333333
// previousStateManager is used to verify that our current runtime configuration is
334334
// compatible with our past configuration as reflected by our state-file
335335
previousStateManager, err := agent.newStateManager(previousTaskEngine, &previousCluster,
336-
&previousContainerInstanceArn, &previousEC2InstanceID, &previousAZ, &previousRegistrationToken)
336+
&previousContainerInstanceArn, &previousEC2InstanceID, &previousAZ)
337337
if err != nil {
338338
seelog.Criticalf("Error creating state manager: %v", err)
339339
return nil, "", err
@@ -419,7 +419,7 @@ func (agent *ecsAgent) newStateManager(
419419
cluster *string,
420420
containerInstanceArn *string,
421421
savedInstanceID *string,
422-
availabilityZone *string, registrationToken *string) (statemanager.StateManager, error) {
422+
availabilityZone *string) (statemanager.StateManager, error) {
423423

424424
if !agent.cfg.Checkpoint {
425425
return statemanager.NewNoopStateManager(), nil
@@ -434,7 +434,6 @@ func (agent *ecsAgent) newStateManager(
434434
// This is for making testing easier as we can mock this
435435
agent.saveableOptionFactory.AddSaveable("EC2InstanceID", savedInstanceID),
436436
agent.saveableOptionFactory.AddSaveable("availabilityZone", availabilityZone),
437-
agent.saveableOptionFactory.AddSaveable("RegistrationToken", registrationToken),
438437
)
439438
}
440439

agent/app/agent_compatibility_linux_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func TestCompatibilityEnabledSuccess(t *testing.T) {
4747

4848
gomock.InOrder(
4949
saveableOptionFactory.EXPECT().AddSaveable(gomock.Any(), gomock.Any()).AnyTimes(),
50-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().Return(stateManager, nil),
50+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().Return(stateManager, nil),
5151
stateManager.EXPECT().Load().AnyTimes(),
5252
state.EXPECT().AllTasks().Return([]*apitask.Task{}),
5353
)
@@ -79,7 +79,7 @@ func TestCompatibilityDefaultEnabledFail(t *testing.T) {
7979
}
8080
gomock.InOrder(
8181
saveableOptionFactory.EXPECT().AddSaveable(gomock.Any(), gomock.Any()).AnyTimes(),
82-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().Return(stateManager, nil),
82+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().Return(stateManager, nil),
8383
stateManager.EXPECT().Load().AnyTimes(),
8484
state.EXPECT().AllTasks().Return(getTaskListWithOneBadTask()),
8585
)
@@ -110,7 +110,7 @@ func TestCompatibilityExplicitlyEnabledFail(t *testing.T) {
110110
}
111111
gomock.InOrder(
112112
saveableOptionFactory.EXPECT().AddSaveable(gomock.Any(), gomock.Any()).AnyTimes(),
113-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().Return(stateManager, nil),
113+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().Return(stateManager, nil),
114114
stateManager.EXPECT().Load().AnyTimes(),
115115
state.EXPECT().AllTasks().Return(getTaskListWithOneBadTask()),
116116
)

agent/app/agent_test.go

+10-31
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,10 @@ func TestDoStartNewTaskEngineError(t *testing.T) {
151151
saveableOptionFactory.EXPECT().AddSaveable("Cluster", gomock.Any()).Return(nil),
152152
saveableOptionFactory.EXPECT().AddSaveable("EC2InstanceID", gomock.Any()).Return(nil),
153153
saveableOptionFactory.EXPECT().AddSaveable("availabilityZone", gomock.Any()).Return(nil),
154-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Return(nil),
154+
155155
// An error in creating the state manager should result in an
156156
// error from newTaskEngine as well
157-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
158-
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(),
159-
).Return(
157+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(
160158
nil, errors.New("error")),
161159
)
162160

@@ -191,8 +189,7 @@ func TestDoStartNewStateManagerError(t *testing.T) {
191189
saveableOptionFactory.EXPECT().AddSaveable("Cluster", gomock.Any()).Return(nil),
192190
saveableOptionFactory.EXPECT().AddSaveable("EC2InstanceID", gomock.Any()).Return(nil),
193191
saveableOptionFactory.EXPECT().AddSaveable("availabilityZone", gomock.Any()).Return(nil),
194-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Return(nil),
195-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(),
192+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
196193
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(
197194
statemanager.NewNoopStateManager(), nil),
198195
state.EXPECT().AllTasks().AnyTimes(),
@@ -201,8 +198,7 @@ func TestDoStartNewStateManagerError(t *testing.T) {
201198
saveableOptionFactory.EXPECT().AddSaveable("Cluster", gomock.Any()).Return(nil),
202199
saveableOptionFactory.EXPECT().AddSaveable("EC2InstanceID", gomock.Any()).Return(nil),
203200
saveableOptionFactory.EXPECT().AddSaveable("availabilityZone", gomock.Any()).Return(nil),
204-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Return(nil),
205-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(),
201+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
206202
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(
207203
nil, errors.New("error")),
208204
)
@@ -385,13 +381,7 @@ func TestNewTaskEngineRestoreFromCheckpointNoEC2InstanceIDToLoadHappyPath(t *tes
385381
saveableOptionFactory.EXPECT().AddSaveable("Cluster", gomock.Any()).Return(nil),
386382
saveableOptionFactory.EXPECT().AddSaveable("EC2InstanceID", gomock.Any()).Return(nil),
387383
saveableOptionFactory.EXPECT().AddSaveable("availabilityZone", gomock.Any()).Return(nil),
388-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Do(
389-
func(name string, saveable statemanager.Saveable) {
390-
previousRegistrationToken, ok := saveable.(*string)
391-
assert.True(t, ok)
392-
*previousRegistrationToken = "prev-reg-token"
393-
}).Return(nil),
394-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(),
384+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
395385
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(
396386
statemanager.NewNoopStateManager(), nil),
397387
state.EXPECT().AllTasks().AnyTimes(),
@@ -415,7 +405,6 @@ func TestNewTaskEngineRestoreFromCheckpointNoEC2InstanceIDToLoadHappyPath(t *tes
415405
assert.NoError(t, err)
416406
assert.Equal(t, expectedInstanceID, instanceID)
417407
assert.Equal(t, "prev-container-inst", agent.containerInstanceARN)
418-
assert.Equal(t, "prev-reg-token", agent.registrationToken)
419408
}
420409

421410
func TestNewTaskEngineRestoreFromCheckpointPreviousEC2InstanceIDLoadedHappyPath(t *testing.T) {
@@ -448,13 +437,7 @@ func TestNewTaskEngineRestoreFromCheckpointPreviousEC2InstanceIDLoadedHappyPath(
448437
assert.True(t, ok)
449438
*previousAZ = "us-west-2b"
450439
}).Return(nil),
451-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Do(
452-
func(name string, saveable statemanager.Saveable) {
453-
previousRegistrationToken, ok := saveable.(*string)
454-
assert.True(t, ok)
455-
*previousRegistrationToken = "prev-reg-token"
456-
}).Return(nil),
457-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(),
440+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
458441
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(
459442
statemanager.NewNoopStateManager(), nil),
460443
state.EXPECT().AllTasks().AnyTimes(),
@@ -509,9 +492,8 @@ func TestNewTaskEngineRestoreFromCheckpointClusterIDMismatch(t *testing.T) {
509492
}).Return(nil),
510493
saveableOptionFactory.EXPECT().AddSaveable("EC2InstanceID", gomock.Any()).Return(nil),
511494
saveableOptionFactory.EXPECT().AddSaveable("availabilityZone", gomock.Any()).Return(nil),
512-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Return(nil),
513495

514-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(),
496+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
515497
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(
516498
statemanager.NewNoopStateManager(), nil),
517499
state.EXPECT().AllTasks().AnyTimes(),
@@ -548,8 +530,7 @@ func TestNewTaskEngineRestoreFromCheckpointNewStateManagerError(t *testing.T) {
548530
saveableOptionFactory.EXPECT().AddSaveable("Cluster", gomock.Any()).Return(nil),
549531
saveableOptionFactory.EXPECT().AddSaveable("EC2InstanceID", gomock.Any()).Return(nil),
550532
saveableOptionFactory.EXPECT().AddSaveable("availabilityZone", gomock.Any()).Return(nil),
551-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Return(nil),
552-
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(), gomock.Any(),
533+
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
553534
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(
554535
nil, errors.New("error")),
555536
)
@@ -584,9 +565,8 @@ func TestNewTaskEngineRestoreFromCheckpointStateLoadError(t *testing.T) {
584565
saveableOptionFactory.EXPECT().AddSaveable("Cluster", gomock.Any()).Return(nil),
585566
saveableOptionFactory.EXPECT().AddSaveable("EC2InstanceID", gomock.Any()).Return(nil),
586567
saveableOptionFactory.EXPECT().AddSaveable("availabilityZone", gomock.Any()).Return(nil),
587-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Return(nil),
588568
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
589-
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(),
569+
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(),
590570
).Return(stateManager, nil),
591571
stateManager.EXPECT().Load().Return(errors.New("error")),
592572
)
@@ -622,9 +602,8 @@ func TestNewTaskEngineRestoreFromCheckpoint(t *testing.T) {
622602
saveableOptionFactory.EXPECT().AddSaveable("Cluster", gomock.Any()).Return(nil),
623603
saveableOptionFactory.EXPECT().AddSaveable("EC2InstanceID", gomock.Any()).Return(nil),
624604
saveableOptionFactory.EXPECT().AddSaveable("availabilityZone", gomock.Any()).Return(nil),
625-
saveableOptionFactory.EXPECT().AddSaveable("RegistrationToken", gomock.Any()).Return(nil),
626605
stateManagerFactory.EXPECT().NewStateManager(gomock.Any(),
627-
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(),
606+
gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(),
628607
).Return(statemanager.NewNoopStateManager(), nil),
629608
state.EXPECT().AllTasks().AnyTimes(),
630609
ec2MetadataClient.EXPECT().InstanceID().Return(expectedInstanceID, nil),

agent/app/agent_unix_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ func TestDoStartTaskENIHappyPath(t *testing.T) {
179179
dockerClient.EXPECT().ListPluginsWithFilters(gomock.Any(), gomock.Any(), gomock.Any(),
180180
gomock.Any()).Return([]string{}, nil),
181181
client.EXPECT().RegisterContainerInstance(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Do(
182-
func(x interface{}, attributes []*ecs.Attribute, y interface{}) {
182+
func(x interface{}, attributes []*ecs.Attribute, y interface{}, z interface{}) {
183183
vpcFound := false
184184
subnetFound := false
185185
for _, attribute := range attributes {

agent/statemanager/state_manager.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ const (
7171
// a) Add 'secrets' field to 'apicontainer.Container'
7272
// b) Add 'ssmsecret' field to 'resources'
7373
// 18) Add 'AvailabilityZone' field to the TaskResponse struct
74-
// 19) Add 'RegistrationToken'
75-
ECSDataVersion = 19
74+
75+
ECSDataVersion = 18
7676

7777
// ecsDataFile specifies the filename in the ECS_DATADIR
7878
ecsDataFile = "ecs_agent_data.json"

0 commit comments

Comments
 (0)