blob: 6913a99a8b41df45d4461ad22055704032f4fdf3 [file] [log] [blame]
Mike Marchetti94b645e2017-08-04 14:33:54 -04001# Copyright 2017 Sandvine
garciadeblase6ba40a2018-09-27 18:07:38 +02002# Copyright 2017-2018 Telefonica
Mike Marchetti94b645e2017-08-04 14:33:54 -04003# 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
garciadeblas878dee42018-10-28 16:12:42 +010019.PHONY: all clean package trees deps yang-ietf openapi_schemas yang2swagger
garciadeblasd6e6ffb2019-04-09 15:12:05 +020020JAVA:=/usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java
Mike Marchetti94b645e2017-08-04 14:33:54 -040021PYANG:= pyang
Mike Marchettice4a73d2018-08-29 15:40:41 -040022PYBINDPLUGIN:=$(shell /usr/bin/env python3 -c \
23 'import pyangbind; import os; print("{}/plugin".format(os.path.dirname(pyangbind.__file__)))')
Mike Marchetti94b645e2017-08-04 14:33:54 -040024
jdelacruz27797532018-09-18 19:16:16 +020025YANG_DESC_MODELS := vnfd nsd nst nsi
garciadeblase4eafa82017-11-29 17:34:36 +010026YANG_RECORD_MODELS := vnfr nsr
27PYTHON_MODELS := $(addsuffix .py, $(YANG_DESC_MODELS))
garciadeblase4eafa82017-11-29 17:34:36 +010028YANG_DESC_TREES := $(addsuffix .tree.txt, $(YANG_DESC_MODELS))
29YANG_DESC_JSTREES := $(addsuffix .html, $(YANG_DESC_MODELS))
30YANG_RECORD_TREES := $(addsuffix .rec.tree.txt, $(YANG_RECORD_MODELS))
31YANG_RECORD_JSTREES := $(addsuffix .rec.html, $(YANG_RECORD_MODELS))
garciadeblas878dee42018-10-28 16:12:42 +010032OPENAPI_SCHEMAS := osm.yaml
Mike Marchetti94b645e2017-08-04 14:33:54 -040033
34OUT_DIR := osm_im
garciadeblase4eafa82017-11-29 17:34:36 +010035TREES_DIR := osm_im_trees
Mike Marchetti94b645e2017-08-04 14:33:54 -040036MODEL_DIR := models/yang
Mike Marchetti94b645e2017-08-04 14:33:54 -040037Q?=@
38
garciadeblas5a20e9b2017-08-29 12:25:24 +020039PYANG_OPTIONS := -Werror
Mike Marchetti94b645e2017-08-04 14:33:54 -040040
garciadeblas878dee42018-10-28 16:12:42 +010041all: $(PYTHON_MODELS) trees openapi_schemas
Mike Marchetti94b645e2017-08-04 14:33:54 -040042 $(MAKE) package
43
garciadeblase4eafa82017-11-29 17:34:36 +010044trees: $(YANG_DESC_TREES) $(YANG_DESC_JSTREES) $(YANG_RECORD_TREES) $(YANG_RECORD_JSTREES)
45
garciadeblas878dee42018-10-28 16:12:42 +010046openapi_schemas: $(OPENAPI_SCHEMAS)
47
Mike Marchetti94b645e2017-08-04 14:33:54 -040048$(OUT_DIR):
49 $(Q)mkdir -p $(OUT_DIR)
50 $(Q)touch $(OUT_DIR)/__init__.py
51
garciadeblase4eafa82017-11-29 17:34:36 +010052$(TREES_DIR):
53 $(Q)mkdir -p $(TREES_DIR)
54
garciadeblasa1744192018-10-28 16:05:18 +010055%.py: $(OUT_DIR) yang-ietf
Mike Marchetti94b645e2017-08-04 14:33:54 -040056 $(Q)echo generating $@ from $*.yang
garciadeblasbc0dd142018-10-28 15:54:24 +010057 $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) --plugindir $(PYBINDPLUGIN) -f pybind -o $(OUT_DIR)/$@ $(MODEL_DIR)/$*.yang
Mike Marchetti94b645e2017-08-04 14:33:54 -040058
garciadeblasa1744192018-10-28 16:05:18 +010059%.tree.txt: $(TREES_DIR) yang-ietf
garciadeblase4eafa82017-11-29 17:34:36 +010060 $(Q)echo generating $@ from $*.yang
garciadeblasbc0dd142018-10-28 15:54:24 +010061 $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f tree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
garciadeblase4eafa82017-11-29 17:34:36 +010062
garciadeblasa1744192018-10-28 16:05:18 +010063%.html: $(TREES_DIR) yang-ietf
garciadeblase4eafa82017-11-29 17:34:36 +010064 $(Q)echo generating $@ from $*.yang
garciadeblasbc0dd142018-10-28 15:54:24 +010065 $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f jstree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
garciadeblase06b0aa2017-12-19 09:21:31 +010066 $(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)/$@
67 $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
garciadeblase4eafa82017-11-29 17:34:36 +010068
garciadeblasa1744192018-10-28 16:05:18 +010069%.rec.tree.txt: $(TREES_DIR) yang-ietf
garciadeblase4eafa82017-11-29 17:34:36 +010070 $(Q)echo generating $@ from $*.yang
garciadeblasbc0dd142018-10-28 15:54:24 +010071 $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f tree -o $(TREES_DIR)/$@ $(MODEL_DIR)/$*.yang
garciadeblase4eafa82017-11-29 17:34:36 +010072 $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.tree.txt
73
garciadeblasa1744192018-10-28 16:05:18 +010074%.rec.html: $(TREES_DIR) yang-ietf
garciadeblase4eafa82017-11-29 17:34:36 +010075 $(Q)echo generating $@ from $*.yang
garciadeblasbc0dd142018-10-28 15:54:24 +010076 $(Q)pyang $(PYANG_OPTIONS) --path $(MODEL_DIR) -f jstree -o $(TREES_DIR)/$@ $(MODEL_DIR)/rw-project.yang $(MODEL_DIR)/$*.yang
garciadeblase06b0aa2017-12-19 09:21:31 +010077 $(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)/$@
78 $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
garciadeblase4eafa82017-11-29 17:34:36 +010079 $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.html
80
garciadeblas878dee42018-10-28 16:12:42 +010081osm.yaml: $(OUT_DIR) yang-ietf yang2swagger
82 $(Q)echo generating $@
garciadeblasd6e6ffb2019-04-09 15:12:05 +020083 $(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)/$@
garciadeblas878dee42018-10-28 16:12:42 +010084
garciadeblasa1744192018-10-28 16:05:18 +010085yang-ietf:
86 $(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
87 $(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
88
garciadeblas878dee42018-10-28 16:12:42 +010089yang2swagger:
90 $(Q)mkdir -p ${HOME}/.m2
91 $(Q)wget -q -O ${HOME}/.m2/settings.xml https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml
92 git clone https://github.com/bartoszm/yang2swagger.git
garciadeblasd6e6ffb2019-04-09 15:12:05 +020093 git -C yang2swagger checkout tags/1.1.11
garciadeblas878dee42018-10-28 16:12:42 +010094 mvn -f yang2swagger/pom.xml clean install
95
Mike Marchetti94b645e2017-08-04 14:33:54 -040096package:
97 tox -e build
Mike Marchettice4a73d2018-08-29 15:40:41 -040098 tox -e build3
Mike Marchetti09a27102018-09-24 15:05:51 -040099 ./build-docs.sh
100
garciadeblas4cdeebb2018-10-28 16:00:37 +0100101deps:
102 $(Q)sudo apt-get -y install git make wget python python-pip debhelper dh-make tox python3 python3-pip maven
103 $(Q)sudo -H python3 -m pip install -U pip
104 $(Q)sudo -H python2 -m pip install -U pip
105 $(Q)sudo -H python3 -m pip install -U pyang pyangbind stdeb
106 $(Q)sudo -H python2 -m pip install -U pyang pyangbind stdeb
107 $(Q)mkdir -p ~/.m2
108 $(Q)cp -n ~/.m2/settings.xml{,.orig} ; wget -q -O - https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml > ~/.m2/settings.xml
109
Mike Marchetti94b645e2017-08-04 14:33:54 -0400110clean:
garciadeblas878dee42018-10-28 16:12:42 +0100111 $(Q)rm -rf dist osm_im.egg-info deb deb_dist *.gz yang2swagger $(OUT_DIR) $(TREES_DIR)