Makefile

   1 # Copyright 2017 Sandvine
   2 # Copyright 2017-2018 Telefonica
   3 # All Rights Reserved.
   4 #
   5 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   6 #    not use this file except in compliance with the License. You may obtain
   7 #    a copy of the License at
   8 #
   9 #         http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #    Unless required by applicable law or agreed to in writing, software
  12 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14 #    License for the specific language governing permissions and limitations
  15 #    under the License.
  16
  17 # NOTE: pyang and pyangbind are required for build
  18
  19 .PHONY: all clean package trees deps yang-ietf openapi_schemas yang2swagger
  20 JAVA:=/usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java
  21 PYANG:= pyang
  22 PYBINDPLUGIN:=$(shell /usr/bin/env python3 -c \
  23                     'import pyangbind; import os; print("{}/plugin".format(os.path.dirname(pyangbind.__file__)))')
  24
  25 YANG_DESC_MODELS := vnfd nsd nst nsi
  26 YANG_RECORD_MODELS := vnfr nsr
  27 PYTHON_MODELS := $(addsuffix .py, $(YANG_DESC_MODELS))
  28 YANG_DESC_TREES := $(addsuffix .tree.txt, $(YANG_DESC_MODELS))
  29 YANG_DESC_JSTREES := $(addsuffix .html, $(YANG_DESC_MODELS))
  30 YANG_RECORD_TREES := $(addsuffix .rec.tree.txt, $(YANG_RECORD_MODELS))
  31 YANG_RECORD_JSTREES := $(addsuffix .rec.html, $(YANG_RECORD_MODELS))
  32 OPENAPI_SCHEMAS := osm.yaml
  33
  34 OUT_DIR := osm_im
  35 TREES_DIR := osm_im_trees
  36 MODEL_DIR := models/yang
  37 Q?=@
  38
  39 PYANG_OPTIONS := -Werror
  40
  41 all: $(PYTHON_MODELS) trees openapi_schemas
  42         $(MAKE) package
  43
  44 trees: $(YANG_DESC_TREES) $(YANG_DESC_JSTREES) $(YANG_RECORD_TREES) $(YANG_RECORD_JSTREES)
  45
  46 openapi_schemas: $(OPENAPI_SCHEMAS)
  47
  48 $(TREES_DIR):
  49         $(Q)mkdir -p $(TREES_DIR)
  50
  51 %.py: yang-ietf
  52         $(Q)echo generating $@ from $*.yang
  53         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) --plugindir $(PYBINDPLUGIN) -f pybind -o $(OUT_DIR)/$@ $(MODEL_DIR)/$*.yang
  54
  55 %.tree.txt: $(TREES_DIR) yang-ietf
  56         $(Q)echo generating $@ from $*.yang
  57         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f tree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
  58
  59 %.html: $(TREES_DIR) yang-ietf
  60         $(Q)echo generating $@ from $*.yang
  61         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f jstree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
  62         $(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)/$@
  63         $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
  64
  65 %.rec.tree.txt: $(TREES_DIR) yang-ietf
  66         $(Q)echo generating $@ from $*.yang
  67         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f tree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
  68         $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.tree.txt
  69
  70 %.rec.html: $(TREES_DIR) yang-ietf
  71         $(Q)echo generating $@ from $*.yang
  72         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f jstree -o $(TREES_DIR)/$@ $(MODEL_DIR)/osm-project.yang $(MODEL_DIR)/$*.yang
  73         $(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)/$@
  74         $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
  75         $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.html
  76
  77 osm.yaml: yang-ietf yang2swagger
  78         $(Q)echo generating $@
  79         $(Q)$(JAVA) -jar ${HOME}/.m2/repository/com/mrv/yangtools/swagger-generator-cli/1.1.11/swagger-generator-cli-1.1.11-executable.jar -yang-dir $(MODEL_DIR) -output $(OUT_DIR)/$@
  80
  81 yang-ietf:
  82         $(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
  83         $(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
  84
  85 yang2swagger:
  86         $(Q)mkdir -p ${HOME}/.m2
  87         $(Q)wget -q -O ${HOME}/.m2/settings.xml https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml
  88         git clone https://github.com/bartoszm/yang2swagger.git
  89         git -C yang2swagger checkout tags/1.1.11
  90         mvn -f yang2swagger/pom.xml clean install
  91
  92 package:
  93         tox -e build
  94         tox -e build3
  95         ./build-docs.sh
  96
  97 deps:
  98         $(Q)sudo apt-get -y install git make wget python python-pip debhelper dh-make tox python3 python3-pip maven
  99         $(Q)sudo -H python3 -m pip install -U pip
 100         $(Q)sudo -H python2 -m pip install -U pip
 101         $(Q)sudo -H python3 -m pip install -U pyang pyangbind stdeb
 102         $(Q)sudo -H python2 -m pip install -U pyang pyangbind stdeb
 103         $(Q)mkdir -p ~/.m2
 104         $(Q)cp -n ~/.m2/settings.xml{,.orig} ; wget -q -O - https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml > ~/.m2/settings.xml
 105
 106 clean:
 107         $(Q)rm -rf dist osm_im.egg-info deb deb_dist *.gz osm-imdocs* yang2swagger $(TREES_DIR)