Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4337 from thaJeztah/dont_mutate_configfile 

cli/command/container: don't mutate ConfigFile.DetachKeys
This commit is contained in:
Sebastiaan van Stijn 2023-06-12 21:37:37 +02:00 committed by GitHub
parent 8aee745ab2 2331e4d521
commit 7d723e2ba7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 95 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
cli/command/container/attach.go
View File

@ -72,12 +72,12 @@ func NewAttachCommand(dockerCli command.Cli) *cobra.Command {
func runAttach(dockerCli command.Cli, opts *attachOptions) error { func runAttach(dockerCli command.Cli, opts *attachOptions) error {
ctx := context.Background() ctx := context.Background()
client := dockerCli.Client() apiClient := dockerCli.Client()
// request channel to wait for client // request channel to wait for client
resultC, errC := client.ContainerWait(ctx, opts.container, "") resultC, errC := apiClient.ContainerWait(ctx, opts.container, "")
c, err := inspectContainerAndCheckState(ctx, client, opts.container) c, err := inspectContainerAndCheckState(ctx, apiClient, opts.container)
if err != nil { if err != nil {
return err return err
} }
@ -86,8 +86,9 @@ func runAttach(dockerCli command.Cli, opts *attachOptions) error {
return err return err
} }
detachKeys := dockerCli.ConfigFile().DetachKeys
if opts.detachKeys != "" { if opts.detachKeys != "" {
dockerCli.ConfigFile().DetachKeys = opts.detachKeys detachKeys = opts.detachKeys
} }
options := types.ContainerAttachOptions{ options := types.ContainerAttachOptions{
@ -95,7 +96,7 @@ func runAttach(dockerCli command.Cli, opts *attachOptions) error {
Stdin: !opts.noStdin && c.Config.OpenStdin, Stdin: !opts.noStdin && c.Config.OpenStdin,
Stdout: true, Stdout: true,
Stderr: true, Stderr: true,
DetachKeys: dockerCli.ConfigFile().DetachKeys, DetachKeys: detachKeys,
} }
var in io.ReadCloser var in io.ReadCloser
@ -109,7 +110,7 @@ func runAttach(dockerCli command.Cli, opts *attachOptions) error {
defer signal.StopCatch(sigc) defer signal.StopCatch(sigc)
} }
resp, errAttach := client.ContainerAttach(ctx, opts.container, options) resp, errAttach := apiClient.ContainerAttach(ctx, opts.container, options)
if errAttach != nil { if errAttach != nil {
return errAttach return errAttach
} }
@ -123,7 +124,7 @@ func runAttach(dockerCli command.Cli, opts *attachOptions) error {
// the container and not exit. // the container and not exit.
// //
// Recheck the container's state to avoid attach block. // Recheck the container's state to avoid attach block.
_, err = inspectContainerAndCheckState(ctx, client, opts.container) _, err = inspectContainerAndCheckState(ctx, apiClient, opts.container)
if err != nil { if err != nil {
return err return err
} }

26
cli/command/container/create.go
View File

@ -104,11 +104,11 @@ func runCreate(dockerCli command.Cli, flags *pflag.FlagSet, options *createOptio
reportError(dockerCli.Err(), "create", err.Error(), true) reportError(dockerCli.Err(), "create", err.Error(), true)
return cli.StatusError{StatusCode: 125} return cli.StatusError{StatusCode: 125}
} }
response, err := createContainer(context.Background(), dockerCli, containerCfg, options) id, err := createContainer(context.Background(), dockerCli, containerCfg, options)
if err != nil { if err != nil {
return err return err
} }
fmt.Fprintln(dockerCli.Out(), response.ID) _, _ = fmt.Fprintln(dockerCli.Out(), id)
return nil return nil
} }
@ -185,7 +185,7 @@ func newCIDFile(path string) (*cidFile, error) {
} }
//nolint:gocyclo //nolint:gocyclo
func createContainer(ctx context.Context, dockerCli command.Cli, containerCfg *containerConfig, opts *createOptions) (*container.CreateResponse, error) { func createContainer(ctx context.Context, dockerCli command.Cli, containerCfg *containerConfig, opts *createOptions) (containerID string, err error) {
config := containerCfg.Config config := containerCfg.Config
hostConfig := containerCfg.HostConfig hostConfig := containerCfg.HostConfig
networkingConfig := containerCfg.NetworkingConfig networkingConfig := containerCfg.NetworkingConfig
@ -200,13 +200,13 @@ func createContainer(ctx context.Context, dockerCli command.Cli, containerCfg *c
containerIDFile, err := newCIDFile(hostConfig.ContainerIDFile) containerIDFile, err := newCIDFile(hostConfig.ContainerIDFile)
if err != nil { if err != nil {
return nil, err return "", err
} }
defer containerIDFile.Close() defer containerIDFile.Close()
ref, err := reference.ParseAnyReference(config.Image) ref, err := reference.ParseAnyReference(config.Image)
if err != nil { if err != nil {
return nil, err return "", err
} }
if named, ok := ref.(reference.Named); ok { if named, ok := ref.(reference.Named); ok {
namedRef = reference.TagNameOnly(named) namedRef = reference.TagNameOnly(named)
@ -215,7 +215,7 @@ func createContainer(ctx context.Context, dockerCli command.Cli, containerCfg *c
var err error var err error
trustedRef, err = image.TrustedReference(ctx, dockerCli, taggedRef) trustedRef, err = image.TrustedReference(ctx, dockerCli, taggedRef)
if err != nil { if err != nil {
return nil, err return "", err
} }
config.Image = reference.FamiliarString(trustedRef) config.Image = reference.FamiliarString(trustedRef)
} }
@ -239,14 +239,14 @@ func createContainer(ctx context.Context, dockerCli command.Cli, containerCfg *c
if opts.platform != "" && versions.GreaterThanOrEqualTo(dockerCli.Client().ClientVersion(), "1.41") { if opts.platform != "" && versions.GreaterThanOrEqualTo(dockerCli.Client().ClientVersion(), "1.41") {
p, err := platforms.Parse(opts.platform) p, err := platforms.Parse(opts.platform)
if err != nil { if err != nil {
return nil, errors.Wrap(err, "error parsing specified platform") return "", errors.Wrap(err, "error parsing specified platform")
} }
platform = &p platform = &p
} }
if opts.pull == PullImageAlways { if opts.pull == PullImageAlways {
if err := pullAndTagImage(); err != nil { if err := pullAndTagImage(); err != nil {
return nil, err return "", err
} }
} }
@ -262,24 +262,24 @@ func createContainer(ctx context.Context, dockerCli command.Cli, containerCfg *c
} }
if err := pullAndTagImage(); err != nil { if err := pullAndTagImage(); err != nil {
return nil, err return "", err
} }
var retryErr error var retryErr error
response, retryErr = dockerCli.Client().ContainerCreate(ctx, config, hostConfig, networkingConfig, platform, opts.name) response, retryErr = dockerCli.Client().ContainerCreate(ctx, config, hostConfig, networkingConfig, platform, opts.name)
if retryErr != nil { if retryErr != nil {
return nil, retryErr return "", retryErr
} }
} else { } else {
return nil, err return "", err
} }
} }
for _, w := range response.Warnings { for _, w := range response.Warnings {
fmt.Fprintf(dockerCli.Err(), "WARNING: %s\n", w) _, _ = fmt.Fprintf(dockerCli.Err(), "WARNING: %s\n", w)
} }
err = containerIDFile.Write(response.ID) err = containerIDFile.Write(response.ID)
return &response, err return response.ID, err
} }
func warnOnOomKillDisable(hostConfig container.HostConfig, stderr io.Writer) { func warnOnOomKillDisable(hostConfig container.HostConfig, stderr io.Writer) {

38
cli/command/container/create_test.go
View File

@ -79,8 +79,10 @@ func TestCIDFileCloseWithWrite(t *testing.T) {
} }
func TestCreateContainerImagePullPolicy(t *testing.T) { func TestCreateContainerImagePullPolicy(t *testing.T) {
imageName := "does-not-exist-locally" const (
containerID := "abcdef" imageName = "does-not-exist-locally"
containerID = "abcdef"
)
config := &containerConfig{ config := &containerConfig{
Config: &container.Config{ Config: &container.Config{
Image: imageName, Image: imageName,
@ -91,18 +93,18 @@ func TestCreateContainerImagePullPolicy(t *testing.T) {
cases := []struct { cases := []struct {
PullPolicy string PullPolicy string
ExpectedPulls int ExpectedPulls int
ExpectedBody container.CreateResponse ExpectedID string
ExpectedErrMsg string ExpectedErrMsg string
ResponseCounter int ResponseCounter int
}{ }{
{ {
PullPolicy: PullImageMissing, PullPolicy: PullImageMissing,
ExpectedPulls: 1, ExpectedPulls: 1,
ExpectedBody: container.CreateResponse{ID: containerID}, ExpectedID: containerID,
}, { }, {
PullPolicy: PullImageAlways, PullPolicy: PullImageAlways,
ExpectedPulls: 1, ExpectedPulls: 1,
ExpectedBody: container.CreateResponse{ID: containerID}, ExpectedID: containerID,
ResponseCounter: 1, // This lets us return a container on the first pull ResponseCounter: 1, // This lets us return a container on the first pull
}, { }, {
PullPolicy: PullImageNever, PullPolicy: PullImageNever,
@ -110,8 +112,9 @@ func TestCreateContainerImagePullPolicy(t *testing.T) {
ExpectedErrMsg: "error fake not found", ExpectedErrMsg: "error fake not found",
}, },
} }
for _, c := range cases { for _, tc := range cases {
c := c tc := tc
t.Run(tc.PullPolicy, func(t *testing.T) {
pullCounter := 0 pullCounter := 0
client := &fakeClient{ client := &fakeClient{
@ -122,8 +125,8 @@ func TestCreateContainerImagePullPolicy(t *testing.T) {
platform *specs.Platform, platform *specs.Platform,
containerName string, containerName string,
) (container.CreateResponse, error) { ) (container.CreateResponse, error) {
defer func() { c.ResponseCounter++ }() defer func() { tc.ResponseCounter++ }()
switch c.ResponseCounter { switch tc.ResponseCounter {
case 0: case 0:
return container.CreateResponse{}, fakeNotFound{} return container.CreateResponse{}, fakeNotFound{}
default: default:
@ -138,22 +141,23 @@ func TestCreateContainerImagePullPolicy(t *testing.T) {
return types.Info{IndexServerAddress: "https://indexserver.example.com"}, nil return types.Info{IndexServerAddress: "https://indexserver.example.com"}, nil
}, },
} }
cli := test.NewFakeCli(client) fakeCLI := test.NewFakeCli(client)
body, err := createContainer(context.Background(), cli, config, &createOptions{ id, err := createContainer(context.Background(), fakeCLI, config, &createOptions{
name: "name", name: "name",
platform: runtime.GOOS, platform: runtime.GOOS,
untrusted: true, untrusted: true,
pull: c.PullPolicy, pull: tc.PullPolicy,
}) })
if c.ExpectedErrMsg != "" { if tc.ExpectedErrMsg != "" {
assert.ErrorContains(t, err, c.ExpectedErrMsg) assert.Check(t, is.ErrorContains(err, tc.ExpectedErrMsg))
} else { } else {
assert.NilError(t, err) assert.Check(t, err)
assert.Check(t, is.DeepEqual(c.ExpectedBody, *body)) assert.Check(t, is.Equal(tc.ExpectedID, id))
} }
assert.Check(t, is.Equal(c.ExpectedPulls, pullCounter)) assert.Check(t, is.Equal(tc.ExpectedPulls, pullCounter))
})
} }
} }

41
cli/command/container/run.go
View File

@ -144,14 +144,14 @@ func runContainer(dockerCli command.Cli, opts *runOptions, copts *containerOptio
ctx, cancelFun := context.WithCancel(context.Background()) ctx, cancelFun := context.WithCancel(context.Background())
defer cancelFun() defer cancelFun()
createResponse, err := createContainer(ctx, dockerCli, containerCfg, &opts.createOptions) containerID, err := createContainer(ctx, dockerCli, containerCfg, &opts.createOptions)
if err != nil { if err != nil {
reportError(stderr, "run", err.Error(), true) reportError(stderr, "run", err.Error(), true)
return runStartContainerErr(err) return runStartContainerErr(err)
} }
if opts.sigProxy { if opts.sigProxy {
sigc := notifyAllSignals() sigc := notifyAllSignals()
go ForwardAllSignals(ctx, dockerCli, createResponse.ID, sigc) go ForwardAllSignals(ctx, dockerCli, containerID, sigc)
defer signal.StopCatch(sigc) defer signal.StopCatch(sigc)
} }
@ -164,26 +164,33 @@ func runContainer(dockerCli command.Cli, opts *runOptions, copts *containerOptio
waitDisplayID = make(chan struct{}) waitDisplayID = make(chan struct{})
go func() { go func() {
defer close(waitDisplayID) defer close(waitDisplayID)
fmt.Fprintln(stdout, createResponse.ID) _, _ = fmt.Fprintln(stdout, containerID)
}() }()
} }
attach := config.AttachStdin || config.AttachStdout || config.AttachStderr attach := config.AttachStdin || config.AttachStdout || config.AttachStderr
if attach { if attach {
detachKeys := dockerCli.ConfigFile().DetachKeys
if opts.detachKeys != "" { if opts.detachKeys != "" {
dockerCli.ConfigFile().DetachKeys = opts.detachKeys detachKeys = opts.detachKeys
} }
closeFn, err := attachContainer(ctx, dockerCli, &errCh, config, createResponse.ID) closeFn, err := attachContainer(ctx, dockerCli, containerID, &errCh, config, types.ContainerAttachOptions{
Stream: true,
Stdin: config.AttachStdin,
Stdout: config.AttachStdout,
Stderr: config.AttachStderr,
DetachKeys: detachKeys,
})
if err != nil { if err != nil {
return err return err
} }
defer closeFn() defer closeFn()
} }
statusChan := waitExitOrRemoved(ctx, dockerCli, createResponse.ID, copts.autoRemove) statusChan := waitExitOrRemoved(ctx, dockerCli, containerID, copts.autoRemove)
// start the container // start the container
if err := client.ContainerStart(ctx, createResponse.ID, types.ContainerStartOptions{}); err != nil { if err := client.ContainerStart(ctx, containerID, types.ContainerStartOptions{}); err != nil {
// If we have hijackedIOStreamer, we should notify // If we have hijackedIOStreamer, we should notify
// hijackedIOStreamer we are going to exit and wait // hijackedIOStreamer we are going to exit and wait
// to avoid the terminal are not restored. // to avoid the terminal are not restored.
@ -201,8 +208,8 @@ func runContainer(dockerCli command.Cli, opts *runOptions, copts *containerOptio
} }
if (config.AttachStdin || config.AttachStdout || config.AttachStderr) && config.Tty && dockerCli.Out().IsTerminal() { if (config.AttachStdin || config.AttachStdout || config.AttachStderr) && config.Tty && dockerCli.Out().IsTerminal() {
if err := MonitorTtySize(ctx, dockerCli, createResponse.ID, false); err != nil { if err := MonitorTtySize(ctx, dockerCli, containerID, false); err != nil {
fmt.Fprintln(stderr, "Error monitoring TTY size:", err) _, _ = fmt.Fprintln(stderr, "Error monitoring TTY size:", err)
} }
} }
@ -232,15 +239,7 @@ func runContainer(dockerCli command.Cli, opts *runOptions, copts *containerOptio
return nil return nil
} }
func attachContainer(ctx context.Context, dockerCli command.Cli, errCh *chan error, config *container.Config, containerID string) (func(), error) { func attachContainer(ctx context.Context, dockerCli command.Cli, containerID string, errCh *chan error, config *container.Config, options types.ContainerAttachOptions) (func(), error) {
options := types.ContainerAttachOptions{
Stream: true,
Stdin: config.AttachStdin,
Stdout: config.AttachStdout,
Stderr: config.AttachStderr,
DetachKeys: dockerCli.ConfigFile().DetachKeys,
}
resp, errAttach := dockerCli.Client().ContainerAttach(ctx, containerID, options) resp, errAttach := dockerCli.Client().ContainerAttach(ctx, containerID, options)
if errAttach != nil { if errAttach != nil {
return nil, errAttach return nil, errAttach
@ -250,13 +249,13 @@ func attachContainer(ctx context.Context, dockerCli command.Cli, errCh *chan err
out, cerr io.Writer out, cerr io.Writer
in io.ReadCloser in io.ReadCloser
) )
if config.AttachStdin { if options.Stdin {
in = dockerCli.In() in = dockerCli.In()
} }
if config.AttachStdout { if options.Stdout {
out = dockerCli.Out() out = dockerCli.Out()
} }
if config.AttachStderr { if options.Stderr {
if config.Tty { if config.Tty {
cerr = dockerCli.Out() cerr = dockerCli.Out()
} else { } else {

5
cli/command/container/start.go
View File

@ -94,8 +94,9 @@ func RunStart(dockerCli command.Cli, opts *StartOptions) error {
defer signal.StopCatch(sigc) defer signal.StopCatch(sigc)
} }
detachKeys := dockerCli.ConfigFile().DetachKeys
if opts.DetachKeys != "" { if opts.DetachKeys != "" {
dockerCli.ConfigFile().DetachKeys = opts.DetachKeys detachKeys = opts.DetachKeys
} }
options := types.ContainerAttachOptions{ options := types.ContainerAttachOptions{
@ -103,7 +104,7 @@ func RunStart(dockerCli command.Cli, opts *StartOptions) error {
Stdin: opts.OpenStdin && c.Config.OpenStdin, Stdin: opts.OpenStdin && c.Config.OpenStdin,
Stdout: true, Stdout: true,
Stderr: true, Stderr: true,
DetachKeys: dockerCli.ConfigFile().DetachKeys, DetachKeys: detachKeys,
} }
var in io.ReadCloser var in io.ReadCloser