Reintroduce nb-bierman02 support in new func tests
[transportpce.git] / tests / transportpce_tests / common / test_utils_rfc8040.py
index ab3a0f260c7c3365610462bbaee1dd8f12f44640..1a5ea6265adcf49706d7c4a099b9a8396f779cde 100644 (file)
@@ -28,15 +28,15 @@ import simulators
 
 SIMS = simulators.SIMS
 
-HONEYNODE_OK_START_MSG = "Netconf SSH endpoint started successfully at 0.0.0.0"
+HONEYNODE_OK_START_MSG = 'Netconf SSH endpoint started successfully at 0.0.0.0'
 KARAF_OK_START_MSG = re.escape(
     "Blueprint container for bundle org.opendaylight.netconf.restconf")+".* was successfully created"
 LIGHTY_OK_START_MSG = re.escape("lighty.io and RESTCONF-NETCONF started")
 
-ODL_LOGIN = "admin"
-ODL_PWD = "admin"
-NODES_LOGIN = "admin"
-NODES_PWD = "admin"
+ODL_LOGIN = 'admin'
+ODL_PWD = 'admin'
+NODES_LOGIN = 'admin'
+NODES_PWD = 'admin'
 
 TYPE_APPLICATION_JSON = {'Content-Type': 'application/json', 'Accept': 'application/json'}
 TYPE_APPLICATION_XML = {'Content-Type': 'application/xml', 'Accept': 'application/xml'}
@@ -44,26 +44,37 @@ TYPE_APPLICATION_XML = {'Content-Type': 'application/xml', 'Accept': 'applicatio
 CODE_SHOULD_BE_200 = 'Http status code should be 200'
 CODE_SHOULD_BE_201 = 'Http status code should be 201'
 
-SIM_LOG_DIRECTORY = os.path.join(os.path.dirname(os.path.realpath(__file__)), "log")
+SIM_LOG_DIRECTORY = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'log')
 
 process_list = []
 
-
-if "USE_ODL_ALT_RESTCONF_PORT" in os.environ:
-    RESTCONF_BASE_URL = "http://localhost:" + os.environ['USE_ODL_ALT_RESTCONF_PORT'] + "/rests"
+if 'USE_ODL_ALT_RESTCONF_PORT' in os.environ:
+    RESTCONF_PORT = os.environ['USE_ODL_ALT_RESTCONF_PORT']
+else:
+    RESTCONF_PORT = 8181
+
+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():
+        print('unsupported RESTCONF version ' + RESTCONF_VERSION)
+        sys.exit(3)
 else:
-    RESTCONF_BASE_URL = "http://localhost:8181/rests"
+    RESTCONF_VERSION = 'rfc8040'
 
-if "USE_ODL_ALT_KARAF_INSTALL_DIR" in os.environ:
+RESTCONF_BASE_URL = 'http://localhost:' + 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']
 else:
-    KARAF_INSTALLDIR = "karaf"
+    KARAF_INSTALLDIR = 'karaf'
 
 KARAF_LOG = os.path.join(
     os.path.dirname(os.path.realpath(__file__)),
-    "..", "..", "..", KARAF_INSTALLDIR, "target", "assembly", "data", "log", "karaf.log")
+    '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'data', 'log', 'karaf.log')
 
-if "USE_LIGHTY" in os.environ and os.environ['USE_LIGHTY'] == 'True':
+if 'USE_LIGHTY' in os.environ and os.environ['USE_LIGHTY'] == 'True':
     TPCE_LOG = 'odl-' + str(os.getpid()) + '.log'
 else:
     TPCE_LOG = KARAF_LOG
@@ -75,14 +86,14 @@ else:
 
 def get_request(url):
     return requests.request(
-        "GET", url.format(RESTCONF_BASE_URL),
+        'GET', url.format(RESTCONF_BASE_URL),
         headers=TYPE_APPLICATION_JSON,
         auth=(ODL_LOGIN, ODL_PWD))
 
 
 def put_request(url, data):
     return requests.request(
-        "PUT", url.format(RESTCONF_BASE_URL),
+        'PUT', url.format(RESTCONF_BASE_URL),
         data=json.dumps(data),
         headers=TYPE_APPLICATION_JSON,
         auth=(ODL_LOGIN, ODL_PWD))
@@ -90,7 +101,7 @@ def put_request(url, data):
 
 def delete_request(url):
     return requests.request(
-        "DELETE", url.format(RESTCONF_BASE_URL),
+        'DELETE', url.format(RESTCONF_BASE_URL),
         headers=TYPE_APPLICATION_JSON,
         auth=(ODL_LOGIN, ODL_PWD))
 
@@ -101,13 +112,13 @@ def delete_request(url):
 
 def start_sims(sims_list):
     for sim in sims_list:
-        print("starting simulator " + sim[0] + " in OpenROADM device version " + sim[1] + "...")
+        print('starting simulator ' + sim[0] + ' in OpenROADM device version ' + sim[1] + '...')
         log_file = os.path.join(SIM_LOG_DIRECTORY, SIMS[sim]['logfile'])
         process = start_honeynode(log_file, sim)
         if wait_until_log_contains(log_file, HONEYNODE_OK_START_MSG, 100):
-            print("simulator for " + sim[0] + " started")
+            print('simulator for ' + sim[0] + ' started')
         else:
-            print("simulator for " + sim[0] + " failed to start")
+            print('simulator for ' + sim[0] + ' failed to start')
             shutdown_process(process)
             for pid in process_list:
                 shutdown_process(pid)
@@ -117,17 +128,17 @@ def start_sims(sims_list):
 
 
 def start_tpce():
-    print("starting OpenDaylight...")
-    if "USE_LIGHTY" in os.environ and os.environ['USE_LIGHTY'] == 'True':
+    print('starting OpenDaylight...')
+    if 'USE_LIGHTY' in os.environ and os.environ['USE_LIGHTY'] == 'True':
         process = start_lighty()
         start_msg = LIGHTY_OK_START_MSG
     else:
         process = start_karaf()
         start_msg = KARAF_OK_START_MSG
     if wait_until_log_contains(TPCE_LOG, start_msg, time_to_wait=300):
-        print("OpenDaylight started !")
+        print('OpenDaylight started !')
     else:
-        print("OpenDaylight failed to start !")
+        print('OpenDaylight failed to start !')
         shutdown_process(process)
         for pid in process_list:
             shutdown_process(pid)
@@ -137,31 +148,31 @@ def start_tpce():
 
 
 def start_karaf():
-    print("starting KARAF TransportPCE build...")
+    print('starting KARAF TransportPCE build...')
     executable = os.path.join(
         os.path.dirname(os.path.realpath(__file__)),
-        "..", "..", "..", KARAF_INSTALLDIR, "target", "assembly", "bin", "karaf")
+        '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'bin', 'karaf')
     with open('odl.log', 'w', encoding='utf-8') as outfile:
         return subprocess.Popen(
-            ["sh", executable, "server"], stdout=outfile, stderr=outfile, stdin=None)
+            ['sh', executable, 'server'], stdout=outfile, stderr=outfile, stdin=None)
 
 
 def start_lighty():
-    print("starting LIGHTY.IO TransportPCE build...")
+    print('starting LIGHTY.IO TransportPCE build...')
     executable = os.path.join(
         os.path.dirname(os.path.realpath(__file__)),
-        "..", "..", "..", "lighty", "target", "tpce",
-        "clean-start-controller.sh")
+        '..', '..', '..', 'lighty', 'target', 'tpce',
+        'clean-start-controller.sh')
     with open(TPCE_LOG, 'w', encoding='utf-8') as outfile:
         return subprocess.Popen(
-            ["sh", executable], stdout=outfile, stderr=outfile, stdin=None)
+            ['sh', executable], stdout=outfile, stderr=outfile, stdin=None)
 
 
 def install_karaf_feature(feature_name: str):
-    print("installing feature " + feature_name)
+    print('installing feature ' + feature_name)
     executable = os.path.join(
         os.path.dirname(os.path.realpath(__file__)),
-        "..", "..", "..", KARAF_INSTALLDIR, "target", "assembly", "bin", "client")
+        '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'bin', 'client')
     return subprocess.run([executable],
                           input='feature:install ' + feature_name + '\n feature:list | grep '
                           + feature_name + ' \n logout \n',
@@ -178,9 +189,9 @@ def shutdown_process(process):
 
 def start_honeynode(log_file: str, sim):
     executable = os.path.join(os.path.dirname(os.path.realpath(__file__)),
-                              "..", "..", "honeynode", sim[1], "honeynode-simulator", "honeycomb-tpce")
+                              '..', '..', 'honeynode', sim[1], 'honeynode-simulator', 'honeycomb-tpce')
     sample_directory = os.path.join(os.path.dirname(os.path.realpath(__file__)),
-                                    "..", "..", "sample_configs", "openroadm", sim[1])
+                                    '..', '..', 'sample_configs', 'openroadm', sim[1])
     if os.path.isfile(executable):
         with open(log_file, 'w', encoding='utf-8') as outfile:
             return subprocess.Popen(
@@ -207,20 +218,20 @@ def wait_until_log_contains(log_file, regexp, time_to_wait=60):
             while True:
                 line = filelogs.readline()
                 if compiled_regexp.search(line):
-                    print("Pattern found!", end=' ')
+                    print('Pattern found!', end=' ')
                     stringfound = True
                     break
                 if not line:
                     time.sleep(0.1)
     except TimeoutError:
-        print("Pattern not found after " + str(time_to_wait), end=" seconds! ", flush=True)
+        print('Pattern not found after ' + str(time_to_wait), end=' seconds! ', flush=True)
     except PermissionError:
-        print("Permission Error when trying to access the log file", end=" ... ", flush=True)
+        print('Permission Error when trying to access the log file', end=' ... ', flush=True)
     finally:
         if filefound:
             filelogs.close()
         else:
-            print("log file does not exist or is not accessible... ", flush=True)
+            print('log file does not exist or is not accessible... ', flush=True)
         return stringfound
 
 
@@ -245,46 +256,50 @@ class TimeOut:
 #
 
 
-def mount_device(node_id, sim):
-    url = "{}/data/network-topology:network-topology/topology=topology-netconf/node={}"
-    body = {"node": [{
-        "node-id": node_id,
-        "netconf-node-topology:username": NODES_LOGIN,
-        "netconf-node-topology:password": NODES_PWD,
-        "netconf-node-topology:host": "127.0.0.1",
-        "netconf-node-topology:port": SIMS[sim]['port'],
-        "netconf-node-topology:tcp-only": "false",
-        "netconf-node-topology:pass-through": {}}]}
-    response = put_request(url.format('{}', node_id), body)
-    if wait_until_log_contains(TPCE_LOG, re.escape("Triggering notification stream NETCONF for node " + node_id), 180):
-        print("Node " + node_id + " correctly added to tpce topology", end='... ', flush=True)
+def mount_device(node: str, sim: str):
+    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
+           'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}'}
+    body = {'node': [{
+        'node-id': node,
+        'netconf-node-topology:username': NODES_LOGIN,
+        'netconf-node-topology:password': NODES_PWD,
+        'netconf-node-topology:host': '127.0.0.1',
+        'netconf-node-topology:port': SIMS[sim]['port'],
+        '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):
+        print('Node ' + node + ' correctly added to tpce topology', end='... ', flush=True)
     else:
-        print("Node " + node_id + " still not added to tpce topology", end='... ', flush=True)
+        print('Node ' + node + ' still not added to tpce topology', end='... ', flush=True)
         if response.status_code == requests.codes.ok:
-            print("It was probably loaded at start-up", end='... ', flush=True)
+            print('It was probably loaded at start-up', end='... ', flush=True)
         # TODO an else-clause to abort test would probably be nice here
     return response
 
 
-def unmount_device(node_id):
-    url = "{}/data/network-topology:network-topology/topology=topology-netconf/node={}"
-    response = delete_request(url.format('{}', node_id))
-    if wait_until_log_contains(TPCE_LOG, re.escape("onDeviceDisConnected: " + node_id), 180):
-        print("Node " + node_id + " correctly deleted from tpce topology", end='... ', flush=True)
+def unmount_device(node: str):
+    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
+           'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}'}
+    response = delete_request(url[RESTCONF_VERSION].format('{}', node))
+    if wait_until_log_contains(TPCE_LOG, re.escape("onDeviceDisConnected: " + node), 180):
+        print('Node ' + node + ' correctly deleted from tpce topology', end='... ', flush=True)
     else:
-        print("Node " + node_id + " still not deleted from tpce topology", end='... ', flush=True)
+        print('Node ' + node + ' still not deleted from tpce topology', end='... ', flush=True)
     return response
 
 
 def check_device_connection(node: str):
-    url = "{}/data/network-topology:network-topology/topology=topology-netconf/node={}"
-    response = get_request(url.format('{}', node))
+    url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
+           'draft-bierman02': '{}/operational/network-topology:network-topology/topology/topology-netconf/node/{}'}
+    response = get_request(url[RESTCONF_VERSION].format('{}', node))
     res = response.json()
-    key = 'network-topology:node'
-    if key in res.keys():
-        connection_status = res[key][0]['netconf-node-topology:connection-status']
+    return_key = {'rfc8040': 'network-topology:node',
+                  'draft-bierman02': 'node'}
+    if return_key[RESTCONF_VERSION] in res.keys():
+        connection_status = res[return_key[RESTCONF_VERSION]][0]['netconf-node-topology:connection-status']
     else:
-        connection_status = res['errors']['error']
+        connection_status = res['errors']['error'][0]
     return {'status_code': response.status_code,
             'connection-status': connection_status}
 
@@ -294,41 +309,52 @@ def check_device_connection(node: str):
 
 
 def get_portmapping(node: str):
-    url = "{}/data/transportpce-portmapping:network/nodes={}"
-    response = get_request(url.format('{}', node))
+    url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}',
+           'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}'}
+    response = get_request(url[RESTCONF_VERSION].format('{}', node))
     res = response.json()
-    nodes = res['transportpce-portmapping:nodes']
+    return_key = {'rfc8040': 'transportpce-portmapping:nodes',
+                  'draft-bierman02': 'nodes'}
+    nodes = res[return_key[RESTCONF_VERSION]]
     return {'status_code': response.status_code,
             'nodes': nodes}
 
 
 def get_portmapping_node_info(node: str):
-    url = "{}/data/transportpce-portmapping:network/nodes={}/node-info"
-    response = get_request(url.format('{}', node))
+    url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}/node-info',
+           'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}/node-info'}
+    response = get_request(url[RESTCONF_VERSION].format('{}', node))
     res = response.json()
-    key = 'transportpce-portmapping:node-info'
-    if key in res.keys():
-        node_info = res[key]
+    return_key = {'rfc8040': 'transportpce-portmapping:node-info',
+                  'draft-bierman02': 'node-info'}
+    if return_key[RESTCONF_VERSION] in res.keys():
+        node_info = res[return_key[RESTCONF_VERSION]]
     else:
-        node_info = res['errors']['error']
+        node_info = res['errors']['error'][0]
     return {'status_code': response.status_code,
             'node-info': node_info}
 
 
 def portmapping_request(node: str, mapping: str):
-    url = "{}/data/transportpce-portmapping:network/nodes={}/mapping={}"
-    response = get_request(url.format('{}', node, mapping))
+    url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}/mapping={}',
+           'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}/mapping/{}'}
+    response = get_request(url[RESTCONF_VERSION].format('{}', node, mapping))
     res = response.json()
-    mapping = res['transportpce-portmapping:mapping']
+    return_key = {'rfc8040': 'transportpce-portmapping:mapping',
+                  'draft-bierman02': 'mapping'}
+    mapping = res[return_key[RESTCONF_VERSION]]
     return {'status_code': response.status_code,
             'mapping': mapping}
 
 
 def portmapping_mc_capa_request(node: str, mc_capa: str):
-    url = "{}/data/transportpce-portmapping:network/nodes={}/mc-capabilities={}"
-    response = get_request(url.format('{}', node, mc_capa))
+    url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}/mc-capabilities={}',
+           'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}/mc-capabilities/{}'}
+    response = get_request(url[RESTCONF_VERSION].format('{}', node, mc_capa))
     res = response.json()
-    capabilities = res['transportpce-portmapping:mc-capabilities']
+    return_key = {'rfc8040': 'transportpce-portmapping:mc-capabilities',
+                  'draft-bierman02': 'mc-capabilities'}
+    capabilities = res[return_key[RESTCONF_VERSION]]
     return {'status_code': response.status_code,
             'mc-capabilities': capabilities}
 
@@ -338,9 +364,18 @@ def portmapping_mc_capa_request(node: str, mc_capa: str):
 
 
 def get_ietf_network_request(network: str, content: str):
-    url = "{}/data/ietf-network:networks/network={}?content={}"
-    response = get_request(url.format('{}', network, content))
+    url = {'rfc8040': '{}/data/ietf-network:networks/network={}?content={}',
+           'draft-bierman02': '{}/{}/ietf-network:networks/network/{}'}
+    if RESTCONF_VERSION == 'rfc8040':
+        format_args = ('{}', network, content)
+    elif content == 'config':
+        format_args = ('{}', content, network)
+    else:
+        format_args = ('{}', 'operational', network)
+    response = get_request(url[RESTCONF_VERSION].format(*format_args))
     res = response.json()
-    networks = res['ietf-network:network']
+    return_key = {'rfc8040': 'ietf-network:network',
+                  'draft-bierman02': 'network'}
+    networks = res[return_key[RESTCONF_VERSION]]
     return {'status_code': response.status_code,
             'network': networks}