Makefile

#   Copyright The containerd 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.


# Base path used to install.
CMD_DESTDIR ?= /usr/local
GO111MODULE_VALUE=auto
OUTDIR ?= $(CURDIR)/out
COVDIR ?= $(CURDIR)/cov
PKG=github.com/awslabs/soci-snapshotter
VERSION=$(shell git describe --match 'v[0-9]*' --dirty='.m' --always --tags)
REVISION=$(shell git rev-parse HEAD)$(shell if ! git diff --no-ext-diff --quiet --exit-code; then echo .m; fi)

GO_BUILDTAGS ?=
ifneq ($(STATIC),)
	GO_BUILDTAGS += osusergo netgo static_build
endif
GO_TAGS=$(if $(GO_BUILDTAGS),-tags "$(strip $(GO_BUILDTAGS))",)

GO_LD_FLAGS=-ldflags '-X $(PKG)/version.Version=$(VERSION) -X $(PKG)/version.Revision=$(REVISION) $(GO_EXTRA_LDFLAGS)
ifeq ($(GODEBUG),)
    GO_LD_FLAGS += -s -w
endif
ifneq ($(STATIC),)
	GO_LD_FLAGS += -extldflags "-static"
endif
GO_LD_FLAGS+='

SOCI_SNAPSHOTTER_PROJECT_ROOT ?= $(shell pwd)
LTAG_TEMPLATE_FLAG=-t ./.headers
ZTOC_FBS_DIR=$(CURDIR)/ztoc/fbs
ZTOC_FBS_FILE=$(ZTOC_FBS_DIR)/ztoc.fbs
ZTOC_FBS_GO_FILES=$(wildcard $(ZTOC_FBS_DIR)/ztoc/*.go)
COMPRESSION_FBS_DIR=$(CURDIR)/ztoc/compression/fbs
COMPRESSION_FBS_FILE=$(COMPRESSION_FBS_DIR)/zinfo.fbs
COMPRESSION_FBS_GO_FILES=$(wildcard $(COMPRESSION_FBS_DIR)/zinfo/*.go)

COMMIT=$(shell git rev-parse HEAD)
STARGZ_BINARY?=/usr/local/bin/containerd-stargz-grpc

INTEG_TEST_CONTAINERS=$(strip $(shell docker ps -aqf name="soci-integration-*"))
SOCI_BASE_IMAGE_IDS=$(shell docker image ls -qf reference="*:soci_test")

CMD=soci-snapshotter-grpc soci

CMD_BINARIES=$(addprefix $(OUTDIR)/,$(CMD))

PACKAGE_LIST_CMD=go list -f '{{.ImportPath}}' ./... | grep -v "benchmark" | paste -sd ","

SOCI_LIBRARY_PACKAGE_LIST=$(shell $(PACKAGE_LIST_CMD))
SOCI_CLI_PACKAGE_LIST=$(shell echo $(SOCI_LIBRARY_PACKAGE_LIST),$(shell cd $(SOCI_SNAPSHOTTER_PROJECT_ROOT)/cmd/soci && $(PACKAGE_LIST_CMD)))
SOCI_GRPC_PACKAGE_LIST=$(shell echo $(SOCI_LIBRARY_PACKAGE_LIST),$(shell cd $(SOCI_SNAPSHOTTER_PROJECT_ROOT)/cmd/soci-snapshotter-grpc && $(PACKAGE_LIST_CMD)))

GO_BENCHMARK_TESTS?=.

NERDCTL_REPO = https://github.com/containerd/nerdctl.git
NERDCTL_TAG = v1.7.7
NERDCTL_PATCH = $(SOCI_SNAPSHOTTER_PROJECT_ROOT)/integration/config/nerdctl.patch

.PHONY: all build check flatc add-ltag install uninstall tidy vendor clean clean-coverage \
	clean-integration test test-with-coverage show-test-coverage show-test-coverage-html nerdctl-with-idmapping \
	integration integration-with-coverage show-integration-coverage show-integration-coverage-html \
	release benchmarks build-benchmarks benchmarks-perf-test benchmarks-comparison-test

all: build

build: $(CMD)

FORCE:

soci-snapshotter-grpc: flatc FORCE
	cd cmd/ ; GO111MODULE=$(GO111MODULE_VALUE) go build -o $(OUTDIR)/$@ $(GO_BUILD_FLAGS) $(GO_LD_FLAGS) $(GO_TAGS) ./soci-snapshotter-grpc

soci: FORCE
	cd cmd/ ; GO111MODULE=$(GO111MODULE_VALUE) go build -o $(OUTDIR)/$@ $(GO_BUILD_FLAGS) $(GO_LD_FLAGS) $(GO_TAGS) ./soci

check:
	cd scripts/ ; ./check-all.sh

flatc: $(ZTOC_FBS_GO_FILES) $(COMPRESSION_FBS_GO_FILES)

$(ZTOC_FBS_GO_FILES): $(ZTOC_FBS_FILE)
	rm -rf $(ZTOC_FBS_DIR)/ztoc
	flatc -o $(ZTOC_FBS_DIR) -g $(ZTOC_FBS_FILE)

$(COMPRESSION_FBS_GO_FILES): $(COMPRESSION_FBS_FILE)
	rm -rf $(COMPRESSION_FBS_DIR)/zinfo
	flatc -o $(COMPRESSION_FBS_DIR) -g $(COMPRESSION_FBS_FILE)

install:
	@echo "$@"
	@mkdir -p $(CMD_DESTDIR)/bin
	@install $(CMD_BINARIES) $(CMD_DESTDIR)/bin

uninstall:
	@echo "$@"
	@rm -f $(addprefix $(CMD_DESTDIR)/bin/,$(notdir $(CMD_BINARIES)))

clean: clean-integration clean-coverage
	@echo "🧹 ... 🗑️"
	@rm -rf $(OUTDIR)
	@rm -rf $(CURDIR)/release/
	@echo "All clean!"

clean-coverage:
	@rm -rf $(COVDIR)

clean-integration:
	@echo "🧹 Cleaning leftover integration test artifacts..."

	@echo "🐳 Cleaning Docker artifacts..."
ifneq ($(INTEG_TEST_CONTAINERS),)
	docker stop $(INTEG_TEST_CONTAINERS)
	docker rm $(INTEG_TEST_CONTAINERS)
	docker network rm $(shell docker network ls -qf name="soci-integration-*")
	docker image rm $(SOCI_BASE_IMAGE_IDS)
	@echo "🐳 All SOCI containers, networks, and images cleaned!"
else
	@echo "🐳 No leftover Docker artifacts."
endif

	@echo "All testing artifacts cleaned!"

tidy:
	@GO111MODULE=$(GO111MODULE_VALUE) go mod tidy
	@cd ./cmd ; GO111MODULE=$(GO111MODULE_VALUE) go mod tidy

vendor:
	@GO111MODULE=$(GO111MODULE_VALUE) go mod vendor
	@cd ./cmd ; GO111MODULE=$(GO111MODULE_VALUE) go mod vendor

test:
	@echo "$@"
	@GO111MODULE=$(GO111MODULE_VALUE) go test $(GO_TEST_FLAGS) $(GO_LD_FLAGS) -race `go list ./... | grep -v benchmark` -args $(GO_TEST_ARGS)

show-test-coverage: test-with-coverage
	go tool covdata percent -i $(COVDIR)/unit

show-test-coverage-html: test-with-coverage $(COVDIR)/html
	go tool covdata textfmt -i $(COVDIR)/unit -o $(COVDIR)/unit/unit.out
	go tool cover -html=$(COVDIR)/unit/unit.out -o $(COVDIR)/html/unit.html

test-with-coverage: $(COVDIR)/unit

$(COVDIR):
	@mkdir -p $@

$(COVDIR)/html:
	@mkdir -p $@

$(COVDIR)/unit: $(COVDIR)
	@mkdir -p $@
	GO_TEST_FLAGS="$(GO_TEST_FLAGS) -cover" \
	GO_TEST_ARGS="-test.gocoverdir=$(COVDIR)/unit" \
	GO_BUILD_FLAGS="$(GO_BUILD_FLAGS) -coverpkg=$(SOCI_LIBRARY_PACKAGE_LIST)"\
		$(MAKE) test

integration: build nerdctl-with-idmapping
	@echo "$@"
	@echo "SOCI_SNAPSHOTTER_PROJECT_ROOT=$(SOCI_SNAPSHOTTER_PROJECT_ROOT)"
	@GO111MODULE=$(GO111MODULE_VALUE) SOCI_SNAPSHOTTER_PROJECT_ROOT=$(SOCI_SNAPSHOTTER_PROJECT_ROOT) ENABLE_INTEGRATION_TEST=true go test $(GO_TEST_FLAGS) -v -timeout=0 ./integration

show-integration-coverage: integration-with-coverage
	go tool covdata percent -i $(COVDIR)/integration

show-integration-coverage-html: integration-with-coverage $(COVDIR)/html
	go tool covdata textfmt -i $(COVDIR)/integration -o $(COVDIR)/integration/integration.out
	go tool cover -html=$(COVDIR)/integration/integration.out -o $(COVDIR)/html/integration.html

integration-with-coverage: $(COVDIR)/integration

$(COVDIR)/integration: $(COVDIR)
	@mkdir -p $@
	GO_TEST_FLAGS="$(GO_TEST_FLAGS)" \
	GO_BUILD_FLAGS="$(GO_BUILD_FLAGS) -coverpkg=$(SOCI_CLI_PACKAGE_LIST),$(SOCI_GRPC_PACKAGE_LIST)" \
		$(MAKE) integration

nerdctl-with-idmapping: $(OUTDIR)/nerdctl-with-idmapping

$(OUTDIR)/nerdctl-with-idmapping:
    # Use a custom patch for testing ID-mapping as nerdctl doesn't fully support this yet.
	rm -rf $(SOCI_SNAPSHOTTER_PROJECT_ROOT)/tempfolder

	git clone $(NERDCTL_REPO) $(SOCI_SNAPSHOTTER_PROJECT_ROOT)/tempfolder
	cd $(SOCI_SNAPSHOTTER_PROJECT_ROOT)/tempfolder && \
	git checkout $(NERDCTL_TAG) && \
	git apply $(NERDCTL_PATCH) && \
	make && \
	cp _output/nerdctl $(OUTDIR)/nerdctl-with-idmapping && \
	cd ../
	rm -rf $(SOCI_SNAPSHOTTER_PROJECT_ROOT)/tempfolder

release:
	@echo "$@"
	@$(SOCI_SNAPSHOTTER_PROJECT_ROOT)/scripts/create-releases.sh $(RELEASE_TAG)

go-benchmarks:
    # -run matches TestXXX type functions. Setting it to ^$ ensures non-benchmark tests are not run
	go test -run=^$$ -bench=$(GO_BENCHMARK_TESTS) -benchmem $(GO_BENCHMARK_FLAGS) ./...

benchmarks: benchmarks-perf-test benchmarks-comparison-test

build-benchmarks: benchmark/bin/PerfTests benchmark/bin/CompTests

benchmark/bin/PerfTests: FORCE
	GO111MODULE=$(GO111MODULE_VALUE) go build -o $@ ./benchmark/performanceTest

benchmark/bin/CompTests: FORCE
	GO111MODULE=$(GO111MODULE_VALUE) go build -o $@ ./benchmark/comparisonTest

benchmarks-perf-test: benchmark/bin/PerfTests
	@echo "$@"
	@cd benchmark/performanceTest ; sudo ../bin/PerfTests -show-commit $(BENCHMARK_FLAGS)

benchmarks-comparison-test: benchmark/bin/CompTests
	@echo "$@"
	@cd benchmark/comparisonTest ; sudo ../bin/CompTests $(BENCHMARK_FLAGS)

benchmarks-stargz:
	@echo "$@"
	@cd benchmark/stargzTest ; GO111MODULE=$(GO111MODULE_VALUE) go build -o ../bin/StargzTests . && sudo ../bin/StargzTests $(COMMIT) ../singleImage.csv 10 $(STARGZ_BINARY)

benchmarks-parser:
	@echo "$@"
	@cd benchmark/parser ; GO111MODULE=$(GO111MODULE_VALUE) go build -o ../bin/Parser .