blob: 4abcff6572828aad08b360bbcad8097442fc5d0b [file] [log] [blame]
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -05001#
2# Copyright 2018 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 Jeanneret134d9e82019-05-08 15:45:10 -040017# set default shell
18SHELL = bash -e -o pipefail
19
20# Variables
21VERSION ?= $(shell cat ../VERSION)
22
Matt Jeanneret08a8e862019-12-20 14:02:32 -050023DOCKER_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 Jeanneret134d9e82019-05-08 15:45:10 -040027## Docker related
28DOCKER_REGISTRY ?=
29DOCKER_REPOSITORY ?=
30DOCKER_BUILD_ARGS ?=
31DOCKER_TAG ?= ${VERSION}
32ADAPTER_IMAGENAME := ${DOCKER_REGISTRY}${DOCKER_REPOSITORY}voltha-openonu-adapter:${DOCKER_TAG}
Andrea Campanella442d7e42019-12-17 15:27:52 -080033TYPE ?= minimal
Matt Jeanneret134d9e82019-05-08 15:45:10 -040034
35## Docker labels. Only set ref and commit date if committed
Matt Jeanneret08a8e862019-12-20 14:02:32 -050036DOCKER_LABEL_VCS_URL ?= $(shell git remote get-url $(shell git remote))
37DOCKER_LABEL_VCS_REF = $(shell git rev-parse HEAD)
38DOCKER_LABEL_BUILD_DATE ?= $(shell date -u "+%Y-%m-%dT%H:%M:%SZ")
39DOCKER_LABEL_COMMIT_DATE = $(shell git show -s --format=%cd --date=iso-strict HEAD)
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -050040
Andrey Pozolotin9981e832020-08-14 02:50:12 +020041## Python tox tests
42VOLTHA_TOOLS_VERSION ?= 2.3.0
43TOX = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app $(shell test -t 0 && echo "-it") voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-python tox
44
Matt Jeanneret134d9e82019-05-08 15:45:10 -040045.PHONY: venv docker-build local-protos local-pyvoltha
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -050046
47# This should to be the first and default target in this Makefile
48help:
49 @echo "Usage: make [<target>]"
50 @echo "where available targets are:"
51 @echo
Matt Jeanneret134d9e82019-05-08 15:45:10 -040052 @echo "build : Build the openonu openomci adapter docker image"
53 @echo "help : Print this help"
54 @echo "docker-push : Push the docker images to an external repository"
55 @echo "venv : Build local Python virtualenv"
Matt Jeanneret18949ae2019-02-09 15:00:14 -050056 @echo "clean : Remove files created by the build and tests"
57 @echo "distclean : Remove venv directory"
Andrey Pozolotin9981e832020-08-14 02:50:12 +020058 @echo "sca : Starts sca checks"
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -050059 @echo
60
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -050061
Matt Jeanneret134d9e82019-05-08 15:45:10 -040062## Docker targets
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -050063
Matt Jeanneret134d9e82019-05-08 15:45:10 -040064build: docker-build
65
Zack Williamsd3a56c42019-05-17 15:44:35 -070066# only test is that the docker container builds
67test: docker-build
68
69local-protos:
Matt Jeanneret134d9e82019-05-08 15:45:10 -040070 mkdir -p local_imports
71ifdef LOCAL_PROTOS
72 mkdir -p local_imports/voltha-protos/dist
Matt Jeanneret5d936262020-01-29 05:04:14 -050073 rm -f local_imports/voltha-protos/dist/*.tar.gz
William Kurkianeffdbf52019-11-13 16:01:09 -050074 cp ${LOCAL_PROTOS}/dist/*.tar.gz local_imports/voltha-protos/dist/
Matt Jeanneret134d9e82019-05-08 15:45:10 -040075endif
76
77local-pyvoltha:
William Kurkian07271552019-04-09 16:52:06 -040078 mkdir -p local_imports
Matt Jeanneret18949ae2019-02-09 15:00:14 -050079ifdef LOCAL_PYVOLTHA
William Kurkian07271552019-04-09 16:52:06 -040080 mkdir -p local_imports/pyvoltha/dist
Matt Jeanneret5d936262020-01-29 05:04:14 -050081 rm -f local_imports/pyvoltha/dist/*.tar.gz
William Kurkianeffdbf52019-11-13 16:01:09 -050082 cp ${LOCAL_PYVOLTHA}/dist/*.tar.gz local_imports/pyvoltha/dist/
Matt Jeanneret18949ae2019-02-09 15:00:14 -050083endif
Matt Jeanneret134d9e82019-05-08 15:45:10 -040084
85docker-build: local-protos local-pyvoltha
86 docker build $(DOCKER_BUILD_ARGS) \
87 -t ${ADAPTER_IMAGENAME} \
88 --build-arg LOCAL_PYVOLTHA=$(LOCAL_PYVOLTHA) \
89 --build-arg LOCAL_PROTOS=$(LOCAL_PROTOS) \
90 --build-arg org_label_schema_version="${VERSION}" \
91 --build-arg org_label_schema_vcs_url="${DOCKER_LABEL_VCS_URL}" \
92 --build-arg org_label_schema_vcs_ref="${DOCKER_LABEL_VCS_REF}" \
93 --build-arg org_label_schema_build_date="${DOCKER_LABEL_BUILD_DATE}" \
94 --build-arg org_opencord_vcs_commit_date="${DOCKER_LABEL_COMMIT_DATE}" \
Matt Jeanneret08a8e862019-12-20 14:02:32 -050095 --build-arg org_opencord_vcs_dirty="${DOCKER_LABEL_VCS_DIRTY}" \
Matt Jeanneret134d9e82019-05-08 15:45:10 -040096 -f docker/Dockerfile.openonu_adapter .
97
98docker-push:
99 docker push ${ADAPTER_IMAGENAME}
100
Andrea Campanella442d7e42019-12-17 15:27:52 -0800101docker-kind-load:
102 @if [ "`kind get clusters | grep voltha-$(TYPE)`" = '' ]; then echo "no voltha-$(TYPE) cluster found" && exit 1; fi
103 kind load docker-image ${ADAPTER_IMAGENAME} --name=voltha-$(TYPE) --nodes $(shell kubectl get nodes --template='{{range .items}}{{.metadata.name}},{{end}}' | sed 's/,$$//')
Matt Jeanneret134d9e82019-05-08 15:45:10 -0400104## Python venv dev environment
105
106VENVDIR := venv-openonu
107
108venv: distclean local-protos local-pyvoltha
Matt Jeanneret2e3cb8d2019-11-16 09:22:41 -0500109 virtualenv --python=python3.6 ${VENVDIR};\
Matt Jeanneret134d9e82019-05-08 15:45:10 -0400110 source ./${VENVDIR}/bin/activate ; set -u ;\
Matt Jeanneret134d9e82019-05-08 15:45:10 -0400111 pip install -r requirements.txt
112
113ifdef LOCAL_PYVOLTHA
114 source ./${VENVDIR}/bin/activate ; set -u ;\
115 pip install local_imports/pyvoltha/dist/*.tar.gz
116endif
William Kurkian07271552019-04-09 16:52:06 -0400117ifdef LOCAL_PROTOS
Matt Jeanneret134d9e82019-05-08 15:45:10 -0400118 source ./${VENVDIR}/bin/activate ; set -u ;\
119 pip install local_imports/voltha-protos/dist/*.tar.gz
William Kurkian07271552019-04-09 16:52:06 -0400120endif
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -0500121
122clean:
William Kurkian07271552019-04-09 16:52:06 -0400123 rm -rf local_imports
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -0500124 find . -name '*.pyc' | xargs rm -f
125
126distclean: clean
127 rm -rf ${VENVDIR}
128
Andrey Pozolotin9981e832020-08-14 02:50:12 +0200129sca:
130 @rm -rf ./sca-report
131 @mkdir -p ./sca-report
132 @echo "Running static code analysis..."
133 @$(TOX) --result-json ./sca-report/sca-report.json
134 @echo ""
135 @echo "Static code analysis OK"
Matt Jeanneretf1e9c5d2019-02-08 07:41:29 -0500136# end file