Adding support to different ingress and egress ports (SFC)
[osm/IM.git] / Makefile
index 62643b0..990b4eb 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,5 @@
 # Copyright 2017 Sandvine
 # Copyright 2017 Sandvine
+# Copyright 2017-2018 Telefonica
 # All Rights Reserved.
 # 
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
 # All Rights Reserved.
 # 
 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
 
 # NOTE: pyang and pyangbind are required for build
 
 
 # NOTE: pyang and pyangbind are required for build
 
+.PHONY: all clean package trees deps yang-ietf openapi_schemas yang2swagger
 PYANG:= pyang
 PYANG:= pyang
-PYBINDPLUGIN:=$(shell /usr/bin/env python -c \
-                   'import pyangbind; import os; print "%s/plugin" % os.path.dirname(pyangbind.__file__)')
+PYBINDPLUGIN:=$(shell /usr/bin/env python3 -c \
+                   'import pyangbind; import os; print("{}/plugin".format(os.path.dirname(pyangbind.__file__)))')
 
 
-YANG_MODELS := vnfd nsd
-PYTHON_MODELS := $(addsuffix .py, $(YANG_MODELS))
-PYTHON_JSONSCHEMAS := $(addsuffix .jsonschema, $(YANG_MODELS))
+YANG_DESC_MODELS := vnfd nsd nst nsi
+YANG_RECORD_MODELS := vnfr nsr
+PYTHON_MODELS := $(addsuffix .py, $(YANG_DESC_MODELS))
+YANG_DESC_TREES := $(addsuffix .tree.txt, $(YANG_DESC_MODELS))
+YANG_DESC_JSTREES := $(addsuffix .html, $(YANG_DESC_MODELS))
+YANG_RECORD_TREES := $(addsuffix .rec.tree.txt, $(YANG_RECORD_MODELS))
+YANG_RECORD_JSTREES := $(addsuffix .rec.html, $(YANG_RECORD_MODELS))
+OPENAPI_SCHEMAS := osm.yaml
 
 OUT_DIR := osm_im
 
 OUT_DIR := osm_im
+TREES_DIR := osm_im_trees
 MODEL_DIR := models/yang
 MODEL_DIR := models/yang
-RW_PB_EXT := build/yang/rw-pb-ext.yang
 Q?=@
 
 PYANG_OPTIONS := -Werror
 
 Q?=@
 
 PYANG_OPTIONS := -Werror
 
-all: $(PYTHON_MODELS) pyangbind $(PYTHON_JSONSCHEMAS)
+all: $(PYTHON_MODELS) trees openapi_schemas
        $(MAKE) package
 
        $(MAKE) package
 
+trees: $(YANG_DESC_TREES) $(YANG_DESC_JSTREES) $(YANG_RECORD_TREES) $(YANG_RECORD_JSTREES)
+
+openapi_schemas: $(OPENAPI_SCHEMAS)
+
 $(OUT_DIR):
        $(Q)mkdir -p $(OUT_DIR)
        $(Q)touch $(OUT_DIR)/__init__.py
 
 $(OUT_DIR):
        $(Q)mkdir -p $(OUT_DIR)
        $(Q)touch $(OUT_DIR)/__init__.py
 
-%.py: $(OUT_DIR) $(RW_PB_EXT)
+$(TREES_DIR):
+       $(Q)mkdir -p $(TREES_DIR)
+
+%.py: $(OUT_DIR) yang-ietf
+       $(Q)echo generating $@ from $*.yang
+       $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) --plugindir $(PYBINDPLUGIN) -f pybind -o $(OUT_DIR)/$@ $(MODEL_DIR)/$*.yang
+
+%.tree.txt: $(TREES_DIR) yang-ietf
+       $(Q)echo generating $@ from $*.yang
+       $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f tree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
+
+%.html: $(TREES_DIR) yang-ietf
+       $(Q)echo generating $@ from $*.yang
+       $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f jstree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
+       $(Q)sed -r -i 's|data\:image/gif\;base64,R0lGODlhS.*RCAA7|https://osm.etsi.org/images/OSM-logo.png\" width=\"175\" height=\"60|g' $(TREES_DIR)/$@
+       $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
+
+%.rec.tree.txt: $(TREES_DIR) yang-ietf
        $(Q)echo generating $@ from $*.yang
        $(Q)echo generating $@ from $*.yang
-       $(Q)pyang $(PYANG_OPTIONS) --path build/yang --path $(MODEL_DIR) --plugindir $(PYBINDPLUGIN) -f pybind -o $(OUT_DIR)/$@ $(MODEL_DIR)/$*.yang
+       $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f tree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
+       $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.tree.txt
 
 
-%.jsonschema: $(OUT_DIR) $(RW_PB_EXT) pyang-json-schema-plugin
+%.rec.html: $(TREES_DIR) yang-ietf
        $(Q)echo generating $@ from $*.yang
        $(Q)echo generating $@ from $*.yang
-       $(Q)pyang $(PYANG_OPTIONS) --path build/yang --path $(MODEL_DIR) --plugindir pyang-json-schema-plugin -f json-schema -o $(OUT_DIR)/$@ $(MODEL_DIR)/$*.yang
+       $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f jstree -o $(TREES_DIR)/$@ $(MODEL_DIR)/rw-project.yang $(MODEL_DIR)/$*.yang
+       $(Q)sed -r -i 's|data\:image/gif\;base64,R0lGODlhS.*RCAA7|https://osm.etsi.org/images/OSM-logo.png\" width=\"175\" height=\"60|g' $(TREES_DIR)/$@
+       $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
+       $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.html
 
 
-$(RW_PB_EXT):
-       $(Q)mkdir -p $$(dirname $@)
-       $(Q)wget -q https://raw.githubusercontent.com/RIFTIO/RIFT.ware/RIFT.ware-4.4.1/modules/core/util/yangtools/yang/rw-pb-ext.yang -O $@
+osm.yaml: $(OUT_DIR) yang-ietf yang2swagger
+       $(Q)echo generating $@
+       $(Q)java -jar ${HOME}/.m2/repository/com/mrv/yangtools/swagger-generator-cli/*-SNAPSHOT/swagger-generator-cli-*-SNAPSHOT-executable.jar -yang-dir $(MODEL_DIR) -output $(OUT_DIR)/$@
+
+yang-ietf:
+       $(Q)wget -q https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-yang-types%402013-07-15.yang -O models/yang/ietf-yang-types.yang
+       $(Q)wget -q https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-inet-types%402013-07-15.yang -O models/yang/ietf-inet-types.yang
+
+yang2swagger:
+       $(Q)mkdir -p ${HOME}/.m2
+       $(Q)wget -q -O ${HOME}/.m2/settings.xml https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml
+       git clone https://github.com/bartoszm/yang2swagger.git
+       mvn -f yang2swagger/pom.xml clean install
 
 package:
        tox -e build
 
 package:
        tox -e build
+       tox -e build3
+       ./build-docs.sh
 
 
-pyangbind:
-       git clone https://github.com/robshakir/pyangbind
-       cd pyangbind; python setup.py --command-packages=stdeb.command bdist_deb; cd ..
-
-pyang-json-schema-plugin:
-       git clone https://github.com/cmoberg/pyang-json-schema-plugin
+deps:
+       $(Q)sudo apt-get -y install git make wget python python-pip debhelper dh-make tox python3 python3-pip maven
+       $(Q)sudo -H python3 -m pip install -U pip
+       $(Q)sudo -H python2 -m pip install -U pip
+       $(Q)sudo -H python3 -m pip install -U pyang pyangbind stdeb
+       $(Q)sudo -H python2 -m pip install -U pyang pyangbind stdeb
+       $(Q)mkdir -p ~/.m2
+       $(Q)cp -n ~/.m2/settings.xml{,.orig} ; wget -q -O - https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml > ~/.m2/settings.xml
 
 clean:
 
 clean:
-       $(Q)rm -rf build dist osm_im.egg-info deb deb_dist *.gz pyangbind $(OUT_DIR)
+       $(Q)rm -rf dist osm_im.egg-info deb deb_dist *.gz yang2swagger $(OUT_DIR) $(TREES_DIR)