Migrate end2end functional tests to RFC8040
[transportpce.git] / tests / transportpce_tests / common / test_utils_rfc8040.py
index 1a5ea6265adcf49706d7c4a099b9a8396f779cde..17ef51d23d086ded0d66c570bb3b309059ae914d 100644 (file)
@@ -57,13 +57,13 @@ RESTCONF_PATH_PREFIX = {'rfc8040': '/rests',
                         'draft-bierman02': '/restconf'}
 if 'USE_ODL_RESTCONF_VERSION' in os.environ:
     RESTCONF_VERSION = os.environ['USE_ODL_RESTCONF_VERSION']
-    if RESTCONF_VERSION not in RESTCONF_PATH_PREFIX.keys():
+    if RESTCONF_VERSION not in RESTCONF_PATH_PREFIX:
         print('unsupported RESTCONF version ' + RESTCONF_VERSION)
         sys.exit(3)
 else:
     RESTCONF_VERSION = 'rfc8040'
 
-RESTCONF_BASE_URL = 'http://localhost:' + RESTCONF_PORT + RESTCONF_PATH_PREFIX[RESTCONF_VERSION]
+RESTCONF_BASE_URL = 'http://localhost:' + str(RESTCONF_PORT) + RESTCONF_PATH_PREFIX[RESTCONF_VERSION]
 
 if 'USE_ODL_ALT_KARAF_INSTALL_DIR' in os.environ:
     KARAF_INSTALLDIR = os.environ['USE_ODL_ALT_KARAF_INSTALL_DIR']
@@ -105,6 +105,19 @@ def delete_request(url):
         headers=TYPE_APPLICATION_JSON,
         auth=(ODL_LOGIN, ODL_PWD))
 
+
+def post_request(url, data):
+    if data:
+        return requests.request(
+            "POST", url.format(RESTCONF_BASE_URL),
+            data=json.dumps(data),
+            headers=TYPE_APPLICATION_JSON,
+            auth=(ODL_LOGIN, ODL_PWD))
+    return requests.request(
+        "POST", url.format(RESTCONF_BASE_URL),
+        headers=TYPE_APPLICATION_JSON,
+        auth=(ODL_LOGIN, ODL_PWD))
+
 #
 # Process management
 #
@@ -268,7 +281,7 @@ def mount_device(node: str, sim: str):
         'netconf-node-topology:tcp-only': 'false',
         'netconf-node-topology:pass-through': {}}]}
     response = put_request(url[RESTCONF_VERSION].format('{}', node), body)
-    if wait_until_log_contains(TPCE_LOG, re.escape('Triggering notification stream NETCONF for node ' + node), 180):
+    if wait_until_log_contains(TPCE_LOG, 'Triggering notification stream NETCONF for node ' + node, 180):
         print('Node ' + node + ' correctly added to tpce topology', end='... ', flush=True)
     else:
         print('Node ' + node + ' still not added to tpce topology', end='... ', flush=True)
@@ -290,7 +303,7 @@ def unmount_device(node: str):
 
 
 def check_device_connection(node: str):
-    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
+    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}?content=nonconfig',
            'draft-bierman02': '{}/operational/network-topology:network-topology/topology/topology-netconf/node/{}'}
     response = get_request(url[RESTCONF_VERSION].format('{}', node))
     res = response.json()
@@ -303,6 +316,60 @@ def check_device_connection(node: str):
     return {'status_code': response.status_code,
             'connection-status': connection_status}
 
+
+def check_node_request(node: str):
+    # pylint: disable=line-too-long
+    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device?content=config',  # nopep8
+           'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device'}  # nopep8
+    response = get_request(url[RESTCONF_VERSION].format('{}', node))
+    res = response.json()
+    return_key = {'rfc8040': 'org-openroadm-device:org-openroadm-device',
+                  'draft-bierman02': 'org-openroadm-device'}
+    if return_key[RESTCONF_VERSION] in res.keys():
+        response_attribute = res[return_key[RESTCONF_VERSION]]
+    else:
+        response_attribute = res['errors']['error'][0]
+    return {'status_code': response.status_code,
+            'org-openroadm-device': response_attribute}
+
+
+def check_node_attribute_request(node: str, attribute: str, attribute_value: str):
+    # pylint: disable=line-too-long
+    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}={}?content=nonconfig',  # nopep8
+           'draft-bierman02': '{}/operational/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}/{}'}  # nopep8
+    response = get_request(url[RESTCONF_VERSION].format('{}', node, attribute, attribute_value))
+    res = response.json()
+    return_key = {'rfc8040': 'org-openroadm-device:' + attribute,
+                  'draft-bierman02': attribute}
+    if return_key[RESTCONF_VERSION] in res.keys():
+        response_attribute = res[return_key[RESTCONF_VERSION]]
+    else:
+        response_attribute = res['errors']['error'][0]
+    return {'status_code': response.status_code,
+            attribute: response_attribute}
+
+
+def check_node_attribute2_request(node: str, attribute: str, attribute_value: str, attribute2: str):
+    # pylint: disable=line-too-long
+    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}={}/{}?content=config',  # nopep8
+           'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}/{}/{}'}  # nopep8
+    response = get_request(url[RESTCONF_VERSION].format('{}', node, attribute, attribute_value, attribute2))
+    res = response.json()
+    if attribute2 in res.keys():
+        response_attribute = res[attribute2]
+    else:
+        response_attribute = res['errors']['error'][0]
+    return {'status_code': response.status_code,
+            attribute2: response_attribute}
+
+
+def del_node_attribute_request(node: str, attribute: str, attribute_value: str):
+    # pylint: disable=line-too-long
+    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}={}',  # nopep8
+           'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}/{}'}  # nopep8
+    response = delete_request(url[RESTCONF_VERSION].format('{}', node, attribute, attribute_value))
+    return response
+
 #
 # Portmapping operations
 #
@@ -347,6 +414,18 @@ def portmapping_request(node: str, mapping: str):
             'mapping': mapping}
 
 
+def portmapping_switching_pool_request(node: str, switching_pool: str):
+    url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}/switching-pool-lcp={}',
+           'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}/switching-pool-lcp/{}'}
+    response = get_request(url[RESTCONF_VERSION].format('{}', node, switching_pool))
+    res = response.json()
+    return_key = {'rfc8040': 'transportpce-portmapping:switching-pool-lcp',
+                  'draft-bierman02': 'switching-pool-lcp'}
+    switching_pool = res[return_key[RESTCONF_VERSION]]
+    return {'status_code': response.status_code,
+            'switching_pool': switching_pool}
+
+
 def portmapping_mc_capa_request(node: str, mc_capa: str):
     url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}/mc-capabilities={}',
            'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}/mc-capabilities/{}'}
@@ -379,3 +458,159 @@ def get_ietf_network_request(network: str, content: str):
     networks = res[return_key[RESTCONF_VERSION]]
     return {'status_code': response.status_code,
             'network': networks}
+
+
+def get_ietf_network_link_request(network: str, link: str, content: str):
+    url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}?content={}',
+           'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
+    if RESTCONF_VERSION == 'rfc8040':
+        format_args = ('{}', network, link, content)
+    elif content == 'config':
+        format_args = ('{}', content, network, link)
+    else:
+        format_args = ('{}', 'operational', network, link)
+    response = get_request(url[RESTCONF_VERSION].format(*format_args))
+    res = response.json()
+    return_key = {'rfc8040': 'ietf-network-topology:link',
+                  'draft-bierman02': 'ietf-network-topology:link'}
+    link = res[return_key[RESTCONF_VERSION]][0]
+    return {'status_code': response.status_code,
+            'link': link}
+
+
+def del_ietf_network_link_request(network: str, link: str, content: str):
+    url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}?content={}',
+           'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
+    if RESTCONF_VERSION == 'rfc8040':
+        format_args = ('{}', network, link, content)
+    elif content == 'config':
+        format_args = ('{}', content, network, link)
+    else:
+        format_args = ('{}', 'operational', network, link)
+    response = delete_request(url[RESTCONF_VERSION].format(*format_args))
+    return response
+
+
+def add_oms_attr_request(link: str, oms_attr: str):
+    url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}',
+           'draft-bierman02': '{}/config/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
+    url2 = url[RESTCONF_VERSION] + '/org-openroadm-network-topology:OMS-attributes/span'
+    network = 'openroadm-topology'
+    response = put_request(url2.format('{}', network, link), oms_attr)
+    return response
+
+
+def del_oms_attr_request(link: str,):
+    url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}',
+           'draft-bierman02': '{}/config/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
+    url2 = url[RESTCONF_VERSION] + '/org-openroadm-network-topology:OMS-attributes/span'
+    network = 'openroadm-topology'
+    response = delete_request(url2.format('{}', network, link))
+    return response
+
+
+def get_ietf_network_node_request(network: str, node: str, content: str):
+    url = {'rfc8040': '{}/data/ietf-network:networks/network={}/node={}?content={}',
+           'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/node/{}'}
+    if RESTCONF_VERSION == 'rfc8040':
+        format_args = ('{}', network, node, content)
+    elif content == 'config':
+        format_args = ('{}', content, network, node)
+    else:
+        format_args = ('{}', 'operational', network, node)
+    response = get_request(url[RESTCONF_VERSION].format(*format_args))
+    res = response.json()
+    return_key = {'rfc8040': 'ietf-network:node',
+                  'draft-bierman02': 'node'}
+    node = res[return_key[RESTCONF_VERSION]][0]
+    return {'status_code': response.status_code,
+            'node': node}
+
+
+def del_ietf_network_node_request(network: str, node: str, content: str):
+    url = {'rfc8040': '{}/data/ietf-network:networks/network={}/node={}?content={}',
+           'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/node/{}'}
+    if RESTCONF_VERSION == 'rfc8040':
+        format_args = ('{}', network, node, content)
+    elif content == 'config':
+        format_args = ('{}', content, network, node)
+    else:
+        format_args = ('{}', 'operational', network, node)
+    response = delete_request(url[RESTCONF_VERSION].format(*format_args))
+    return response
+
+
+#
+# Service list operations
+#
+
+
+def get_ordm_serv_list_request():
+    url = {'rfc8040': '{}/data/org-openroadm-service:service-list?content=nonconfig',
+           'draft-bierman02': '{}/operational/org-openroadm-service:service-list/'}
+    response = get_request(url[RESTCONF_VERSION])
+    res = response.json()
+    return_key = {'rfc8040': 'org-openroadm-service:service-list',
+                  'draft-bierman02': 'service-list'}
+    if return_key[RESTCONF_VERSION] in res.keys():
+        response_attribute = res[return_key[RESTCONF_VERSION]]
+    else:
+        response_attribute = res['errors']['error'][0]
+    return {'status_code': response.status_code,
+            'service-list': response_attribute}
+
+
+def get_ordm_serv_list_attr_request(attribute: str, value: str):
+    url = {'rfc8040': '{}/data/org-openroadm-service:service-list/{}={}?content=nonconfig',
+           'draft-bierman02': '{}/operational/org-openroadm-service:service-list/{}/{}'}
+    if RESTCONF_VERSION == 'rfc8040':
+        format_args = ('{}', attribute, value)
+    else:
+        format_args = ('{}', attribute, value)
+    response = get_request(url[RESTCONF_VERSION].format(*format_args))
+    res = response.json()
+    return_key = {'rfc8040': 'org-openroadm-service:' + attribute,
+                  'draft-bierman02': attribute}
+    if return_key[RESTCONF_VERSION] in res.keys():
+        response_attribute = res[return_key[RESTCONF_VERSION]]
+    else:
+        response_attribute = res['errors']['error'][0]
+    return {'status_code': response.status_code,
+            attribute: response_attribute}
+
+
+#
+# TransportPCE internal API RPCs
+#
+
+
+def prepend_dict_keys(input_dict: dict, prefix: str):
+    return_dict = {}
+    for key, value in input_dict.items():
+        newkey = prefix + key
+        if isinstance(value, dict):
+            return_dict[newkey] = prepend_dict_keys(value, prefix)
+            # TODO: perhaps some recursion depth limit or another solution has to be considered here
+            # even if recursion depth is given by the input_dict argument
+            # direct (self-)recursive functions may carry unwanted side-effects such as ressource consumptions
+        else:
+            return_dict[newkey] = value
+    return return_dict
+
+
+def transportpce_api_rpc_request(api_module: str, rpc: str, payload: dict):
+    # pylint: disable=consider-using-f-string
+    url = "{}/operations/{}:{}".format('{}', api_module, rpc)
+    if payload is None:
+        data = None
+    elif RESTCONF_VERSION == 'draft-bierman02':
+        data = prepend_dict_keys({'input': payload}, api_module + ':')
+    else:
+        data = {'input': payload}
+    response = post_request(url, data)
+    res = response.json()
+    return_key = {'rfc8040': api_module + ':output',
+                  'draft-bierman02': 'output'}
+    return_output = res[return_key[RESTCONF_VERSION]]
+    return {'status_code': response.status_code,
+            'output': return_output}