blob: 04b3d311796cf0fc2007b45f1247b7f5894bb956 [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
36PONSIMOLT_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-adapter-ponsim-olt
37PONSIMONU_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-adapter-ponsim-onu
Matt Jeanneret2e3051a2019-05-11 15:01:46 -040038
39## Docker labels. Only set ref and commit date if committed
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040040DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote))
41DOCKER_LABEL_VCS_REF = $(shell git rev-parse HEAD)
42DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ")
43DOCKER_LABEL_COMMIT_DATE = $(shell git show -s --format=%cd --date=iso-strict HEAD)
Matt Jeanneret2e3051a2019-05-11 15:01:46 -040044
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040045DOCKER_BUILD_ARGS ?= \
David K. Bainbridgee14914d2019-05-24 13:43:05 -070046 ${DOCKER_EXTRA_ARGS} \
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040047 --build-arg org_label_schema_version="${VERSION}" \
48 --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \
49 --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \
50 --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \
51 --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \
52 --build-arg org_opencord_vcs_dirty="${DOCKER_LABEL_VCS_DIRTY}"
53
54DOCKER_BUILD_ARGS_LOCAL ?= ${DOCKER_BUILD_ARGS} \
55 --build-arg LOCAL_PYVOLTHA=${LOCAL_PYVOLTHA} \
56 --build-arg LOCAL_PROTOS=${LOCAL_PROTOS}
khenaidoocfee5f42018-07-19 22:47:38 -040057
Scott Bakerbeb3cfa2019-10-01 14:44:30 -070058.PHONY: rw_core ro_core local-protos local-pyvoltha
khenaidoocfee5f42018-07-19 22:47:38 -040059
60# This should to be the first and default target in this Makefile
61help:
62 @echo "Usage: make [<target>]"
63 @echo "where available targets are:"
64 @echo
David K. Bainbridge1678e192019-05-17 11:48:29 -070065 @echo "build : Build the docker images."
66 @echo " - If this is the first time you are building, choose 'make build' option."
67 @echo "rw_core : Build the rw_core docker image"
68 @echo "ro_core : Build the ro_core docker image"
David K. Bainbridge1678e192019-05-17 11:48:29 -070069 @echo "ofagent : Build the openflow agent docker image"
70 @echo "cli : Build the voltha CLI docker image"
71 @echo "adapter_ponsim_olt : Build the ponsim olt adapter docker image"
72 @echo "adapter_ponsim_onu : Build the ponsim onu adapter docker image"
73 @echo "venv : Build local Python virtualenv"
74 @echo "clean : Remove files created by the build and tests"
75 @echo "distclean : Remove venv directory"
76 @echo "docker-push : Push the docker images to an external repository"
David Bainbridge5f3619c2019-07-10 22:51:09 +000077 @echo "lint-dockerfile : Perform static analysis on Dockerfiles"
David K. Bainbridge1678e192019-05-17 11:48:29 -070078 @echo "lint-style : Verify code is properly gofmt-ed"
79 @echo "lint-sanity : Verify that 'go vet' doesn't report any issues"
80 @echo "lint-dep : Verify the integrity of the 'dep' files"
81 @echo "lint : Shorthand for lint-style & lint-sanity"
82 @echo "test : Generate reports for all go tests"
khenaidoocfee5f42018-07-19 22:47:38 -040083 @echo
84
David K. Bainbridge1678e192019-05-17 11:48:29 -070085## Local Development Helpers
86local-protos:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040087 @mkdir -p python/local_imports
David K. Bainbridge1678e192019-05-17 11:48:29 -070088ifdef LOCAL_PROTOS
89 mkdir -p vendor/github.com/opencord/voltha-protos/go
90 cp -r ${GOPATH}/src/github.com/opencord/voltha-protos/go/* vendor/github.com/opencord/voltha-protos/go
William Kurkiand4eccbc2019-07-30 10:17:21 -040091 rm -rf python/local_imports/voltha-protos
David K. Bainbridge1678e192019-05-17 11:48:29 -070092 mkdir -p python/local_imports/voltha-protos/dist
93 cp ../voltha-protos/dist/*.tar.gz python/local_imports/voltha-protos/dist/
94endif
95
96local-pyvoltha:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -040097 @mkdir -p python/local_imports
David K. Bainbridge1678e192019-05-17 11:48:29 -070098ifdef LOCAL_PYVOLTHA
William Kurkiand4eccbc2019-07-30 10:17:21 -040099 rm -rf python/local_imports/pyvoltha
David K. Bainbridge1678e192019-05-17 11:48:29 -0700100 mkdir -p python/local_imports/pyvoltha/dist
101 cp ../pyvoltha/dist/*.tar.gz python/local_imports/pyvoltha/dist/
102endif
103
104## Python venv dev environment
105
106VENVDIR := python/venv-volthago
107
108venv: distclean local-protos local-pyvoltha
109 virtualenv ${VENVDIR};\
110 source ./${VENVDIR}/bin/activate ; set -u ;\
111 rm -f ${VENVDIR}/local/bin ${VENVDIR}/local/lib ${VENVDIR}/local/include ;\
112 pip install -r python/requirements.txt
113ifdef LOCAL_PYVOLTHA
114 source ./${VENVDIR}/bin/activate ; set -u ;\
115 pip install python/local_imports/pyvoltha/dist/*.tar.gz
116endif
117ifdef LOCAL_PROTOS
118 source ./${VENVDIR}/bin/activate ; set -u ;\
119 pip install python/local_imports/voltha-protos/dist/*.tar.gz
120endif
khenaidoocfee5f42018-07-19 22:47:38 -0400121
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400122## Docker targets
khenaidoocfee5f42018-07-19 22:47:38 -0400123
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400124build: docker-build
khenaidoocfee5f42018-07-19 22:47:38 -0400125
Scott Bakerbeb3cfa2019-10-01 14:44:30 -0700126docker-build: rw_core ro_core ofagent cli adapter_ponsim_olt adapter_ponsim_onu
sslobodra3ea7d42019-01-16 15:03:16 -0500127
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400128rw_core: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400129 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 -0400130
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400131ro_core: local-protos
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400132 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 -0500133
David K. Bainbridge1678e192019-05-17 11:48:29 -0700134ofagent: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400135 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 -0700136
137cli: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400138 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 -0700139
140adapter_ponsim_olt: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400141 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 -0700142
143adapter_ponsim_onu: local-protos local-pyvoltha
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400144 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 -0400145
146docker-push:
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400147 docker push ${RWCORE_IMAGENAME}:${DOCKER_TAG}
148 docker push ${ROCORE_IMAGENAME}:${DOCKER_TAG}
Kent Hagermanf4a3aab2019-05-22 14:42:34 -0400149 docker push ${OFAGENT_IMAGENAME}:${DOCKER_TAG}
150 docker push ${CLI_IMAGENAME}:${DOCKER_TAG}
151 docker push ${PONSIMOLT_IMAGENAME}:${DOCKER_TAG}
152 docker push ${PONSIMONU_IMAGENAME}:${DOCKER_TAG}
Matt Jeanneret2e3051a2019-05-11 15:01:46 -0400153
154## lint and unit tests
khenaidood2b6df92018-12-13 16:37:20 -0500155
David Bainbridge5f3619c2019-07-10 22:51:09 +0000156PATH:=$(GOPATH)/bin:$(PATH)
157HADOLINT=$(shell PATH=$(GOPATH):$(PATH) which hadolint)
158lint-dockerfile:
159ifeq (,$(shell PATH=$(GOPATH):$(PATH) which hadolint))
160 mkdir -p $(GOPATH)/bin
161 curl -o $(GOPATH)/bin/hadolint -sNSL https://github.com/hadolint/hadolint/releases/download/v1.17.1/hadolint-$(shell uname -s)-$(shell uname -m)
162 chmod 755 $(GOPATH)/bin/hadolint
163endif
164 @echo "Running Dockerfile lint check ..."
165 @hadolint $$(find . -name "Dockerfile.*")
166 @echo "Dockerfile lint check OK"
167
Kent Hagerman074d0e02019-04-24 17:58:16 -0400168lint-style:
Zack Williams7cf78002019-04-30 21:45:35 -0700169ifeq (,$(shell which gofmt))
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400170 go get -u github.com/golang/go/src/cmd/gofmt
Zack Williams7cf78002019-04-30 21:45:35 -0700171endif
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400172 @echo "Running style check..."
173 @gofmt_out="$$(gofmt -l $$(find . -name '*.go' -not -path './vendor/*'))" ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700174 if [ ! -z "$$gofmt_out" ]; then \
175 echo "$$gofmt_out" ;\
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400176 echo "Style check failed on one or more files ^, run 'go fmt' to fix." ;\
Zack Williams7cf78002019-04-30 21:45:35 -0700177 exit 1 ;\
Kent Hagerman074d0e02019-04-24 17:58:16 -0400178 fi
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400179 @echo "Style check OK"
Kent Hagerman074d0e02019-04-24 17:58:16 -0400180
181lint-sanity:
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400182 @echo "Running sanity check..."
183 @go vet ./...
184 @echo "Sanity check OK"
Kent Hagerman074d0e02019-04-24 17:58:16 -0400185
Kent Hagerman0ab4cb22019-04-24 13:13:35 -0400186lint-dep:
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400187 @echo "Running dependency check..."
188 @dep check
189 @echo "Dependency check OK"
Kent Hagerman0ab4cb22019-04-24 13:13:35 -0400190
David Bainbridge5f3619c2019-07-10 22:51:09 +0000191lint: lint-style lint-sanity lint-dep lint-dockerfile
Kent Hagerman074d0e02019-04-24 17:58:16 -0400192
Zack Williams7cf78002019-04-30 21:45:35 -0700193GO_JUNIT_REPORT:=$(shell which go-junit-report)
194GOCOVER_COBERTURA:=$(shell which gocover-cobertura)
David K. Bainbridge1678e192019-05-17 11:48:29 -0700195
Kent Hagerman074d0e02019-04-24 17:58:16 -0400196test:
Zack Williams7cf78002019-04-30 21:45:35 -0700197ifeq (,$(GO_JUNIT_REPORT))
198 go get -u github.com/jstemmer/go-junit-report
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400199 @GO_JUNIT_REPORT=$(GOPATH)/bin/go-junit-report
Zack Williams7cf78002019-04-30 21:45:35 -0700200endif
Zack Williams7cf78002019-04-30 21:45:35 -0700201ifeq (,$(GOCOVER_COBERTURA))
202 go get -u github.com/t-yuki/gocover-cobertura
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400203 @GOCOVER_COBERTURA=$(GOPATH)/bin/gocover-cobertura
Zack Williams7cf78002019-04-30 21:45:35 -0700204endif
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400205 @mkdir -p ./tests/results
Kent Hagermanca4c51e2019-05-02 12:28:55 -0400206 @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 -0700207 RETURN=$$? ;\
208 $(GO_JUNIT_REPORT) < ./tests/results/go-test-results.out > ./tests/results/go-test-results.xml ;\
209 $(GOCOVER_COBERTURA) < ./tests/results/go-test-coverage.out > ./tests/results/go-test-coverage.xml ;\
210 exit $$RETURN
Kent Hagerman074d0e02019-04-24 17:58:16 -0400211
David K. Bainbridge1678e192019-05-17 11:48:29 -0700212clean:
213 rm -rf python/local_imports
214 find python -name '*.pyc' | xargs rm -f
215
216distclean: clean
217 rm -rf ${VENVDIR}
218
khenaidoocfee5f42018-07-19 22:47:38 -0400219# end file