Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[sonic-cfggen]: Update UT to run yang validation #9700

Merged
merged 21 commits into from
May 16, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions src/sonic-config-engine/tests/common_utils.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
import json
import re
import sys
import os
import subprocess
import argparse
import shlex


PY3x = sys.version_info >= (3, 0)
PYvX_DIR = "py3" if PY3x else "py2"
PYTHON_INTERPRETTER = "python3" if PY3x else "python2"
YANG_MODELS_DIR = "/usr/local/yang-models"

def tuple_to_str(tuplestr):
""" Convert Python tuple '('elem1', 'elem2')' representation into string on the for "elem1|elem2" """
Expand All @@ -31,3 +37,46 @@ def liststr_to_dict(liststr):

return list_obj

class YangWrapper(object):
def __init__(self, path=YANG_MODELS_DIR):
"""
sonic_yang only supports python3
"""
if PY3x:
import sonic_yang
self.yang_parser = sonic_yang.SonicYang(path)
self.yang_parser.loadYangModel()
self.test_dir = os.path.dirname(os.path.realpath(__file__))
self.script_file = PYTHON_INTERPRETTER + ' ' + os.path.join(self.test_dir, '..', 'sonic-cfggen')

def validate(self, argument):
"""
Raise exception when yang validation failed
"""
if PY3x and "-m" in argument:
parser=argparse.ArgumentParser(description="Render configuration file from minigraph data and jinja2 template.")
parser.add_argument("-m", "--minigraph", help="minigraph xml file", nargs='?', const='/etc/sonic/minigraph.xml')
parser.add_argument("-k", "--hwsku", help="HwSKU")
parser.add_argument("-n", "--namespace", help="namespace name", nargs='?', const=None, default=None)
parser.add_argument("-p", "--port-config", help="port config file, used with -m or -k", nargs='?', const=None)
parser.add_argument("-S", "--hwsku-config", help="hwsku config file, used with -p and -m or -k", nargs='?', const=None)
args, unknown = parser.parse_known_args(shlex.split(argument))

print('\n Validating yang schema')
cmd = self.script_file + ' -m ' + args.minigraph
if args.hwsku is not None:
cmd += ' -k ' + args.hwsku
if args.hwsku_config is not None:
cmd += ' -S ' + args.hwsku_config
if args.port_config is not None:
cmd += ' -p ' + args.port_config
if args.namespace is not None:
cmd += ' -n ' + args.namespace
cmd += ' --print-data'
output = subprocess.check_output(cmd, shell=True).decode()
self.yang_parser.loadData(configdbJson=json.loads(output))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line can throw, place it in the try catch.

try:
self.yang_parser.validate_data_tree()
except sonic_yang.SonicYangException as e:
print("yang data generated from %s is not valid"%(args.minigraph))
raise
Copy link
Collaborator

@qiluo-msft qiluo-msft Jan 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

raise

raise is not friendly in unit test, You may return a bool, and a string. And the caller could use assert to apply the pair.

Validation failure should be treated as a test case failure, not an exception. #Closed

3 changes: 3 additions & 0 deletions src/sonic-config-engine/tests/test_cfggen.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
class TestCfgGen(TestCase):

def setUp(self):
self.yang = utils.YangWrapper()
self.test_dir = os.path.dirname(os.path.realpath(__file__))
self.script_file = utils.PYTHON_INTERPRETTER + ' ' + os.path.join(self.test_dir, '..', 'sonic-cfggen')
self.sample_graph = os.path.join(self.test_dir, 'sample_graph.xml')
Expand Down Expand Up @@ -49,6 +50,8 @@ def tearDown(self):

def run_script(self, argument, check_stderr=False, verbose=False):
print('\n Running sonic-cfggen ' + argument)
self.yang.validate(argument)

if check_stderr:
output = subprocess.check_output(self.script_file + ' ' + argument, stderr=subprocess.STDOUT, shell=True)
else:
Expand Down
3 changes: 3 additions & 0 deletions src/sonic-config-engine/tests/test_minigraph_case.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
class TestCfgGenCaseInsensitive(TestCase):

def setUp(self):
self.yang = utils.YangWrapper()
self.test_dir = os.path.dirname(os.path.realpath(__file__))
self.script_file = utils.PYTHON_INTERPRETTER + ' ' + os.path.join(self.test_dir, '..', 'sonic-cfggen')
self.sample_graph = os.path.join(self.test_dir, 'simple-sample-graph-case.xml')
Expand All @@ -23,6 +24,8 @@ def setUp(self):

def run_script(self, argument, check_stderr=False):
ganglyu marked this conversation as resolved.
Show resolved Hide resolved
print('\n Running sonic-cfggen ' + argument)
self.yang.validate(argument)

if check_stderr:
output = subprocess.check_output(self.script_file + ' ' + argument, stderr=subprocess.STDOUT, shell=True)
else:
Expand Down
3 changes: 3 additions & 0 deletions src/sonic-config-engine/tests/test_multinpu_cfggen.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
class TestMultiNpuCfgGen(TestCase):

def setUp(self):
self.yang = utils.YangWrapper()
self.test_dir = os.path.dirname(os.path.realpath(__file__))
self.test_data_dir = os.path.join(self.test_dir, 'multi_npu_data')
self.script_file = utils.PYTHON_INTERPRETTER + ' ' + os.path.join(self.test_dir, '..', 'sonic-cfggen')
Expand All @@ -33,6 +34,8 @@ def setUp(self):

def run_script(self, argument, check_stderr=False):
ganglyu marked this conversation as resolved.
Show resolved Hide resolved
print('\n Running sonic-cfggen ' + argument)
self.yang.validate(argument)

if check_stderr:
output = subprocess.check_output(self.script_file + ' ' + argument, stderr=subprocess.STDOUT, shell=True)
else:
Expand Down