[sonic-yang-models]: First version of yang models for Port, VLan, Interface, PortChannel, loopback and ACL.

files/build_templates/sonic_debian_extension.j2

@@ -116,6 +116,15 @@ sudo cp {{swsssdk_py2_wheel_path}} $FILESYSTEM_ROOT/$SWSSSDK_PY2_WHEEL_NAME
 sudo https_proxy=$https_proxy LANG=C chroot $FILESYSTEM_ROOT pip install $SWSSSDK_PY2_WHEEL_NAME
 sudo rm -rf $FILESYSTEM_ROOT/$SWSSSDK_PY2_WHEEL_NAME
 
+# Install sonic-yang-models py3 package, install dependencies
+sudo dpkg --root=$FILESYSTEM_ROOT -i $debs_path/libyang_*.deb
+sudo dpkg --root=$FILESYSTEM_ROOT -i $debs_path/libyang-cpp_*.deb
+sudo dpkg --root=$FILESYSTEM_ROOT -i $debs_path/python2-yang_*.deb
+SONIC_YANG_MODEL_PY3_WHEEL_NAME=$(basename {{sonic_yang_models_py3_wheel_path}})
+sudo cp {{sonic_yang_models_py3_wheel_path}} $FILESYSTEM_ROOT/$SONIC_YANG_MODEL_PY3_WHEEL_NAME
+sudo https_proxy=$https_proxy LANG=C chroot $FILESYSTEM_ROOT pip3 install $SONIC_YANG_MODEL_PY3_WHEEL_NAME
+sudo rm -rf $FILESYSTEM_ROOT/$SONIC_YANG_MODEL_PY3_WHEEL_NAME
+
 # Install sonic-platform-common Python 2 package
 PLATFORM_COMMON_PY2_WHEEL_NAME=$(basename {{platform_common_py2_wheel_path}})
 sudo cp {{platform_common_py2_wheel_path}} $FILESYSTEM_ROOT/$PLATFORM_COMMON_PY2_WHEEL_NAME

rules/sonic-yang-models-py3.mk

@@ -0,0 +1,7 @@
+SONIC_YANG_MODELS_PY3 = sonic_yang_models-1.0-py3-none-any.whl
+$(SONIC_YANG_MODELS_PY3)_SRC_PATH = $(SRC_PATH)/sonic-yang-models
+$(SONIC_YANG_MODELS_PY3)_PYTHON_VERSION = 3
+$(SONIC_YANG_MODELS_PY3)_DEBS_DEPENDS = $(LIBYANG)
+
+SONIC_PYTHON_WHEELS += $(SONIC_YANG_MODELS_PY3)
+export SONIC_YANG_MODELS_PY3

slave.mk

@@ -49,6 +49,8 @@ export BUILD_NUMBER
 export BUILD_TIMESTAMP
 export CONFIGURED_PLATFORM
 export CONFIGURED_ARCH
+export STRETCH_DEBS_PATH
+export PYTHON_WHEELS_PATH
 
 ###############################################################################
 ## Utility rules
@@ -524,7 +526,8 @@ SONIC_TARGET_LIST += $(addprefix $(PYTHON_DEBS_PATH)/, $(SONIC_PYTHON_STDEB_DEBS
 #     $(SOME_NEW_WHL)_DEPENDS = $(SOME_OTHER_WHL1) $(SOME_OTHER_WHL2) ...
 #     SONIC_PYTHON_WHEELS += $(SOME_NEW_WHL)
 $(addprefix $(PYTHON_WHEELS_PATH)/, $(SONIC_PYTHON_WHEELS)) : $(PYTHON_WHEELS_PATH)/% : .platform $$(addsuffix -install,$$(addprefix $(PYTHON_WHEELS_PATH)/,$$($$*_DEPENDS))) \
-			$(call dpkg_depend,$(PYTHON_WHEELS_PATH)/%.dep)
+			$(call dpkg_depend,$(PYTHON_WHEELS_PATH)/%.dep) \
+			$$(addsuffix -install,$$(addprefix $(DEBS_PATH)/,$$($$*_DEBS_DEPENDS)))
 
 	$(HEADER)
 
@@ -749,7 +752,8 @@ $(addprefix $(TARGET_PATH)/, $(SONIC_INSTALLERS)) : $(TARGET_PATH)/% : \
         $(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_CONFIG_ENGINE)) \
         $(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_PLATFORM_COMMON_PY2)) \
         $(addprefix $(PYTHON_WHEELS_PATH)/,$(REDIS_DUMP_LOAD_PY2)) \
-        $(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_PLATFORM_API_PY2))
+        $(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_PLATFORM_API_PY2)) \
+        $(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_YANG_MODELS_PY3))
 	$(HEADER)
 	# Pass initramfs and linux kernel explicitly. They are used for all platforms
 	export debs_path="$(STRETCH_DEBS_PATH)"
@@ -778,6 +782,7 @@ $(addprefix $(TARGET_PATH)/, $(SONIC_INSTALLERS)) : $(TARGET_PATH)/% : \
 	export platform_common_py2_wheel_path="$(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_PLATFORM_COMMON_PY2))"
 	export redis_dump_load_py2_wheel_path="$(addprefix $(PYTHON_WHEELS_PATH)/,$(REDIS_DUMP_LOAD_PY2))"
 	export install_debug_image="$(INSTALL_DEBUG_TOOLS)"
+	export sonic_yang_models_py3_wheel_path="$(addprefix $(PYTHON_WHEELS_PATH)/,$(SONIC_YANG_MODELS_PY3))"
 	export multi_instance="false"
 
 	$(foreach docker, $($*_DOCKERS),\

sonic-slave-stretch/Dockerfile.j2

@@ -367,6 +367,13 @@ RUN pip install mockredispy==2.9.3
 RUN pip install pytest-runner==4.4
 RUN pip install setuptools==40.8.0
 
+# For sonic_yang_mgmt build
+RUN pip install ijson==2.6.1
+RUN pip3 install ijson==2.6.1
+RUN pip install jsondiff==1.2.0
+RUN pip install xmltodict==0.12.0
+RUN pip install pyang==2.1.1
+
 # For mgmt-framework build
 RUN pip install mmh3
 

src/sonic-yang-models/AUTHORS.rst

@@ -0,0 +1,14 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+LNOS-CODERS    <lnos-coders@linkedin.com>
+MSFT-LINUX-DEV <linuxnetdev@microsoft.com>
+
+Contributors
+------------
+
+Praveen Chaudhary      <pchaudhary@linkedin.com>

src/sonic-yang-models/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2019 Microsoft, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

src/sonic-yang-models/README.rst

@@ -0,0 +1,4 @@
+"
+This Package contains YANG models for sonic which are written with guidelines mentioned in
+https://github.com/Azure/SONiC/blob/master/doc/mgmt/SONiC_YANG_Model_Guidelines.md.
+"

src/sonic-yang-models/setup.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""The setup script."""
+
+from setuptools import setup, find_packages
+from setuptools.command.build_py import build_py
+from os import system, environ
+from sys import exit
+
+# find path of pkgs from environment vars
+prefix = '/sonic'; debs = environ["STRETCH_DEBS_PATH"]
+deps_path = '{}/{}'.format(prefix, debs)
+# dependencies
+libyang = '{}/{}'.format(deps_path, environ["LIBYANG"])
+libyangCpp = '{}/{}'.format(deps_path, environ["LIBYANG_CPP"])
+libyangPy2 = '{}/{}'.format(deps_path, environ["LIBYANG_PY2"])
+libyangPy3 = '{}/{}'.format(deps_path, environ["LIBYANG_PY3"])
+
+# important reuirements parameters
+build_requirements = [libyang, libyangCpp, libyangPy2, libyangPy3,]
+
+setup_requirements = ['pytest-runner']
+
+test_requirements = ['pytest>=3']
+
+# read me
+with open('README.rst') as readme_file:
+    readme = readme_file.read()
+
+# class for prerequisites to build this package
+class pkgBuild(build_py):
+    """Custom Build PLY"""
+
+    def run (self):
+        #  install libyang
+        for req in build_requirements:
+            if '.deb'in req:
+                pkg_install_cmd = "sudo dpkg -i {}".format(req)
+                if (system(pkg_install_cmd)):
+                    print("{} installation failed".format(req))
+                    exit(1)
+                else:
+                    print("{} installed".format(req))
+
+        # json file for YANG model test cases.
+        test_yangJson_file = './tests/yang_model_tests/yangTest.json'
+        # YANG models are in below dir
+        yang_model_dir = './yang-models/'
+        # yang model tester python module
+        yang_test_py = './tests/yang_model_tests/yangModelTesting.py'
+        #  run tests for yang models
+        test_yang_cmd = "python {} -f {} -y {}".format(yang_test_py, test_yangJson_file, yang_model_dir)
+        if (system(test_yang_cmd)):
+            print("YANG Tests failed\n")
+            # below line will be uncommented after libyang python support PR #
+            exit(1)
+        else:
+            print("YANG Tests passed\n")
+
+        # Generate YANG Tree
+        pyang_tree_cmd = "pyang -f tree ./yang-models/*.yang > ./yang-models/sonic_yang_tree"
+        if (system(pyang_tree_cmd)):
+            print("Failed: {}".format(pyang_tree_cmd))
+        else:
+            print("Passed: {}".format(pyang_tree_cmd))
+
+        # Continue usual build steps
+        build_py.run(self)
+
+setup(
+    cmdclass={
+        'build_py': pkgBuild,
+    },
+    author="lnos-coders",
+    author_email='lnos-coders@linkedin.com',
+    python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*',
+    classifiers=[
+        'Development Status :: 2 - Pre-Alpha',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+        'Natural Language :: English',
+        "Programming Language :: Python :: 2",
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+    ],
+    description="Package contains YANG models for sonic.",
+    tests_require = test_requirements,
+    license="GNU General Public License v3",
+    long_description=readme + '\n\n',
+    include_package_data=True,
+    keywords='sonic_yang_models',
+    name='sonic_yang_models',
+    py_modules=[],
+    packages=find_packages(),
+    setup_requires=setup_requirements,
+    version='1.0',
+    data_files=[
+        ('yang-models', ['./yang-models/sonic-head.yang',
+                         './yang-models/sonic-extension.yang',
+                         './yang-models/sonic-acl.yang',
+                         './yang-models/sonic-interface.yang',
+                         './yang-models/sonic-loopback-interface.yang',
+                         './yang-models/sonic-port.yang',
+                         './yang-models/sonic-portchannel.yang',
+                         './yang-models/sonic-vlan.yang',
+                         './yang-models/sonic_yang_tree']),
+    ],
+    zip_safe=False,
+)

src/sonic-yang-models/tests/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+"""Unit test package for sonic_yang_models."""

src/sonic-yang-models/tests/test_sonic_yang_models.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""Tests for `sonic_yang_models` package."""
+
+import pytest
+
+@pytest.fixture
+def response():
+    """Sample pytest fixture.
+
+    See more at: http://doc.pytest.org/en/latest/fixture.html
+    """
+    # import requests
+    # return requests.get('https://github.com/audreyr/cookiecutter-pypackage')
+
+
+def test_content(response):
+    """Sample pytest test function with the pytest fixture as an argument."""
+    # from bs4 import BeautifulSoup
+    # assert 'GitHub' in BeautifulSoup(response.content).title.string