Makefile

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

GO := go
GOOS := $(shell $(GO) env GOOS)
GOARCH := $(shell $(GO) env GOARCH)
EPOCH_TEST_COMMIT := f9e02affccd51702191e5312665a16045ffef8ab
PROJECT := github.com/containerd/cri
BINDIR := ${DESTDIR}/usr/local/bin
BUILD_DIR := _output
# VERSION is derived from the current tag for HEAD plus amends. Version is used
# to set/overide the containerd version in vendor/github.com/containerd/containerd/version.
VERSION := $(shell git describe --tags --dirty --always)
# strip the first char of the tag if it's a `v`
VERSION := $(VERSION:v%=%)
TARBALL_PREFIX := cri-containerd
TARBALL := $(TARBALL_PREFIX)-$(VERSION).$(GOOS)-$(GOARCH).tar.gz
BUILD_TAGS := seccomp apparmor
# Add `-TEST` suffix to indicate that all binaries built from this repo are for test.
GO_LDFLAGS := -X $(PROJECT)/vendor/github.com/containerd/containerd/version.Version=$(VERSION)-TEST
SOURCES := $(shell find cmd/ pkg/ vendor/ -name '*.go')
PLUGIN_SOURCES := $(shell ls *.go)
INTEGRATION_SOURCES := $(shell find integration/ -name '*.go')

all: binaries

default: help

help:
	@echo "Usage: make <target>"
	@echo
	@echo " * 'install'          	- Install binaries to system locations"
	@echo " * 'binaries'         	- Build containerd and ctr"
	@echo " * 'static-binaries   	- Build static containerd and ctr"
	@echo " * 'ctr'  		- Build ctr"
	@echo " * 'install-ctr' 	- Install ctr"
	@echo " * 'containerd'  	- Build a customized containerd with CRI plugin for testing"
	@echo " * 'install-containerd'	- Install customized containerd to system location"
	@echo " * 'release'          	- Build release tarball"
	@echo " * 'push'             	- Push release tarball to GCS"
	@echo " * 'test'             	- Test cri with unit test"
	@echo " * 'test-integration' 	- Test cri with integration test"
	@echo " * 'test-cri'         	- Test cri with cri validation test"
	@echo " * 'test-e2e-node'    	- Test cri with Kubernetes node e2e test"
	@echo " * 'clean'            	- Clean artifacts"
	@echo " * 'verify'           	- Execute the source code verification tools"
	@echo " * 'proto'            	- Update protobuf of the cri plugin api"
	@echo " * 'install.tools'    	- Install tools used by verify"
	@echo " * 'install.deps'     	- Install dependencies of cri (Note: BUILDTAGS defaults to 'seccomp apparmor' for runc build")
	@echo " * 'uninstall'        	- Remove installed binaries from system locations"
	@echo " * 'version'          	- Print current cri plugin release version"
	@echo " * 'update-vendor'    	- Syncs containerd/vendor.conf -> vendor.conf and sorts vendor.conf"

verify: lint gofmt boiler

version:
	@echo $(VERSION)

lint:
	@echo "checking lint"
	@./hack/verify-lint.sh

gofmt:
	@echo "checking gofmt"
	@./hack/verify-gofmt.sh

boiler:
	@echo "checking boilerplate"
	@./hack/verify-boilerplate.sh

.PHONY: sort-vendor sync-vendor update-vendor

sort-vendor:
	@echo "sorting vendor.conf"
	@./hack/sort-vendor.sh

sync-vendor:
	@echo "syncing vendor.conf from containerd"
	@./hack/sync-vendor.sh

update-vendor: sync-vendor sort-vendor

$(BUILD_DIR)/ctr: $(SOURCES)
	$(GO) build -o $@ \
		-tags '$(BUILD_TAGS)' \
		-ldflags '$(GO_LDFLAGS)' \
		-gcflags '$(GO_GCFLAGS)' \
		$(PROJECT)/cmd/ctr

$(BUILD_DIR)/containerd: $(SOURCES) $(PLUGIN_SOURCES)
	$(GO) build -o $@ \
		-tags '$(BUILD_TAGS)' \
		-ldflags '$(GO_LDFLAGS)' \
		-gcflags '$(GO_GCFLAGS)' \
		$(PROJECT)/cmd/containerd

test:
	$(GO) test -timeout=10m -race ./pkg/... \
		-tags '$(BUILD_TAGS)' \
	        -ldflags '$(GO_LDFLAGS)' \
		-gcflags '$(GO_GCFLAGS)'

$(BUILD_DIR)/integration.test: $(INTEGRATION_SOURCES)
	$(GO) test -c $(PROJECT)/integration -o $(BUILD_DIR)/integration.test

test-integration: $(BUILD_DIR)/integration.test binaries
	@./hack/test-integration.sh

test-cri: binaries
	@./hack/test-cri.sh

test-e2e-node: binaries
	@VERSION=$(VERSION) ./hack/test-e2e-node.sh

clean:
	rm -rf $(BUILD_DIR)/*

binaries: $(BUILD_DIR)/containerd $(BUILD_DIR)/ctr

static-binaries: GO_LDFLAGS += -extldflags "-fno-PIC -static"
static-binaries: $(BUILD_DIR)/containerd $(BUILD_DIR)/ctr

ctr: $(BUILD_DIR)/ctr

install-ctr: ctr
	install -D -m 755 $(BUILD_DIR)/ctr $(BINDIR)/ctr

containerd: $(BUILD_DIR)/containerd

install-containerd: containerd
	install -D -m 755 $(BUILD_DIR)/containerd $(BINDIR)/containerd

install: install-ctr install-containerd

uninstall:
	rm -f $(BINDIR)/containerd
	rm -f $(BINDIR)/ctr

$(BUILD_DIR)/$(TARBALL): static-binaries vendor.conf
	@BUILD_DIR=$(BUILD_DIR) TARBALL=$(TARBALL) VERSION=$(VERSION) ./hack/release.sh

release: $(BUILD_DIR)/$(TARBALL)

push: $(BUILD_DIR)/$(TARBALL)
	@BUILD_DIR=$(BUILD_DIR) TARBALL=$(TARBALL) VERSION=$(VERSION) ./hack/push.sh

proto:
	@hack/update-proto.sh

.PHONY: install.deps

install.deps:
	@./hack/install/install-deps.sh

.PHONY: .gitvalidation
# When this is running in travis, it will only check the travis commit range.
# When running outside travis, it will check from $(EPOCH_TEST_COMMIT)..HEAD.
.gitvalidation:
ifeq ($(TRAVIS),true)
	git-validation -q -run DCO,short-subject
else
	git-validation -v -run DCO,short-subject -range $(EPOCH_TEST_COMMIT)..HEAD
endif

.PHONY: install.tools .install.gitvalidation .install.gometalinter

install.tools: .install.gitvalidation .install.gometalinter

.install.gitvalidation:
	$(GO) get -u github.com/vbatts/git-validation

.install.gometalinter:
	$(GO) get -u github.com/alecthomas/gometalinter
	gometalinter --install

.PHONY: \
	binaries \
	static-binaries \
	ctr \
	install-ctr \
	containerd \
	install-containerd \
	release \
	push \
	boiler \
	clean \
	default \
	gofmt \
	help \
	install \
	lint \
	test \
	test-integration \
	test-cri \
	test-e2e-node \
	uninstall \
	version \
	proto