def test_adding_new_message_object_with_array(self): """ New message with array """ p = json.loads(TestPAPIMessageParsing.ip_address_details_msg) msglist = VPP(testmode=True) msglist.add_message(p[0], p[1:]) self.assertTrue(msglist['ip_address_details'])
def replay(args): """Replay into running VPP instance""" from vpp_papi import VPP JSON = 1 APITRACE = 2 filename, file_extension = os.path.splitext(args.input) input_type = JSON if file_extension == '.json' else APITRACE vpp = VPP(use_socket=args.socket) rv = vpp.connect(name='vppapireplay', chroot_prefix=args.shmprefix) if rv != 0: sys.exit('Cannot connect to VPP') if input_type == JSON: with open(args.input, 'r') as file: msgs = json.load(file, object_hook=vpp_decode) else: msgs = apitrace2json(messages, args.input) replaymsgs(vpp, msgs) vpp.disconnect()
def test_add_new_compound_type_with_array(self): """ New compound type with array """ counter_type = '''["ip4_fib_counter", ["u32", "address"], ["u8", "address_length"], ["u64", "packets"], ["u64", "bytes"], {"crc" : "0xb2739495"} ]''' with_type_msg = '''["with_type_msg", ["u32", "length"], ["u16", "list", 0, "length"], ["vl_api_ip4_fib_counter_t", "counter", 2] ]''' # Add new type msglist = VPP(testmode=True) p = json.loads(counter_type) msglist.add_type(p[0], p[1:]) p = json.loads(with_type_msg) msgdef = msglist.add_message(p[0], p[1:]) b = msglist.encode(msgdef, {'length': 2, 'list': [1, 2], 'counter': [{'address': 4, 'address_length': 12, 'packets': 1235, 'bytes': 5678}, {'address': 111, 'address_length': 222, 'packets': 333, 'bytes': 444}]}) self.assertEqual(50, len(b)) rv = msglist.decode(msgdef, b) self.assertEqual([1, 2], rv.list) self.assertEqual(1235, rv.counter[0].packets) with_type_variable_msg = '''["with_type_variable_msg", ["u32", "length"], ["vl_api_ip4_fib_counter_t", "counter", 0, "length"] ]''' p = json.loads(with_type_variable_msg) msgdef = msglist.add_message(p[0], p[1:]) b = msglist.encode(msgdef, {'length': 2, 'counter': [{'address': 4, 'address_length': 12, 'packets': 1235, 'bytes': 5678}, {'address': 111, 'address_length': 222, 'packets': 333, 'bytes': 444}]}) self.assertEqual(46, len(b)) rv = msglist.decode(msgdef, b) self.assertEqual(2, rv.length) self.assertEqual(1235, rv.counter[0].packets) self.assertEqual(333, rv.counter[1].packets)
def test_add_two_new_types(self): """ Add new types 2 """ mock_r1 = '''["mock_r1", ["u32", "a1"], {"crc" : "0xb2739495"} ]''' mock_r2 = '''["mock_r2", ["u32", "a1"], {"crc" : "0xb2739495"} ]''' mock_msg = '''["mock_msg", ["u32", "context"], ["i32", "retval"], ["vl_api_mock_r1_t", "r1"], ["vl_api_mock_r2_t", "r2"], {"crc" : "0xb2739495"} ]''' # Add new type msglist = VPP(testmode=True) p = json.loads(mock_r1) msglist.add_type(p[0], p[1:]) p = json.loads(mock_r2) msglist.add_type(p[0], p[1:]) p = json.loads(mock_msg) msgdef = msglist.add_message(p[0], p[1:]) b = msglist.encode(msgdef, {'context': 2, 'retval': 0, 'r1': {'a1': 4}, 'r2': {'a1': 12}}) self.assertEqual(16, len(b)) rv = msglist.decode(msgdef, b) self.assertEqual(4, rv.r1.a1)
def __init__(self): self.vpp = None jsonfiles = [] for root, dirnames, filenames in os.walk(vpp_json_dir_core): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(vpp_json_dir_core, filename)) for root, dirnames, filenames in os.walk(vpp_json_dir_plugins): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(vpp_json_dir_plugins, filename)) self.vpp = VPP(jsonfiles)
def test_argument_name(self): msglist = VPP(testmode=True) simple_name = '''["simple_name", ["u32", "length"], ["u8", "name"] ]''' p = json.loads(simple_name) msgdef = msglist.add_message(p[0], p[1:]) b = msglist.encode(msgdef, {'length': 6, 'name': 1}) self.assertEqual(5, len(b)) rv = msglist.decode(msgdef, b) self.assertEqual(6, rv.length) self.assertEqual(1, rv.name)
def test_adding_new_message_object(self): p = json.loads(TestPAPI.show_version_msg) msglist = VPP(testmode=json) msgdef = msglist.add_message(p[0], p[1:]) # Verify that message can be retrieved self.assertTrue(msglist['show_version']) self.assertFalse(msglist['foobar']) # Test duplicate self.assertRaises(ValueError, msglist.add_message, p[0], p[1:]) # Look at return tuple self.assertTrue(msglist.ret_tup('show_version'))
def __init__(self, name, shm_prefix, test_class): self.hook = Hook("vpp-papi-provider") self.name = name self.shm_prefix = shm_prefix self.test_class = test_class jsonfiles = [] install_dir = os.getenv('VPP_TEST_INSTALL_PATH') for root, dirnames, filenames in os.walk(install_dir): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(root, filename)) self.papi = VPP(jsonfiles) self._events = deque()
def test_old_vla_array_u32(self): msglist = VPP(testmode = True) # VLA vla_byte_array = '''["vla_byte_array", ["u32", "foobar"], ["u32", "oldmask", 0], {"crc" : "0xb2739495"} ]''' p = json.loads(vla_byte_array) msgdef = msglist.add_message(p[0], p[1:]) b = msglist.encode(msgdef, {'foobar' : 123, 'oldmask': [123, 456, 789]}) self.assertEqual(16, len(b)) rv = msglist.decode(msgdef, b) self.assertEqual([123, 456, 789], rv.oldmask)
def connect(cls, connection_name='api-test'): obj = cls() vpp = VPP(obj.json_files) r = vpp.connect(connection_name) if r != 0: sys.stderr.write('error: connecting to VPP\n') sys.exit(r) atexit.register(vpp.disconnect) r = vpp.api.show_version() sys.stdout.write('connected to VPP {}\n'.format( r.version.decode().rstrip('\0x00'))) return vpp
def test_array_count_not_previous(self): msglist = VPP(testmode = True) # VLA vla_byte_array = '''["vla_byte_array", ["u32", "count"], ["u32", "filler"], ["u32", "lst", 0, "count"], {"crc" : "0xb2739495"} ]''' p = json.loads(vla_byte_array) msgdef = msglist.add_message(p[0], p[1:]) b = msglist.encode(msgdef, {'count': 3, 'lst': [1,2,3], 'filler' : 1 }) rv = msglist.decode(msgdef, b) self.assertEqual(rv.lst, [1,2,3])
def __init__(self, name, shm_prefix, test_class, read_timeout): self.hook = Hook("vpp-papi-provider") self.name = name self.shm_prefix = shm_prefix self.test_class = test_class self._expect_api_retval = self._zero self._expect_stack = [] jsonfiles = [] install_dir = os.getenv('VPP_TEST_INSTALL_PATH') for root, dirnames, filenames in os.walk(install_dir): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(root, filename)) self.vpp = VPP(jsonfiles, logger=test_class.logger, read_timeout=read_timeout) self._events = deque()
def connect(self, vpp_json_dir='/usr/share/vpp/api/'): """Connect to VPP. :param vpp_json_dir: Path to json files with API description. :returns: 'True' if connected and 'False' otherwise. """ if self.connected: return True fwglobals.log.debug("VPP_API.connect: loading VPP API files") self.jsonfiles = [] for root, _, filenames in os.walk(vpp_json_dir): for filename in fnmatch.filter(filenames, '*.api.json'): self.jsonfiles.append(os.path.join(root, filename)) if not self.jsonfiles and not vppWrapper: fwglobals.log.error("VPP_API.connect: no vpp api files were found") return False fwglobals.log.debug("VPP_API.connect: connecting to VPP") self.vpp = VPP(self.jsonfiles) num_retries = 3 for i in range(num_retries): try: fwglobals.log.debug("Trying to connect vpp, num " + str(i)) self.vpp.connect('fwagent') break except Exception as e: if i == num_retries - 1: raise e else: time.sleep(10) self.connected = True fwglobals.log.debug("VPP_API.connect: connected to VPP") # vpp_methods = [] # for method_name in dir(self.vpp): # if callable(getattr(self.vpp, method_name)): # vpp_methods.append(method_name) # print("vpp.methods: " + format(vpp_methods)) # vpp_api_methods = [] # for method_name in dir(self.vpp.api): # if callable(getattr(self.vpp.api, method_name)): # vpp_api_methods.append(method_name) # print("vpp.api.methods: " + format(vpp_api_methods)) return True
def test_add_new_types(self): """ Add new types """ counter_type = '''["ip4_fib_counter", ["u32", "address"], ["u8", "address_length"], ["u64", "packets"], ["u64", "bytes"], {"crc" : "0xb2739495"} ]''' with_type_msg = '''["with_type_msg", ["u32", "length"], ["u16", "list", 0, "length"], ["vl_api_ip4_fib_counter_t", "counter"] ]''' # Add new type msglist = VPP(testmode=True) p = json.loads(counter_type) msglist.add_type(p[0], p[1:]) p = json.loads(with_type_msg) msgdef = msglist.add_message(p[0], p[1:]) b = msglist.encode(msgdef, {'length': 2, 'list': [1, 2], 'counter': {'address': 4, 'address_length': 12, 'packets': 1235, 'bytes': 5678}}) self.assertEqual(29, len(b)) rv = msglist.decode(msgdef, b) self.assertEqual(2, rv.length) self.assertEqual(5678, rv.counter.bytes)
def test_dump_details_function(self): vpp = VPP(jsonfiles) vpp.connect('test_vpp_papi3') rv = vpp.sw_interface_dump() #self.assertEqual(0, rv.retval) print('RV', rv) vpp.disconnect()
def test_request_reply_function(self): vpp = VPP(jsonfiles) vpp.connect('test_vpp_papi2') rv = vpp.show_version() self.assertEqual(0, rv.retval) self.assertEqual('vpe', rv.program.decode().rstrip('\0x00')) vpp.disconnect()
def test_nested_array_type(self): bier_type = '''["bier_table_id", ["u8", "bt_set"], ["u8", "bt_sub_domain"], ["u8", "bt_hdr_len_id"], {"crc" : "0xb2739495"} ]''' fib_path3 = '''["fib_path3", ["u32", "sw_if_index"], ["u8", "n_labels"], ["u32", "label_stack", 0, "n_labels"], {"crc" : "0xb2739495"} ]''' bier_route_details = '''["bier_route_details", ["u32", "client_index"], ["vl_api_bier_table_id_t", "br_tbl_id"], ["u32", "br_n_paths"], ["vl_api_fib_path3_t", "br_paths", 0, "br_n_paths"], {"crc" : "0xb2739495"} ]''' # Add new type msglist = VPP(testmode=True) p = json.loads(bier_type) msglist.add_type(p[0], p[1:]) p = json.loads(fib_path3) msglist.add_type(p[0], p[1:]) p = json.loads(bier_route_details) msgdef = msglist.add_message(p[0], p[1:]) bt_tbl_id = {'bt_set': 1, 'bt_sub_domain': 2, 'bt_hdr_len_id': 3} fib_path = {'sw_if_index': 1, 'n_labels': 2, 'label_stack': [123, 456]} b = msglist.encode( msgdef, { 'client_index': 2, 'br_tbl_id': bt_tbl_id, 'br_n_paths': 2, 'br_paths': [fib_path, fib_path] }) self.assertEqual(37, len(b)) rv = msglist.decode(msgdef, b) self.assertEqual([123, 456], rv.br_paths[1].label_stack) self.assertEqual(bt_tbl_id['bt_set'], rv.br_tbl_id.bt_set)
def test_old_vla_array_not_last_member(self): msglist = VPP(testmode = True) # VLA vla_byte_array = '''["vla_byte_array", ["u8", "oldmask", 0], ["u32", "foobar"], {"crc" : "0xb2739495"} ]''' p = json.loads(vla_byte_array) self.assertRaises(ValueError, msglist.add_message, p[0], p[1:])
def test_old_vla_array(self): msglist = VPP(testmode = True) # VLA vla_byte_array = '''["vla_byte_array", ["u32", "foobar"], ["u32", "list", 2], ["u32", "propercount"], ["u8", "propermask", 0, "propercount"], ["u8", "oldmask", 0], {"crc" : "0xb2739495"} ]''' p = json.loads(vla_byte_array) msgdef = msglist.add_message(p[0], p[1:]) b = msglist.encode(msgdef, {'list' : [123, 456], 'oldmask': b'foobar', 'propercount' : 2, 'propermask' : [8,9]}) self.assertEqual(24, len(b)) rv = msglist.decode(msgdef, b) self.assertEqual(b'foobar', rv.oldmask)
def test_acl_interface_get(self): vpp = VPP(jsonfiles) vpp.connect('test_vpp_papi2') rv = vpp.macip_acl_interface_get() print('RV', rv) vpp.disconnect()
def test_acl_create(self): vpp = VPP(jsonfiles) vpp.connect('acl-test') rv = vpp.acl_plugin_get_version() print('RV', rv) self.assertEqual(rv.major, 1) self.assertEqual(rv.minor, 1) rv = vpp.acl_add_replace(acl_index = 0xFFFFFFFF, r = [{ "is_permit" : 1, "is_ipv6" : 0, "proto" : 6, "srcport_or_icmptype_first" : 80, }], count = 1) print ('RV', rv) rv = vpp.acl_add_replace(acl_index = 0xFFFFFFFF, r = [{ "is_permit" : 1, "is_ipv6" : 0, "proto" : 6, "srcport_or_icmptype_first" : 81, }], count = 1) self.assertEqual(rv.retval, 0) print ('RV', rv) ai = rv.acl_index rv = vpp.acl_dump() print ('RV', rv) #rv = vpp.acl_del(acl_index = ai) #self.assertEqual(rv.retval, 0) #rv = vpp.acl_dump() #self.assertEqual([], vpp.acl_dump()) vpp.disconnect()
def test_vla(self): vpp = VPP(jsonfiles) vpp.connect('test_vpp_papi3') cmd = 'show version verbose' rv = vpp.cli_inband(length=len(cmd), cmd=cmd) self.assertEqual(0, rv.retval) print('RV', rv.reply) cmd = 'show vlib graph' rv = vpp.cli_inband(length=len(cmd), cmd=cmd) self.assertEqual(0, rv.retval) print('RV', rv.reply) vpp.disconnect()
def test_old_vla_array_compound(self): msglist = VPP(testmode = True) # VLA counter_type = '''["ip4_fib_counter", ["u32", "address"], ["u8", "address_length"], ["u64", "packets"], ["u64", "bytes"], {"crc" : "0xb2739495"} ]''' vla_byte_array = '''["vla_byte_array", ["vl_api_ip4_fib_counter_t", "counter", 0], {"crc" : "0xb2739495"} ]''' p = json.loads(counter_type) msglist.add_type(p[0], p[1:]) p = json.loads(vla_byte_array) with self.assertRaises(NotImplementedError): msgdef = msglist.add_message(p[0], p[1:])
def __init__(self): # construct a list of all the json api files for root, dirnames, filenames in os.walk(self.vpp_json_dir): for filename in fnmatch.filter(filenames, '*.api.json'): self.jsonfiles.append(os.path.join(self.vpp_json_dir, filename)) if vpp_ctl.vpp != None: return if not self.jsonfiles: print('Error: no json api files found') exit(-1) vpp_ctl.vpp = VPP(self.jsonfiles) r = vpp_ctl.vpp.connect('papi') if r != None: print(r)
import fnmatch from vpp_papi import VPP vpp_json_dir = '/usr/share/vpp/api/' jsonfiles = [] for root, dirnames, filenames in os.walk(vpp_json_dir): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(vpp_json_dir, filename)) if not jsonfiles: print('Error: no json api files found') exit(-1) vpp = VPP(jsonfiles) if_1_name = 'tap-0' if_2_name = 'tap-1' r = vpp.connect('papi') print(r) if_1_sw_if_index = vpp.sw_interface_dump(name_filter_valid=1, name_filter=if_1_name)[0].sw_if_index if_2_sw_if_index = vpp.sw_interface_dump(name_filter_valid=1, name_filter=if_2_name)[0].sw_if_index # hook on the first interface # leave flows_max and next_node_index untouched r = vpp.flowtable_conf(flows_max=0xffffffff,
def connect_vpp(jsonfiles): vpp = VPP(jsonfiles) r = vpp.connect("CLIENT_ID") print("VPP api opened with code: %s" % r) return vpp
def process_json_request(args): """Process the request/reply and dump classes of VPP API methods. :param args: Command line arguments passed to VPP PAPI Provider. :type args: ArgumentParser :returns: JSON formatted string. :rtype: str :raises RuntimeError: If PAPI command error occurs. """ try: vpp = VPP() except Exception as err: raise RuntimeError(f"PAPI init failed:\n{err!r}") reply = list() def process_value(val): """Process value. :param val: Value to be processed. :type val: object :returns: Processed value. :rtype: dict or str or int """ if isinstance(val, dict): for val_k, val_v in val.items(): val[str(val_k)] = process_value(val_v) return val elif isinstance(val, list): for idx, val_l in enumerate(val): val[idx] = process_value(val_l) return val elif isinstance(val, str): return bytes.fromhex(val).decode(encoding=u"utf-8") elif isinstance(val, int): return val else: return str(val) json_data = json.loads(args.data) vpp.connect(CLIENT_NAME) for data in json_data: api_name = data[u"api_name"] api_args_unicode = data[u"api_args"] api_reply = dict(api_name=api_name) api_args = dict() for a_k, a_v in api_args_unicode.items(): api_args[str(a_k)] = process_value(a_v) try: papi_fn = getattr(vpp.api, api_name) rep = papi_fn(**api_args) if isinstance(rep, list): converted_reply = list() for r in rep: converted_reply.append(_convert_reply(r)) else: converted_reply = _convert_reply(rep) api_reply[u"api_reply"] = converted_reply reply.append(api_reply) except (AttributeError, ValueError) as err: vpp.disconnect() raise RuntimeError( f"PAPI command {api_name}({api_args}) input error:\n{err!r}") except Exception as err: vpp.disconnect() raise RuntimeError( f"PAPI command {api_name}({api_args}) error:\n{err!r}") vpp.disconnect() return json.dumps(reply)
import fnmatch from vpp_papi import VPP vpp_json_dir = '/usr/share/vpp/api/' jsonfiles = [] for root, dirnames, filenames in os.walk(vpp_json_dir): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(vpp_json_dir, filename)) if not jsonfiles: print('Error: no json api files found') exit(-1) vpp = VPP(jsonfiles) if_1_name = 'tap-0' if_2_name = 'tap-1' if_3_name = 'tap-2' r = vpp.connect('papi') print(r) if_1_sw_if_index = vpp.sw_interface_dump(name_filter_valid=1, name_filter=if_1_name)[0].sw_if_index if_2_sw_if_index = vpp.sw_interface_dump(name_filter_valid=1, name_filter=if_2_name)[0].sw_if_index if_3_sw_if_index = vpp.sw_interface_dump(name_filter_valid=1, name_filter=if_3_name)[0].sw_if_index
class VppPapiProvider(object): """VPP-api provider using vpp-papi @property hook: hook object providing before and after api/cli hooks """ def __init__(self, name, shm_prefix, test_class): self.hook = Hook("vpp-papi-provider") self.name = name self.shm_prefix = shm_prefix self.test_class = test_class jsonfiles = [] install_dir = os.getenv('VPP_TEST_INSTALL_PATH') for root, dirnames, filenames in os.walk(install_dir): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(root, filename)) self.papi = VPP(jsonfiles) self._events = deque() def register_hook(self, hook): """Replace hook registration with new hook :param hook: """ self.hook = hook def collect_events(self): """ Collect all events from the internal queue and clear the queue. """ e = self._events self._events = deque() return e def wait_for_event(self, timeout, name=None): """ Wait for and return next event. """ if self._events: self.test_class.logger.debug("Not waiting, event already queued") limit = time.time() + timeout while time.time() < limit: if self._events: e = self._events.popleft() if name and type(e).__name__ != name: raise Exception( "Unexpected event received: %s, expected: %s" % (type(e).__name__, name)) self.test_class.logger.debug("Returning event %s:%s" % (name, e)) return e time.sleep(0) # yield if name is not None: raise Exception("Event %s did not occur within timeout" % name) raise Exception("Event did not occur within timeout") def __call__(self, name, event): """ Enqueue event in the internal event queue. """ # FIXME use the name instead of relying on type(e).__name__ ? # FIXME #2 if this throws, it is eaten silently, Ole? self.test_class.logger.debug("New event: %s: %s" % (name, event)) self._events.append(event) def connect(self): """Connect the API to VPP""" self.papi.connect(self.name, self.shm_prefix) self.papi.register_event_callback(self) def disconnect(self): """Disconnect the API from VPP""" self.papi.disconnect() def api(self, api_fn, api_args, expected_retval=0): """ Call API function and check it's return value. Call the appropriate hooks before and after the API call :param api_fn: API function to call :param api_args: tuple of API function arguments :param expected_retval: Expected return value (Default value = 0) :returns: reply from the API """ self.hook.before_api(api_fn.__name__, api_args) reply = api_fn(**api_args) if hasattr(reply, 'retval') and reply.retval != expected_retval: msg = "API call failed, expected retval == %d, got %s" % ( expected_retval, repr(reply)) self.test_class.logger.info(msg) raise Exception(msg) self.hook.after_api(api_fn.__name__, api_args) return reply def cli(self, cli): """ Execute a CLI, calling the before/after hooks appropriately. :param cli: CLI to execute :returns: CLI output """ self.hook.before_cli(cli) cli += '\n' r = self.papi.cli_inband(length=len(cli), cmd=cli) self.hook.after_cli(cli) if hasattr(r, 'reply'): return r.reply.decode().rstrip('\x00') def ppcli(self, cli): """ Helper method to print CLI command in case of info logging level. :param cli: CLI to execute :returns: CLI output """ return cli + "\n" + str(self.cli(cli)) def _convert_mac(self, mac): return int(mac.replace(":", ""), 16) << 16 def show_version(self): """ """ return self.papi.show_version() def pg_create_interface(self, pg_index): """ :param pg_index: """ return self.api(self.papi.pg_create_interface, {"interface_id": pg_index}) def sw_interface_dump(self, filter=None): """ :param filter: (Default value = None) """ if filter is not None: args = {"name_filter_valid": 1, "name_filter": filter} else: args = {} return self.api(self.papi.sw_interface_dump, args) def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id): """ Set the IPvX Table-id for the Interface :param sw_if_index: :param is_ipv6: :param table_id: """ return self.api(self.papi.sw_interface_set_table, {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6, 'vrf_id': table_id}) def sw_interface_add_del_address(self, sw_if_index, addr, addr_len, is_ipv6=0, is_add=1, del_all=0): """ :param addr: param is_ipv6: (Default value = 0) :param sw_if_index: :param addr_len: :param is_ipv6: (Default value = 0) :param is_add: (Default value = 1) :param del_all: (Default value = 0) """ return self.api(self.papi.sw_interface_add_del_address, {'sw_if_index': sw_if_index, 'is_add': is_add, 'is_ipv6': is_ipv6, 'del_all': del_all, 'address_length': addr_len, 'address': addr}) def sw_interface_enable_disable_mpls(self, sw_if_index, is_enable=1): """ Enable/Disable MPLS on the interface :param sw_if_index: :param is_enable: (Default value = 1) """ return self.api(self.papi.sw_interface_set_mpls_enable, {'sw_if_index': sw_if_index, 'enable': is_enable}) def sw_interface_ra_suppress(self, sw_if_index): return self.api(self.papi.sw_interface_ip6nd_ra_config, {'sw_if_index': sw_if_index}) def vxlan_add_del_tunnel( self, src_addr, dst_addr, mcast_sw_if_index=0xFFFFFFFF, is_add=1, is_ipv6=0, encap_vrf_id=0, decap_next_index=0xFFFFFFFF, vni=0): """ :param dst_addr: :param src_addr: :param is_add: (Default value = 1) :param is_ipv6: (Default value = 0) :param encap_vrf_id: (Default value = 0) :param decap_next_index: (Default value = 0xFFFFFFFF) :param mcast_sw_if_index: (Default value = 0xFFFFFFFF) :param vni: (Default value = 0) """ return self.api(self.papi.vxlan_add_del_tunnel, {'is_add': is_add, 'is_ipv6': is_ipv6, 'src_address': src_addr, 'dst_address': dst_addr, 'mcast_sw_if_index': mcast_sw_if_index, 'encap_vrf_id': encap_vrf_id, 'decap_next_index': decap_next_index, 'vni': vni}) def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1, learn=1, arp_term=0, is_add=1): """Create/delete bridge domain. :param int bd_id: Bridge domain index. :param int flood: Enable/disable bcast/mcast flooding in the BD. (Default value = 1) :param int uu_flood: Enable/disable unknown unicast flood in the BD. (Default value = 1) :param int forward: Enable/disable forwarding on all interfaces in the BD. (Default value = 1) :param int learn: Enable/disable learning on all interfaces in the BD. (Default value = 1) :param int arp_term: Enable/disable arp termination in the BD. (Default value = 1) :param int is_add: Add or delete flag. (Default value = 1) """ return self.api(self.papi.bridge_domain_add_del, {'bd_id': bd_id, 'flood': flood, 'uu_flood': uu_flood, 'forward': forward, 'learn': learn, 'arp_term': arp_term, 'is_add': is_add}) def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0, filter_mac=0, bvi_mac=0): """Create/delete L2 FIB entry. :param str mac: MAC address to create FIB entry for. :param int bd_id: Bridge domain index. :param int sw_if_index: Software interface index of the interface. :param int is_add: Add or delete flag. (Default value = 1) :param int static_mac: Set to 1 to create static MAC entry. (Default value = 0) :param int filter_mac: Set to 1 to drop packet that's source or destination MAC address contains defined MAC address. (Default value = 0) :param int bvi_mac: Set to 1 to create entry that points to BVI interface. (Default value = 0) """ return self.api(self.papi.l2fib_add_del, {'mac': self._convert_mac(mac), 'bd_id': bd_id, 'sw_if_index': sw_if_index, 'is_add': is_add, 'static_mac': static_mac, 'filter_mac': filter_mac, 'bvi_mac': bvi_mac}) def sw_interface_set_l2_bridge(self, sw_if_index, bd_id, shg=0, bvi=0, enable=1): """Add/remove interface to/from bridge domain. :param int sw_if_index: Software interface index of the interface. :param int bd_id: Bridge domain index. :param int shg: Split-horizon group index. (Default value = 0) :param int bvi: Set interface as a bridge group virtual interface. (Default value = 0) :param int enable: Add or remove interface. (Default value = 1) """ return self.api(self.papi.sw_interface_set_l2_bridge, {'rx_sw_if_index': sw_if_index, 'bd_id': bd_id, 'shg': shg, 'bvi': bvi, 'enable': enable}) def bridge_flags(self, bd_id, is_set, feature_bitmap): """Enable/disable required feature of the bridge domain with defined ID. :param int bd_id: Bridge domain ID. :param int is_set: Set to 1 to enable, set to 0 to disable the feature. :param int feature_bitmap: Bitmap value of the feature to be set: - learn (1 << 0), - forward (1 << 1), - flood (1 << 2), - uu-flood (1 << 3) or - arp-term (1 << 4). """ return self.api(self.papi.bridge_flags, {'bd_id': bd_id, 'is_set': is_set, 'feature_bitmap': feature_bitmap}) def bridge_domain_dump(self, bd_id=0): """ :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all existing bridge domains returned) :return: Dictionary of bridge domain(s) data. """ return self.api(self.papi.bridge_domain_dump, {'bd_id': bd_id}) def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index, enable): """Create or delete unidirectional cross-connect from Tx interface to Rx interface. :param int rx_sw_if_index: Software interface index of Rx interface. :param int tx_sw_if_index: Software interface index of Tx interface. :param int enable: Create cross-connect if equal to 1, delete cross-connect if equal to 0. """ return self.api(self.papi.sw_interface_set_l2_xconnect, {'rx_sw_if_index': rx_sw_if_index, 'tx_sw_if_index': tx_sw_if_index, 'enable': enable}) def sw_interface_set_l2_tag_rewrite( self, sw_if_index, vtr_oper, push=0, tag1=0, tag2=0): """L2 interface vlan tag rewrite configure request :param client_index - opaque cookie to identify the sender :param context - sender context, to match reply w/ request :param sw_if_index - interface the operation is applied to :param vtr_op - Choose from l2_vtr_op_t enum values :param push_dot1q - first pushed flag dot1q id set, else dot1ad :param tag1 - Needed for any push or translate vtr op :param tag2 - Needed for any push 2 or translate x-2 vtr ops """ return self.api(self.papi.l2_interface_vlan_tag_rewrite, {'sw_if_index': sw_if_index, 'vtr_op': vtr_oper, 'push_dot1q': push, 'tag1': tag1, 'tag2': tag2}) def sw_interface_set_flags(self, sw_if_index, admin_up_down, link_up_down=0, deleted=0): """ :param admin_up_down: :param sw_if_index: :param link_up_down: (Default value = 0) :param deleted: (Default value = 0) """ return self.api(self.papi.sw_interface_set_flags, {'sw_if_index': sw_if_index, 'admin_up_down': admin_up_down, 'link_up_down': link_up_down, 'deleted': deleted}) def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan, no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0, default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0): """Create subinterface from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad :param sub_id: param inner_vlan: :param sw_if_index: :param outer_vlan: :param inner_vlan: :param no_tags: (Default value = 0) :param one_tag: (Default value = 0) :param two_tags: (Default value = 0) :param dot1ad: (Default value = 0) :param exact_match: (Default value = 0) :param default_sub: (Default value = 0) :param outer_vlan_id_any: (Default value = 0) :param inner_vlan_id_any: (Default value = 0) """ return self.api( self.papi.create_subif, {'sw_if_index': sw_if_index, 'sub_id': sub_id, 'no_tags': no_tags, 'one_tag': one_tag, 'two_tags': two_tags, 'dot1ad': dot1ad, 'exact_match': exact_match, 'default_sub': default_sub, 'outer_vlan_id_any': outer_vlan_id_any, 'inner_vlan_id_any': inner_vlan_id_any, 'outer_vlan_id': outer_vlan, 'inner_vlan_id': inner_vlan}) def delete_subif(self, sw_if_index): """Delete subinterface :param sw_if_index: """ return self.api(self.papi.delete_subif, {'sw_if_index': sw_if_index}) def create_vlan_subif(self, sw_if_index, vlan): """ :param vlan: :param sw_if_index: """ return self.api(self.papi.create_vlan_subif, {'sw_if_index': sw_if_index, 'vlan_id': vlan}) def create_loopback(self, mac=''): """ :param mac: (Optional) """ return self.api(self.papi.create_loopback, {'mac_address': mac}) def ip_add_del_route( self, dst_address, dst_address_length, next_hop_address, next_hop_sw_if_index=0xFFFFFFFF, table_id=0, next_hop_table_id=0, next_hop_weight=1, next_hop_n_out_labels=0, next_hop_out_label_stack=[], next_hop_via_label=MPLS_LABEL_INVALID, create_vrf_if_needed=0, is_resolve_host=0, is_resolve_attached=0, classify_table_index=0xFFFFFFFF, is_add=1, is_drop=0, is_unreach=0, is_prohibit=0, is_ipv6=0, is_local=0, is_classify=0, is_multipath=0, not_last=0): """ :param dst_address_length: :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) :param dst_address: :param next_hop_address: :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) :param vrf_id: (Default value = 0) :param lookup_in_vrf: (Default value = 0) :param classify_table_index: (Default value = 0xFFFFFFFF) :param create_vrf_if_needed: (Default value = 0) :param is_add: (Default value = 1) :param is_drop: (Default value = 0) :param is_ipv6: (Default value = 0) :param is_local: (Default value = 0) :param is_classify: (Default value = 0) :param is_multipath: (Default value = 0) :param is_resolve_host: (Default value = 0) :param is_resolve_attached: (Default value = 0) :param not_last: (Default value = 0) :param next_hop_weight: (Default value = 1) """ return self.api( self.papi.ip_add_del_route, {'next_hop_sw_if_index': next_hop_sw_if_index, 'table_id': table_id, 'classify_table_index': classify_table_index, 'next_hop_table_id': next_hop_table_id, 'create_vrf_if_needed': create_vrf_if_needed, 'is_add': is_add, 'is_drop': is_drop, 'is_unreach': is_unreach, 'is_prohibit': is_prohibit, 'is_ipv6': is_ipv6, 'is_local': is_local, 'is_classify': is_classify, 'is_multipath': is_multipath, 'is_resolve_host': is_resolve_host, 'is_resolve_attached': is_resolve_attached, 'not_last': not_last, 'next_hop_weight': next_hop_weight, 'dst_address_length': dst_address_length, 'dst_address': dst_address, 'next_hop_address': next_hop_address, 'next_hop_n_out_labels': next_hop_n_out_labels, 'next_hop_via_label': next_hop_via_label, 'next_hop_out_label_stack': next_hop_out_label_stack}) def ip_fib_dump(self): return self.api(self.papi.ip_fib_dump, {}) def ip_neighbor_add_del(self, sw_if_index, mac_address, dst_address, vrf_id=0, is_add=1, is_ipv6=0, is_static=0, ): """ Add neighbor MAC to IPv4 or IPv6 address. :param sw_if_index: :param mac_address: :param dst_address: :param vrf_id: (Default value = 0) :param is_add: (Default value = 1) :param is_ipv6: (Default value = 0) :param is_static: (Default value = 0) """ return self.api( self.papi.ip_neighbor_add_del, {'vrf_id': vrf_id, 'sw_if_index': sw_if_index, 'is_add': is_add, 'is_ipv6': is_ipv6, 'is_static': is_static, 'mac_address': mac_address, 'dst_address': dst_address } ) def sw_interface_span_enable_disable( self, sw_if_index_from, sw_if_index_to, state=1): """ :param sw_if_index_from: :param sw_if_index_to: :param state: """ return self.api(self.papi.sw_interface_span_enable_disable, {'sw_if_index_from': sw_if_index_from, 'sw_if_index_to': sw_if_index_to, 'state': state}) def gre_tunnel_add_del(self, src_address, dst_address, outer_fib_id=0, is_teb=0, is_add=1, is_ip6=0): """ Add a GRE tunnel :param src_address: :param dst_address: :param outer_fib_id: (Default value = 0) :param is_add: (Default value = 1) :param is_ipv6: (Default value = 0) :param is_teb: (Default value = 0) """ return self.api( self.papi.gre_add_del_tunnel, {'is_add': is_add, 'is_ipv6': is_ip6, 'teb': is_teb, 'src_address': src_address, 'dst_address': dst_address, 'outer_fib_id': outer_fib_id} ) def mpls_route_add_del( self, label, eos, next_hop_proto_is_ip4, next_hop_address, next_hop_sw_if_index=0xFFFFFFFF, table_id=0, next_hop_table_id=0, next_hop_weight=1, next_hop_n_out_labels=0, next_hop_out_label_stack=[], next_hop_via_label=MPLS_LABEL_INVALID, create_vrf_if_needed=0, is_resolve_host=0, is_resolve_attached=0, is_add=1, is_drop=0, is_multipath=0, classify_table_index=0xFFFFFFFF, is_classify=0, not_last=0): """ :param dst_address_length: :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) :param dst_address: :param next_hop_address: :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) :param vrf_id: (Default value = 0) :param lookup_in_vrf: (Default value = 0) :param classify_table_index: (Default value = 0xFFFFFFFF) :param create_vrf_if_needed: (Default value = 0) :param is_add: (Default value = 1) :param is_drop: (Default value = 0) :param is_ipv6: (Default value = 0) :param is_local: (Default value = 0) :param is_classify: (Default value = 0) :param is_multipath: (Default value = 0) :param is_resolve_host: (Default value = 0) :param is_resolve_attached: (Default value = 0) :param not_last: (Default value = 0) :param next_hop_weight: (Default value = 1) """ return self.api( self.papi.mpls_route_add_del, {'mr_label': label, 'mr_eos': eos, 'mr_table_id': table_id, 'mr_classify_table_index': classify_table_index, 'mr_create_table_if_needed': create_vrf_if_needed, 'mr_is_add': is_add, 'mr_is_classify': is_classify, 'mr_is_multipath': is_multipath, 'mr_is_resolve_host': is_resolve_host, 'mr_is_resolve_attached': is_resolve_attached, 'mr_next_hop_proto_is_ip4': next_hop_proto_is_ip4, 'mr_next_hop_weight': next_hop_weight, 'mr_next_hop': next_hop_address, 'mr_next_hop_n_out_labels': next_hop_n_out_labels, 'mr_next_hop_sw_if_index': next_hop_sw_if_index, 'mr_next_hop_table_id': next_hop_table_id, 'mr_next_hop_via_label': next_hop_via_label, 'mr_next_hop_out_label_stack': next_hop_out_label_stack}) def mpls_ip_bind_unbind( self, label, dst_address, dst_address_length, table_id=0, ip_table_id=0, is_ip4=1, create_vrf_if_needed=0, is_bind=1): """ """ return self.api( self.papi.mpls_ip_bind_unbind, {'mb_mpls_table_id': table_id, 'mb_label': label, 'mb_ip_table_id': ip_table_id, 'mb_create_table_if_needed': create_vrf_if_needed, 'mb_is_bind': is_bind, 'mb_is_ip4': is_ip4, 'mb_address_length': dst_address_length, 'mb_address': dst_address}) def mpls_tunnel_add_del( self, tun_sw_if_index, next_hop_proto_is_ip4, next_hop_address, next_hop_sw_if_index=0xFFFFFFFF, next_hop_table_id=0, next_hop_weight=1, next_hop_n_out_labels=0, next_hop_out_label_stack=[], next_hop_via_label=MPLS_LABEL_INVALID, create_vrf_if_needed=0, is_add=1, l2_only=0): """ :param dst_address_length: :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) :param dst_address: :param next_hop_address: :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF) :param vrf_id: (Default value = 0) :param lookup_in_vrf: (Default value = 0) :param classify_table_index: (Default value = 0xFFFFFFFF) :param create_vrf_if_needed: (Default value = 0) :param is_add: (Default value = 1) :param is_drop: (Default value = 0) :param is_ipv6: (Default value = 0) :param is_local: (Default value = 0) :param is_classify: (Default value = 0) :param is_multipath: (Default value = 0) :param is_resolve_host: (Default value = 0) :param is_resolve_attached: (Default value = 0) :param not_last: (Default value = 0) :param next_hop_weight: (Default value = 1) """ return self.api( self.papi.mpls_tunnel_add_del, {'mt_sw_if_index': tun_sw_if_index, 'mt_is_add': is_add, 'mt_l2_only': l2_only, 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4, 'mt_next_hop_weight': next_hop_weight, 'mt_next_hop': next_hop_address, 'mt_next_hop_n_out_labels': next_hop_n_out_labels, 'mt_next_hop_sw_if_index': next_hop_sw_if_index, 'mt_next_hop_table_id': next_hop_table_id, 'mt_next_hop_out_label_stack': next_hop_out_label_stack}) def snat_interface_add_del_feature( self, sw_if_index, is_inside=1, is_add=1): """Enable/disable S-NAT feature on the interface :param sw_if_index: Software index of the interface :param is_inside: 1 if inside, 0 if outside (Default value = 1) :param is_add: 1 if add, 0 if delete (Default value = 1) """ return self.api( self.papi.snat_interface_add_del_feature, {'is_add': is_add, 'is_inside': is_inside, 'sw_if_index': sw_if_index}) def snat_add_static_mapping( self, local_ip, external_ip, local_port=0, external_port=0, addr_only=1, vrf_id=0, is_add=1, is_ip4=1): """Add/delete S-NAT static mapping :param local_ip: Local IP address :param external_ip: External IP address :param local_port: Local port number (Default value = 0) :param external_port: External port number (Default value = 0) :param addr_only: 1 if address only mapping, 0 if address and port :param vrf_id: VRF ID :param is_add: 1 if add, 0 if delete (Default value = 1) :param is_ip4: 1 if address type is IPv4 (Default value = 1) """ return self.api( self.papi.snat_add_static_mapping, {'is_add': is_add, 'is_ip4': is_ip4, 'addr_only': addr_only, 'local_ip_address': local_ip, 'external_ip_address': external_ip, 'local_port': local_port, 'external_port': external_port, 'vrf_id': vrf_id}) def snat_add_address_range( self, first_ip_address, last_ip_address, is_add=1, is_ip4=1): """Add/del S-NAT address range :param first_ip_address: First IP address :param last_ip_address: Last IP address :param is_add: 1 if add, 0 if delete (Default value = 1) :param is_ip4: 1 if address type is IPv4 (Default value = 1) """ return self.api( self.papi.snat_add_address_range, {'is_ip4': is_ip4, 'first_ip_address': first_ip_address, 'last_ip_address': last_ip_address, 'is_add': is_add}) def snat_address_dump(self): """Dump S-NAT addresses :return: Dictionary of S-NAT addresses """ return self.api(self.papi.snat_address_dump, {}) def snat_interface_dump(self): """Dump interfaces with S-NAT feature :return: Dictionary of interfaces with S-NAT feature """ return self.api(self.papi.snat_interface_dump, {}) def snat_static_mapping_dump(self): """Dump S-NAT static mappings :return: Dictionary of S-NAT static mappings """ return self.api(self.papi.snat_static_mapping_dump, {}) def snat_show_config(self): """Show S-NAT config :return: S-NAT config parameters """ return self.api(self.papi.snat_show_config, {}) def control_ping(self): self.api(self.papi.control_ping) def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx, detect_mult, local_addr, peer_addr, is_ipv6=0): return self.api(self.papi.bfd_udp_add, { 'sw_if_index': sw_if_index, 'desired_min_tx': desired_min_tx, 'required_min_rx': required_min_rx, 'local_addr': local_addr, 'peer_addr': peer_addr, 'is_ipv6': is_ipv6, 'detect_mult': detect_mult, }) def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0): return self.api(self.papi.bfd_udp_del, { 'sw_if_index': sw_if_index, 'local_addr': local_addr, 'peer_addr': peer_addr, 'is_ipv6': is_ipv6, }) def bfd_udp_session_dump(self): return self.api(self.papi.bfd_udp_session_dump, {}) def bfd_session_set_flags(self, bs_idx, admin_up_down): return self.api(self.papi.bfd_session_set_flags, { 'bs_index': bs_idx, 'admin_up_down': admin_up_down, }) def want_bfd_events(self, enable_disable=1): return self.api(self.papi.want_bfd_events, { 'enable_disable': enable_disable, 'pid': os.getpid(), }) def classify_add_del_table( self, is_add, mask, match_n_vectors=1, table_index=0xFFFFFFFF, nbuckets=2, memory_size=2097152, skip_n_vectors=0, next_table_index=0xFFFFFFFF, miss_next_index=0xFFFFFFFF, current_data_flag=0, current_data_offset=0): """ :param is_add: :param mask: :param match_n_vectors (Default value = 1): :param table_index (Default value = 0xFFFFFFFF) :param nbuckets: (Default value = 2) :param memory_size: (Default value = 2097152) :param skip_n_vectors: (Default value = 0) :param next_table_index: (Default value = 0xFFFFFFFF) :param miss_next_index: (Default value = 0xFFFFFFFF) :param current_data_flag: (Default value = 0) :param current_data_offset: (Default value = 0) """ return self.api( self.papi.classify_add_del_table, {'is_add' : is_add, 'table_index' : table_index, 'nbuckets' : nbuckets, 'memory_size': memory_size, 'skip_n_vectors' : skip_n_vectors, 'match_n_vectors' : match_n_vectors, 'next_table_index' : next_table_index, 'miss_next_index' : miss_next_index, 'current_data_flag' : current_data_flag, 'current_data_offset' : current_data_offset, 'mask' : mask}) def classify_add_del_session( self, is_add, table_index, match, opaque_index=0xFFFFFFFF, hit_next_index=0xFFFFFFFF, advance=0, action=0, metadata=0): """ :param is_add: :param table_index: :param match: :param opaque_index: (Default value = 0xFFFFFFFF) :param hit_next_index: (Default value = 0xFFFFFFFF) :param advance: (Default value = 0) :param action: (Default value = 0) :param metadata: (Default value = 0) """ return self.api( self.papi.classify_add_del_session, {'is_add' : is_add, 'table_index' : table_index, 'hit_next_index' : hit_next_index, 'opaque_index' : opaque_index, 'advance' : advance, 'action' : action, 'metadata' : metadata, 'match' : match}) def input_acl_set_interface( self, is_add, sw_if_index, ip4_table_index=0xFFFFFFFF, ip6_table_index=0xFFFFFFFF, l2_table_index=0xFFFFFFFF): """ :param is_add: :param sw_if_index: :param ip4_table_index: (Default value = 0xFFFFFFFF) :param ip6_table_index: (Default value = 0xFFFFFFFF) :param l2_table_index: (Default value = 0xFFFFFFFF) """ return self.api( self.papi.input_acl_set_interface, {'sw_if_index' : sw_if_index, 'ip4_table_index' : ip4_table_index, 'ip6_table_index' : ip6_table_index, 'l2_table_index' : l2_table_index, 'is_add' : is_add})
class VppApi(object): def __init__(self): self.vpp = None jsonfiles = [] for root, dirnames, filenames in os.walk(vpp_json_dir_core): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(vpp_json_dir_core, filename)) for root, dirnames, filenames in os.walk(vpp_json_dir_plugins): for filename in fnmatch.filter(filenames, '*.api.json'): jsonfiles.append(os.path.join(vpp_json_dir_plugins, filename)) self.vpp = VPP(jsonfiles) def connect(self): resp = self.vpp.connect("ligato-test-api") if resp != 0: raise RuntimeError("VPP papi connection failed.") def list_capabilities(self): print(dir(self.vpp.api)) def disconnect(self): resp = self.vpp.disconnect() if resp != 0: print("Warning: VPP papi disconnect failed.") def show_version(self): print(self.vpp.api.show_version()) def process_json_request(self, args): """Process the request/reply and dump classes of VPP API methods. :param args: Command line arguments passed to VPP PAPI Provider. :type args: ArgumentParser :returns: JSON formatted string. :rtype: str :raises RuntimeError: If PAPI command error occurs. """ vpp = self.vpp reply = list() def process_value(val): """Process value. :param val: Value to be processed. :type val: object :returns: Processed value. :rtype: dict or str or int """ if isinstance(val, dict): for val_k, val_v in val.items(): val[str(val_k)] = process_value(val_v) return val elif isinstance(val, list): for idx, val_l in enumerate(val): val[idx] = process_value(val_l) return val elif isinstance(val, str): return binascii.unhexlify(val) elif isinstance(val, int): return val else: return str(val) self.connect() json_data = json.loads(args.data) for data in json_data: api_name = data['api_name'] api_args_unicode = data['api_args'] api_reply = dict(api_name=api_name) api_args = dict() for a_k, a_v in api_args_unicode.items(): api_args[str(a_k)] = process_value(a_v) try: papi_fn = getattr(vpp.api, api_name) rep = papi_fn(**api_args) if isinstance(rep, list): converted_reply = list() for r in rep: converted_reply.append(_convert_reply(r)) else: converted_reply = _convert_reply(rep) api_reply['api_reply'] = converted_reply reply.append(api_reply) except (AttributeError, ValueError) as err: vpp.disconnect() raise RuntimeError( 'PAPI command {api}({args}) input error:\n{err}'.format( api=api_name, args=api_args, err=repr(err))) except Exception as err: vpp.disconnect() raise RuntimeError( 'PAPI command {api}({args}) error:\n{exc}'.format( api=api_name, args=api_args, exc=repr(err))) self.disconnect() return json.dumps(reply)