+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_BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD)
+
+BUILD_HOST ?= $(shell hostname)
+BUILD_USER ?= $(shell id -un)
+
+GO ?= go
+
+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)
+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)
+
+# VPP Docker image to use for api generation (gen-binapi-docker)
+VPP_IMG ?= ligato/vpp-base:latest
+# Local VPP directory used for binary api generation (gen-binapi-from-code)
+VPP_DIR ?=
+# Target directory for generated go api bindings
+BINAPI_DIR ?= ./binapi
+# Binapi generator path
+BINAPI_GENERATOR = ./bin/binapi-generator
+
+bin:
+ mkdir -p bin
+
+build: ## Build all
+ @echo "# building ${VERSION}"
+ $(GO) build ${GO_BUILD_ARGS} ./...
+
+cmd-binapi-generator: bin ## Build commands
+ $(GO) build ${GO_BUILD_ARGS} -o bin ./cmd/binapi-generator
+
+cmd: bin ## Build commands
+ $(GO) build ${GO_BUILD_ARGS} -o bin ./cmd/...
-all: test build examples
+examples: bin ## Build examples
+ $(GO) build ${GO_BUILD_ARGS} -o bin ./examples/...
-install:
- @echo "=> installing ${VERSION}"
- go install ./cmd/binapi-generator
+clean: ## Clean all
+ @echo "# cleaning"
+ $(GO) clean -v ./...
-build:
- @echo "=> building ${VERSION}"
- cd cmd/binapi-generator && go build -v
+test: ## Run unit tests
+ $(GO) version
+ @echo "# running tests"
+ $(GO) test -tags="${GO_BUILD_TAGS}" ./...
-examples:
- @echo "=> building examples"
- cd examples/cmd/simple-client && go build -v
- cd examples/cmd/stats-client && go build -v
- cd examples/cmd/perf-bench && go build -v
+integration: ## Run integration tests
+ @echo "# running integration tests"
+ $(GO) test -tags="integration ${GO_BUILD_TAGS}" ./test/integration
-test:
- @echo "=> testing"
- go test -cover ./cmd/...
- go test -cover ./core ./api ./codec
+lint: ## Run code linter
+ @echo "# running linter"
+ @golint ./...
+
+install: install-generator install-proxy ## Install all
+
+install-generator: ## Install binapi-generator
+ @echo "# installing binapi-generator ${VERSION}"
+ @$(GO) install ${GO_BUILD_ARGS} ./cmd/binapi-generator
+
+install-proxy: ## Install vpp-proxy
+ @echo "# installing vpp-proxy ${VERSION}"
+ $(GO) install ${GO_BUILD_ARGS} ./cmd/vpp-proxy
+
+generate: ## Generate all
+ @echo "# generating code"
+ $(GO) generate -x ./...
+
+generate-binapi: install-generator ## Generate binapi code
+ @echo "# generating binapi VPP $(VPP_VERSION)"
+ $(GO) generate -x "$(BINAPI_DIR)"
+
+gen-binapi-from-code: cmd-binapi-generator
+ $(eval VPP_API_DIR := ${VPP_DIR}/build-root/install-vpp-native/vpp/share/vpp/api/)
+ @echo "Generating vpp API.json and go bindings"
+ @echo "Vpp Directory ${VPP_DIR}"
+ @echo "Vpp API files ${VPP_API_DIR}"
+ @echo "Go bindings ${BINAPI_DIR}"
+ @cd ${VPP_DIR} && make json-api-files
+ @${BINAPI_GENERATOR} \
+ --input-dir=${VPP_API_DIR} \
+ --output-dir=${BINAPI_DIR} \
+ --gen rpc,rest \
+ --no-source-path-info
+
+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 \
+ -e DEBUG_GOVPP \
+ -v "$(shell which binapi-generator):/usr/local/bin/binapi-generator:ro" \
+ -v "$(shell pwd):/govpp" \
+ -w /govpp \
+ -u "$(shell id -u):$(shell id -g)" \
+ "${VPP_IMG}" \
+ sh -ec "cd $(BINAPI_DIR) && $(cmds)"
extras:
- @echo "=> building extras"
- cd extras/libmemif/examples/gopacket && go build -v
- cd extras/libmemif/examples/icmp-responder && go build -v
- cd extras/libmemif/examples/jumbo-frames && go build -v
- cd extras/libmemif/examples/raw-data && go build -v
-
-clean:
- @echo "=> cleaning"
- rm -f cmd/binapi-generator/binapi-generator
- rm -f examples/cmd/perf-bench/perf-bench
- rm -f examples/cmd/simple-client/simple-client
- rm -f examples/cmd/stats-client/stats-client
- rm -f extras/libmemif/examples/gopacket/gopacket
- rm -f extras/libmemif/examples/icmp-responder/icmp-responder
- rm -f extras/libmemif/examples/jumbo-frames/jumbo-frames
- rm -f extras/libmemif/examples/raw-data/raw-data
-
-generate: install
- @echo "=> generating code"
- cd examples && go generate ./...
-
-lint:
- @echo "=> running linter"
- @golint ./... | grep -v vendor | grep -v bin_api || true
-
-.PHONY: all \
- install build examples test \
- extras clean generate lint
+ @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}'
+
+.DEFAULT_GOAL = help
+
+.PHONY: help \
+ build cmd examples clean \
+ lint test integration \
+ install install-generator install-proxy \
+ generate generate-binapi gen-binapi-docker \
+ extras
+