VOL-1448: Initial checkin of pyvoltha repository
This is very early work and unit tests are not currently running.
Future versions of this code will remove the protobuf directory
and address any v2.0 API changes such as the key-value store API
used by various libraries in pyvoltha
- Added .gitreview config file
- Moved VERSION file to expected location and specified a dev version
so no git tags or PyPI publishing occurs until we are ready.
- Removed generated .desc protobuf files
Change-Id: Icaedc6a4d2cff87cd7d538d3610586d0f5a5db18
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..cb917b6
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,132 @@
+#
+# Copyright 2018 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+VENVDIR := venv-$(shell uname -s | tr '[:upper:]' '[:lower:]')
+
+VENV_BIN ?= virtualenv
+VENV_OPTS ?=
+
+.PHONY: $(DIRS) $(DIRS_CLEAN) $(DIRS_FLAKE8) flake8 protos venv rebuild-venv clean distclean build test
+
+# This should to be the first and default target in this Makefile
+help:
+ @echo "Usage: make [<target>]"
+ @echo "where available targets are:"
+ @echo
+ @echo "build : Build the protos"
+ @echo "dist : Build the protos and create the python package"
+ @echo "test : Run all unit test"
+ @echo "clean : Remove files created by the build and tests"
+ @echo "distclean : Remove venv directory"
+ @echo "help : Print this help"
+ @echo "protos : Compile all grpc/protobuf files"
+ @echo "rebuild-venv : Rebuild local Python virtualenv from scratch"
+ @echo "venv : Build local Python virtualenv if did not exist yet"
+ @echo
+
+## New directories can be added here
+#DIRS:=
+
+## If one directory depends on another directory that
+## dependency can be expressed here
+##
+## For example, if the Tibit directory depended on the eoam
+## directory being built first, then that can be expressed here.
+## driver/tibit: eoam
+
+# Parallel Build
+$(DIRS):
+ @echo " MK $@"
+ $(Q)$(MAKE) -C $@
+
+# Parallel Clean
+DIRS_CLEAN = $(addsuffix .clean,$(DIRS))
+$(DIRS_CLEAN):
+ @echo " CLEAN $(basename $@)"
+ $(Q)$(MAKE) -C $(basename $@) clean
+
+# Parallel Flake8
+DIRS_FLAKE8 = $(addsuffix .flake8,$(DIRS))
+$(DIRS_FLAKE8):
+ @echo " FLAKE8 $(basename $@)"
+ -$(Q)$(MAKE) -C $(basename $@) flake8
+
+build: protos
+
+protos:
+ make -C pyvoltha/protos
+
+dist: venv protos
+ @ echo "Creating PyPi artifacts"
+ python setup.py sdist
+
+upload: dist
+ @ echo "Uploading PyPi artifacts"
+ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+ twine upload dist/*
+
+install-protoc:
+ make -C pyvoltha/protos install-protoc
+
+test: venv protos
+ @ echo "Executing all unit tests"
+ @ . ${VENVDIR}/bin/activate && tox
+# @ . ${VENVDIR}/bin/activate && make -C test utest
+
+COVERAGE_OPTS=--with-xcoverage --with-xunit --cover-package=voltha,common,ofagent --cover-html\
+ --cover-html-dir=tmp/cover
+
+utest-with-coverage: venv protos
+ @ echo "Executing all unit tests and producing coverage results"
+ @ . ${VENVDIR}/bin/activate && nosetests $(COVERAGE_OPTS) pyvoltha/tests/utests
+
+clean:
+ find . -name '*.pyc' | xargs rm -f
+ find . -name 'coverage.xml' | xargs rm -f
+ find . -name 'nosetests.xml' | xargs rm -f
+ rm -f pyvoltha/protos/*_pb2.py
+ rm -f pyvoltha/protos/*_pb2_grpc.py
+ rm -f pyvoltha/protos/*.desc
+ rm -rf PyVoltha.egg-info
+ rm -rf dist
+
+distclean: clean
+ rm -rf ${VENVDIR}
+
+purge-venv:
+ rm -fr ${VENVDIR}
+
+rebuild-venv: purge-venv venv
+
+venv: ${VENVDIR}/.built
+
+${VENVDIR}/.built:
+ @ $(VENV_BIN) ${VENV_OPTS} ${VENVDIR}
+ @ $(VENV_BIN) ${VENV_OPTS} --relocatable ${VENVDIR}
+ @ . ${VENVDIR}/bin/activate && \
+ pip install --upgrade pip; \
+ if ! pip install -r requirements.txt; \
+ then \
+ echo "On MAC OS X, if the installation failed with an error \n'<openssl/opensslv.h>': file not found,"; \
+ echo "see the BUILD.md file for a workaround"; \
+ else \
+ uname -s > ${VENVDIR}/.built; \
+ fi
+ @ $(VENV_BIN) ${VENV_OPTS} --relocatable ${VENVDIR}
+
+
+flake8: $(DIRS_FLAKE8)
+
+# end file