PKG := github.com/docker/compose/v5

VERSION ?= $(shell git describe --match 'v[0-9]*' --dirty='.m' --always --tags)

GO_LDFLAGS ?= -w -X ${PKG}/internal.Version=${VERSION}

GO_BUILDTAGS ?= e2e

DRIVE_PREFIX?=

ifeq ($(OS),Windows_NT)

DETECTED_OS = Windows

DRIVE_PREFIX=C:

DETECTED_OS = $(shell uname -s)

ifeq ($(DETECTED_OS),Windows)

BINARY_EXT=.exe

BUILD_FLAGS?=

TEST_FLAGS?=

E2E_TEST?=

E2E_PARALLEL_PLUGIN?=4

E2E_STANDALONE_PARALLEL?=4

ifneq ($(E2E_TEST),)

TEST_FLAGS:=$(TEST_FLAGS) -run '$(E2E_TEST)'

EXCLUDE_E2E_TESTS?=

ifneq ($(EXCLUDE_E2E_TESTS),)

TEST_FLAGS:=$(TEST_FLAGS) -skip '$(EXCLUDE_E2E_TESTS)'

BUILDX_CMD ?= docker buildx

GOTESTSUM_VERSION ?= v1.13.0

GOFUMPT_VERSION ?= v0.12.0

GOTESTSUM = go run gotest.tools/gotestsum@$(GOTESTSUM_VERSION)

DESTDIR ?=

all: build

.PHONY: build ## Build the compose cli-plugin

build:

GO111MODULE=on go build $(BUILD_FLAGS) -trimpath -tags "$(GO_BUILDTAGS)" -ldflags "$(GO_LDFLAGS)" -o "$(or $(DESTDIR),./bin/build)/docker-compose$(BINARY_EXT)" ./cmd

.PHONY: binary

binary:

BUILD_TAGS="$(GO_BUILDTAGS)" $(BUILDX_CMD) bake binary

.PHONY: binary-with-coverage

binary-with-coverage:

BUILD_TAGS="$(GO_BUILDTAGS)" $(BUILDX_CMD) bake binary-with-coverage

.PHONY: install

install: binary

mkdir -p ~/.docker/cli-plugins

install $(or $(DESTDIR),./bin/build)/docker-compose ~/.docker/cli-plugins/docker-compose

.PHONY: e2e-compose

e2e-compose: example-provider ## Run end to end local tests in plugin mode. Set E2E_TEST=TestName to run a single test

$(GOTESTSUM) --format testname --junitfile "/tmp/report/report.xml" -- -v $(TEST_FLAGS) -count=1 -parallel=$(E2E_PARALLEL_PLUGIN) -timeout 20m -tags e2e ./pkg/e2e

.PHONY: e2e-compose-standalone

e2e-compose-standalone: ## Run End to end local tests in standalone mode. Set E2E_TEST=TestName to run a single test

$(GOTESTSUM) --format testname --junitfile "/tmp/report/report.xml" -- $(TEST_FLAGS) -v -count=1 -parallel=$(E2E_STANDALONE_PARALLEL) -timeout 20m --tags=e2e,standalone ./pkg/e2e

.PHONY: build-and-e2e-compose

build-and-e2e-compose: build e2e-compose ## Compile the compose cli-plugin and run end to end local tests in plugin mode. Set E2E_TEST=TestName to run a single test

.PHONY: build-and-e2e-compose-standalone

build-and-e2e-compose-standalone: build e2e-compose-standalone ## Compile the compose cli-plugin and run End to end local tests in standalone mode. Set E2E_TEST=TestName to run a single test

.PHONY: example-provider

example-provider: ## build example provider for e2e tests

go build -o bin/build/example-provider docs/examples/provider.go

MOCKGEN = go run go.uber.org/mock/mockgen@v0.4.0

.PHONY: mocks

mocks: ## Regenerate pkg/mocks

$(MOCKGEN) -destination pkg/mocks/mock_docker_cli.go -package mocks github.com/docker/cli/cli/command Cli

$(MOCKGEN) -destination pkg/mocks/mock_docker_api.go -package mocks github.com/moby/moby/client APIClient

$(MOCKGEN) -destination pkg/mocks/mock_docker_compose_api.go -package mocks -source=./pkg/api/api.go

.PHONY: e2e

e2e: e2e-compose e2e-compose-standalone ## Run end to end local tests in both modes. Set E2E_TEST=TestName to run a single test

.PHONY: build-and-e2e

build-and-e2e: build e2e-compose e2e-compose-standalone ## Compile the compose cli-plugin and run end to end local tests in both modes. Set E2E_TEST=TestName to run a single test

.PHONY: cross

cross: ## Compile the CLI for linux, darwin and windows

$(BUILDX_CMD) bake binary-cross

.PHONY: test

test: ## Run unit tests

$(BUILDX_CMD) bake test

.PHONY: relay-test

relay-test: ## Run unit tests for the relay/ module

$(BUILDX_CMD) bake relay-test

.PHONY: cache-clear

cache-clear: ## Clear the builder cache

$(BUILDX_CMD) prune --force --filter type=exec.cachemount --filter=unused-for=24h

.PHONY: lint

lint: ## run linter(s)

$(BUILDX_CMD) bake lint

.PHONY: relay-lint

relay-lint: ## run linter(s) for the relay/ module

$(BUILDX_CMD) bake relay-lint

.PHONY: fmt

fmt:

gofumpt --version >/dev/null 2>&1 || go install mvdan.cc/gofumpt@$(GOFUMPT_VERSION)

gofumpt -w .

.PHONY: docs

docs: ## generate documentation

$(eval $@_TMP_OUT := $(shell mktemp -d -t compose-output.XXXXXXXXXX))

$(BUILDX_CMD) bake --set "*.output=type=local,dest=$($@_TMP_OUT)" docs-update

rm -rf ./docs/internal

cp -R "$(DRIVE_PREFIX)$($@_TMP_OUT)"/out/* ./docs/

rm -rf "$(DRIVE_PREFIX)$($@_TMP_OUT)"/*

.PHONY: validate-docs

validate-docs: ## validate the doc does not change

$(BUILDX_CMD) bake docs-validate

.PHONY: check-dependencies

check-dependencies: ## check dependency updates

go list -u -m -f '{{if not .Indirect}}{{if .Update}}{{.}}{{end}}{{end}}' all

.PHONY: validate-headers

validate-headers: ## Check license header for all files

$(BUILDX_CMD) bake license-validate

.PHONY: go-mod-tidy

go-mod-tidy: ## Run go mod tidy in a container and output resulting go.mod and go.sum

$(BUILDX_CMD) bake vendor-update

.PHONY: validate-go-mod

validate-go-mod: ## Validate go.mod and go.sum are up-to-date

$(BUILDX_CMD) bake vendor-validate

.PHONY: validate-mocks

validate-mocks: ## Validate pkg/mocks is up-to-date with the mocked interfaces

$(BUILDX_CMD) bake mocks-validate

validate: validate-go-mod validate-headers validate-docs validate-mocks ## Validate sources

pre-commit: validate check-dependencies lint relay-lint build test relay-test e2e-compose

help: ## Show help

@echo Please specify a build target. The choices are:

@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'