Migrate Get Requests invocations(libraries)
[integration/test.git] / csit / libraries / MdsalLowlevelPy.py
index e7f38dae95fbb6f23d0fa4b59199747bde225ea3..4e1b24243ac55948cf9919384c17d6f146f21d4b 100644 (file)
@@ -2,7 +2,8 @@
 Python invocation of several parallel publish-notifications RPCs.
 """
 from robot.api import logger
-import Queue
+import time
+import queue
 import requests
 import string
 import threading
@@ -11,35 +12,42 @@ import threading
 _globals = {}
 
 
-def _send_http_request_thread_impl(rqueue, url, data, http_timeout):
+def _send_http_request_thread_impl(rqueue, prefix_id, url, data, http_timeout):
     """Start either publish or write transactions rpc based on input.
 
     :param rqueue: result queue
-    :type rqueue: Queue.Queue
+    :type rqueue: queue.Queue
+    :param prefix_id: identifier for prefix, should imply cluster member index
+    :type prefix_id: str
     :param url: rpc url
-    :type url: string
+    :type url: str
     :param data: http request content
-    :type data: string
+    :type data: str
     :param http_timeout: http response timeout
     :type http_timeout: int
     """
-    logger.info('rpc indoked with details: {}'.format(data))
+    logger.info("rpc invoked with details: {}".format(data))
     try:
-        resp = requests.post(url=url, headers={'Content-Type': 'application/xml'},
-                             data=data, auth=('admin', 'admin'), timeout=http_timeout)
+        resp = requests.post(
+            url=url,
+            headers={"Content-Type": "application/xml"},
+            data=data,
+            auth=("admin", "admin"),
+            timeout=http_timeout,
+        )
     except Exception as exc:
         resp = exc
         logger.debug(exc)
-    rqueue.put(resp)
+    rqueue.put((time.ctime(), prefix_id, resp))
 
 
-def _initiate_rpcs(host_list, prefix_list, url_templ, data_templ, subst_dict):
+def _initiate_rpcs(host_list, index_list, url_templ, data_templ, subst_dict):
     """Initiate rpc on given hosts.
 
-    :param host_list: list of ip address of odl nodes
-    :type host_list: list of strings
-    :param id_prefix: list of node indexes which coresponds to the ip addresses
-    :type id_prefix: string
+    :param host_list: IP addresses of odl nodes
+    :type host_list: list[str]
+    :param index_list: node indices which correspond to the ip addresses
+    :type index_list: list[int]
     :param url_templ: url template
     :type url_templ: string.Template object
     :param data_templ: http request data
@@ -47,33 +55,43 @@ def _initiate_rpcs(host_list, prefix_list, url_templ, data_templ, subst_dict):
     :param subst_dict: dictionary with key value pairs to be used with template
     :type subst_dict: dict
     """
-    resqueue = _globals.pop('result_queue', Queue.Queue())
-    lthreads = _globals.pop('threads', [])
+    resqueue = _globals.pop("result_queue", queue.Queue())
+    lthreads = _globals.pop("threads", [])
     for i, host in enumerate(host_list):
-        subst_dict.update({'ID': '{}{}'.format(subst_dict['ID_PREFIX'], prefix_list[i])})
-        url = url_templ.substitute({'HOST': host})
+        url = url_templ.substitute({"HOST": host})
+        timeout = int(subst_dict["DURATION"]) + 3 * 125 + 10
+        prefix_id = subst_dict["ID_PREFIX"] + str(index_list[i])
+        subst_dict["ID"] = prefix_id
         data = data_templ.substitute(subst_dict)
-        timeout = int(subst_dict['DURATION'])+260
-        logger.info('url: {}, data: {}, timeout: {}'.format(url, data, timeout))
-        t = threading.Thread(target=_send_http_request_thread_impl,
-                             args=(resqueue, url, data, timeout))
+        logger.info("url: {}, data: {}, timeout: {}".format(url, data, timeout))
+        t = threading.Thread(
+            target=_send_http_request_thread_impl,
+            args=(resqueue, prefix_id, url, data, timeout),
+        )
         t.daemon = True
         t.start()
         lthreads.append(t)
 
-    _globals.update({'threads': lthreads, 'result_queue': resqueue})
+    _globals.update({"threads": lthreads, "result_queue": resqueue})
 
 
-def start_write_transactions_on_nodes(host_list, prefix_list, id_prefix, duration, rate, chained_flag=False,
-                                      reset_globals=True):
+def start_write_transactions_on_nodes(
+    host_list,
+    index_list,
+    id_prefix,
+    duration,
+    rate,
+    chained_flag=False,
+    reset_globals=True,
+):
     """Invoke write-transactions rpc on given nodes.
 
-    :param host_list: list of ip address of odl nodes
-    :type host_list: list of strings
-    :param prefix_list: list of node indexes which coresponds to the ip addresses
-    :type prefix_list: list
+    :param host_list: IP addresses of odl nodes
+    :type host_list: list[str]
+    :param index_list: node indices which correspond to the ip addresses
+    :type index_list: list[int]
     :param id_prefix: identifier prefix
-    :type id_prefix: string
+    :type id_prefix: str
     :param duration: time in seconds
     :type duration: int
     :param rate: writing transactions rate in transactions per second
@@ -87,29 +105,47 @@ def start_write_transactions_on_nodes(host_list, prefix_list, id_prefix, duratio
         _globals.clear()
 
     logger.info(
-        "Input parameters: host_list:{}, prefix_list:{}, id_prefix:{}, duration:{}, rate:{}, chained_flag:{}".format(
-            host_list, prefix_list, id_prefix, duration, rate, chained_flag))
-    datat = string.Template('''<input xmlns="tag:opendaylight.org,2017:controller:yang:lowlevel:control">
+        "Input parameters: host_list:{}, index_list:{}, id_prefix:{}, duration:{}, rate:{}, chained_flag:{}".format(
+            host_list, index_list, id_prefix, duration, rate, chained_flag
+        )
+    )
+    datat = string.Template(
+        """<input xmlns="tag:opendaylight.org,2017:controller:yang:lowlevel:control">
   <id>$ID</id>
   <seconds>$DURATION</seconds>
   <transactions-per-second>$RATE</transactions-per-second>
   <chained-transactions>$CHAINED_FLAG</chained-transactions>
-</input>''')
-    subst_dict = {'ID_PREFIX': id_prefix, 'DURATION': duration, 'RATE': rate, 'CHAINED_FLAG': chained_flag}
-    urlt = string.Template('''http://$HOST:8181/restconf/operations/odl-mdsal-lowlevel-control:write-transactions''')
-    _initiate_rpcs(host_list, prefix_list, urlt, datat, subst_dict)
-
-
-def start_produce_transactions_on_nodes(host_list, prefix_list, id_prefix,
-                                        duration, rate, isolated_transactions_flag=False, reset_globals=True):
+</input>"""
+    )
+    subst_dict = {
+        "ID_PREFIX": id_prefix,
+        "DURATION": duration,
+        "RATE": rate,
+        "CHAINED_FLAG": "true" if chained_flag else "false",
+    }
+    urlt = string.Template(
+        """http://$HOST:8181/rests/operations/odl-mdsal-lowlevel-control:write-transactions"""
+    )
+    _initiate_rpcs(host_list, index_list, urlt, datat, subst_dict)
+
+
+def start_produce_transactions_on_nodes(
+    host_list,
+    index_list,
+    id_prefix,
+    duration,
+    rate,
+    isolated_transactions_flag=False,
+    reset_globals=True,
+):
     """Invoke produce-transactions rpcs on given nodes.
 
-    :param host_list: list of ip address of odl nodes
-    :type host_list: list of strings
-    :param prefix_list: list of node indexes which coresponds to the ip addresses
-    :type prefix_list: list
+    :param host_list: IP addresses of odl nodes
+    :type host_list: list[str]
+    :param index_list: node indices which correspond to the ip addresses
+    :type index_list: list[int]
     :param id_prefix: identifier prefix
-    :type id_prefix: string
+    :type id_prefix: str
     :param duration: time in seconds
     :type duration: int
     :param rate: produce transactions rate in transactions per second
@@ -122,26 +158,39 @@ def start_produce_transactions_on_nodes(host_list, prefix_list, id_prefix,
     if reset_globals:
         _globals.clear()
 
-    msg = "host_list:{}, prefix_list:{} ,id_prefix:{}, duration:{}, rate:{}, isolated_transactions:{}".format(
-            host_list, prefix_list, id_prefix, duration, rate, isolated_transactions_flag)
+    msg = "host_list:{}, index_list:{} ,id_prefix:{}, duration:{}, rate:{}, isolated_transactions:{}".format(
+        host_list, index_list, id_prefix, duration, rate, isolated_transactions_flag
+    )
     msg = "Input parameters: " + msg
     logger.info(msg)
-    datat = string.Template('''<input xmlns="tag:opendaylight.org,2017:controller:yang:lowlevel:control">
+    datat = string.Template(
+        """<input xmlns="tag:opendaylight.org,2017:controller:yang:lowlevel:control">
   <id>$ID</id>
   <seconds>$DURATION</seconds>
   <transactions-per-second>$RATE</transactions-per-second>
   <isolated-transactions>$ISOLATED_TRANSACTIONS</isolated-transactions>
-</input>''')
-    subst_dict = {'ID_PREFIX': id_prefix, 'DURATION': duration, 'RATE': rate,
-                  'ISOLATED_TRANSACTIONS': isolated_transactions_flag}
-    urlt = string.Template('''http://$HOST:8181/restconf/operations/odl-mdsal-lowlevel-control:produce-transactions''')
-    _initiate_rpcs(host_list, prefix_list, urlt, datat, subst_dict)
+</input>"""
+    )
+    subst_dict = {
+        "ID_PREFIX": id_prefix,
+        "DURATION": duration,
+        "RATE": rate,
+        "ISOLATED_TRANSACTIONS": "true" if isolated_transactions_flag else "false",
+    }
+    urlt = string.Template(
+        """http://$HOST:8181/rests/operations/odl-mdsal-lowlevel-control:produce-transactions"""
+    )
+    _initiate_rpcs(host_list, index_list, urlt, datat, subst_dict)
 
 
 def wait_for_transactions():
-    """Blocking call, waitig for responses from all threads."""
-    lthreads = _globals.pop('threads')
-    resqueue = _globals.pop('result_queue')
+    """Blocking call, waitig for responses from all threads.
+
+    :return: list of triples; triple consists of response time, prefix identifier and response object
+    :rtype: list[(str, str, requests.Response)]
+    """
+    lthreads = _globals.pop("threads")
+    resqueue = _globals.pop("result_queue")
 
     for t in lthreads:
         t.join()
@@ -150,22 +199,26 @@ def wait_for_transactions():
     while not resqueue.empty():
         results.append(resqueue.get())
     for rsp in results:
-        if isinstance(rsp, requests.Response):
-            logger.info(rsp.text)
+        if isinstance(rsp[2], requests.Response):
+            logger.info(rsp[2].text)
         else:
-            logger.info(rsp)
+            logger.info(rsp[2])
     return results
 
 
 def get_next_transactions_response():
-    """Get http response from write-transactions rpc if available."""
-    resqueue = _globals.get('result_queue')
+    """Get http response from write-transactions rpc if available.
+
+    :return: None or a triple consisting of response time, prefix identifier and response object
+    :rtype: (str, str, requests.Response)
+    """
+    resqueue = _globals.get("result_queue")
 
     if not resqueue.empty():
         rsp = resqueue.get()
-        if isinstance(rsp, requests.Response):
-            logger.info(rsp.text)
+        if isinstance(rsp[2], requests.Response):
+            logger.info(rsp[2].text)
         else:
-            logger.info(rsp)
+            logger.info(rsp[2])
         return rsp
     return None