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 yang-ietf openapi_schemas yang2swagger
  20 JAVA := /usr/lib/jvm/java-19-openjdk-amd64/bin/java
  21 PYANG := pyang
  22 ifeq ($(OS),Windows_NT)     # is Windows_NT on XP, 2000, 7, Vista, 10...
  23     PYTHON_INTERPRETER := python
  24 else
  25     PYTHON_INTERPRETER := python3
  26 endif
  27 PYBINDPLUGIN := $(shell $(PYTHON_INTERPRETER) -c \
  28     'import pyangbind; import os; print(os.path.join(f"{os.path.dirname(pyangbind.__file__)}", "plugin"))')
  29
  30 YANG_DESC_MODELS := vnfd nsd nst nsi etsi-nfv-vnfd etsi-nfv-nsd
  31 YANG_RECORD_MODELS := vnfr nsr
  32 PYTHON_MODELS := $(addsuffix .py, $(YANG_DESC_MODELS))
  33 YANG_DESC_TREES := $(addsuffix .tree.txt, $(YANG_DESC_MODELS))
  34 YANG_DESC_JSTREES := $(addsuffix .html, $(YANG_DESC_MODELS))
  35 YANG_RECORD_TREES := $(addsuffix .rec.tree.txt, $(YANG_RECORD_MODELS))
  36 YANG_RECORD_JSTREES := $(addsuffix .rec.html, $(YANG_RECORD_MODELS))
  37 OPENAPI_SCHEMAS := osm.yaml
  38
  39 OUT_DIR := osm_im
  40 TREES_DIR := osm_im_trees
  41 MODEL_DIR := models/yang
  42 SOL006_MODEL_DIR := sol006_model/src/yang
  43 SOL006_AUGMENTS_DIR := models/augments/*
  44
  45 Q?=@
  46
  47 PYANG_OPTIONS := -Werror
  48
  49 all: models trees openapi_schemas
  50         $(MAKE) package
  51
  52 models: sol006_deps $(PYTHON_MODELS) rename_etsi_nfv_py
  53
  54 trees: $(YANG_DESC_TREES) $(YANG_DESC_JSTREES)
  55
  56 openapi_schemas: $(OPENAPI_SCHEMAS)
  57
  58 $(TREES_DIR):
  59         $(Q)mkdir -p $(TREES_DIR)
  60
  61 %.py: yang-ietf
  62         $(Q)echo generating $@ from $*.yang
  63         $(if $(findstring etsi,$@), $(eval DIR=$(SOL006_MODEL_DIR)),$(eval DIR=$(MODEL_DIR)))
  64         $(if $(findstring etsi,$@), $(eval AUGMENTS_DIR=$(SOL006_AUGMENTS_DIR)),$(eval AUGMENTS_DIR=))
  65         $(Q)pyang $(PYANG_OPTIONS) --path $(DIR) --plugindir "$(PYBINDPLUGIN)" -f pybind -o $(OUT_DIR)/$@ $(AUGMENTS_DIR) $(DIR)/$*.yang
  66
  67 %.tree.txt: $(TREES_DIR) yang-ietf
  68         $(Q)echo generating $@ from $*.yang
  69         $(if $(findstring etsi,$@), $(eval DIR=$(SOL006_MODEL_DIR)),$(eval DIR = $(MODEL_DIR)))
  70         $(if $(findstring etsi,$@), $(eval AUGMENTS_DIR=$(SOL006_AUGMENTS_DIR)),$(eval AUGMENTS_DIR=))
  71         $(Q)pyang $(PYANG_OPTIONS) --path $(DIR) -f tree -o $(TREES_DIR)/$@ $(DIR)/$*.yang $(AUGMENTS_DIR)
  72
  73 %.html: $(TREES_DIR) yang-ietf
  74         $(Q)echo generating $@ from $*.yang
  75         $(if $(findstring etsi,$@), $(eval DIR=$(SOL006_MODEL_DIR)),$(eval DIR = $(MODEL_DIR)))
  76         $(if $(findstring etsi,$@), $(eval AUGMENTS_DIR=$(SOL006_AUGMENTS_DIR)),$(eval AUGMENTS_DIR=))
  77         $(Q)pyang $(PYANG_OPTIONS) --path $(DIR) -f jstree -o $(TREES_DIR)/$@ $(DIR)/$*.yang $(AUGMENTS_DIR)
  78         $(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)/$@
  79         $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
  80
  81 %.rec.tree.txt: $(TREES_DIR) yang-ietf
  82         $(Q)echo generating $@ from $*.yang
  83         $(if $(findstring etsi,$@), $(eval DIR=$(SOL006_MODEL_DIR)),$(eval DIR=$(MODEL_DIR)))
  84         $(Q)pyang $(PYANG_OPTIONS) --path $(DIR) -f tree -o $(TREES_DIR)/$@ $(DIR)/$*.yang
  85         $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.tree.txt
  86
  87 %.rec.html: $(TREES_DIR) yang-ietf
  88         $(Q)echo generating $@ from $*.yang
  89         $(if $(findstring etsi,$@), $(eval DIR=$(SOL006_MODEL_DIR)),$(eval DIR=$(MODEL_DIR)))
  90         $(Q)pyang $(PYANG_OPTIONS) --path $(DIR) -f jstree -o $(TREES_DIR)/$@ $(DIR)/osm-project.yang $(DIR)/$*.yang
  91         $(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)/$@
  92         $(Q)sed -r -i 's|<a href=\"http://www.tail-f.com">|<a href="http://osm.etsi.org">|g' $(TREES_DIR)/$@
  93         $(Q)mv $(TREES_DIR)/$@ $(TREES_DIR)/$*.html
  94
  95 osm.yaml: yang-ietf yang2swagger
  96         $(Q)echo generating $@
  97         $(Q)$(JAVA) -jar ${HOME}/.m2/repository/com/mrv/yangtools/swagger-generator-cli/2.1.0/swagger-generator-cli-2.1.0-executable.jar -yang-dir $(MODEL_DIR) -output $(OUT_DIR)/$@
  98
  99 yang-ietf:
 100         $(Q)wget -q https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-yang-types%402013-07-15.yang -O $(MODEL_DIR)/ietf-yang-types.yang
 101         $(Q)wget -q https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-inet-types%402013-07-15.yang -O $(MODEL_DIR)/ietf-inet-types.yang
 102         $(Q)cp $(MODEL_DIR)/ietf-yang-types.yang $(SOL006_MODEL_DIR)/ietf-yang-types.yang
 103         $(Q)cp $(MODEL_DIR)/ietf-inet-types.yang $(SOL006_MODEL_DIR)/ietf-inet-types.yang
 104
 105 yang2swagger:
 106         $(Q)mkdir -p ${HOME}/.m2
 107         $(Q)wget -q -O ${HOME}/.m2/settings.xml https://raw.githubusercontent.com/opendaylight/odlparent/master/settings.xml
 108         $(Q)git clone https://github.com/bartoszm/yang2swagger.git
 109         $(Q)git -C yang2swagger checkout tags/2.1.0
 110         $(Q)mvn -f yang2swagger/pom.xml clean install
 111
 112 package:
 113         ./build-docs.sh
 114
 115 sol006_deps:
 116         $(Q)git clone --single-branch --branch v2.6.1 https://forge.etsi.org/rep/nfv/SOL006.git sol006_model
 117         $(Q)patch -p2 < patch/deref_warnings.patch
 118         $(Q)patch -p2 < patch/nested_workaround.patch
 119
 120 rename_etsi_nfv_py:
 121         mv osm_im/etsi-nfv-nsd.py osm_im/etsi_nfv_nsd.py
 122         mv osm_im/etsi-nfv-vnfd.py osm_im/etsi_nfv_vnfd.py
 123
 124 clean:
 125         $(Q)rm -rf dist sol006_model osm_im.egg-info deb deb_dist *.gz osm-imdocs* yang2swagger $(TREES_DIR)
 126         $(Q)rm -rf debian/osm-imdocs.install
 127         $(Q)rm -rf osm_im/etsi_nfv_nsd.py osm_im/etsi_nfv_vnfd.py
 128         $(Q)rm -rf osm_im/nsd.py osm_im/nsi.py osm_im/nst.py osm_im/osm.yaml osm_im/vnfd.py