blob: d87af77883ccfe9941765dbd0329a3afb356b8e8 [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"
85 @echo "test : Generate reports for all go tests"
khenaidoocfee5f42018-07-19 22:47:38 -040086 @echo
87
David K. Bainbridge1678e192019-05-17 11:48:29 -070088## Local Development Helpers
89local-protos:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040090 @mkdir -p python/local_imports
David K. Bainbridge1678e192019-05-17 11:48:29 -070091ifdef LOCAL_PROTOS
92 mkdir -p vendor/github.com/opencord/voltha-protos/go
93 cp -r ${GOPATH}/src/github.com/opencord/voltha-protos/go/* vendor/github.com/opencord/voltha-protos/go
William Kurkiand4eccbc2019-07-30 10:17:21 -040094 rm -rf python/local_imports/voltha-protos
David K. Bainbridge1678e192019-05-17 11:48:29 -070095 mkdir -p python/local_imports/voltha-protos/dist
96 cp ../voltha-protos/dist/*.tar.gz python/local_imports/voltha-protos/dist/
97endif
98
99local-pyvoltha:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400100 @mkdir -p python/local_imports
David K. Bainbridge1678e192019-05-17 11:48:29 -0700101ifdef LOCAL_PYVOLTHA
William Kurkiand4eccbc2019-07-30 10:17:21 -0400102 rm -rf python/local_imports/pyvoltha
David K. Bainbridge1678e192019-05-17 11:48:29 -0700103 mkdir -p python/local_imports/pyvoltha/dist
104 cp ../pyvoltha/dist/*.tar.gz python/local_imports/pyvoltha/dist/
105endif
106
107## Python venv dev environment
108
109VENVDIR := python/venv-volthago
110
111venv: distclean local-protos local-pyvoltha
112 virtualenv ${VENVDIR};\
113 source ./${VENVDIR}/bin/activate ; set -u ;\
114 rm -f ${VENVDIR}/local/bin ${VENVDIR}/local/lib ${VENVDIR}/local/include ;\
115 pip install -r python/requirements.txt
116ifdef LOCAL_PYVOLTHA
117 source ./${VENVDIR}/bin/activate ; set -u ;\
118 pip install python/local_imports/pyvoltha/dist/*.tar.gz
119endif
120ifdef LOCAL_PROTOS
121 source ./${VENVDIR}/bin/activate ; set -u ;\
122 pip install python/local_imports/voltha-protos/dist/*.tar.gz
123endif
khenaidoocfee5f42018-07-19 22:47:38 -0400124
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400125## Docker targets
khenaidoocfee5f42018-07-19 22:47:38 -0400126
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400127build: docker-build
khenaidoocfee5f42018-07-19 22:47:38 -0400128
Scott Baker676f0dd2019-10-14 17:07:48 -0700129docker-build: rw_core ro_core ofagent cli
sslobodra3ea7d42019-01-16 15:03:16 -0500130
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400131rw_core: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400132 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 -0400133
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400134ro_core: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400135 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 -0500136
David K. Bainbridge1678e192019-05-17 11:48:29 -0700137ofagent: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400138 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 -0700139
140cli: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400141 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 -0700142
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400143docker-push:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400144 docker push ${RWCORE_IMAGENAME}:${DOCKER_TAG}
145 docker push ${ROCORE_IMAGENAME}:${DOCKER_TAG}
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400146 docker push ${OFAGENT_IMAGENAME}:${DOCKER_TAG}
147 docker push ${CLI_IMAGENAME}:${DOCKER_TAG}
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400148
149## lint and unit tests
khenaidood2b6df92018-12-13 16:37:20 -0500150
David Bainbridge5f3619c2019-07-10 22:51:09 +0000151PATH:=$(GOPATH)/bin:$(PATH)
152HADOLINT=$(shell PATH=$(GOPATH):$(PATH) which hadolint)
153lint-dockerfile:
154ifeq (,$(shell PATH=$(GOPATH):$(PATH) which hadolint))
155 mkdir -p $(GOPATH)/bin
156 curl -o $(GOPATH)/bin/hadolint -sNSL https://github.com/hadolint/hadolint/releases/download/v1.17.1/hadolint-$(shell uname -s)-$(shell uname -m)
157 chmod 755 $(GOPATH)/bin/hadolint
158endif
159 @echo "Running Dockerfile lint check ..."
160 @hadolint $$(find . -name "Dockerfile.*")
161 @echo "Dockerfile lint check OK"
162
Kent Hagerman074d0e02019-04-24 17:58:16 -0400163lint-style:
Zack Williams7cf78002019-04-30 21:45:35 -0700164ifeq (,$(shell which gofmt))
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400165 go get -u github.com/golang/go/src/cmd/gofmt
Zack Williams7cf78002019-04-30 21:45:35 -0700166endif
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400167 @echo "Running style check..."
168 @gofmt_out="$$(gofmt -l $$(find . -name '*.go' -not -path './vendor/*'))" ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700169 if [ ! -z "$$gofmt_out" ]; then \
170 echo "$$gofmt_out" ;\
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400171 echo "Style check failed on one or more files ^, run 'go fmt' to fix." ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700172 exit 1 ;\
Kent Hagerman074d0e02019-04-24 17:58:16 -0400173 fi
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400174 @echo "Style check OK"
Kent Hagerman074d0e02019-04-24 17:58:16 -0400175
176lint-sanity:
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400177 @echo "Running sanity check..."
girishk5259f8e2019-10-10 18:44:44 +0000178 @go vet -mod=vendor ./...
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400179 @echo "Sanity check OK"
Kent Hagerman074d0e02019-04-24 17:58:16 -0400180
girishk5259f8e2019-10-10 18:44:44 +0000181lint-mod:
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400182 @echo "Running dependency check..."
girishk5259f8e2019-10-10 18:44:44 +0000183 @go mod verify
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400184 @echo "Dependency check OK"
Kent Hagerman0ab4cb22019-04-24 13:13:35 -0400185
girishk5259f8e2019-10-10 18:44:44 +0000186lint: lint-style lint-sanity lint-mod lint-dockerfile
Kent Hagerman074d0e02019-04-24 17:58:16 -0400187
Scott Baker18ea5a42019-10-15 16:08:42 -0700188# Rules to automatically install golangci-lint
189GOLANGCI_LINT_TOOL?=$(shell which golangci-lint)
190ifeq (,$(GOLANGCI_LINT_TOOL))
191GOLANGCI_LINT_TOOL=$(GOPATH)/bin/golangci-lint
192golangci_lint_tool_install:
193 # Same version as installed by Jenkins ci-management
194 # Note that install using `go get` is not recommended as per https://github.com/golangci/golangci-lint
195 curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(GOPATH)/bin v1.17.0
196else
197golangci_lint_tool_install:
198endif
David K. Bainbridge1678e192019-05-17 11:48:29 -0700199
Scott Baker18ea5a42019-10-15 16:08:42 -0700200# Rules to automatically install go-junit-report
201GO_JUNIT_REPORT?=$(shell which go-junit-report)
Zack Williams7cf78002019-04-30 21:45:35 -0700202ifeq (,$(GO_JUNIT_REPORT))
Scott Baker18ea5a42019-10-15 16:08:42 -0700203GO_JUNIT_REPORT=$(GOPATH)/bin/go-junit-report
204go_junit_install:
Zack Williams7cf78002019-04-30 21:45:35 -0700205 go get -u github.com/jstemmer/go-junit-report
Scott Baker18ea5a42019-10-15 16:08:42 -0700206else
207go_junit_install:
Zack Williams7cf78002019-04-30 21:45:35 -0700208endif
Scott Baker18ea5a42019-10-15 16:08:42 -0700209
210# Rules to automatically install gocover-covertura
211GOCOVER_COBERTURA?=$(shell which gocover-cobertura)
Zack Williams7cf78002019-04-30 21:45:35 -0700212ifeq (,$(GOCOVER_COBERTURA))
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400213 @GOCOVER_COBERTURA=$(GOPATH)/bin/gocover-cobertura
Scott Baker18ea5a42019-10-15 16:08:42 -0700214gocover_cobertura_install:
215 go get -u github.com/t-yuki/gocover-cobertura
216else
217gocover_cobertura_install:
Zack Williams7cf78002019-04-30 21:45:35 -0700218endif
Scott Baker18ea5a42019-10-15 16:08:42 -0700219
220sca: golangci_lint_tool_install
221 rm -rf ./sca-report
222 @mkdir -p ./sca-report
223 $(GOLANGCI_LINT_TOOL) run --out-format junit-xml ./... 2>&1 | tee ./sca-report/sca-report.xml
224
225test: go_junit_install gocover_cobertura_install
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400226 @mkdir -p ./tests/results
girishk5259f8e2019-10-10 18:44:44 +0000227 @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 -0700228 RETURN=$$? ;\
229 $(GO_JUNIT_REPORT) < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\
230 $(GOCOVER_COBERTURA) < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\
231 exit $$RETURN
Kent Hagerman074d0e02019-04-24 17:58:16 -0400232
David K. Bainbridge1678e192019-05-17 11:48:29 -0700233clean:
234 rm -rf python/local_imports
235 find python -name '*.pyc' | xargs rm -f
236
237distclean: clean
David Bainbridge81175e42019-10-16 19:06:37 +0000238 rm -rf ${VENVDIR} ./sca_report
David K. Bainbridge1678e192019-05-17 11:48:29 -0700239
khenaidoocfee5f42018-07-19 22:47:38 -0400240# end file