Files
moby/integration/container/stop_linux_test.go
Paweł Gronowski 946bf70f89 integration: Deduplicate TestStopContainerWithTimeout
The test had 2 almost identical separate  implementations (Linux and
Windows). The Windows one was skipped anyway.
Make one test that covers all test cases.

The test still needs to be fixed for Windows, so don't unskip it yet.

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2025-03-10 17:04:29 +01:00

93 lines
2.9 KiB
Go

package container // import "github.com/docker/docker/integration/container"
import (
"bytes"
"context"
"io"
"strings"
"testing"
"time"
containertypes "github.com/docker/docker/api/types/container"
"github.com/docker/docker/client"
"github.com/docker/docker/errdefs"
"github.com/docker/docker/integration/internal/container"
"github.com/docker/docker/pkg/stdcopy"
"gotest.tools/v3/assert"
is "gotest.tools/v3/assert/cmp"
"gotest.tools/v3/poll"
)
// TestStopContainerWithTimeoutCancel checks that ContainerStop is not cancelled
// if the request is cancelled.
// See issue https://github.com/moby/moby/issues/45731
func TestStopContainerWithTimeoutCancel(t *testing.T) {
ctx := setupTest(t)
apiClient := testEnv.APIClient()
t.Cleanup(func() { _ = apiClient.Close() })
t.Parallel()
id := container.Run(ctx, t, apiClient,
container.WithCmd("sh", "-c", "trap 'echo received TERM' TERM; while true; do usleep 10; done"),
)
ctxCancel, cancel := context.WithCancel(ctx)
t.Cleanup(cancel)
const stopTimeout = 3
stoppedCh := make(chan error)
go func() {
sto := stopTimeout
stoppedCh <- apiClient.ContainerStop(ctxCancel, id, containertypes.StopOptions{Timeout: &sto})
}()
poll.WaitOn(t, logsContains(ctx, apiClient, id, "received TERM"))
// Cancel the context once we verified the container was signaled, and check
// that the container is not killed immediately
cancel()
select {
case stoppedErr := <-stoppedCh:
assert.Check(t, is.ErrorType(stoppedErr, errdefs.IsCancelled))
case <-time.After(5 * time.Second):
t.Fatal("timeout waiting for stop request to be cancelled")
}
inspect, err := apiClient.ContainerInspect(ctx, id)
assert.Check(t, err)
assert.Check(t, inspect.State.Running)
// container should be stopped after stopTimeout is reached. The daemon.containerStop
// code is rather convoluted, and waits another 2 seconds for the container to
// terminate after signaling it;
// https://github.com/moby/moby/blob/97455cc31ffa08078db6591f018256ed59c35bbc/daemon/stop.go#L101-L112
//
// Adding 3 seconds to the specified stopTimeout to take this into account,
// and add another second margin to try to avoid flakiness.
poll.WaitOn(t, container.IsStopped(ctx, apiClient, id), poll.WithTimeout((3+stopTimeout)*time.Second))
}
// logsContains verifies the container contains the given text in the log's stdout.
func logsContains(ctx context.Context, client client.APIClient, containerID string, logString string) func(log poll.LogT) poll.Result {
return func(log poll.LogT) poll.Result {
logs, err := client.ContainerLogs(ctx, containerID, containertypes.LogsOptions{
ShowStdout: true,
})
if err != nil {
return poll.Error(err)
}
defer logs.Close()
var stdout bytes.Buffer
_, err = stdcopy.StdCopy(&stdout, io.Discard, logs)
if err != nil {
return poll.Error(err)
}
if strings.Contains(stdout.String(), logString) {
return poll.Success()
}
return poll.Continue("waiting for logstring '%s' in container", logString)
}
}