Merge pull request #447 from kool-dev/compose-v2

Compose v2

Author: fabriciojs

Dockerfile

@@ -1,4 +1,3 @@
-FROM docker/compose:alpine-1.29.2 AS docker-compose
 FROM golang:1.19 AS build
 
 ARG BUILD_VERSION=0.0.0-auto
@@ -12,14 +11,13 @@ RUN go build -a \
 	-ldflags '-X kool-dev/kool/commands.version='$BUILD_VERSION' -extldflags "-static"' \
 	-o kool
 
-FROM alpine:3.15.4
+FROM docker:20.10.21-cli
 
 ENV DOCKER_HOST=tcp://docker:2375
 
-COPY --from=docker-compose /usr/local/bin/docker /usr/local/bin/docker
-COPY --from=docker-compose /usr/local/bin/docker-compose /usr/local/bin/docker-compose
 COPY --from=build /app/kool /usr/local/bin/kool
 
-RUN apk add --no-cache git bash
+RUN apk add --no-cache git bash \
+	&& rm -rf /var/cache/apk/* /tmp/*
 
 CMD [ "kool" ]

README.md

@@ -13,7 +13,7 @@
 
 ## About `kool`
 
-**Kool** is a CLI tool that brings the complexities of modern software development environments down to earth - making these environments lightweight, fast and reproducible. It reduces the complexity and learning curve of _Docker_ and _Docker Compose_ for local environments, and offers a simplified interface for using _Kubernetes_ to deploy staging and production environments to the cloud.
+**Kool** is a CLI tool that brings the complexities of modern software development environments down to earth - making these environments lightweight, fast and reproducible. It reduces the complexity and learning curve of _Docker_ containers for local environments, and offers a simplified interface for using _Kubernetes_ to deploy staging and production environments to the cloud.
 
 **Kool** gets your local development environment up and running easily and quickly, so you have more time to build a great application. When the time is right, you can then use Kool Cloud to deploy and share your work with the world!
 
@@ -25,6 +25,8 @@
 
 Requirements: Kool is powered by [Docker](https://docs.docker.com/get-docker/). If you haven't done so already, you first need to [install Docker and the kool CLI](https://kool.dev/docs/getting-started/installation).
 
+**Important**: make sure you are running the latest version of Docker and that you do have Composer V2 available (`docker compose`). You can read more about [Compose V2 release via its documentation](https://docs.docker.com/compose/reference/).
+
 ### For Linux and macOS
 
 Install **kool** by running the following script. It will download the latest **kool** binary from [https://github.com/kool-dev/kool/releases](https://github.com/kool-dev/kool/releases), and save it in your `/usr/local/bin` folder.

commands/exec.go

@@ -6,7 +6,6 @@ import (
 	"io"
 	"kool-dev/kool/core/builder"
 	"kool-dev/kool/core/environment"
-	"kool-dev/kool/services/compose"
 	"os"
 	"strings"
 
@@ -44,7 +43,7 @@ func NewKoolExec() *KoolExec {
 		*newDefaultKoolService(),
 		&KoolExecFlags{false, []string{}, false},
 		environment.NewEnvStorage(),
-		compose.NewDockerCompose("exec"),
+		builder.NewCommand("docker", "compose", "exec"),
 	}
 }
 
@@ -54,11 +53,6 @@ func (e *KoolExec) detectTTY() {
 	if !isTerminal {
 		e.composeExec.AppendArgs("-T")
 	}
-
-	if aware, ok := e.composeExec.(compose.TtyAware); ok {
-		// let DockerCompose know about whether we are under TTY or not
-		aware.SetIsTTY(isTerminal)
-	}
 }
 
 func (e *KoolExec) checkUser(service string) {
@@ -88,9 +82,11 @@ func (e *KoolExec) checkUser(service string) {
 		// so we avoid getting cross-fire on in/out redirections
 		actualOut := e.Shell().OutStream()
 		defer e.Shell().SetOutStream(actualOut)
-
 		e.Shell().SetOutStream(os.Stderr)
-		e.Shell().Warning(fmt.Sprintf("failed to check running container for kool user; did you forget kool start? (err: %s)", err.Error()))
+
+		if e.env.IsTrue("KOOL_VERBOSE") {
+			e.Shell().Warning(fmt.Sprintf("failed to check running container for kool user; did you forget kool start? (err: %s)", err.Error()))
+		}
 	} else if strings.Contains(passwd, fmt.Sprintf("kool:x:%s", asuser)) {
 		// since user (kool:x:UID) exists within the container, we set it
 		e.composeExec.AppendArgs("--user", asuser)

commands/exec_test.go

@@ -6,8 +6,6 @@ import (
 	"kool-dev/kool/core/builder"
 	"kool-dev/kool/core/environment"
 	"kool-dev/kool/core/shell"
-	"kool-dev/kool/services/compose"
-	"strings"
 	"testing"
 )
 
@@ -51,10 +49,6 @@ func TestNewKoolExec(t *testing.T) {
 			t.Errorf("bad default value for Detach flag on default KoolExec instance")
 		}
 	}
-
-	if _, ok := k.composeExec.(*compose.DockerCompose); !ok {
-		t.Errorf("unexpected compose.DockerCompose on default KoolExec instance")
-	}
 }
 
 func TestNewExecCommand(t *testing.T) {
@@ -191,31 +185,20 @@ func TestFailingNewExecCommand(t *testing.T) {
 
 func TestDockerComposeTerminalAwarness(t *testing.T) {
 	f := newFakeKoolExec()
-	f.composeExec = compose.NewDockerCompose("cmd")
-	f.composeExec.(*compose.DockerCompose).SetShell(&shell.FakeShell{})
-	f.composeExec.(*compose.DockerCompose).SetLocalDockerCompose(&builder.FakeCommand{
-		MockLookPathError: errors.New("some error"),
-	})
-
-	cmd := NewExecCommand(f)
-	cmd.SetArgs([]string{"service", "command"})
+	f.composeExec = &builder.FakeCommand{MockCmd: "docker", ArgsAppend: []string{"compose", "exec"}}
 
 	f.shell.(*shell.FakeShell).MockIsTerminal = false
-	if err := cmd.Execute(); err != nil {
-		t.Errorf("unexpected error executing exec command; error: %v", err)
-	}
-
-	if strings.Contains(f.composeExec.String(), " -t ") {
-		t.Errorf("unexpected -t flag when NOT under TTY; %s", f.composeExec.String())
+	f.detectTTY()
+	var l = len(f.composeExec.Args())
+	if f.composeExec.Args()[l-1] != "-T" {
+		t.Errorf("missing -T flag when NOT under TTY; %s", f.composeExec.String())
 	}
 
+	f.composeExec = &builder.FakeCommand{MockCmd: "docker", ArgsAppend: []string{"compose", "exec"}}
 	f.shell.(*shell.FakeShell).MockIsTerminal = true
-	if err := cmd.Execute(); err != nil {
-		t.Errorf("unexpected error executing exec command; error: %v", err)
-	}
-
-	if !strings.Contains(f.composeExec.String(), " -t ") {
-		t.Error("missing -t flag when under TTY")
+	l = len(f.composeExec.Args())
+	if f.composeExec.Args()[l-1] == "-T" {
+		t.Error("unexpected -t flag when under TTY")
 	}
 }
 

commands/info.go

@@ -1,6 +1,7 @@
 package commands
 
 import (
+	"fmt"
 	"kool-dev/kool/core/builder"
 	"kool-dev/kool/core/environment"
 	"os"
@@ -37,7 +38,7 @@ func NewKoolInfo() *KoolInfo {
 		*newDefaultKoolService(),
 		environment.NewEnvStorage(),
 		builder.NewCommand("docker", "-v"),
-		builder.NewCommand("docker-compose", "-v"),
+		builder.NewCommand("docker", "compose", "version"),
 	}
 }
 
@@ -79,16 +80,14 @@ func (i *KoolInfo) Execute(args []string) (err error) {
 
 	i.Shell().Println("")
 
-	// docker-compose CLI info
+	// docker compose v2 info
 	if output, err = i.Shell().Exec(i.cmdDockerCompose); err != nil {
-		// just alert missing docker-compose, but don't elevate error
+		// just alert missing docker compose, but don't elevate error
 		i.Shell().Warning("Docker Compose:", err.Error())
-		i.Shell().Warning("It's okay not having docker-compose installed, as kool will fallback to using a container for it when necessary.")
-		err = nil
+		i.Shell().Error(fmt.Errorf("You need to have Docker Compose V2 available. Make sure to update your Docker installation."))
+		return
 	} else {
 		i.Shell().Println(output)
-		output, _ = exec.LookPath("docker-compose")
-		i.Shell().Println("Docker Compose Bin Path:", output)
 	}
 
 	i.Shell().Println("")
@@ -106,5 +105,8 @@ func (i *KoolInfo) Execute(args []string) (err error) {
 		}
 	}
 
+	i.Shell().Println("")
+	i.Shell().Println("kool installation seems to be working as expected.")
+
 	return
 }

commands/logs.go

@@ -2,7 +2,6 @@ package commands
 
 import (
 	"kool-dev/kool/core/builder"
-	"kool-dev/kool/services/compose"
 	"strconv"
 	"strings"
 
@@ -38,8 +37,8 @@ func NewKoolLogs() *KoolLogs {
 	return &KoolLogs{
 		*newDefaultKoolService(),
 		&KoolLogsFlags{25, false},
-		compose.NewDockerCompose("ps", "-aq"),
-		compose.NewDockerCompose("logs"),
+		builder.NewCommand("docker", "compose", "ps", "-aq"),
+		builder.NewCommand("docker", "compose", "logs"),
 	}
 }
 

commands/logs_test.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"kool-dev/kool/core/builder"
 	"kool-dev/kool/core/shell"
-	"kool-dev/kool/services/compose"
 	"testing"
 )
 
@@ -46,12 +45,12 @@ func TestNewKoolLogs(t *testing.T) {
 		}
 	}
 
-	if _, ok := k.logs.(*compose.DockerCompose); !ok {
+	if _, ok := k.logs.(*builder.DefaultCommand); !ok {
 		t.Error("unexpected builder.Command on default KoolLogs instance")
 	}
 
-	if k.logs.(*compose.DockerCompose).Command.String() != "logs" {
-		t.Error("unexpected compose.DockerCompose.Command.String() on default KoolLogs instance logs")
+	if k.logs.String() != "docker compose logs" {
+		t.Error("unexpected logs .String() on default KoolLogs instance logs")
 	}
 }
 
@@ -177,7 +176,7 @@ func TestNoContainersNewLogsCommand(t *testing.T) {
 	}
 
 	if val, ok := f.shell.(*shell.FakeShell).CalledInteractive["logs"]; val && ok {
-		t.Error("should not call docker-compose logs if there are no containers")
+		t.Error("should not call docker compose logs if there are no containers")
 	}
 }
 

commands/self-update.go

@@ -57,6 +57,7 @@ func (s *KoolSelfUpdate) Execute(args []string) (err error) {
 	}
 
 	s.Shell().Success("Successfully updated to version ", latestVersion.String())
+	s.Shell().Println("Please run 'kool info' now to validate your local environment.")
 	return
 }
 

commands/start.go

@@ -5,7 +5,6 @@ import (
 	"kool-dev/kool/core/environment"
 	"kool-dev/kool/core/network"
 	"kool-dev/kool/services/checker"
-	"kool-dev/kool/services/compose"
 	"kool-dev/kool/services/updater"
 
 	"github.com/spf13/cobra"
@@ -68,11 +67,11 @@ func NewKoolStart() *KoolStart {
 		checker.NewChecker(defaultKoolService.shell),
 		network.NewHandler(defaultKoolService.shell),
 		environment.NewEnvStorage(),
-		compose.NewDockerCompose("up", "--force-recreate"),
+		builder.NewCommand("docker", "compose", "up", "--force-recreate"),
 		&KoolRebuild{
 			*newDefaultKoolService(),
-			compose.NewDockerCompose("pull"),
-			compose.NewDockerCompose("build", "--pull"),
+			builder.NewCommand("docker", "compose", "pull"),
+			builder.NewCommand("docker", "compose", "build", "--pull"),
 		},
 	}
 }
@@ -100,10 +99,7 @@ func (s *KoolStart) Execute(args []string) (err error) {
 	}
 
 	if len(s.Flags.Profile) > 0 {
-		if aware, ok := s.start.(compose.LocalDockerComposeAware); ok {
-			// let DockerCompose know about whether we are under TTY or not
-			aware.LocalDockerCompose().AppendArgs("--profile", s.Flags.Profile)
-		}
+		s.start.AppendArgs("--profile", s.Flags.Profile)
 	}
 
 	if !s.Flags.Foreground {

commands/status.go

@@ -6,7 +6,6 @@ import (
 	"kool-dev/kool/core/network"
 	"kool-dev/kool/core/shell"
 	"kool-dev/kool/services/checker"
-	"kool-dev/kool/services/compose"
 	"strings"
 	"sync"
 
@@ -51,8 +50,8 @@ func NewKoolStatus() *KoolStatus {
 		checker.NewChecker(defaultKoolService.shell),
 		network.NewHandler(defaultKoolService.shell),
 		environment.NewEnvStorage(),
-		compose.NewDockerCompose("ps", "--services"),
-		compose.NewDockerCompose("ps", "-q"),
+		builder.NewCommand("docker", "compose", "ps", "--services"),
+		builder.NewCommand("docker", "compose", "ps", "-q"),
 		builder.NewCommand("docker", "ps", "-a", "--format", "{{.Status}}|{{.Ports}}"),
 		shell.NewTableWriter(),
 	}