Expose version info control flags
[govpp.git] / Makefile
index ed6bfd5..5257617 100644 (file)
--- a/Makefile
+++ b/Makefile
-SHELL = /bin/bash
-
-GO ?= GO111MODULE=on go
-GOVPP_PKG := $(shell go list)
+SHELL := /usr/bin/env bash -o pipefail
 
 VERSION ?= $(shell git describe --always --tags --dirty)
 COMMIT ?= $(shell git rev-parse HEAD)
-BUILD_STAMP ?= $(shell git log -1 --format="%ct")
+BUILD_STAMP ?= $(shell git log -1 --format='%ct')
 BUILD_BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD)
+
 BUILD_HOST ?= $(shell hostname)
 BUILD_USER ?= $(shell id -un)
 
-VPP_VERSION    = $(shell dpkg-query -f '\${Version}' -W vpp)
-
-VPP_IMG        ?= ligato/vpp-base:latest
-BINAPI_DIR     ?= ./examples/binapi
+GO ?= go
 
-LDFLAGS = -w -s \
+GOVPP_PKG := git.fd.io/govpp.git
+LDFLAGS = \
        -X ${GOVPP_PKG}/version.version=$(VERSION) \
        -X ${GOVPP_PKG}/version.commitHash=$(COMMIT) \
        -X ${GOVPP_PKG}/version.buildStamp=$(BUILD_STAMP) \
        -X ${GOVPP_PKG}/version.buildBranch=$(BUILD_BRANCH) \
        -X ${GOVPP_PKG}/version.buildUser=$(BUILD_USER) \
        -X ${GOVPP_PKG}/version.buildHost=$(BUILD_HOST)
-
-GO_BUILD_ARGS = -ldflags "${LDFLAGS}"
-ifeq ($(V),1)
-GO_BUILD_ARGS += -v
+ifeq ($(NOSTRIP),)
+LDFLAGS += -w -s
 endif
+
+GO_BUILD_TAGS ?= novpp
+
+GO_BUILD_ARGS = -ldflags "$(LDFLAGS)"
 ifneq ($(GO_BUILD_TAGS),)
 GO_BUILD_ARGS += -tags="${GO_BUILD_TAGS}"
 endif
+ifneq ($(GO_NOTRIM),0)
+GO_BUILD_ARGS += -trimpath
+endif
+ifeq ($(V),1)
+GO_BUILD_ARGS += -v
+endif
+
+VPP_VERSION    = $(shell dpkg-query -f '\${Version}' -W vpp)
 
-all: test build examples
+VPP_IMG        ?= ligato/vpp-base:latest
+BINAPI_DIR     ?= ./binapi
+
+bin:
+       mkdir -p bin
+
+build: ## Build all
+       @echo "# building ${VERSION}"
+       $(GO) build ${GO_BUILD_ARGS} ./...
+
+cmd: bin ## Build commands
+       $(GO) build ${GO_BUILD_ARGS} -o bin ./cmd/...
+
+examples: bin ## Build examples
+       $(GO) build ${GO_BUILD_ARGS} -o bin ./examples/...
+
+clean: ## Clean all
+       @echo "# cleaning"
+       $(GO) clean -v ./...
+
+test: ## Run unit tests
+       $(GO) version
+       @echo "# running tests"
+       $(GO) test -tags="${GO_BUILD_TAGS}" ./...
+
+integration: ## Run integration tests
+       @echo "# running integration tests"
+       $(GO) test -tags="integration ${GO_BUILD_TAGS}" ./test/integration
 
-install:
-       @echo "=> installing binapi-generator ${VERSION}"
-       $(GO) install ${GO_BUILD_ARGS} ./cmd/binapi-generator
+lint: ## Run code linter
+       @echo "# running linter"
+       @golint ./...
 
-build:
-       @echo "=> building binapi-generator ${VERSION}"
-       cd cmd/binapi-generator && $(GO) build ${GO_BUILD_ARGS}
+install: install-generator install-proxy ## Install all
 
-examples:
-       @echo "=> building examples"
-       cd examples/simple-client && $(GO) build ${GO_BUILD_ARGS} -v
-       cd examples/stats-api && $(GO) build ${GO_BUILD_ARGS} -v
-       cd examples/perf-bench && $(GO) build ${GO_BUILD_ARGS} -v
-       cd examples/union-example && $(GO) build ${GO_BUILD_ARGS} -v
-       cd examples/rpc-service && $(GO) build ${GO_BUILD_ARGS} -v
+install-generator: ## Install binapi-generator
+       @echo "# installing binapi-generator ${VERSION}"
+       @$(GO) install ${GO_BUILD_ARGS} ./cmd/binapi-generator
 
-clean:
-       @echo "=> cleaning"
-       go clean -v ./cmd/...
-       go clean -v ./examples/...
+install-proxy: ## Install vpp-proxy
+       @echo "# installing vpp-proxy ${VERSION}"
+       $(GO) install ${GO_BUILD_ARGS} ./cmd/vpp-proxy
 
-test:
-       @echo "=> running tests"
-       $(GO) test -v ./cmd/...
-       $(GO) test -v ./ ./api ./adapter ./codec ./core
+generate: ## Generate all
+       @echo "# generating code"
+       $(GO) generate -x ./...
 
-lint:
-       @echo "=> running linter"
-       @golint ./... | grep -v vendor | grep -v /binapi/ || true
+generate-binapi: install-generator ## Generate binapi code
+       @echo "# generating binapi VPP $(VPP_VERSION)"
+       $(GO) generate -x "$(BINAPI_DIR)"
 
-gen-binapi-docker: install
-       @echo "=> generating binapi in docker image ${VPP_IMG}"
+gen-binapi-docker: install-generator ## Generate binapi code (using Docker)
+       @echo "# generating binapi in docker image ${VPP_IMG}"
        $(eval cmds := $(shell go generate -n $(BINAPI_DIR) 2>&1 | tr "\n" ";"))
        docker run -t --rm \
-               -v "$(shell which gofmt):/usr/local/bin/gofmt:ro" \
+               -e DEBUG_GOVPP \
                -v "$(shell which binapi-generator):/usr/local/bin/binapi-generator:ro" \
-               -v "$(shell pwd):/govpp" -w /govpp \
+               -v "$(shell pwd):/govpp" \
+               -w /govpp \
                -u "$(shell id -u):$(shell id -g)" \
                "${VPP_IMG}" \
-         sh -xc "cd $(BINAPI_DIR) && $(cmds)"
-
-generate-binapi: install
-       @echo "=> generating binapi VPP $(VPP_VERSION)"
-       $(GO) generate -x "$(BINAPI_DIR)"
-
-generate:
-       @echo "=> generating code"
-       $(GO) generate -x ./...
+         sh -ec "cd $(BINAPI_DIR) && $(cmds)"
 
 extras:
        @make -C extras
 
+help:
+       @echo "List of make targets:"
+       @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-.PHONY: all \
-       install build examples clean test lint \
+.DEFAULT_GOAL = help
+
+.PHONY: help \
+    build cmd examples clean \
+       lint test integration \
+       install install-generator install-proxy \
        generate generate-binapi gen-binapi-docker \
        extras
+