/* Copyright 2020 Docker Compose CLI authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package main import ( "context" "fmt" "math/rand" "os" "os/signal" "path/filepath" "regexp" "strings" "syscall" "time" "github.com/compose-spec/compose-go/types" "github.com/docker/cli/cli" "github.com/pkg/errors" "github.com/sirupsen/logrus" "github.com/spf13/cobra" "github.com/docker/compose-cli/api/backend" "github.com/docker/compose-cli/api/config" apicontext "github.com/docker/compose-cli/api/context" "github.com/docker/compose-cli/api/context/store" "github.com/docker/compose-cli/cli/cmd" contextcmd "github.com/docker/compose-cli/cli/cmd/context" "github.com/docker/compose-cli/cli/cmd/login" "github.com/docker/compose-cli/cli/cmd/logout" "github.com/docker/compose-cli/cli/cmd/run" "github.com/docker/compose-cli/cli/cmd/volume" cliconfig "github.com/docker/compose-cli/cli/config" "github.com/docker/compose-cli/cli/metrics" "github.com/docker/compose-cli/cli/mobycli" cliopts "github.com/docker/compose-cli/cli/options" compose2 "github.com/docker/compose-cli/cmd/compose" "github.com/docker/compose-cli/local" "github.com/docker/compose-cli/pkg/api" "github.com/docker/compose-cli/pkg/compose" // Backend registrations _ "github.com/docker/compose-cli/aci" _ "github.com/docker/compose-cli/ecs" _ "github.com/docker/compose-cli/ecs/local" _ "github.com/docker/compose-cli/local" ) var ( contextAgnosticCommands = map[string]struct{}{ "context": {}, "login": {}, "logout": {}, "serve": {}, "version": {}, "backend-metadata": {}, // Special hidden commands used by cobra for completion "__complete": {}, "__completeNoDesc": {}, } unknownCommandRegexp = regexp.MustCompile(`unknown docker command: "([^"]*)"`) ) func init() { // initial hack to get the path of the project's bin dir // into the env of this cli for development path, err := filepath.Abs(filepath.Dir(os.Args[0])) if err != nil { fatal(errors.Wrap(err, "unable to get absolute bin path")) } if err := os.Setenv("PATH", appendPaths(os.Getenv("PATH"), path)); err != nil { panic(err) } // Seed random rand.Seed(time.Now().UnixNano()) } func appendPaths(envPath string, path string) string { if envPath == "" { return path } return strings.Join([]string{envPath, path}, string(os.PathListSeparator)) } func isContextAgnosticCommand(cmd *cobra.Command) bool { if cmd == nil { return false } if _, ok := contextAgnosticCommands[cmd.Name()]; ok { return true } return isContextAgnosticCommand(cmd.Parent()) } func main() { var opts cliopts.GlobalOpts root := &cobra.Command{ Use: "docker", SilenceErrors: true, SilenceUsage: true, TraverseChildren: true, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { if !isContextAgnosticCommand(cmd) { mobycli.ExecIfDefaultCtxType(cmd.Context(), cmd.Root()) } return nil }, RunE: func(cmd *cobra.Command, args []string) error { if len(args) == 0 { return cmd.Help() } return fmt.Errorf("unknown docker command: %q", args[0]) }, } root.AddCommand( contextcmd.Command(), cmd.PsCommand(), cmd.ServeCommand(), cmd.ExecCommand(), cmd.LogsCommand(), cmd.RmCommand(), cmd.StartCommand(), cmd.InspectCommand(), login.Command(), logout.Command(), cmd.VersionCommand(), cmd.StopCommand(), cmd.KillCommand(), cmd.SecretCommand(), cmd.PruneCommand(), cmd.MetadataCommand(), // Place holders cmd.EcsCommand(), ) helpFunc := root.HelpFunc() root.SetHelpFunc(func(cmd *cobra.Command, args []string) { if !isContextAgnosticCommand(cmd) { mobycli.ExecIfDefaultCtxType(cmd.Context(), cmd.Root()) } helpFunc(cmd, args) }) flags := root.Flags() opts.InstallFlags(flags) opts.AddConfigFlags(flags) flags.BoolVarP(&opts.Version, "version", "v", false, "Print version information and quit") flags.SetInterspersed(false) walk(root, func(c *cobra.Command) { c.Flags().BoolP("help", "h", false, "Help for "+c.Name()) }) // populate the opts with the global flags flags.Parse(os.Args[1:]) // nolint: errcheck level, err := logrus.ParseLevel(opts.LogLevel) if err != nil { fmt.Fprintf(os.Stderr, "Unable to parse logging level: %s\n", opts.LogLevel) os.Exit(1) } logrus.SetFormatter(&logrus.TextFormatter{ DisableTimestamp: true, DisableLevelTruncation: true, }) logrus.SetLevel(level) if opts.Debug { logrus.SetLevel(logrus.DebugLevel) } ctx, cancel := newSigContext() defer cancel() // --version should immediately be forwarded to the original cli if opts.Version { mobycli.Exec(root) } if opts.Config == "" { fatal(errors.New("config path cannot be empty")) } configDir := opts.Config config.WithDir(configDir) currentContext := cliconfig.GetCurrentContext(opts.Context, configDir, opts.Hosts) apicontext.WithCurrentContext(currentContext) s, err := store.New(configDir) if err != nil { mobycli.Exec(root) } store.WithContextStore(s) ctype := store.DefaultContextType cc, _ := s.Get(currentContext) if cc != nil { ctype = cc.Type() } service, err := getBackend(ctype, configDir, opts) if err != nil { fatal(err) } backend.WithBackend(service) root.AddCommand( run.Command(ctype), volume.Command(ctype), ) // On default context, "compose" is implemented by CLI Plugin proxy := api.NewServiceProxy().WithService(service.ComposeService()) command := compose2.RootCommand(ctype, proxy) if ctype == store.AciContextType { customizeCliForACI(command, proxy) } root.AddCommand(command) if err = root.ExecuteContext(ctx); err != nil { handleError(ctx, err, ctype, currentContext, cc, root) } metrics.Track(ctype, os.Args[1:], compose.SuccessStatus) } func customizeCliForACI(command *cobra.Command, proxy *api.ServiceProxy) { var domainName string for _, c := range command.Commands() { if c.Name() == "up" { c.Flags().StringVar(&domainName, "domainname", "", "Container NIS domain name") proxy.WithInterceptor(func(ctx context.Context, project *types.Project) { if domainName != "" { // arbitrarily set the domain name on the first service ; ACI backend will expose the entire project project.Services[0].DomainName = domainName } }) } } } func getBackend(ctype string, configDir string, opts cliopts.GlobalOpts) (backend.Service, error) { switch ctype { case store.DefaultContextType, store.LocalContextType: return local.GetLocalBackend(configDir, opts) } service, err := backend.Get(ctype) if api.IsNotFoundError(err) { return service, nil } return service, err } func handleError(ctx context.Context, err error, ctype string, currentContext string, cc *store.DockerContext, root *cobra.Command) { // if user canceled request, simply exit without any error message if api.IsErrCanceled(err) || errors.Is(ctx.Err(), context.Canceled) { metrics.Track(ctype, os.Args[1:], compose.CanceledStatus) os.Exit(130) } if ctype == store.AwsContextType { exit(currentContext, errors.Errorf(`%q context type has been renamed. Recreate the context by running: $ docker context create %s `, cc.Type(), store.EcsContextType), ctype) } // Context should always be handled by new CLI requiredCmd, _, _ := root.Find(os.Args[1:]) if requiredCmd != nil && isContextAgnosticCommand(requiredCmd) { exit(currentContext, err, ctype) } mobycli.ExecIfDefaultCtxType(ctx, root) checkIfUnknownCommandExistInDefaultContext(err, currentContext, ctype) exit(currentContext, err, ctype) } func exit(ctx string, err error, ctype string) { if exit, ok := err.(cli.StatusError); ok { metrics.Track(ctype, os.Args[1:], compose.SuccessStatus) os.Exit(exit.StatusCode) } var composeErr compose.Error metricsStatus := compose.FailureStatus exitCode := 1 if errors.As(err, &composeErr) { metricsStatus = composeErr.GetMetricsFailureCategory().MetricsStatus exitCode = composeErr.GetMetricsFailureCategory().ExitCode } if strings.HasPrefix(err.Error(), "unknown shorthand flag:") || strings.HasPrefix(err.Error(), "unknown flag:") || strings.HasPrefix(err.Error(), "unknown docker command:") { metricsStatus = compose.CommandSyntaxFailure.MetricsStatus exitCode = compose.CommandSyntaxFailure.ExitCode } metrics.Track(ctype, os.Args[1:], metricsStatus) if errors.Is(err, api.ErrLoginRequired) { fmt.Fprintln(os.Stderr, err) os.Exit(api.ExitCodeLoginRequired) } if compose2.Warning != "" { logrus.Warn(err) fmt.Fprintln(os.Stderr, compose2.Warning) } if errors.Is(err, api.ErrNotImplemented) { name := metrics.GetCommand(os.Args[1:]) fmt.Fprintf(os.Stderr, "Command %q not available in current context (%s)\n", name, ctx) os.Exit(1) } fmt.Fprintln(os.Stderr, err) os.Exit(exitCode) } func fatal(err error) { fmt.Fprintln(os.Stderr, err) os.Exit(1) } func checkIfUnknownCommandExistInDefaultContext(err error, currentContext string, contextType string) { submatch := unknownCommandRegexp.FindSubmatch([]byte(err.Error())) if len(submatch) == 2 { dockerCommand := string(submatch[1]) if mobycli.IsDefaultContextCommand(dockerCommand) { fmt.Fprintf(os.Stderr, "Command %q not available in current context (%s), you can use the \"default\" context to run this command\n", dockerCommand, currentContext) metrics.Track(contextType, os.Args[1:], compose.FailureStatus) os.Exit(1) } } } func newSigContext() (context.Context, func()) { ctx, cancel := context.WithCancel(context.Background()) s := make(chan os.Signal, 1) signal.Notify(s, syscall.SIGTERM, syscall.SIGINT) go func() { <-s cancel() }() return ctx, cancel } func walk(c *cobra.Command, f func(*cobra.Command)) { f(c) for _, c := range c.Commands() { walk(c, f) } }