c51be77767
This patch adds a "cause" to the `context.Context` error when the user terminates the process through SIGINT/SIGTERM. This allows us to distinguish the cause of the `context.Context` cancellation. In future we would also be able to improve the UX of printed errors based on the underlying cause. Signed-off-by: Alano Terblanche <18033717+Benehiko@users.noreply.github.com> cmd/docker: fix possible race between ctx channel and signal channel Signed-off-by: Alano Terblanche <18033717+Benehiko@users.noreply.github.com> test: notifyContext Signed-off-by: Alano Terblanche <18033717+Benehiko@users.noreply.github.com> cmd/docker: print status on SIGTERM and not SIGINT Signed-off-by: Alano Terblanche <18033717+Benehiko@users.noreply.github.com>
111 lines
2.9 KiB
Go
111 lines
2.9 KiB
Go
package main
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"io"
|
|
"os"
|
|
"syscall"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/debug"
|
|
platformsignals "github.com/docker/cli/cmd/docker/internal/signals"
|
|
"github.com/pkg/errors"
|
|
"github.com/sirupsen/logrus"
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
)
|
|
|
|
func TestClientDebugEnabled(t *testing.T) {
|
|
defer debug.Disable()
|
|
ctx, cancel := context.WithCancel(context.TODO())
|
|
defer cancel()
|
|
|
|
cli, err := command.NewDockerCli(command.WithBaseContext(ctx))
|
|
assert.NilError(t, err)
|
|
tcmd := newDockerCommand(cli)
|
|
tcmd.SetFlag("debug", "true")
|
|
cmd, _, err := tcmd.HandleGlobalFlags()
|
|
assert.NilError(t, err)
|
|
assert.NilError(t, tcmd.Initialize())
|
|
err = cmd.PersistentPreRunE(cmd, []string{})
|
|
assert.NilError(t, err)
|
|
assert.Check(t, is.Equal("1", os.Getenv("DEBUG")))
|
|
assert.Check(t, is.Equal(logrus.DebugLevel, logrus.GetLevel()))
|
|
}
|
|
|
|
var discard = io.NopCloser(bytes.NewBuffer(nil))
|
|
|
|
func runCliCommand(t *testing.T, r io.ReadCloser, w io.Writer, args ...string) error {
|
|
t.Helper()
|
|
if r == nil {
|
|
r = discard
|
|
}
|
|
if w == nil {
|
|
w = io.Discard
|
|
}
|
|
ctx, cancel := context.WithCancel(context.TODO())
|
|
defer cancel()
|
|
|
|
cli, err := command.NewDockerCli(
|
|
command.WithBaseContext(ctx),
|
|
command.WithInputStream(r),
|
|
command.WithCombinedStreams(w))
|
|
assert.NilError(t, err)
|
|
tcmd := newDockerCommand(cli)
|
|
|
|
tcmd.SetArgs(args)
|
|
cmd, _, err := tcmd.HandleGlobalFlags()
|
|
assert.NilError(t, err)
|
|
assert.NilError(t, tcmd.Initialize())
|
|
return cmd.Execute()
|
|
}
|
|
|
|
func TestExitStatusForInvalidSubcommandWithHelpFlag(t *testing.T) {
|
|
err := runCliCommand(t, nil, nil, "help", "invalid")
|
|
assert.Error(t, err, "unknown help topic: invalid")
|
|
}
|
|
|
|
func TestExitStatusForInvalidSubcommand(t *testing.T) {
|
|
err := runCliCommand(t, nil, nil, "invalid")
|
|
assert.Check(t, is.ErrorContains(err, "docker: unknown command: docker invalid"))
|
|
}
|
|
|
|
func TestVersion(t *testing.T) {
|
|
var b bytes.Buffer
|
|
err := runCliCommand(t, nil, &b, "--version")
|
|
assert.NilError(t, err)
|
|
assert.Check(t, is.Contains(b.String(), "Docker version"))
|
|
}
|
|
|
|
func TestUserTerminatedError(t *testing.T) {
|
|
ctx, cancel := context.WithTimeoutCause(context.Background(), time.Second*1, errors.New("test timeout"))
|
|
t.Cleanup(cancel)
|
|
|
|
notifyCtx, cancelNotify := notifyContext(ctx, platformsignals.TerminationSignals...)
|
|
t.Cleanup(cancelNotify)
|
|
|
|
syscall.Kill(syscall.Getpid(), syscall.SIGINT)
|
|
|
|
<-notifyCtx.Done()
|
|
assert.ErrorIs(t, context.Cause(notifyCtx), errCtxSignalTerminated{
|
|
signal: syscall.SIGINT,
|
|
})
|
|
|
|
assert.Equal(t, getExitCode(context.Cause(notifyCtx)), 130)
|
|
|
|
notifyCtx, cancelNotify = notifyContext(ctx, platformsignals.TerminationSignals...)
|
|
t.Cleanup(cancelNotify)
|
|
|
|
syscall.Kill(syscall.Getpid(), syscall.SIGTERM)
|
|
|
|
<-notifyCtx.Done()
|
|
assert.ErrorIs(t, context.Cause(notifyCtx), errCtxSignalTerminated{
|
|
signal: syscall.SIGTERM,
|
|
})
|
|
|
|
assert.Equal(t, getExitCode(context.Cause(notifyCtx)), 143)
|
|
}
|