compose-cli/cli/main.go

/*
   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"
	compose2 "github.com/docker/compose/v2/cmd/compose"
	"github.com/docker/compose/v2/pkg/api"
	"github.com/docker/compose/v2/pkg/compose"
	"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"
	"github.com/docker/compose-cli/local"

	// 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 (
	metricsClient           metrics.Client
	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)
	}

	metricsClient = metrics.NewDefaultClient()
	metricsClient.WithCliVersionFunc(func() string {
		return mobycli.CliVersion()
	})

	// 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 && isFirstLevelCommand(cmd) {
		return true
	}
	return isContextAgnosticCommand(cmd.Parent())
}

func isFirstLevelCommand(cmd *cobra.Command) bool {
	return !cmd.HasParent() || !cmd.Parent().HasParent()
}

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()
	}
	ctx = context.WithValue(ctx, config.ContextTypeKey, ctype)

	initLocalFn := func() (backend.Service, error) {
		return local.GetLocalBackend(configDir, opts)
	}
	backend.Register(store.DefaultContextType, store.DefaultContextType, initLocalFn, nil)
	backend.Register(store.LocalContextType, store.LocalContextType, initLocalFn, nil)
	service, err := backend.Get(ctype)
	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(proxy)

	if ctype == store.AciContextType {
		customizeCliForACI(command, proxy)
	}

	root.AddCommand(command)

	start := time.Now().UTC()
	err = root.ExecuteContext(ctx)
	duration := time.Since(start)
	if err != nil {
		handleError(ctx, err, ctype, currentContext, cc, root, start, duration)
	}
	metricsClient.Track(
		metrics.CmdResult{
			ContextType: ctype,
			Args:        os.Args[1:],
			Status:      metrics.SuccessStatus,
			Start:       start,
			Duration:    duration,
		})
}

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 handleError(
	ctx context.Context,
	err error,
	ctype string,
	currentContext string,
	cc *store.DockerContext,
	root *cobra.Command,
	start time.Time,
	duration time.Duration,
) {
	// if user canceled request, simply exit without any error message
	if api.IsErrCanceled(err) || errors.Is(ctx.Err(), context.Canceled) {
		metricsClient.Track(
			metrics.CmdResult{
				ContextType: ctype,
				Args:        os.Args[1:],
				Status:      metrics.CanceledStatus,
				Start:       start,
				Duration:    duration,
			},
		)
		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 <name>`, cc.Type(), store.EcsContextType),
			ctype,
			start,
			duration,
		)
	}

	// Context should always be handled by new CLI
	requiredCmd, _, _ := root.Find(os.Args[1:])
	if requiredCmd != nil && isContextAgnosticCommand(requiredCmd) {
		exit(currentContext, err, ctype, start, duration)
	}
	mobycli.ExecIfDefaultCtxType(ctx, root)

	checkIfUnknownCommandExistInDefaultContext(err, currentContext, ctype)

	exit(currentContext, err, ctype, start, duration)
}

func exit(ctx string, err error, ctype string, start time.Time, duration time.Duration) {
	if exit, ok := err.(cli.StatusError); ok {
		// TODO(milas): shouldn't this use the exit code to determine status?
		metricsClient.Track(
			metrics.CmdResult{
				ContextType: ctype,
				Args:        os.Args[1:],
				Status:      metrics.SuccessStatus,
				Start:       start,
				Duration:    duration,
			},
		)
		os.Exit(exit.StatusCode)
	}

	var composeErr compose.Error
	metricsStatus := metrics.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 = metrics.CommandSyntaxFailure.MetricsStatus
		exitCode = metrics.CommandSyntaxFailure.ExitCode
	}
	metricsClient.Track(
		metrics.CmdResult{
			ContextType: ctype,
			Args:        os.Args[1:],
			Status:      metricsStatus,
			Start:       start,
			Duration:    duration,
		},
	)

	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). %q\n", name, ctx, err)

		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)
			metricsClient.Track(metrics.CmdResult{
				ContextType: contextType,
				Args:        os.Args[1:],
				Status:      metrics.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)
	}
}