Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-protos / 43bfd9e5457889c460e3bab77c58309a138ef94e
commit43bfd9e5457889c460e3bab77c58309a138ef94e[log] [tgz]
authorZack Williams <zdw@opennetworking.org>Fri Apr 12 13:09:31 2019 -0700
committerZack Williams <zdw@opennetworking.org>Mon Apr 15 14:46:44 2019 -0700
tree77efee083fc11e4dc31c829bab27e7bc19e4d345
parent61e94873aa4b4cfd5e9277c666402214b031c05b [diff]
[VOL-1460]

Build Go stubs using the Makefile, instead of in a separate script.

New method is independent of GOPATH (which makes testing easier), and is
'go_package' aware, so any new .proto files will have directories
created and regenerated under go/

Cleaned up README.md and Makefile

Lexically sort input to protoc as --descriptor_set_out differs depending
on the order of file arguments passed to it.

Released v0.1.2

Change-Id: If9d5aabc89b4d73f3e069b01b38bd0bf8d1b3c43
6 files changed
tree: 77efee083fc11e4dc31c829bab27e7bc19e4d345
  1. .gitignore
  2. .gitreview
  3. MANIFEST.in
  4. Makefile
  5. README.md
  6. VERSION
  7. go/
  8. protos/
  9. python/
  10. setup.py
  11. test/
  12. tox.ini
README.md

voltha-protos

Protobuf files used by VOLTHA.

Currently this is used to generate both Golang and Python protobufs and gRPC stubs.

Protobuf definition files are located in protos/voltha_protos directory. This directory hierarchy and import scheme is required to allow the python code generated by the gRPC compiler to have the correct import paths.

NOTE: The protos/google/api directory has files copied from the Google APIs, and is only included for initial compilation of the VOLTHA protobuf files - these API's should be installed independently via either the python googleapis-common-protos package or the golang go-genproto repo.

Go Environment

Get the voltha-protos repository:

mkdir -p ~/source
cd ~/source
git clone https://gerrit.opencord.org/voltha-protos
cd voltha-protos

Setting up the Go environment

After installing Go on a Mac or Linux environment, the GOPATH environment variable needs be set. These instructions assume it's ~/go.

Create a symbolic link in the $GOPATH/src tree to the voltha-go repository:

mkdir -p $GOPATH/src/github.com/opencord
ln -s ~/source/voltha-protos $GOPATH/src/github.com/opencord/voltha-protos

Go Dependencies

Install Dependencies

Checkout and go install correct version of protoc-gen-go:

cd $GOPATH/src/github.com/opencord/voltha-protos
go get -d github.com/golang/protobuf/
cd $GOPATH/src/github.com/golang/protobuf
git checkout v1.3.1
make install

Building locally

Install libprotoc 3.7.0 manually or use the Makefile target install it. Then build the python and golang stubs:

cd $GOPATH/src/github.com/opencord/voltha-protos
make install-protoc
make build

use dist/*.tar.gz for local python imports use go/ for local go imports

Using voltha-protos in your project

Python

Installation from Pypi:

pip install voltha-protos

or from a local build:

pip install ~/source/voltha-protos/dist/*.tar.gz

To use it within your code (for example)

from voltha_protos import voltha_pb2

Go

go get github.com/opencord/voltha-protos
cd $GOPATH/github.com/opencord/voltha-protos
make build

Protos are importable from github.com/opencord/voltha-protos/go/<packagename>

To use the libraries, import protos with the root path github.com/opencord/voltha-protos/go/

Testing

make test will run tests for all languages.