Merge pull request #3668 from nicks/nicks/issue-3667

command: print appropriate warning messages on 'context list'/'contex…
This commit is contained in:
Sebastiaan van Stijn 2022-07-29 12:23:10 +02:00 committed by GitHub
commit 7963778e0a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 81 additions and 3 deletions

View File

@ -456,10 +456,10 @@ func resolveContextName(opts *cliflags.CommonOptions, config *configfile.ConfigF
if len(opts.Hosts) > 0 { if len(opts.Hosts) > 0 {
return DefaultContextName, nil return DefaultContextName, nil
} }
if _, present := os.LookupEnv(client.EnvOverrideHost); present { if os.Getenv(client.EnvOverrideHost) != "" {
return DefaultContextName, nil return DefaultContextName, nil
} }
if ctxName, ok := os.LookupEnv("DOCKER_CONTEXT"); ok { if ctxName := os.Getenv("DOCKER_CONTEXT"); ctxName != "" {
return ctxName, nil return ctxName, nil
} }
if config != nil && config.CurrentContext != "" { if config != nil && config.CurrentContext != "" {

View File

@ -42,7 +42,7 @@ func RunUse(dockerCli command.Cli, name string) error {
} }
fmt.Fprintln(dockerCli.Out(), name) fmt.Fprintln(dockerCli.Out(), name)
fmt.Fprintf(dockerCli.Err(), "Current context is now %q\n", name) fmt.Fprintf(dockerCli.Err(), "Current context is now %q\n", name)
if os.Getenv(client.EnvOverrideHost) != "" { if name != command.DefaultContextName && os.Getenv(client.EnvOverrideHost) != "" {
fmt.Fprintf(dockerCli.Err(), "Warning: %[1]s environment variable overrides the active context. "+ fmt.Fprintf(dockerCli.Err(), "Warning: %[1]s environment variable overrides the active context. "+
"To use %[2]q, either set the global --context flag, or unset %[1]s environment variable.\n", client.EnvOverrideHost, name) "To use %[2]q, either set the global --context flag, or unset %[1]s environment variable.\n", client.EnvOverrideHost, name)
} }

View File

@ -1,13 +1,17 @@
package context package context
import ( import (
"bytes"
"path/filepath" "path/filepath"
"testing" "testing"
"github.com/docker/cli/cli/command"
"github.com/docker/cli/cli/config" "github.com/docker/cli/cli/config"
"github.com/docker/cli/cli/config/configfile" "github.com/docker/cli/cli/config/configfile"
"github.com/docker/cli/cli/context/store" "github.com/docker/cli/cli/context/store"
"github.com/docker/cli/cli/flags"
"gotest.tools/v3/assert" "gotest.tools/v3/assert"
is "gotest.tools/v3/assert/cmp"
) )
func TestUse(t *testing.T) { func TestUse(t *testing.T) {
@ -41,3 +45,77 @@ func TestUseNoExist(t *testing.T) {
err := newUseCommand(cli).RunE(nil, []string{"test"}) err := newUseCommand(cli).RunE(nil, []string{"test"})
assert.Check(t, store.IsErrContextDoesNotExist(err)) assert.Check(t, store.IsErrContextDoesNotExist(err))
} }
func TestUseHostOverride(t *testing.T) {
t.Setenv("DOCKER_HOST", "tcp://ed:2375/")
configDir := t.TempDir()
configFilePath := filepath.Join(configDir, "config.json")
testCfg := configfile.New(configFilePath)
cli := makeFakeCli(t, withCliConfig(testCfg))
err := RunCreate(cli, &CreateOptions{
Name: "test",
Docker: map[string]string{},
})
assert.NilError(t, err)
cli.ResetOutputBuffers()
err = newUseCommand(cli).RunE(nil, []string{"test"})
assert.NilError(t, err)
assert.Assert(t, is.Contains(
cli.ErrBuffer().String(),
`Warning: DOCKER_HOST environment variable overrides the active context.`,
))
assert.Assert(t, is.Contains(cli.ErrBuffer().String(), `Current context is now "test"`))
assert.Equal(t, cli.OutBuffer().String(), "test\n")
// setting DOCKER_HOST with the default context should not print a warning
cli.ResetOutputBuffers()
err = newUseCommand(cli).RunE(nil, []string{"default"})
assert.NilError(t, err)
assert.Assert(t, is.Contains(cli.ErrBuffer().String(), `Current context is now "default"`))
assert.Equal(t, cli.OutBuffer().String(), "default\n")
}
// An empty DOCKER_HOST used to break the 'context use' flow.
// So we have a test with fewer fakes that tests this flow holistically.
// https://github.com/docker/cli/issues/3667
func TestUseHostOverrideEmpty(t *testing.T) {
t.Setenv("DOCKER_HOST", "")
configDir := t.TempDir()
config.SetDir(configDir)
socketPath := "unix://" + filepath.Join(configDir, "docker.sock")
var out *bytes.Buffer
var cli *command.DockerCli
loadCli := func() {
out = bytes.NewBuffer(nil)
var err error
cli, err = command.NewDockerCli(command.WithCombinedStreams(out))
assert.NilError(t, err)
assert.NilError(t, cli.Initialize(flags.NewClientOptions()))
}
loadCli()
err := RunCreate(cli, &CreateOptions{
Name: "test",
Docker: map[string]string{"host": socketPath},
})
assert.NilError(t, err)
err = newUseCommand(cli).RunE(nil, []string{"test"})
assert.NilError(t, err)
assert.Assert(t, !is.Contains(out.String(), "Warning")().Success())
assert.Assert(t, is.Contains(out.String(), `Current context is now "test"`))
loadCli()
err = newShowCommand(cli).RunE(nil, nil)
assert.NilError(t, err)
assert.Assert(t, is.Contains(out.String(), "test"))
apiclient := cli.Client()
assert.Equal(t, apiclient.DaemonHost(), socketPath)
}