blob: 5e38f302a6e88e291a91f64ece0a7846a01538bf [file] [log] [blame]
Andrea Campanella031ea1e2020-06-08 11:37:44 +02001# Copyright 2020-present Open Networking Foundation
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15# Makefile for device-management-interface
16default: test
17
Shivanagouda Malaginahalli335fe4d2021-03-31 16:52:28 +053018# initialize path of grpc_cpp_plugin binary
19GRPC_CPP_PLUGIN_PATH ?= $(shell which grpc_cpp_plugin)
20
Andrea Campanella031ea1e2020-06-08 11:37:44 +020021# set default shell options
22SHELL = bash -e -o pipefail
23
24# tool containers
Andrea Campanellac795b7d2021-04-14 13:24:44 +020025VOLTHA_TOOLS_VERSION ?= 2.5.0
Andrea Campanella031ea1e2020-06-08 11:37:44 +020026
27PROTOC = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app $(shell test -t 0 && echo "-it") voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-protoc protoc
28PROTOC_SH = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/go/src/github.com/opencord/device-management-interface/v3 $(shell test -t 0 && echo "-it") --workdir=/go/src/github.com/opencord/device-management-interface/v3 voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-protoc sh -c
29GO = docker run --rm --user $$(id -u):$$(id -g) -v ${CURDIR}:/app $(shell test -t 0 && echo "-it") -v gocache:/.cache -v gocache-${VOLTHA_TOOLS_VERSION}:/go/pkg voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-golang go
30
uwe ottrembka66d91ea2020-08-11 10:50:55 +020031# Function to extract the last path component from package line in .proto files
32define if_package_path
33$(shell grep if_package $(1) | sed -n 's/.*\/\(.*\)";/\1/p')
Andrea Campanella031ea1e2020-06-08 11:37:44 +020034endef
35
36# Variables
37PROTO_FILES := $(sort $(wildcard protos/dmi/*.proto))
38
39PROTO_GO_DEST_DIR := go
uwe ottrembka66d91ea2020-08-11 10:50:55 +020040PROTO_GO_PB:= $(foreach f, $(PROTO_FILES), $(patsubst protos/dmi/%.proto,$(PROTO_GO_DEST_DIR)/$(call if_package_path,$(f))/%.pb.go,$(f)))
41
Andrea Campanellaadd99442020-10-02 12:02:42 +020042PROTO_PYTHON_DEST_DIR := python/dmi
43PROTO_PYTHON_PB2 := $(foreach f, $(PROTO_FILES), $(patsubst protos/dmi/%.proto,$(PROTO_PYTHON_DEST_DIR)/%_pb2.py,$(f)))
uwe ottrembka66d91ea2020-08-11 10:50:55 +020044
Shivanagouda Malaginahalli335fe4d2021-03-31 16:52:28 +053045PROTO_CPP_DEST_DIR := cpp
46PROTO_CPP_PB := $(foreach f, $(PROTO_FILES), $(patsubst protos/dmi/%.proto,$(PROTO_CPP_DEST_DIR)/$(call if_package_path,$(f))/%.pb.cc,$(f)))
Andrea Campanella031ea1e2020-06-08 11:37:44 +020047# Force pb file to be regenrated every time. Otherwise the make process assumes generated version is still valid
48.PHONY: dmi.pb
49
50print:
51 @echo "Proto files: $(PROTO_FILES)"
52 @echo "Go PB files: $(PROTO_GO_PB)"
uwe ottrembka66d91ea2020-08-11 10:50:55 +020053 @echo "python PB files: $(PROTO_PYTHON_PB)"
Andrea Campanella031ea1e2020-06-08 11:37:44 +020054
55# Generic targets
Shivanagouda Malaginahalli335fe4d2021-03-31 16:52:28 +053056protos: go-protos python-protos cpp-protos
Andrea Campanella031ea1e2020-06-08 11:37:44 +020057
58build: protos
59
Shivanagouda Malaginahalli335fe4d2021-03-31 16:52:28 +053060test: go-test python-test cpp-test
uwe ottrembka66d91ea2020-08-11 10:50:55 +020061
Andrea Campanella031ea1e2020-06-08 11:37:44 +020062
63venv_protos:
64 virtualenv -p python3 $@;\
65 source ./$@/bin/activate ; set -u ;\
66 pip install grpcio-tools googleapis-common-protos
67
Andrea Campanellaadd99442020-10-02 12:02:42 +020068# Python targets
69python-protos: $(PROTO_PYTHON_PB2)
70
71$(PROTO_PYTHON_DEST_DIR)/%_pb2.py: protos/dmi/%.proto Makefile venv_protos
uwe ottrembka5ea5c0a2020-08-31 10:37:35 +020072 source ./venv_protos/bin/activate ; set -u ;\
Andrea Campanellaadd99442020-10-02 12:02:42 +020073 python -m grpc_tools.protoc \
74 -I protos \
75 --python_out=python \
76 --grpc_python_out=python \
77 --descriptor_set_out=$(PROTO_PYTHON_DEST_DIR)/$(basename $(notdir $<)).desc \
78 --include_imports \
79 --include_source_info \
80 $<
uwe ottrembka66d91ea2020-08-11 10:50:55 +020081
Andrea Campanella031ea1e2020-06-08 11:37:44 +020082# Go targets
83go-protos: dmi.pb
84 @echo "Creating *.go.pb files"
85 @${PROTOC_SH} " \
86 set -e -o pipefail; \
87 for x in ${PROTO_FILES}; do \
88 echo \$$x; \
89 protoc --go_out=plugins=grpc:/go/src -I protos \$$x; \
90 done"
91
92dmi.pb:
93 @echo "Creating $@"
94 @${PROTOC} -I protos \
95 --include_imports --include_source_info \
96 --descriptor_set_out=$@ \
97 ${PROTO_FILES}
98
Shivanagouda Malaginahalli335fe4d2021-03-31 16:52:28 +053099# Cpp targets
100cpp-protos:
101 echo "Creating *.pb.cpp files"
102 @${PROTOC_SH} " \
103 set -e -o pipefail; \
104 for x in ${PROTO_FILES}; do \
105 echo \$$x; \
Andrea Campanellac795b7d2021-04-14 13:24:44 +0200106 protoc --cpp_out=\$(PROTO_CPP_DEST_DIR) -I protos \$$x; \
107 protoc --grpc_out=\$(PROTO_CPP_DEST_DIR) --plugin=protoc-gen-grpc=/usr/local/bin/grpc_cpp_plugin -I protos \$$x; \
Shivanagouda Malaginahalli335fe4d2021-03-31 16:52:28 +0530108 done"
109
Andrea Campanella031ea1e2020-06-08 11:37:44 +0200110go-test:
111 test/test-go-proto-consistency.sh
112 ${GO} mod verify
uwe ottrembka66d91ea2020-08-11 10:50:55 +0200113
114python-test: tox.ini
115 test/test-python-proto-consistency.sh
Andrea Campanellaadd99442020-10-02 12:02:42 +0200116 tox
117
118python-build: setup.py python-protos
119 rm -rf dist/
120 python ./setup.py sdist
Shivanagouda Malaginahalli335fe4d2021-03-31 16:52:28 +0530121
122cpp-test:
123 test/test-cpp-proto-consistency.sh