Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Container transition to MANIFEST_PULLED state should happen after network pause container reaches RESOURCES_PROVISIONED state #4286

Merged
merged 8 commits into from
Aug 15, 2024
Merged

Container transition to MANIFEST_PULLED state should happen after network pause container reaches RESOURCES_PROVISIONED state #4286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4db377d
Add a test to ensure that repo-interacting Docker calls happen after …
amogh09 Aug 15, 2024
1280ef0
Move the new test to Linux specific file and update a corresponding W…
amogh09 Aug 15, 2024
5a59e9f
Minor reformat
amogh09 Aug 15, 2024
a0c6427
Update Windows test
amogh09 Aug 15, 2024
9207656
Remove redundant new test
amogh09 Aug 15, 2024
bbb9714
Add test description
amogh09 Aug 15, 2024
fad3fc7
Minor comment change
amogh09 Aug 15, 2024
bf79ae1
Minor reformat
amogh09 Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion agent/api/task/task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1491,7 +1491,7 @@ func (task *Task) addNetworkResourceProvisioningDependencyAwsvpc(cfg *config.Con
if container.IsInternal() {
continue
}
container.BuildContainerDependency(NetworkPauseContainerName, apicontainerstatus.ContainerResourcesProvisioned, apicontainerstatus.ContainerPulled)
container.BuildContainerDependency(NetworkPauseContainerName, apicontainerstatus.ContainerResourcesProvisioned, apicontainerstatus.ContainerManifestPulled)
pauseContainer.BuildContainerDependency(container.Name, apicontainerstatus.ContainerStopped, apicontainerstatus.ContainerStopped)
}

Expand Down
45 changes: 41 additions & 4 deletions agent/engine/docker_task_engine_linux_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -822,6 +822,15 @@ func TestTaskWithSteadyStateResourcesProvisioned(t *testing.T) {
waitForStopEvents(t, taskEngine.StateChangeEvents(), true, false)
}

// Tests a happy case scenario for an AWSVPC task.
//
// This test also verifies that
// any DockerClient calls that interact with an image repository (PullContainerManifest
// and PullContainer, currently) happen after the pause container has reached
// ContainerResourcesProvisioned state.
//
// If you are updating this test then make sure that you call assertPauseContainerIsRunning()
// in any dockerClient expected calls that are supposed to interact with an image repository.
func TestPauseContainerHappyPath(t *testing.T) {
ctx, cancel := context.WithCancel(context.TODO())
defer cancel()
Expand Down Expand Up @@ -857,6 +866,19 @@ func TestPauseContainerHappyPath(t *testing.T) {
dockerClient.EXPECT().ContainerEvents(gomock.Any()).Return(eventStream, nil)
serviceConnectManager.EXPECT().GetAppnetContainerTarballDir().AnyTimes()

// A function to assert that the network pause container in the task is in
// ContainerResourcesProvisioned state. This will be used by dockerClient mock later.
assertPauseContainerIsRunning := func() {
assert.Len(t, sleepTask.Containers, 3, "expected pause container to be populated")
pauseContainer := sleepTask.Containers[2]
assert.Equal(t, apitask.NetworkPauseContainerName, pauseContainer.Name)
assert.Equal(t, apicontainer.ContainerCNIPause, pauseContainer.Type)
assert.Equal(t,
apicontainerstatus.ContainerResourcesProvisioned,
pauseContainer.GetKnownStatus(),
"expected pause container to be running before image repository is called")
}

sleepContainerID1 := containerID + "1"
sleepContainerID2 := containerID + "2"
pauseContainerID := "pauseContainerID"
Expand All @@ -870,8 +892,13 @@ func TestPauseContainerHappyPath(t *testing.T) {
assert.True(t, ok)
assert.Equal(t, apitask.NetworkPauseContainerName, name)
}).Return(dockerapi.DockerContainerMetadata{DockerID: "pauseContainerID"}),
dockerClient.EXPECT().StartContainer(gomock.Any(), pauseContainerID, defaultConfig.ContainerStartTimeout).Return(
dockerapi.DockerContainerMetadata{DockerID: "pauseContainerID"}),
dockerClient.EXPECT().
StartContainer(gomock.Any(), pauseContainerID, defaultConfig.ContainerStartTimeout).
Do(func(ctx interface{}, id string, timeout time.Duration) {
// Simulate some startup time
time.Sleep(5 * time.Millisecond)
}).
Return(dockerapi.DockerContainerMetadata{DockerID: "pauseContainerID"}),
dockerClient.EXPECT().InspectContainer(gomock.Any(), gomock.Any(), gomock.Any()).Return(
&types.ContainerJSON{
ContainerJSONBase: &types.ContainerJSONBase{
Expand All @@ -892,9 +919,19 @@ func TestPauseContainerHappyPath(t *testing.T) {
imageManager.EXPECT().AddAllImageStates(gomock.Any()).AnyTimes()
dockerClient.EXPECT().WithVersion(dockerclient.Version_1_35).Times(2).Return(manifestPullClient, nil)
manifestPullClient.EXPECT().
PullImageManifest(gomock.Any(), gomock.Any(), gomock.Any()).Times(2).
PullImageManifest(gomock.Any(), gomock.Any(), gomock.Any()).
Times(2).
Do(func(context.Context, string, *apicontainer.RegistryAuthenticationData) {
assertPauseContainerIsRunning() // Ensure that pause container is already RUNNING
}).
Return(registry.DistributionInspect{}, nil)
dockerClient.EXPECT().PullImage(gomock.Any(), gomock.Any(), nil, gomock.Any()).Return(dockerapi.DockerContainerMetadata{}).Times(2)
dockerClient.EXPECT().
PullImage(gomock.Any(), gomock.Any(), nil, gomock.Any()).
Do(func(context.Context, string, *apicontainer.RegistryAuthenticationData, time.Duration) {
assertPauseContainerIsRunning() // Ensure that pause container is already RUNNING
}).
Return(dockerapi.DockerContainerMetadata{}).
Times(2)
imageManager.EXPECT().RecordContainerReference(gomock.Any()).Return(nil).Times(2)
imageManager.EXPECT().GetImageStateFromImageName(gomock.Any()).Return(nil, false).Times(2)
dockerClient.EXPECT().APIVersion().Return(defaultDockerClientAPIVersion, nil).Times(2)
Expand Down
42 changes: 39 additions & 3 deletions agent/engine/docker_task_engine_windows_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,15 @@ func TestTaskWithSteadyStateResourcesProvisioned(t *testing.T) {
waitForStopEvents(t, taskEngine.StateChangeEvents(), true, false)
}

// Tests a happy case scenario for an AWSVPC task.
//
// This test also verifies that
// any DockerClient calls that interact with an image repository (PullContainerManifest
// and PullContainer, currently) happen after the pause container has reached
// ContainerResourcesProvisioned state.
//
// If you are updating this test then make sure that you call assertPauseContainerIsRunning()
// in any dockerClient expected calls that are supposed to interact with an image repository.
func TestPauseContainerHappyPath(t *testing.T) {
ctx, cancel := context.WithCancel(context.TODO())
defer cancel()
Expand Down Expand Up @@ -509,8 +518,13 @@ func TestPauseContainerHappyPath(t *testing.T) {
assert.True(t, ok)
assert.Equal(t, apitask.NetworkPauseContainerName, name)
}).Return(dockerapi.DockerContainerMetadata{DockerID: "pauseContainerID"}),
dockerClient.EXPECT().StartContainer(gomock.Any(), pauseContainerID, defaultConfig.ContainerStartTimeout).Return(
dockerapi.DockerContainerMetadata{DockerID: "pauseContainerID"}),
dockerClient.EXPECT().
StartContainer(gomock.Any(), pauseContainerID, defaultConfig.ContainerStartTimeout).
Do(func(ctx interface{}, id string, timeout time.Duration) {
// Simulate some startup time
time.Sleep(5 * time.Millisecond)
}).
Return(dockerapi.DockerContainerMetadata{DockerID: "pauseContainerID"}),
dockerClient.EXPECT().InspectContainer(gomock.Any(), gomock.Any(), gomock.Any()).Return(
&types.ContainerJSON{
ContainerJSONBase: &types.ContainerJSONBase{
Expand All @@ -531,6 +545,19 @@ func TestPauseContainerHappyPath(t *testing.T) {
}, nil),
)

// A function to assert that the network pause container in the task is in
// ContainerResourcesProvisioned state. This will be used by dockerClient mock later.
assertPauseContainerIsRunning := func() {
assert.Len(t, sleepTask.Containers, 3, "expected pause container to be populated")
pauseContainer := sleepTask.Containers[2]
assert.Equal(t, apitask.NetworkPauseContainerName, pauseContainer.Name)
assert.Equal(t, apicontainer.ContainerCNIPause, pauseContainer.Type)
assert.Equal(t,
apicontainerstatus.ContainerResourcesProvisioned,
pauseContainer.GetKnownStatus(),
"expected pause container to be running before image repository is called")
}

// For the other container
imageManager.EXPECT().AddAllImageStates(gomock.Any()).AnyTimes()
manifestPullClient := mock_dockerapi.NewMockDockerClient(ctrl)
Expand All @@ -541,8 +568,17 @@ func TestPauseContainerHappyPath(t *testing.T) {
manifestPullClient.EXPECT().
PullImageManifest(gomock.Any(), gomock.Any(), gomock.Any()).
Times(2).
Do(func(context.Context, string, *apicontainer.RegistryAuthenticationData) {
assertPauseContainerIsRunning() // Ensure that pause container is already RUNNING
}).
Return(registry.DistributionInspect{}, nil)
dockerClient.EXPECT().PullImage(gomock.Any(), gomock.Any(), nil, gomock.Any()).Return(dockerapi.DockerContainerMetadata{}).Times(2)
dockerClient.EXPECT().
PullImage(gomock.Any(), gomock.Any(), nil, gomock.Any()).
Do(func(context.Context, string, *apicontainer.RegistryAuthenticationData, time.Duration) {
assertPauseContainerIsRunning() // Ensure that pause container is already RUNNING
}).
Return(dockerapi.DockerContainerMetadata{}).
Times(2)
imageManager.EXPECT().RecordContainerReference(gomock.Any()).Return(nil).Times(2)
imageManager.EXPECT().GetImageStateFromImageName(gomock.Any()).Return(nil, false).Times(2)
dockerClient.EXPECT().APIVersion().Return(defaultDockerClientAPIVersion, nil).Times(2)
Expand Down
Loading