blob: 02e144df8754ee05e9b819ad0f8a696158b7ec35 [file] [log] [blame]
khenaidoocfee5f42018-07-19 22:47:38 -04001#
2# Copyright 2016 the original author or authors.
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16
Matt Jeanneret2e3051a2019-05-11 15:01:46 -040017# set default shell
18SHELL = bash -e -o pipefail
Kent Hagerman074d0e02019-04-24 17:58:16 -040019
Zack Williams27f59a42019-05-10 09:12:07 -070020# Variables
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040021VERSION ?= $(shell cat ./VERSION)
Zack Williams27f59a42019-05-10 09:12:07 -070022
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040023DOCKER_LABEL_VCS_DIRTY = false
24ifneq ($(shell git ls-files --others --modified --exclude-standard 2>/dev/null | wc -l | sed -e 's/ //g'),0)
25 DOCKER_LABEL_VCS_DIRTY = true
26endif
Matt Jeanneret2e3051a2019-05-11 15:01:46 -040027## Docker related
David K. Bainbridgee14914d2019-05-24 13:43:05 -070028DOCKER_EXTRA_ARGS ?=
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040029DOCKER_REGISTRY ?=
30DOCKER_REPOSITORY ?=
31DOCKER_TAG ?= ${VERSION}$(shell [[ ${DOCKER_LABEL_VCS_DIRTY} == "true" ]] && echo "-dirty" || true)
32RWCORE_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-rw-core
33ROCORE_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-ro-core
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040034OFAGENT_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-ofagent
35CLI_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-cli
Matt Jeanneret2e3051a2019-05-11 15:01:46 -040036
37## Docker labels. Only set ref and commit date if committed
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040038DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote))
39DOCKER_LABEL_VCS_REF = $(shell git rev-parse HEAD)
40DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ")
41DOCKER_LABEL_COMMIT_DATE = $(shell git show -s --format=%cd --date=iso-strict HEAD)
Matt Jeanneret2e3051a2019-05-11 15:01:46 -040042
girishk5259f8e2019-10-10 18:44:44 +000043# Default is GO111MODULE=auto, which will refuse to use go mod if running
44# go less than 1.13.0 and this repository is checked out in GOPATH. For now,
45# force module usage. This affects commands executed from this Makefile, but
46# not the environment inside the Docker build (which does not build from
47# inside a GOPATH).
48export GO111MODULE=on
49
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040050DOCKER_BUILD_ARGS ?= \
David K. Bainbridgee14914d2019-05-24 13:43:05 -070051 ${DOCKER_EXTRA_ARGS} \
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040052 --build-arg org_label_schema_version="${VERSION}" \
53 --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \
54 --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \
55 --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \
56 --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \
57 --build-arg org_opencord_vcs_dirty="${DOCKER_LABEL_VCS_DIRTY}"
58
59DOCKER_BUILD_ARGS_LOCAL ?= ${DOCKER_BUILD_ARGS} \
60 --build-arg LOCAL_PYVOLTHA=${LOCAL_PYVOLTHA} \
61 --build-arg LOCAL_PROTOS=${LOCAL_PROTOS}
khenaidoocfee5f42018-07-19 22:47:38 -040062
Scott Baker8461e152019-10-01 14:44:30 -070063.PHONY: rw_core ro_core local-protos local-pyvoltha
khenaidoocfee5f42018-07-19 22:47:38 -040064
65# This should to be the first and default target in this Makefile
66help:
67 @echo "Usage: make [<target>]"
68 @echo "where available targets are:"
69 @echo
David K. Bainbridge1678e192019-05-17 11:48:29 -070070 @echo "build : Build the docker images."
71 @echo " - If this is the first time you are building, choose 'make build' option."
72 @echo "rw_core : Build the rw_core docker image"
73 @echo "ro_core : Build the ro_core docker image"
David K. Bainbridge1678e192019-05-17 11:48:29 -070074 @echo "ofagent : Build the openflow agent docker image"
75 @echo "cli : Build the voltha CLI docker image"
David K. Bainbridge1678e192019-05-17 11:48:29 -070076 @echo "venv : Build local Python virtualenv"
77 @echo "clean : Remove files created by the build and tests"
78 @echo "distclean : Remove venv directory"
79 @echo "docker-push : Push the docker images to an external repository"
David Bainbridge5f3619c2019-07-10 22:51:09 +000080 @echo "lint-dockerfile : Perform static analysis on Dockerfiles"
David K. Bainbridge1678e192019-05-17 11:48:29 -070081 @echo "lint-style : Verify code is properly gofmt-ed"
82 @echo "lint-sanity : Verify that 'go vet' doesn't report any issues"
girishk5259f8e2019-10-10 18:44:44 +000083 @echo "lint-mod : Verify the integrity of the 'mod' files"
David K. Bainbridge1678e192019-05-17 11:48:29 -070084 @echo "lint : Shorthand for lint-style & lint-sanity"
npujar03b018e2019-11-13 15:29:36 +053085 @echo "sca : Runs various SCA through golangci-lint tool"
David K. Bainbridge1678e192019-05-17 11:48:29 -070086 @echo "test : Generate reports for all go tests"
khenaidoocfee5f42018-07-19 22:47:38 -040087 @echo
88
David K. Bainbridge1678e192019-05-17 11:48:29 -070089## Local Development Helpers
90local-protos:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040091 @mkdir -p python/local_imports
David K. Bainbridge1678e192019-05-17 11:48:29 -070092ifdef LOCAL_PROTOS
William Kurkian905834f2019-11-13 15:40:46 -050093 mkdir -p vendor/github.com/opencord/voltha-protos/v2/go
94 cp -r ${LOCAL_PROTOS}/go/* vendor/github.com/opencord/voltha-protos/v2/go
William Kurkiand4eccbc2019-07-30 10:17:21 -040095 rm -rf python/local_imports/voltha-protos
David K. Bainbridge1678e192019-05-17 11:48:29 -070096 mkdir -p python/local_imports/voltha-protos/dist
William Kurkian905834f2019-11-13 15:40:46 -050097 cp ${LOCAL_PROTOS}/dist/*.tar.gz python/local_imports/voltha-protos/dist/
David K. Bainbridge1678e192019-05-17 11:48:29 -070098endif
99
Scott Bakercb7c88a2019-10-16 18:32:48 -0700100## Local Development Helpers
101local-lib-go:
102ifdef LOCAL_LIB_GO
Scott Baker17f1d9d2019-10-25 12:51:25 -0700103 mkdir -p vendor/github.com/opencord/voltha-lib-go/v2/pkg
104 cp -r ${LOCAL_LIB_GO}/pkg/* vendor/github.com/opencord/voltha-lib-go/v2/pkg/
Scott Bakercb7c88a2019-10-16 18:32:48 -0700105endif
106
David K. Bainbridge1678e192019-05-17 11:48:29 -0700107local-pyvoltha:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400108 @mkdir -p python/local_imports
David K. Bainbridge1678e192019-05-17 11:48:29 -0700109ifdef LOCAL_PYVOLTHA
William Kurkiand4eccbc2019-07-30 10:17:21 -0400110 rm -rf python/local_imports/pyvoltha
David K. Bainbridge1678e192019-05-17 11:48:29 -0700111 mkdir -p python/local_imports/pyvoltha/dist
Scott Baker17f1d9d2019-10-25 12:51:25 -0700112 cp ${LOCAL_PYVOLTHA}/dist/*.tar.gz python/local_imports/pyvoltha/dist/
David K. Bainbridge1678e192019-05-17 11:48:29 -0700113endif
114
115## Python venv dev environment
116
117VENVDIR := python/venv-volthago
118
119venv: distclean local-protos local-pyvoltha
120 virtualenv ${VENVDIR};\
121 source ./${VENVDIR}/bin/activate ; set -u ;\
122 rm -f ${VENVDIR}/local/bin ${VENVDIR}/local/lib ${VENVDIR}/local/include ;\
123 pip install -r python/requirements.txt
124ifdef LOCAL_PYVOLTHA
125 source ./${VENVDIR}/bin/activate ; set -u ;\
126 pip install python/local_imports/pyvoltha/dist/*.tar.gz
127endif
128ifdef LOCAL_PROTOS
129 source ./${VENVDIR}/bin/activate ; set -u ;\
130 pip install python/local_imports/voltha-protos/dist/*.tar.gz
131endif
khenaidoocfee5f42018-07-19 22:47:38 -0400132
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400133## Docker targets
khenaidoocfee5f42018-07-19 22:47:38 -0400134
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400135build: docker-build
khenaidoocfee5f42018-07-19 22:47:38 -0400136
Scott Baker676f0dd2019-10-14 17:07:48 -0700137docker-build: rw_core ro_core ofagent cli
sslobodra3ea7d42019-01-16 15:03:16 -0500138
Scott Bakercb7c88a2019-10-16 18:32:48 -0700139rw_core: local-protos local-lib-go
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400140 docker build $(DOCKER_BUILD_ARGS) -t ${RWCORE_IMAGENAME}:${DOCKER_TAG} -t ${RWCORE_IMAGENAME}:latest -f docker/Dockerfile.rw_core .
khenaidoocfee5f42018-07-19 22:47:38 -0400141
Scott Bakercb7c88a2019-10-16 18:32:48 -0700142ro_core: local-protos local-lib-go
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400143 docker build $(DOCKER_BUILD_ARGS) -t ${ROCORE_IMAGENAME}:${DOCKER_TAG} -t ${ROCORE_IMAGENAME}:latest -f docker/Dockerfile.ro_core .
Stephane Barbariea75791c2019-01-24 10:58:06 -0500144
David K. Bainbridge1678e192019-05-17 11:48:29 -0700145ofagent: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400146 docker build $(DOCKER_BUILD_ARGS_LOCAL) -t ${OFAGENT_IMAGENAME}:${DOCKER_TAG} -t ${OFAGENT_IMAGENAME}:latest -f python/docker/Dockerfile.ofagent python
David K. Bainbridge1678e192019-05-17 11:48:29 -0700147
148cli: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400149 docker build $(DOCKER_BUILD_ARGS_LOCAL) -t ${CLI_IMAGENAME}:${DOCKER_TAG} -t ${CLI_IMAGENAME}:latest -f python/docker/Dockerfile.cli python
David K. Bainbridge1678e192019-05-17 11:48:29 -0700150
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400151docker-push:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400152 docker push ${RWCORE_IMAGENAME}:${DOCKER_TAG}
153 docker push ${ROCORE_IMAGENAME}:${DOCKER_TAG}
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400154 docker push ${OFAGENT_IMAGENAME}:${DOCKER_TAG}
155 docker push ${CLI_IMAGENAME}:${DOCKER_TAG}
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400156
157## lint and unit tests
khenaidood2b6df92018-12-13 16:37:20 -0500158
David Bainbridge5f3619c2019-07-10 22:51:09 +0000159PATH:=$(GOPATH)/bin:$(PATH)
160HADOLINT=$(shell PATH=$(GOPATH):$(PATH) which hadolint)
161lint-dockerfile:
162ifeq (,$(shell PATH=$(GOPATH):$(PATH) which hadolint))
163 mkdir -p $(GOPATH)/bin
164 curl -o $(GOPATH)/bin/hadolint -sNSL https://github.com/hadolint/hadolint/releases/download/v1.17.1/hadolint-$(shell uname -s)-$(shell uname -m)
165 chmod 755 $(GOPATH)/bin/hadolint
166endif
167 @echo "Running Dockerfile lint check ..."
168 @hadolint $$(find . -name "Dockerfile.*")
169 @echo "Dockerfile lint check OK"
170
Kent Hagerman074d0e02019-04-24 17:58:16 -0400171lint-style:
Zack Williams7cf78002019-04-30 21:45:35 -0700172ifeq (,$(shell which gofmt))
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400173 go get -u github.com/golang/go/src/cmd/gofmt
Zack Williams7cf78002019-04-30 21:45:35 -0700174endif
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400175 @echo "Running style check..."
176 @gofmt_out="$$(gofmt -l $$(find . -name '*.go' -not -path './vendor/*'))" ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700177 if [ ! -z "$$gofmt_out" ]; then \
178 echo "$$gofmt_out" ;\
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400179 echo "Style check failed on one or more files ^, run 'go fmt' to fix." ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700180 exit 1 ;\
Kent Hagerman074d0e02019-04-24 17:58:16 -0400181 fi
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400182 @echo "Style check OK"
Kent Hagerman074d0e02019-04-24 17:58:16 -0400183
184lint-sanity:
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400185 @echo "Running sanity check..."
girishk5259f8e2019-10-10 18:44:44 +0000186 @go vet -mod=vendor ./...
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400187 @echo "Sanity check OK"
Kent Hagerman074d0e02019-04-24 17:58:16 -0400188
girishk5259f8e2019-10-10 18:44:44 +0000189lint-mod:
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400190 @echo "Running dependency check..."
girishk5259f8e2019-10-10 18:44:44 +0000191 @go mod verify
Scott Bakere4c2a982019-11-21 16:32:03 -0800192 @echo "Dependency check OK. Running vendor check..."
193 @git status > /dev/null
194 @git diff-index --quiet HEAD -- go.mod go.sum vendor || (echo "ERROR: Staged or modified files must be committed before running this test" && echo "`git status`" && exit 1)
195 @[[ `git ls-files --exclude-standard --others go.mod go.sum vendor` == "" ]] || (echo "ERROR: Untracked files must be cleaned up before running this test" && echo "`git status`" && exit 1)
196 go mod tidy
197 go mod vendor
198 @git status > /dev/null
199 @git diff-index --quiet HEAD -- go.mod go.sum vendor || (echo "ERROR: Modified files detected after running go mod tidy / go mod vendor" && echo "`git status`" && exit 1)
200 @[[ `git ls-files --exclude-standard --others go.mod go.sum vendor` == "" ]] || (echo "ERROR: Untracked files detected after running go mod tidy / go mod vendor" && echo "`git status`" && exit 1)
201 @echo "Vendor check OK."
202
Kent Hagerman0ab4cb22019-04-24 13:13:35 -0400203
girishk5259f8e2019-10-10 18:44:44 +0000204lint: lint-style lint-sanity lint-mod lint-dockerfile
Kent Hagerman074d0e02019-04-24 17:58:16 -0400205
Scott Baker18ea5a42019-10-15 16:08:42 -0700206# Rules to automatically install golangci-lint
207GOLANGCI_LINT_TOOL?=$(shell which golangci-lint)
208ifeq (,$(GOLANGCI_LINT_TOOL))
209GOLANGCI_LINT_TOOL=$(GOPATH)/bin/golangci-lint
210golangci_lint_tool_install:
211 # Same version as installed by Jenkins ci-management
212 # Note that install using `go get` is not recommended as per https://github.com/golangci/golangci-lint
213 curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(GOPATH)/bin v1.17.0
214else
215golangci_lint_tool_install:
216endif
David K. Bainbridge1678e192019-05-17 11:48:29 -0700217
Scott Baker18ea5a42019-10-15 16:08:42 -0700218# Rules to automatically install go-junit-report
219GO_JUNIT_REPORT?=$(shell which go-junit-report)
Zack Williams7cf78002019-04-30 21:45:35 -0700220ifeq (,$(GO_JUNIT_REPORT))
Scott Baker18ea5a42019-10-15 16:08:42 -0700221GO_JUNIT_REPORT=$(GOPATH)/bin/go-junit-report
222go_junit_install:
Zack Williams7cf78002019-04-30 21:45:35 -0700223 go get -u github.com/jstemmer/go-junit-report
Scott Baker18ea5a42019-10-15 16:08:42 -0700224else
225go_junit_install:
Zack Williams7cf78002019-04-30 21:45:35 -0700226endif
Scott Baker18ea5a42019-10-15 16:08:42 -0700227
228# Rules to automatically install gocover-covertura
229GOCOVER_COBERTURA?=$(shell which gocover-cobertura)
Zack Williams7cf78002019-04-30 21:45:35 -0700230ifeq (,$(GOCOVER_COBERTURA))
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400231 @GOCOVER_COBERTURA=$(GOPATH)/bin/gocover-cobertura
Scott Baker18ea5a42019-10-15 16:08:42 -0700232gocover_cobertura_install:
233 go get -u github.com/t-yuki/gocover-cobertura
234else
235gocover_cobertura_install:
Zack Williams7cf78002019-04-30 21:45:35 -0700236endif
Scott Baker18ea5a42019-10-15 16:08:42 -0700237
238sca: golangci_lint_tool_install
239 rm -rf ./sca-report
240 @mkdir -p ./sca-report
npujar9b959eb2019-11-14 16:57:46 +0530241 $(GOLANGCI_LINT_TOOL) run -E golint -D structcheck --out-format junit-xml ./cli/... ./rw_core/... ./ro_core/... ./tests/... ./common/... 2>&1 | tee ./sca-report/sca-report.xml
Scott Baker18ea5a42019-10-15 16:08:42 -0700242
Scott Bakercb7c88a2019-10-16 18:32:48 -0700243test: go_junit_install gocover_cobertura_install local-lib-go
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400244 @mkdir -p ./tests/results
girishk5259f8e2019-10-10 18:44:44 +0000245 @go test -mod=vendor -v -coverprofile ./tests/results/go-test-coverage.out -covermode count ./... 2>&1 | tee ./tests/results/go-test-results.out ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700246 RETURN=$$? ;\
247 $(GO_JUNIT_REPORT) < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\
248 $(GOCOVER_COBERTURA) < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\
249 exit $$RETURN
Kent Hagerman074d0e02019-04-24 17:58:16 -0400250
David K. Bainbridge1678e192019-05-17 11:48:29 -0700251clean:
252 rm -rf python/local_imports
253 find python -name '*.pyc' | xargs rm -f
254
255distclean: clean
David Bainbridge81175e42019-10-16 19:06:37 +0000256 rm -rf ${VENVDIR} ./sca_report
David K. Bainbridge1678e192019-05-17 11:48:29 -0700257
Scott Bakercb7c88a2019-10-16 18:32:48 -0700258mod-update:
259 go mod tidy
260 go mod vendor
261
khenaidoocfee5f42018-07-19 22:47:38 -0400262# end file