de6020a240
The package defined various special errors; these errors existed for two reasons; - being able to distinguish "not found" errors from other errors (as "not found" errors can be ignored in various cases). - to be able to update the context _name_ in the error message after the error was created. This was needed in cases where the name was not available at the location where the error was produced (e.g. only the "id" was present), and the helpers to detect "not found" errors did not support wrapped errors (so wrapping the error with a "name" could break logic); a `setContextName` interface and corresponding `patchErrContextName()` utility was created for this (which was a "creative", but not very standard approach). This patch: - Removes the special error-types, replacing them with errdefs definitions (which is a more common approach in our code-base to detect error types / classes). - Removes the internal utilities for error-handling, and deprecates the exported utilities (to allow external consumers to adjust their code). - Some errors have been enriched with detailed information (which may be useful for debugging / problem solving). - Note that in some cases, `patchErrContextName()` was called, but the code producing the error would never return a `setContextName` error, so would never update the error message. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
86 lines
2.3 KiB
Go
86 lines
2.3 KiB
Go
package context
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/docker/errdefs"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// RemoveOptions are the options used to remove contexts
|
|
type RemoveOptions struct {
|
|
Force bool
|
|
}
|
|
|
|
func newRemoveCommand(dockerCli command.Cli) *cobra.Command {
|
|
var opts RemoveOptions
|
|
cmd := &cobra.Command{
|
|
Use: "rm CONTEXT [CONTEXT...]",
|
|
Aliases: []string{"remove"},
|
|
Short: "Remove one or more contexts",
|
|
Args: cli.RequiresMinArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
return RunRemove(dockerCli, opts, args)
|
|
},
|
|
}
|
|
cmd.Flags().BoolVarP(&opts.Force, "force", "f", false, "Force the removal of a context in use")
|
|
return cmd
|
|
}
|
|
|
|
// RunRemove removes one or more contexts
|
|
func RunRemove(dockerCli command.Cli, opts RemoveOptions, names []string) error {
|
|
var errs []string
|
|
currentCtx := dockerCli.CurrentContext()
|
|
for _, name := range names {
|
|
if name == "default" {
|
|
errs = append(errs, `default: context "default" cannot be removed`)
|
|
} else if err := doRemove(dockerCli, name, name == currentCtx, opts.Force); err != nil {
|
|
errs = append(errs, err.Error())
|
|
} else {
|
|
fmt.Fprintln(dockerCli.Out(), name)
|
|
}
|
|
}
|
|
if len(errs) > 0 {
|
|
return errors.New(strings.Join(errs, "\n"))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func doRemove(dockerCli command.Cli, name string, isCurrent, force bool) error {
|
|
if isCurrent {
|
|
if !force {
|
|
return errors.Errorf("context %q is in use, set -f flag to force remove", name)
|
|
}
|
|
// fallback to DOCKER_HOST
|
|
cfg := dockerCli.ConfigFile()
|
|
cfg.CurrentContext = ""
|
|
if err := cfg.Save(); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if !force {
|
|
if err := checkContextExists(dockerCli, name); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return dockerCli.ContextStore().Remove(name)
|
|
}
|
|
|
|
// checkContextExists returns an error if the context directory does not exist.
|
|
func checkContextExists(dockerCli command.Cli, name string) error {
|
|
contextDir := dockerCli.ContextStore().GetStorageInfo(name).MetadataPath
|
|
_, err := os.Stat(contextDir)
|
|
if os.IsNotExist(err) {
|
|
return errdefs.NotFound(errors.Errorf("context %q does not exist", name))
|
|
}
|
|
// Ignore other errors; if relevant, they will produce an error when
|
|
// performing the actual delete.
|
|
return nil
|
|
}
|