blob: c34fb7e80935c24991ba547398960ab3a8effb8d [file] [log] [blame]
Zack Williams52209662019-02-07 10:15:31 -07001# Copyright 2019-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 voltha-protos
16default: test
17
Zack Williams43bfd9e2019-04-12 13:09:31 -070018# set default shell options
19SHELL = bash -e -o pipefail
20
21# Function to extract the last path component from go_package line in .proto files
22define go_package_path
23$(shell grep go_package $(1) | sed -n 's/.*\/\(.*\)";/\1/p')
24endef
25
Zack Williams52209662019-02-07 10:15:31 -070026# Variables
Zack Williams43bfd9e2019-04-12 13:09:31 -070027PROTO_FILES := $(sort $(wildcard protos/voltha_protos/*.proto))
28
Zack Williams52209662019-02-07 10:15:31 -070029PROTO_PYTHON_DEST_DIR := python/voltha_protos
30PROTO_PYTHON_PB2 := $(foreach f, $(PROTO_FILES), $(patsubst protos/voltha_protos/%.proto,$(PROTO_PYTHON_DEST_DIR)/%_pb2.py,$(f)))
Matt Jeanneret37e0fc62019-03-07 12:33:21 -050031PROTO_PYTHON_PB2_GRPC := $(foreach f, $(PROTO_FILES), $(patsubst protos/voltha_protos/%.proto,$(PROTO_PYTHON_DEST_DIR)/%_pb2_grpc.py,$(f)))
Zack Williams43bfd9e2019-04-12 13:09:31 -070032PROTO_GO_DEST_DIR := go
33PROTO_GO_PB:= $(foreach f, $(PROTO_FILES), $(patsubst protos/voltha_protos/%.proto,$(PROTO_GO_DEST_DIR)/$(call go_package_path,$(f))/%.pb.go,$(f)))
Zack Williams52209662019-02-07 10:15:31 -070034
Zack Williams25e0a322019-06-07 14:07:21 -070035# Force pb file to be regenrated every time. Otherwise the make process assumes generated version is still valid
Scott Baker39210792019-10-03 15:00:52 -070036.PHONY: voltha.pb protoc_check
Matt Jeanneret15249fa2019-04-12 20:25:31 -040037
Zack Williams52209662019-02-07 10:15:31 -070038print:
Zack Williams43bfd9e2019-04-12 13:09:31 -070039 @echo "Proto files: $(PROTO_FILES)"
40 @echo "Python PB2 files: $(PROTO_PYTHON_PB2)"
41 @echo "Go PB files: $(PROTO_GO_PB)"
Zack Williams52209662019-02-07 10:15:31 -070042
43# Generic targets
44protos: python-protos go-protos
45
William Kurkianbd3736d2019-03-08 12:20:40 -050046build: protos python-build go-protos
Zack Williams52209662019-02-07 10:15:31 -070047
48test: python-test go-test
49
50clean: python-clean go-clean
51
52# Python targets
Zack Williams25e0a322019-06-07 14:07:21 -070053python-protos: protoc_check $(PROTO_PYTHON_PB2)
Zack Williams52209662019-02-07 10:15:31 -070054
55venv_protos:
56 virtualenv $@;\
57 source ./$@/bin/activate ; set -u ;\
58 pip install grpcio-tools googleapis-common-protos
59
60$(PROTO_PYTHON_DEST_DIR)/%_pb2.py: protos/voltha_protos/%.proto Makefile venv_protos
61 source ./venv_protos/bin/activate ; set -u ;\
62 python -m grpc_tools.protoc \
Zack Williams43bfd9e2019-04-12 13:09:31 -070063 -I protos \
64 --python_out=python \
65 --grpc_python_out=python \
66 --descriptor_set_out=$(PROTO_PYTHON_DEST_DIR)/$(basename $(notdir $<)).desc \
67 --include_imports \
68 --include_source_info \
69 $<
Zack Williams52209662019-02-07 10:15:31 -070070
Zack Williams43bfd9e2019-04-12 13:09:31 -070071python-build: setup.py python-protos
William Kurkian4ae78492019-06-11 20:33:05 -040072 rm -rf dist/
Zack Williams52209662019-02-07 10:15:31 -070073 python ./setup.py sdist
74
75python-test: tox.ini setup.py python-protos
76 tox
77
78python-clean:
Matt Jeanneret37e0fc62019-03-07 12:33:21 -050079 find python/ -name '*.pyc' | xargs rm -f
Zack Williams43bfd9e2019-04-12 13:09:31 -070080 rm -rf \
81 .coverage \
82 .tox \
83 coverage.xml \
84 dist \
85 nose2-results.xml \
86 python/__pycache__ \
87 python/test/__pycache__ \
88 python/voltha_protos.egg-info \
89 venv_protos \
90 $(PROTO_PYTHON_DEST_DIR)/*.desc \
91 $(PROTO_PYTHON_PB2) \
92 $(PROTO_PYTHON_PB2_GRPC)
Zack Williams52209662019-02-07 10:15:31 -070093
94# Go targets
Scott Baker39210792019-10-03 15:00:52 -070095go-protos: protoc_check $(PROTO_GO_PB) voltha.pb
Zack Williams43bfd9e2019-04-12 13:09:31 -070096
97go_temp:
98 mkdir -p go_temp
99
100$(PROTO_GO_PB): $(PROTO_FILES) go_temp
101 @echo "Creating $@"
102 cd protos && protoc \
103 --go_out=MAPS=Mgoogle/protobuf/descriptor.proto=github.com/golang/protobuf/protoc-gen-go/descriptor,plugins=grpc,paths=source_relative:../go_temp \
104 -I . voltha_protos/$$(echo $@ | sed -n 's/.*\/\(.*\).pb.go/\1.proto/p' )
105 mkdir -p $(dir $@)
106 mv go_temp/voltha_protos/$(notdir $@) $@
107
Scott Baker39210792019-10-03 15:00:52 -0700108voltha.pb: ${PROTO_FILES}
Zack Williams43bfd9e2019-04-12 13:09:31 -0700109 @echo "Creating $@"
110 protoc -I protos -I protos/google/api \
111 --include_imports --include_source_info \
112 --descriptor_set_out=$@ \
113 ${PROTO_FILES}
Zack Williams52209662019-02-07 10:15:31 -0700114
Zack Williams25e0a322019-06-07 14:07:21 -0700115go-test: protoc_check
William Kurkianad745652019-03-20 08:45:51 -0400116 test/test-go-proto-consistency.sh
Scott Bakerb6b797c2019-10-04 15:50:09 -0700117 GO111MODULE=on go mod verify
Zack Williams52209662019-02-07 10:15:31 -0700118
119go-clean:
Zack Williams43bfd9e2019-04-12 13:09:31 -0700120 rm -rf go_temp
Zack Williams52209662019-02-07 10:15:31 -0700121
Zack Williams25e0a322019-06-07 14:07:21 -0700122# Protobuf compiler helper functions
123protoc_check:
124ifeq ("", "$(shell which protoc)")
125 @echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
126 @echo "It looks like you don't have a version of protocol buffer tools."
127 @echo "To install the protocol buffer toolchain on Linux, you can run:"
128 @echo " make install-protoc"
129 @echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
130 exit 1
131endif
132ifneq ("libprotoc 3.7.0", "$(shell protoc --version)")
133 @echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
134 @echo "You have the wrong version of protoc installed"
135 @echo "Please install version 3.7.0"
136 @echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
137 exit 1
138endif
139
William Kurkian6ea97f82019-03-13 15:51:55 -0400140install-protoc:
Zack Williams25e0a322019-06-07 14:07:21 -0700141 @echo "Downloading and installing protocol buffer support (Linux amd64 only)"
142ifneq ("Linux", "$(shell uname -s)")
143 @echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
144 @echo "Automated installation of protoc not supported on $(shell uname -s)"
145 @echo "Please install protoc v3.7.0 from:"
146 @echo " https://github.com/protocolbuffers/protobuf/releases"
147 @echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
148 exit 1
149endif
Matt Jeanneret61e94872019-03-22 16:16:01 -0400150 @echo "Installation will require sudo priviledges"
William Kurkian6ea97f82019-03-13 15:51:55 -0400151 @echo "This will take a few minutes."
Zack Williams25e0a322019-06-07 14:07:21 -0700152 @echo "Asking for sudo credentials now so we can install at the end"
William Kurkian6ea97f82019-03-13 15:51:55 -0400153 sudo echo "Thanks"; \
Zack Williams25e0a322019-06-07 14:07:21 -0700154 PROTOC_VERSION="3.7.0" ;\
155 PROTOC_SHA256SUM="a1b8ed22d6dc53c5b8680a6f1760a305b33ef471bece482e92728f00ba2a2969" ;\
156 curl -L -o /tmp/protoc-$${PROTOC_VERSION}-linux-x86_64.zip https://github.com/google/protobuf/releases/download/v$${PROTOC_VERSION}/protoc-$${PROTOC_VERSION}-linux-x86_64.zip ;\
157 echo "$${PROTOC_SHA256SUM} /tmp/protoc-$${PROTOC_VERSION}-linux-x86_64.zip" | sha256sum -c - ;\
158 unzip /tmp/protoc-$${PROTOC_VERSION}-linux-x86_64.zip -d /tmp/protoc3 ;\
159 sudo mv /tmp/protoc3/bin/* /usr/local/bin/ ;\
160 sudo mv /tmp/protoc3/include/* /usr/local/include/ ;\
161 sudo chmod -R a+rx /usr/local/bin/* ;\
162 sudo chmod -R a+rX /usr/local/include/