add example of using Native STL or HLTAPI via JSONRPC calls

2 files changed, 247 insertions, 0 deletions

diff --git a/scripts/automation/trex_control_plane/stl/examples/rpc_proxy_server.py b/scripts/automation/trex_control_plane/stl/examples/rpc_proxy_server.py
new file mode 100755
index 00000000..39d642f4
--- /dev/null
+++ b/scripts/automation/trex_control_plane/stl/examples/rpc_proxy_server.py
@@ -0,0 +1,146 @@
+#!/usr/bin/python
+
+import argparse
+import traceback
+import logging
+import sys
+import os
+import json
+logging.basicConfig(level = logging.FATAL) # keep quiet
+
+import stl_path
+from trex_stl_lib.api import *
+from trex_stl_lib.trex_stl_hltapi import CTRexHltApi, HLT_ERR
+
+# ext libs
+ext_libs = os.path.join(os.pardir, os.pardir, os.pardir, os.pardir, 'external_libs')
+sys.path.append(os.path.join(ext_libs, 'jsonrpclib-pelix-0.2.5'))
+from jsonrpclib.SimpleJSONRPCServer import SimpleJSONRPCServer
+import yaml
+
+# TODO: refactor this to class
+
+native_client = None
+hltapi_client = None
+
+def OK(res = True):
+    return[True, res]
+
+def ERR(res = 'Unknown error'):
+    return [False, res]
+
+def deunicode_json(data):
+    return yaml.safe_load(json.dumps(data))
+
+
+### Server functions ###
+
+def add(a, b): # for sanity checks
+    try:
+        return OK(a + b)
+    except:
+        return ERR(traceback.format_exc())
+
+def check_connectivity():
+    return OK()
+
+def native_proxy_init(force = False, *args, **kwargs):
+    global native_client
+    if native_client and not force:
+        return ERR('Native Client is already initiated')
+    try:
+        native_client = STLClient(*args, **kwargs)
+        return OK('Native Client initiated')
+    except:
+        return ERR(traceback.format_exc())
+
+def native_proxy_del():
+    global native_client
+    native_client = None
+    return OK()
+
+def hltapi_proxy_init(force = False, *args, **kwargs):
+    global hltapi_client
+    if hltapi_client and not force:
+        return ERR('HLTAPI Client is already initiated')
+    try:
+        hltapi_client = CTRexHltApi(*args, **kwargs)
+        return OK('HLTAPI Client initiated')
+    except:
+        return ERR(traceback.format_exc())
+
+def hltapi_proxy_del():
+    global hltapi_client
+    hltapi_client = None
+    return OK()
+
+
+# any method not listed above can be called with passing its name here
+def native_method(func_name, *args, **kwargs):
+    try:
+        func = getattr(native_client, func_name)
+        return OK(func(*deunicode_json(args), **deunicode_json(kwargs)))
+    except:
+        return ERR(traceback.format_exc())
+
+# any HLTAPI method can be called with passing its name here
+def hltapi_method(func_name, *args, **kwargs):
+    try:
+        func = getattr(hltapi_client, func_name)
+        return func(*deunicode_json(args), **deunicode_json(kwargs))
+    except:
+        return HLT_ERR(traceback.format_exc())
+
+### /Server functions ###
+
+
+### Main ###
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description = 'Runs TRex Stateless proxy for usage with any language client.')
+    parser.add_argument('-p', '--port', type=int, default = 8095, dest='port', action = 'store',
+                        help = 'Select port on which the stl proxy will run.\nDefault is 8095.')
+    args = parser.parse_args()
+    native_methods = [
+                      'acquire',
+                      'connect',
+                      'disconnect',
+                      'get_stats',
+                      'get_warnings',
+                      'push_remote',
+                      'reset',
+                      'wait_on_traffic',
+                     ]
+    hltapi_methods = [
+                      'connect',
+                      'cleanup_session',
+                      'interface_config',
+                      'traffic_config',
+                      'traffic_control',
+                      'traffic_stats',
+                     ]
+
+    try:
+        server = SimpleJSONRPCServer(('0.0.0.0', args.port))
+        server.register_function(add)
+        server.register_function(check_connectivity)
+        server.register_function(native_proxy_init)
+        server.register_function(native_proxy_del)
+        server.register_function(hltapi_proxy_init)
+        server.register_function(hltapi_proxy_del)
+
+        for method in native_methods:
+            server.register_function(lambda  method=method, *args, **kwargs: native_method(method, *args, **kwargs), method)
+        server.register_function(native_method)
+        for method in hltapi_methods:
+            if method == 'connect':
+                server.register_function(lambda  method=method, *args, **kwargs: hltapi_method(method, *args, **kwargs), 'hlt_connect')
+            else:
+                server.register_function(lambda  method=method, *args, **kwargs: hltapi_method(method, *args, **kwargs), method)
+        server.register_function(hltapi_method)
+        print('Started Stateless RPC proxy at port %s' % args.port)
+        server.serve_forever()
+    except KeyboardInterrupt:
+        print('Done')
+
diff --git a/scripts/automation/trex_control_plane/stl/examples/using_rpc_proxy.py b/scripts/automation/trex_control_plane/stl/examples/using_rpc_proxy.py
new file mode 100755
index 00000000..82bf0d0a
--- /dev/null
+++ b/scripts/automation/trex_control_plane/stl/examples/using_rpc_proxy.py
@@ -0,0 +1,101 @@
+#!/router/bin/python
+
+import argparse
+import sys
+import os
+from time import sleep
+
+# ext libs
+ext_libs = os.path.join(os.pardir, os.pardir, os.pardir, os.pardir, 'external_libs')
+sys.path.append(os.path.join(ext_libs, 'jsonrpclib-pelix-0.2.5'))
+import jsonrpclib
+
+def fail(msg):
+    print(msg)
+    sys.exit(1)
+
+def verify(res):
+    if not res[0]:
+        fail(res[1])
+    return res
+
+def verify_hlt(res):
+    if res['status'] == 0:
+        fail(res['log'])
+    return res
+
+### Main ###
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description = 'Use of Stateless through rpc_proxy. (Can be implemented in any language)')
+    parser.add_argument('-s', '--server', type=str, default = 'localhost', dest='server', action = 'store',
+                        help = 'Address of rpc proxy.')
+    parser.add_argument('-p', '--port', type=int, default = 8095, dest='port', action = 'store',
+                        help = 'Port of rpc proxy.\nDefault is 8095.')
+    args = parser.parse_args()
+
+    server = jsonrpclib.Server('http://%s:%s' % (args.server, args.port))
+
+# Native API
+
+    print('Initializing Native Client')
+    verify(server.native_proxy_init(server = args.server, force = True))
+
+    print('Connecting to TRex server')
+    verify(server.connect())
+
+    print('Resetting all ports')
+    verify(server.reset())
+
+    print('Getting ports info')
+    res = verify(server.native_method(func_name = 'get_port_info'))
+    print('Ports info is: %s' % res[1])
+    ports = [port['index'] for port in res[1]]
+
+    print('Sending pcap to ports %s' % ports)
+    verify(server.push_remote(pcap_filename = 'stl/sample.pcap'))
+
+    print('Getting stats')
+    res = verify(server.get_stats())
+    print('Stats: %s' % res[1])
+
+    print('Resetting all ports')
+    verify(server.reset())
+
+    print('Deleting Native Client instance')
+    verify(server.native_proxy_del())
+
+# HLTAPI
+
+    print('Initializing HLTAPI Client')
+    verify(server.hltapi_proxy_init(force = True))
+
+    print('HLTAPI connect')
+    verify_hlt(server.hlt_connect(device = args.server, port_list = ports, reset = True, break_locks = True))
+
+    print('Creating traffic')
+    verify_hlt(server.traffic_config(
+            mode = 'create', bidirectional = True,
+            port_handle = ports[0], port_handle2 = ports[1],
+            frame_size = 100,
+            l3_protocol = 'ipv4',
+            ip_src_addr = '10.0.0.1', ip_src_mode = 'increment', ip_src_count = 254,
+            ip_dst_addr = '8.0.0.1', ip_dst_mode = 'increment', ip_dst_count = 254,
+            l4_protocol = 'udp',
+            udp_dst_port = 12, udp_src_port = 1025,
+            rate_percent = 10, ignore_macs = True,
+            ))
+
+    print('Starting traffic for 5 sec')
+    verify_hlt(server.traffic_control(action = 'run', port_handle = ports[:2]))
+
+    sleep(5)
+    print('Stopping traffic')
+    verify_hlt(server.traffic_control(action = 'stop', port_handle = ports[:2]))
+
+    print('Getting stats')
+    res = verify_hlt(server.traffic_stats(mode = 'aggregate', port_handle = ports[:2]))
+    print(res)
+
+    print('Deleting HLTAPI Client instance')
+    verify(server.hltapi_proxy_del())