Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-protos / 1df4e7130585be99780bb99c6095f7ddc3896392
commit1df4e7130585be99780bb99c6095f7ddc3896392[log] [tgz]
authorWilliam Kurkian <wkurkian@cisco.com>Fri Jun 07 17:08:26 2019 -0400
committerWilliam Kurkian <wkurkian@cisco.com>Fri Jun 07 17:08:26 2019 -0400
treeff4cc1c47c62c3bec1cb1df50b301d7156a4ed33
parent4b0dab2699ecc30ef043b4113e6a754e5c4342e7 [diff]
VOL-1688 Fixing subtle error where multiple dist versions can exist if the version file is updated without a make clean. This can cause the wrong version to be loaded in local builds

Change-Id: I18ee71fa6875aae70ace6c9861926c4b3b43644b
1 file changed
tree: ff4cc1c47c62c3bec1cb1df50b301d7156a4ed33
  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.