363d692f35
After several requests for information about platform support, configuration introspection and feature switches, we now have a solution that should work in all these use cases. The Introspection API hooks into the plugin subsystem registration process. During registration, plugins declare several pieces of information, allowing clients to discover the cababilities and support that a containerd instance provides, including whether or not it loaded with an error. To allow symmetrical error reporting, the `google/rpc.Status` protobuf definitions have been brought in from the googleapis project. Unfortunately, we had to generate these in place to match our protobuf system. Once we like this design, we can add an implementation to integrate it directly with the plugin system. Enjoy! Signed-off-by: Stephen J Day <stephen.day@docker.com>
221 lines
7.9 KiB
Makefile
221 lines
7.9 KiB
Makefile
# Root directory of the project (absolute path).
|
|
ROOTDIR=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
|
|
|
|
# Base path used to install.
|
|
DESTDIR=/usr/local
|
|
|
|
# Used to populate variables in version package.
|
|
VERSION=$(shell git describe --match 'v[0-9]*' --dirty='.m' --always)
|
|
REVISION=$(shell git rev-parse HEAD)$(shell if ! git diff --no-ext-diff --quiet --exit-code; then echo .m; fi)
|
|
|
|
ifneq "$(strip $(shell command -v go 2>/dev/null))" ""
|
|
GOOS ?= $(shell go env GOOS)
|
|
GOARCH ?= $(shell go env GOARCH)
|
|
else
|
|
GOOS ?= $$GOOS
|
|
GOARCH ?= $$GOARCH
|
|
endif
|
|
|
|
WHALE = "🇩"
|
|
ONI = "👹"
|
|
FIX_PATH = $1
|
|
|
|
RELEASE=containerd-$(VERSION:v%=%).${GOOS}-${GOARCH}
|
|
|
|
PKG=github.com/containerd/containerd
|
|
|
|
# Project packages.
|
|
PACKAGES=$(shell go list ./... | grep -v /vendor/)
|
|
INTEGRATION_PACKAGE=${PKG}
|
|
TEST_REQUIRES_ROOT_PACKAGES=$(filter \
|
|
${PACKAGES}, \
|
|
$(shell \
|
|
for f in $$(git grep -l testutil.RequiresRoot | grep -v Makefile); do \
|
|
d="$$(dirname $$f)"; \
|
|
[ "$$d" = "." ] && echo "${PKG}" && continue; \
|
|
echo "${PKG}/$$d"; \
|
|
done | sort -u) \
|
|
)
|
|
|
|
# Project binaries.
|
|
COMMANDS=ctr containerd containerd-stress
|
|
BINARIES=$(addprefix bin/,$(COMMANDS))
|
|
|
|
GO_TAGS=$(if $(BUILDTAGS),-tags "$(BUILDTAGS)",)
|
|
GO_LDFLAGS=-ldflags "-X $(PKG)/version.Version=$(VERSION) -X $(PKG)/version.Revision=$(REVISION) -X $(PKG)/version.Package=$(PKG) $(EXTRA_LDFLAGS)"
|
|
|
|
TESTFLAGS_RACE=
|
|
|
|
#Detect the target os
|
|
include Makefile.OS
|
|
#include platform specific makefile
|
|
include Makefile.$(target_os)
|
|
|
|
# Flags passed to `go test`
|
|
TESTFLAGS ?= -v $(TESTFLAGS_RACE)
|
|
TESTFLAGS_PARALLEL ?= 8
|
|
|
|
.PHONY: clean all AUTHORS fmt vet lint dco build binaries test integration setup generate protos checkprotos coverage ci check help install uninstall vendor release
|
|
.DEFAULT: default
|
|
|
|
all: binaries
|
|
|
|
check: fmt vet lint ineffassign ## run fmt, vet, lint, ineffassign
|
|
|
|
ci: check binaries checkprotos coverage coverage-integration ## to be used by the CI
|
|
|
|
AUTHORS: .mailmap .git/HEAD
|
|
git log --format='%aN <%aE>' | sort -fu > $@
|
|
|
|
setup: ## install dependencies
|
|
@echo "$(WHALE) $@"
|
|
# TODO(stevvooe): Install these from the vendor directory
|
|
@go get -u github.com/golang/lint/golint
|
|
#@go get -u github.com/kisielk/errcheck
|
|
@go get -u github.com/gordonklaus/ineffassign
|
|
@go get -u github.com/stevvooe/protobuild
|
|
|
|
generate: protos
|
|
@echo "$(WHALE) $@"
|
|
@PATH=${ROOTDIR}/bin:${PATH} go generate -x ${PACKAGES}
|
|
|
|
protos: bin/protoc-gen-gogoctrd ## generate protobuf
|
|
@echo "$(WHALE) $@"
|
|
@PATH=${ROOTDIR}/bin:${PATH} protobuild ${PACKAGES}
|
|
|
|
check-protos: protos ## check if protobufs needs to be generated again
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(git status --short | grep ".pb.go" | tee /dev/stderr)" || \
|
|
((git diff | cat) && \
|
|
(echo "$(ONI) please run 'make protos' when making changes to proto files" && false))
|
|
|
|
check-api-descriptors: protos ## check that protobuf changes aren't present.
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(git status --short | grep ".pb.txt" | tee /dev/stderr)" || \
|
|
((git diff $$(find . -name '*.pb.txt') | cat) && \
|
|
(echo "$(ONI) please run 'make protos' when making changes to proto files and check-in the generated descriptor file changes" && false))
|
|
|
|
# Depends on binaries because vet will silently fail if it can't load compiled
|
|
# imports
|
|
vet: ## run go vet
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(go vet ${PACKAGES} 2>&1 | grep -v 'constant [0-9]* not a string in call to Errorf' | grep -v 'unrecognized printf verb 'r'' | egrep -v '(timestamp_test.go|duration_test.go|fetch.go|exit status 1)' | tee /dev/stderr)"
|
|
|
|
fmt: ## run go fmt
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(gofmt -s -l . | grep -Fv $(call FIX_PATH,'vendor/') | grep -v ".pb.go$$" | tee /dev/stderr)" || \
|
|
(echo "$(ONI) please format Go code with 'gofmt -s -w'" && false)
|
|
@test -z "$$(find . -path ./vendor -prune -o -path ./protobuf/google/rpc -prune -o -name '*.proto' -type f -exec grep -Hn -e "^ " {} \; | tee /dev/stderr)" || \
|
|
(echo "$(ONI) please indent proto files with tabs only" && false)
|
|
@test -z "$$(find . -path ./vendor -prune -o -name '*.proto' -type f -exec grep -Hn "Meta meta = " {} \; | grep -v '(gogoproto.nullable) = false' | tee /dev/stderr)" || \
|
|
(echo "$(ONI) meta fields in proto files must have option (gogoproto.nullable) = false" && false)
|
|
|
|
lint: ## run go lint
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(golint ./... | grep -Fv $(call FIX_PATH,'vendor/') | grep -v ".pb.go:" | tee /dev/stderr)"
|
|
|
|
dco: ## dco check
|
|
@which git-validation > /dev/null 2>/dev/null || (echo "ERROR: git-validation not found" && false)
|
|
ifdef TRAVIS_COMMIT_RANGE
|
|
git-validation -q -run DCO,short-subject,dangling-whitespace
|
|
else
|
|
git-validation -v -run DCO,short-subject,dangling-whitespace -range $(EPOCH_TEST_COMMIT)..HEAD
|
|
endif
|
|
|
|
ineffassign: ## run ineffassign
|
|
@echo "$(WHALE) $@"
|
|
@test -z "$$(ineffassign . | grep -Fv $(call FIX_PATH,'vendor/') | grep -v ".pb.go:" | tee /dev/stderr)"
|
|
|
|
#errcheck: ## run go errcheck
|
|
# @echo "$(WHALE) $@"
|
|
# @test -z "$$(errcheck ./... | grep -Fv $(call FIX_PATH,'vendor/') | grep -v ".pb.go:" | tee /dev/stderr)"
|
|
|
|
build: ## build the go packages
|
|
@echo "$(WHALE) $@"
|
|
@go build -v ${EXTRA_FLAGS} ${GO_LDFLAGS} ${GO_GCFLAGS} ${PACKAGES}
|
|
|
|
test: ## run tests, except integration tests and tests that require root
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES})
|
|
|
|
root-test: ## run tests, except integration tests
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} $(filter-out ${INTEGRATION_PACKAGE},${TEST_REQUIRES_ROOT_PACKAGES}) -test.root
|
|
|
|
integration: ## run integration tests
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} -test.root -parallel 1
|
|
|
|
integration-parallel: ## run integration tests
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} -test.root -parallel ${TESTFLAGS_PARALLEL}
|
|
|
|
benchmark: ## run benchmarks tests
|
|
@echo "$(WHALE) $@"
|
|
@go test ${TESTFLAGS} -bench . -run Benchmark -test.root
|
|
|
|
FORCE:
|
|
|
|
# Build a binary from a cmd.
|
|
bin/%: cmd/% FORCE
|
|
@echo "$(WHALE) $@${BINARY_SUFFIX}"
|
|
@go build -o $@${BINARY_SUFFIX} ${GO_LDFLAGS} ${GO_TAGS} ${GO_GCFLAGS} ./$<
|
|
|
|
binaries: $(BINARIES) ## build binaries
|
|
@echo "$(WHALE) $@"
|
|
|
|
release: $(BINARIES)
|
|
@echo "$(WHALE) $@"
|
|
@rm -rf releases/$(RELEASE) releases/$(RELEASE).tar.gz
|
|
@install -d releases/$(RELEASE)/bin
|
|
@install $(BINARIES) releases/$(RELEASE)/bin
|
|
@cd releases/$(RELEASE) && tar -czf ../$(RELEASE).tar.gz *
|
|
|
|
clean: ## clean up binaries
|
|
@echo "$(WHALE) $@"
|
|
@rm -f $(BINARIES)
|
|
|
|
install: ## install binaries
|
|
@echo "$(WHALE) $@ $(BINARIES)"
|
|
@mkdir -p $(DESTDIR)/bin
|
|
@install $(BINARIES) $(DESTDIR)/bin
|
|
|
|
uninstall:
|
|
@echo "$(WHALE) $@"
|
|
@rm -f $(addprefix $(DESTDIR)/bin/,$(notdir $(BINARIES)))
|
|
|
|
|
|
coverage: ## generate coverprofiles from the unit tests, except tests that require root
|
|
@echo "$(WHALE) $@"
|
|
@rm -f coverage.txt
|
|
( for pkg in $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES}); do \
|
|
go test -i ${TESTFLAGS} -test.short -coverprofile=coverage.out -covermode=atomic $$pkg || exit; \
|
|
if [ -f profile.out ]; then \
|
|
cat profile.out >> coverage.txt; \
|
|
rm profile.out; \
|
|
fi; \
|
|
go test ${TESTFLAGS} -test.short -coverprofile=coverage.out -covermode=atomic $$pkg || exit; \
|
|
if [ -f profile.out ]; then \
|
|
cat profile.out >> coverage.txt; \
|
|
rm profile.out; \
|
|
fi; \
|
|
done )
|
|
|
|
root-coverage: ## generae coverage profiles for the unit tests
|
|
@echo "$(WHALE) $@"
|
|
@( for pkg in $(filter-out ${INTEGRATION_PACKAGE},${TEST_REQUIRES_ROOT_PACKAGES}); do \
|
|
go test -i ${TESTFLAGS} -test.short -coverprofile="../../../$$pkg/coverage.txt" -covermode=atomic $$pkg -test.root || exit; \
|
|
go test ${TESTFLAGS} -test.short -coverprofile="../../../$$pkg/coverage.txt" -covermode=atomic $$pkg -test.root || exit; \
|
|
done )
|
|
|
|
coverage-integration: ## generate coverprofiles from the integration tests
|
|
@echo "$(WHALE) $@"
|
|
go test ${TESTFLAGS} -test.short -coverprofile="../../../${INTEGRATION_PACKAGE}/coverage.txt" -covermode=atomic ${INTEGRATION_PACKAGE} -test.root
|
|
|
|
vendor:
|
|
@echo "$(WHALE) $@"
|
|
@vndr
|
|
|
|
help: ## this help
|
|
@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
|