Add optional args to traffic script arg parser

[csit.git] / resources / libraries / python / VatJsonUtil.py

diff --git a/resources/libraries/python/VatJsonUtil.py b/resources/libraries/python/VatJsonUtil.py
index 36c5053..05c93a1 100644 (file)
--- a/resources/libraries/python/VatJsonUtil.py
+++ b/resources/libraries/python/VatJsonUtil.py
@@ -43,7 +43,7 @@ class VatJsonUtil(object):
         """Return interface dictionary from interface_list by MAC address.
 
         Extracts interface dictionary from all of the interfaces in interfaces
-        list parsed from json according to mac_address of the interface.
+        list parsed from JSON according to mac_address of the interface.
 
         :param interfaces_list: Interfaces parsed from JSON.
         :param mac_address: MAC address of interface we are looking for.
@@ -78,7 +78,7 @@ class VatJsonUtil(object):
 
     @staticmethod
     def update_vpp_interface_data_from_json(node, interface_dump_json):
-        """Update vpp node data in node__DICT from json interface dump.
+        """Update vpp node data in node__DICT from JSON interface dump.
 
         This method updates vpp interface names and sw if indexes according to
         interface MAC addresses found in interface_dump_json.
@@ -100,3 +100,26 @@ class VatJsonUtil(object):
             ifc['name'] = interface_dict["interface_name"]
             ifc['vpp_sw_index'] = interface_dict["sw_if_index"]
             ifc['mtu'] = interface_dict["mtu"]
+
+    @staticmethod
+    def verify_vat_retval(vat_out, exp_retval=0, err_msg='VAT cmd failed'):
+        """Verify return value of VAT command.
+
+        VAT command JSON output should be object (dict in python) or array. We
+        are looking for something like this: { "retval": 0 }. Verification is
+        skipped if VAT output does not contain return value element or root
+        elemet is array.
+
+        :param vat_out: VAT command output in python representation of JSON.
+        :param exp_retval: Expected return value (default 0).
+        :err_msg: Message to be displayed in case of error (optional).
+        :type vat_out: dict or list
+        :type exp_retval: int
+        :type err_msg: str
+        :raises RuntimeError: If VAT command return value is incorrect.
+        """
+        if type(vat_out) is dict:
+            retval = vat_out.get('retval')
+            if retval is not None:
+                if retval != exp_retval:
+                    raise RuntimeError(err_msg)