Makefile

   1 SHELL := /usr/bin/env bash -o pipefail
   2
   3 PROJECT := govpp
   4
   5 VERSION      ?= $(shell git describe --always --tags --dirty)
   6 COMMIT       ?= $(shell git rev-parse HEAD)
   7 BUILD_STAMP  ?= $(shell git log -1 --format='%ct')
   8 BUILD_BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD)
   9
  10 BUILD_HOST ?= $(shell hostname)
  11 BUILD_USER ?= $(shell id -un)
  12
  13 GOVPP_PKG := git.fd.io/govpp.git
  14
  15 VERSION_PKG := $(GOVPP_PKG)/internal/version
  16 LDFLAGS = \
  17         -X $(VERSION_PKG).version=$(VERSION) \
  18         -X $(VERSION_PKG).commitHash=$(COMMIT) \
  19         -X $(VERSION_PKG).buildStamp=$(BUILD_STAMP) \
  20         -X $(VERSION_PKG).buildBranch=$(BUILD_BRANCH) \
  21         -X $(VERSION_PKG).buildUser=$(BUILD_USER) \
  22         -X $(VERSION_PKG).buildHost=$(BUILD_HOST)
  23
  24 ifeq ($(NOSTRIP),)
  25 LDFLAGS += -w -s
  26 endif
  27
  28 GO_BUILD_TAGS ?= novpp
  29
  30 GO_BUILD_ARGS = -ldflags "$(LDFLAGS)"
  31 ifneq ($(GO_BUILD_TAGS),)
  32 GO_BUILD_ARGS += -tags="${GO_BUILD_TAGS}"
  33 endif
  34 ifneq ($(GO_NOTRIM),0)
  35 GO_BUILD_ARGS += -trimpath
  36 endif
  37 ifeq ($(V),1)
  38 GO_BUILD_ARGS += -v
  39 endif
  40
  41 # VPP Docker image to use for api generation (gen-binapi-docker)
  42 VPP_IMG               ?= ligato/vpp-base:latest
  43 # Local VPP directory used for binary api generation (gen-binapi-from-code)
  44 VPP_DIR           ?=
  45 # Target directory for generated go api bindings
  46 BINAPI_DIR            ?= ./binapi
  47 # Binapi generator path
  48 BINAPI_GENERATOR  = ./bin/binapi-generator
  49
  50 .DEFAULT_GOAL = help
  51
  52 bin:
  53         mkdir -p bin
  54
  55 build: ## Build all
  56         @echo "# building ${VERSION}"
  57         go build ${GO_BUILD_ARGS} ./...
  58
  59 cmd: bin ## Build commands
  60         go build ${GO_BUILD_ARGS} -o bin ./cmd/...
  61
  62 examples: bin ## Build examples
  63         go build ${GO_BUILD_ARGS} -o bin ./examples/...
  64
  65 test: ## Run unit tests
  66         @echo "# running tests"
  67         go test -tags="${GO_BUILD_TAGS}" ./...
  68
  69 test-integration: ## Run integration tests
  70         @echo "# running integration tests"
  71         go test -tags="integration ${GO_BUILD_TAGS}" ./test/integration
  72
  73 lint: ## Run code linter
  74         @echo "# running linter"
  75         @golint ./...
  76
  77 install: install-generator install-proxy ## Install all
  78
  79 install-generator: ## Install binapi-generator
  80         @echo "# installing binapi-generator ${VERSION}"
  81         @go install ${GO_BUILD_ARGS} ./cmd/binapi-generator
  82
  83 install-proxy: ## Install vpp-proxy
  84         @echo "# installing vpp-proxy ${VERSION}"
  85         go install ${GO_BUILD_ARGS} ./cmd/vpp-proxy
  86
  87 generate: generate-binapi ## Generate all
  88
  89 generate-binapi: install-generator ## Generate binapi code
  90         @echo "# generating binapi"
  91         go generate -x "$(BINAPI_DIR)"
  92
  93 gen-binapi-from-code: cmd-binapi-generator
  94         $(eval VPP_API_DIR := ${VPP_DIR}/build-root/install-vpp-native/vpp/share/vpp/api/)
  95         @echo "Generating vpp API.json and go bindings"
  96         @echo "Vpp Directory ${VPP_DIR}"
  97         @echo "Vpp API files ${VPP_API_DIR}"
  98         @echo "Go bindings   ${BINAPI_DIR}"
  99         @cd ${VPP_DIR} && make json-api-files
 100         @${BINAPI_GENERATOR} \
 101                 --input-dir=${VPP_API_DIR} \
 102             --output-dir=${BINAPI_DIR} \
 103             --gen rpc,rest \
 104             --no-source-path-info
 105
 106 gen-binapi-docker: install-generator ## Generate binapi code (using Docker)
 107         @echo "# generating binapi in docker image ${VPP_IMG}"
 108         $(eval cmds := $(shell go generate -n $(BINAPI_DIR) 2>&1 | tr "\n" ";"))
 109         docker run -t --rm \
 110                 -e DEBUG_GOVPP \
 111                 -v "$(shell which binapi-generator):/usr/local/bin/binapi-generator:ro" \
 112                 -v "$(shell pwd):/govpp" \
 113                 -w /govpp \
 114                 -u "$(shell id -u):$(shell id -g)" \
 115                 "${VPP_IMG}" \
 116           sh -ec "cd $(BINAPI_DIR) && $(cmds)"
 117
 118 help:
 119         @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 120
 121 .PHONY: help \
 122     build cmd examples clean \
 123         lint test integration \
 124         install install-generator install-proxy \
 125         generate generate-binapi gen-binapi-docker \
 126         extras
 127