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 PYANG:= pyang
  21 PYBINDPLUGIN:=$(shell /usr/bin/env python3 -c \
  22                     'import pyangbind; import os; print("{}/plugin".format(os.path.dirname(pyangbind.__file__)))')
  23
  24 YANG_DESC_MODELS := vnfd nsd nst nsi
  25 YANG_RECORD_MODELS := vnfr nsr
  26 PYTHON_MODELS := $(addsuffix .py, $(YANG_DESC_MODELS))
  27 YANG_DESC_TREES := $(addsuffix .tree.txt, $(YANG_DESC_MODELS))
  28 YANG_DESC_JSTREES := $(addsuffix .html, $(YANG_DESC_MODELS))
  29 YANG_RECORD_TREES := $(addsuffix .rec.tree.txt, $(YANG_RECORD_MODELS))
  30 YANG_RECORD_JSTREES := $(addsuffix .rec.html, $(YANG_RECORD_MODELS))
  31 OPENAPI_SCHEMAS := osm.yaml
  32
  33 OUT_DIR := osm_im
  34 TREES_DIR := osm_im_trees
  35 MODEL_DIR := models/yang
  36 Q?=@
  37
  38 PYANG_OPTIONS := -Werror
  39
  40 all: $(PYTHON_MODELS) trees openapi_schemas
  41         $(MAKE) package
  42
  43 trees: $(YANG_DESC_TREES) $(YANG_DESC_JSTREES) $(YANG_RECORD_TREES) $(YANG_RECORD_JSTREES)
  44
  45 openapi_schemas: $(OPENAPI_SCHEMAS)
  46
  47 $(OUT_DIR):
  48         $(Q)mkdir -p $(OUT_DIR)
  49         $(Q)touch $(OUT_DIR)/__init__.py
  50
  51 $(TREES_DIR):
  52         $(Q)mkdir -p $(TREES_DIR)
  53
  54 %.py: $(OUT_DIR) yang-ietf
  55         $(Q)echo generating $@ from $*.yang
  56         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) --plugindir $(PYBINDPLUGIN) -f pybind -o $(OUT_DIR)/$@ $(MODEL_DIR)/$*.yang
  57
  58 %.tree.txt: $(TREES_DIR) yang-ietf
  59         $(Q)echo generating $@ from $*.yang
  60         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f tree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
  61
  62 %.html: $(TREES_DIR) yang-ietf
  63         $(Q)echo generating $@ from $*.yang
  64         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f jstree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
  65         $(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)/$@
  66         $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
  67
  68 %.rec.tree.txt: $(TREES_DIR) yang-ietf
  69         $(Q)echo generating $@ from $*.yang
  70         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f tree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
  71         $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.tree.txt
  72
  73 %.rec.html: $(TREES_DIR) yang-ietf
  74         $(Q)echo generating $@ from $*.yang
  75         $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f jstree -o $(TREES_DIR)/$@ $(MODEL_DIR)/rw-project.yang $(MODEL_DIR)/$*.yang
  76         $(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)/$@
  77         $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
  78         $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.html
  79
  80 osm.yaml: $(OUT_DIR) yang-ietf yang2swagger
  81         $(Q)echo generating $@
  82         $(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)/$@
  83
  84 yang-ietf:
  85         $(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
  86         $(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
  87
  88 yang2swagger:
  89         $(Q)mkdir -p ${HOME}/.m2
  90         $(Q)wget -q -O ${HOME}/.m2/settings.xml https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml
  91         git clone https://github.com/bartoszm/yang2swagger.git
  92         mvn -f yang2swagger/pom.xml clean install
  93
  94 package:
  95         tox -e build
  96         tox -e build3
  97         ./build-docs.sh
  98
  99 deps:
 100         $(Q)sudo apt-get -y install git make wget python python-pip debhelper dh-make tox python3 python3-pip maven
 101         $(Q)sudo -H python3 -m pip install -U pip
 102         $(Q)sudo -H python2 -m pip install -U pip
 103         $(Q)sudo -H python3 -m pip install -U pyang pyangbind stdeb
 104         $(Q)sudo -H python2 -m pip install -U pyang pyangbind stdeb
 105         $(Q)mkdir -p ~/.m2
 106         $(Q)cp -n ~/.m2/settings.xml{,.orig} ; wget -q -O - https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml > ~/.m2/settings.xml
 107
 108 clean:
 109         $(Q)rm -rf dist osm_im.egg-info deb deb_dist *.gz yang2swagger $(OUT_DIR) $(TREES_DIR)