blob: edd5ef15f6df44a9ba4888a0220940ba76e55c09 [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
34AFROUTER_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-afrouter
35AFROUTERTEST_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-afroutertest
36AFROUTERD_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-afrouterd
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040037OFAGENT_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-ofagent
38CLI_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-cli
39PONSIMOLT_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-adapter-ponsim-olt
40PONSIMONU_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-adapter-ponsim-onu
Matt Jeanneret2e3051a2019-05-11 15:01:46 -040041
42## Docker labels. Only set ref and commit date if committed
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040043DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote))
44DOCKER_LABEL_VCS_REF = $(shell git rev-parse HEAD)
45DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ")
46DOCKER_LABEL_COMMIT_DATE = $(shell git show -s --format=%cd --date=iso-strict HEAD)
Matt Jeanneret2e3051a2019-05-11 15:01:46 -040047
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040048DOCKER_BUILD_ARGS ?= \
David K. Bainbridgee14914d2019-05-24 13:43:05 -070049 ${DOCKER_EXTRA_ARGS} \
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040050 --build-arg org_label_schema_version="${VERSION}" \
51 --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \
52 --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \
53 --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \
54 --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \
55 --build-arg org_opencord_vcs_dirty="${DOCKER_LABEL_VCS_DIRTY}"
56
57DOCKER_BUILD_ARGS_LOCAL ?= ${DOCKER_BUILD_ARGS} \
58 --build-arg LOCAL_PYVOLTHA=${LOCAL_PYVOLTHA} \
59 --build-arg LOCAL_PROTOS=${LOCAL_PROTOS}
khenaidoocfee5f42018-07-19 22:47:38 -040060
Scott Baker169c0692019-09-24 13:36:23 -070061.PHONY: rw_core ro_core afrouter afrouterd local-protos local-pyvoltha
khenaidoocfee5f42018-07-19 22:47:38 -040062
63# This should to be the first and default target in this Makefile
64help:
65 @echo "Usage: make [<target>]"
66 @echo "where available targets are:"
67 @echo
David K. Bainbridge1678e192019-05-17 11:48:29 -070068 @echo "build : Build the docker images."
69 @echo " - If this is the first time you are building, choose 'make build' option."
70 @echo "rw_core : Build the rw_core docker image"
71 @echo "ro_core : Build the ro_core docker image"
72 @echo "afrouter : Build the afrouter docker image"
73 @echo "afrouterTest : Build the afrouterTest docker image"
74 @echo "afrouterd : Build the afrouterd docker image"
David K. Bainbridge1678e192019-05-17 11:48:29 -070075 @echo "ofagent : Build the openflow agent docker image"
76 @echo "cli : Build the voltha CLI docker image"
77 @echo "adapter_ponsim_olt : Build the ponsim olt adapter docker image"
78 @echo "adapter_ponsim_onu : Build the ponsim onu adapter docker image"
79 @echo "venv : Build local Python virtualenv"
80 @echo "clean : Remove files created by the build and tests"
81 @echo "distclean : Remove venv directory"
82 @echo "docker-push : Push the docker images to an external repository"
David Bainbridge5f3619c2019-07-10 22:51:09 +000083 @echo "lint-dockerfile : Perform static analysis on Dockerfiles"
David K. Bainbridge1678e192019-05-17 11:48:29 -070084 @echo "lint-style : Verify code is properly gofmt-ed"
85 @echo "lint-sanity : Verify that 'go vet' doesn't report any issues"
86 @echo "lint-dep : Verify the integrity of the 'dep' files"
87 @echo "lint : Shorthand for lint-style & lint-sanity"
88 @echo "test : Generate reports for all go tests"
khenaidoocfee5f42018-07-19 22:47:38 -040089 @echo
90
David K. Bainbridge1678e192019-05-17 11:48:29 -070091## Local Development Helpers
92local-protos:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040093 @mkdir -p python/local_imports
David K. Bainbridge1678e192019-05-17 11:48:29 -070094ifdef LOCAL_PROTOS
95 mkdir -p vendor/github.com/opencord/voltha-protos/go
96 cp -r ${GOPATH}/src/github.com/opencord/voltha-protos/go/* vendor/github.com/opencord/voltha-protos/go
William Kurkiand4eccbc2019-07-30 10:17:21 -040097 rm -rf python/local_imports/voltha-protos
David K. Bainbridge1678e192019-05-17 11:48:29 -070098 mkdir -p python/local_imports/voltha-protos/dist
99 cp ../voltha-protos/dist/*.tar.gz python/local_imports/voltha-protos/dist/
100endif
101
102local-pyvoltha:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400103 @mkdir -p python/local_imports
David K. Bainbridge1678e192019-05-17 11:48:29 -0700104ifdef LOCAL_PYVOLTHA
William Kurkiand4eccbc2019-07-30 10:17:21 -0400105 rm -rf python/local_imports/pyvoltha
David K. Bainbridge1678e192019-05-17 11:48:29 -0700106 mkdir -p python/local_imports/pyvoltha/dist
107 cp ../pyvoltha/dist/*.tar.gz python/local_imports/pyvoltha/dist/
108endif
109
110## Python venv dev environment
111
112VENVDIR := python/venv-volthago
113
114venv: distclean local-protos local-pyvoltha
115 virtualenv ${VENVDIR};\
116 source ./${VENVDIR}/bin/activate ; set -u ;\
117 rm -f ${VENVDIR}/local/bin ${VENVDIR}/local/lib ${VENVDIR}/local/include ;\
118 pip install -r python/requirements.txt
119ifdef LOCAL_PYVOLTHA
120 source ./${VENVDIR}/bin/activate ; set -u ;\
121 pip install python/local_imports/pyvoltha/dist/*.tar.gz
122endif
123ifdef LOCAL_PROTOS
124 source ./${VENVDIR}/bin/activate ; set -u ;\
125 pip install python/local_imports/voltha-protos/dist/*.tar.gz
126endif
khenaidoocfee5f42018-07-19 22:47:38 -0400127
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400128## Docker targets
khenaidoocfee5f42018-07-19 22:47:38 -0400129
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400130build: docker-build
khenaidoocfee5f42018-07-19 22:47:38 -0400131
Scott Baker169c0692019-09-24 13:36:23 -0700132docker-build: rw_core ro_core afrouter afrouterd ofagent cli adapter_ponsim_olt adapter_ponsim_onu
khenaidoocfee5f42018-07-19 22:47:38 -0400133
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400134afrouter: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400135 docker build $(DOCKER_BUILD_ARGS) -t ${AFROUTER_IMAGENAME}:${DOCKER_TAG} -t ${AFROUTER_IMAGENAME}:latest -f docker/Dockerfile.afrouter .
sslobodra3ea7d42019-01-16 15:03:16 -0500136
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400137afrouterTest: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400138 docker build $(DOCKER_BUILD_ARGS) -t ${AFROUTERTEST_IMAGENAME}:${DOCKER_TAG} -t ${AFROUTERTEST_IMAGENAME}:latest -f docker/Dockerfile.afrouterTest .
sslobodrd6e07e72019-01-31 16:07:20 -0500139
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400140afrouterd: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400141 docker build $(DOCKER_BUILD_ARGS) -t ${AFROUTERD_IMAGENAME}:${DOCKER_TAG} -t ${AFROUTERD_IMAGENAME}:latest -f docker/Dockerfile.afrouterd .
sslobodra3ea7d42019-01-16 15:03:16 -0500142
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400143rw_core: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400144 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 -0400145
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400146ro_core: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400147 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 -0500148
David K. Bainbridge1678e192019-05-17 11:48:29 -0700149ofagent: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400150 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 -0700151
152cli: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400153 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 -0700154
155adapter_ponsim_olt: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400156 docker build $(DOCKER_BUILD_ARGS_LOCAL) -t ${PONSIMOLT_IMAGENAME}:${DOCKER_TAG} -t ${PONSIMOLT_IMAGENAME}:latest -f python/docker/Dockerfile.adapter_ponsim_olt python
David K. Bainbridge1678e192019-05-17 11:48:29 -0700157
158adapter_ponsim_onu: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400159 docker build $(DOCKER_BUILD_ARGS_LOCAL) -t ${PONSIMONU_IMAGENAME}:${DOCKER_TAG} -t ${PONSIMONU_IMAGENAME}:latest -f python/docker/Dockerfile.adapter_ponsim_onu python
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400160
161docker-push:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400162 docker push ${AFROUTER_IMAGENAME}:${DOCKER_TAG}
163 docker push ${AFROUTERD_IMAGENAME}:${DOCKER_TAG}
164 docker push ${RWCORE_IMAGENAME}:${DOCKER_TAG}
165 docker push ${ROCORE_IMAGENAME}:${DOCKER_TAG}
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400166 docker push ${OFAGENT_IMAGENAME}:${DOCKER_TAG}
167 docker push ${CLI_IMAGENAME}:${DOCKER_TAG}
168 docker push ${PONSIMOLT_IMAGENAME}:${DOCKER_TAG}
169 docker push ${PONSIMONU_IMAGENAME}:${DOCKER_TAG}
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400170
171## lint and unit tests
khenaidood2b6df92018-12-13 16:37:20 -0500172
David Bainbridge5f3619c2019-07-10 22:51:09 +0000173PATH:=$(GOPATH)/bin:$(PATH)
174HADOLINT=$(shell PATH=$(GOPATH):$(PATH) which hadolint)
175lint-dockerfile:
176ifeq (,$(shell PATH=$(GOPATH):$(PATH) which hadolint))
177 mkdir -p $(GOPATH)/bin
178 curl -o $(GOPATH)/bin/hadolint -sNSL https://github.com/hadolint/hadolint/releases/download/v1.17.1/hadolint-$(shell uname -s)-$(shell uname -m)
179 chmod 755 $(GOPATH)/bin/hadolint
180endif
181 @echo "Running Dockerfile lint check ..."
182 @hadolint $$(find . -name "Dockerfile.*")
183 @echo "Dockerfile lint check OK"
184
Kent Hagerman074d0e02019-04-24 17:58:16 -0400185lint-style:
Zack Williams7cf78002019-04-30 21:45:35 -0700186ifeq (,$(shell which gofmt))
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400187 go get -u github.com/golang/go/src/cmd/gofmt
Zack Williams7cf78002019-04-30 21:45:35 -0700188endif
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400189 @echo "Running style check..."
190 @gofmt_out="$$(gofmt -l $$(find . -name '*.go' -not -path './vendor/*'))" ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700191 if [ ! -z "$$gofmt_out" ]; then \
192 echo "$$gofmt_out" ;\
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400193 echo "Style check failed on one or more files ^, run 'go fmt' to fix." ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700194 exit 1 ;\
Kent Hagerman074d0e02019-04-24 17:58:16 -0400195 fi
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400196 @echo "Style check OK"
Kent Hagerman074d0e02019-04-24 17:58:16 -0400197
198lint-sanity:
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400199 @echo "Running sanity check..."
200 @go vet ./...
201 @echo "Sanity check OK"
Kent Hagerman074d0e02019-04-24 17:58:16 -0400202
Kent Hagerman0ab4cb22019-04-24 13:13:35 -0400203lint-dep:
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400204 @echo "Running dependency check..."
205 @dep check
206 @echo "Dependency check OK"
Kent Hagerman0ab4cb22019-04-24 13:13:35 -0400207
David Bainbridge5f3619c2019-07-10 22:51:09 +0000208lint: lint-style lint-sanity lint-dep lint-dockerfile
Kent Hagerman074d0e02019-04-24 17:58:16 -0400209
Zack Williams7cf78002019-04-30 21:45:35 -0700210GO_JUNIT_REPORT:=$(shell which go-junit-report)
211GOCOVER_COBERTURA:=$(shell which gocover-cobertura)
David K. Bainbridge1678e192019-05-17 11:48:29 -0700212
Kent Hagerman074d0e02019-04-24 17:58:16 -0400213test:
Zack Williams7cf78002019-04-30 21:45:35 -0700214ifeq (,$(GO_JUNIT_REPORT))
215 go get -u github.com/jstemmer/go-junit-report
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400216 @GO_JUNIT_REPORT=$(GOPATH)/bin/go-junit-report
Zack Williams7cf78002019-04-30 21:45:35 -0700217endif
Zack Williams7cf78002019-04-30 21:45:35 -0700218ifeq (,$(GOCOVER_COBERTURA))
219 go get -u github.com/t-yuki/gocover-cobertura
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400220 @GOCOVER_COBERTURA=$(GOPATH)/bin/gocover-cobertura
Zack Williams7cf78002019-04-30 21:45:35 -0700221endif
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400222 @mkdir -p ./tests/results
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400223 @go test -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 -0700224 RETURN=$$? ;\
225 $(GO_JUNIT_REPORT) < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\
226 $(GOCOVER_COBERTURA) < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\
227 exit $$RETURN
Kent Hagerman074d0e02019-04-24 17:58:16 -0400228
David K. Bainbridge1678e192019-05-17 11:48:29 -0700229clean:
230 rm -rf python/local_imports
231 find python -name '*.pyc' | xargs rm -f
232
233distclean: clean
234 rm -rf ${VENVDIR}
235
khenaidoocfee5f42018-07-19 22:47:38 -0400236# end file