tests/transportpce_tests/common/test_utils.py

   1 #!/usr/bin/env python
   2
   3 ##############################################################################
   4 # Copyright (c) 2021 Orange, Inc. and others.  All rights reserved.
   5 #
   6 # All rights reserved. This program and the accompanying materials
   7 # are made available under the terms of the Apache License, Version 2.0
   8 # which accompanies this distribution, and is available at
   9 # http://www.apache.org/licenses/LICENSE-2.0
  10 ##############################################################################
  11
  12 # pylint: disable=no-member
  13
  14 import json
  15 import os
  16 # pylint: disable=wrong-import-order
  17 import sys
  18 import re
  19 import signal
  20 import subprocess
  21 import time
  22
  23 import psutil
  24 import requests
  25
  26 # pylint: disable=import-error
  27 import simulators
  28
  29 SIMS = simulators.SIMS
  30
  31 HONEYNODE_OK_START_MSG = 'Netconf SSH endpoint started successfully at 0.0.0.0'
  32 LIGHTYNODE_OK_START_MSG = 'Data tree change listeners registered'
  33 KARAF_OK_START_MSG = "Transportpce controller started"
  34 LIGHTY_OK_START_MSG = re.escape("lighty.io and RESTCONF-NETCONF started")
  35
  36 ODL_LOGIN = 'admin'
  37 ODL_PWD = 'admin'
  38 NODES_LOGIN = 'admin'
  39 NODES_PWD = 'admin'
  40
  41 TYPE_APPLICATION_JSON = {'Content-Type': 'application/json', 'Accept': 'application/json'}
  42 TYPE_APPLICATION_XML = {'Content-Type': 'application/xml', 'Accept': 'application/xml'}
  43
  44 REQUEST_TIMEOUT = 10
  45
  46 CODE_SHOULD_BE_200 = 'Http status code should be 200'
  47 CODE_SHOULD_BE_201 = 'Http status code should be 201'
  48 T100GE = 'Transponder 100GE'
  49 T0_MULTILAYER_TOPO = 'T0 - Multi-layer topology'
  50 T0_FULL_MULTILAYER_TOPO = 'T0 - Full Multi-layer topology'
  51
  52 SIM_LOG_DIRECTORY = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'log')
  53
  54 process_list = []
  55
  56 if 'USE_ODL_ALT_RESTCONF_PORT' in os.environ:
  57     RESTCONF_PORT = os.environ['USE_ODL_ALT_RESTCONF_PORT']
  58 else:
  59     RESTCONF_PORT = 8181
  60
  61 RESTCONF_PATH_PREFIX = {'rfc8040': '/rests',
  62                         'draft-bierman02': '/restconf'}
  63
  64 if 'USE_ODL_RESTCONF_VERSION' in os.environ:
  65     RESTCONF_VERSION = os.environ['USE_ODL_RESTCONF_VERSION']
  66     if RESTCONF_VERSION not in RESTCONF_PATH_PREFIX:
  67         print('unsupported RESTCONF version ' + RESTCONF_VERSION)
  68         sys.exit(3)
  69 else:
  70     RESTCONF_VERSION = 'rfc8040'
  71
  72 RESTCONF_BASE_URL = 'http://localhost:' + str(RESTCONF_PORT) + RESTCONF_PATH_PREFIX[RESTCONF_VERSION]
  73
  74 if 'USE_ODL_ALT_KARAF_INSTALL_DIR' in os.environ:
  75     KARAF_INSTALLDIR = os.environ['USE_ODL_ALT_KARAF_INSTALL_DIR']
  76 else:
  77     KARAF_INSTALLDIR = 'karaf'
  78
  79 KARAF_LOG = os.path.join(
  80     os.path.dirname(os.path.realpath(__file__)),
  81     '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'data', 'log', 'karaf.log')
  82
  83 if 'USE_LIGHTY' in os.environ and os.environ['USE_LIGHTY'] == 'True':
  84     TPCE_LOG = 'odl-' + str(os.getpid()) + '.log'
  85 else:
  86     TPCE_LOG = KARAF_LOG
  87
  88 #
  89 # Basic HTTP operations
  90 #
  91
  92
  93 def get_request(url):
  94     return requests.request(
  95         'GET', url.format(RESTCONF_BASE_URL),
  96         headers=TYPE_APPLICATION_JSON,
  97         auth=(ODL_LOGIN, ODL_PWD),
  98         timeout=REQUEST_TIMEOUT)
  99
 100
 101 def put_request(url, data):
 102     return requests.request(
 103         'PUT', url.format(RESTCONF_BASE_URL),
 104         data=json.dumps(data),
 105         headers=TYPE_APPLICATION_JSON,
 106         auth=(ODL_LOGIN, ODL_PWD),
 107         timeout=REQUEST_TIMEOUT)
 108
 109
 110 def delete_request(url):
 111     return requests.request(
 112         'DELETE', url.format(RESTCONF_BASE_URL),
 113         headers=TYPE_APPLICATION_JSON,
 114         auth=(ODL_LOGIN, ODL_PWD),
 115         timeout=REQUEST_TIMEOUT)
 116
 117
 118 def post_request(url, data):
 119     if data:
 120         return requests.request(
 121             "POST", url.format(RESTCONF_BASE_URL),
 122             data=json.dumps(data),
 123             headers=TYPE_APPLICATION_JSON,
 124             auth=(ODL_LOGIN, ODL_PWD),
 125             timeout=REQUEST_TIMEOUT)
 126     return requests.request(
 127         "POST", url.format(RESTCONF_BASE_URL),
 128         headers=TYPE_APPLICATION_JSON,
 129         auth=(ODL_LOGIN, ODL_PWD),
 130         timeout=REQUEST_TIMEOUT)
 131
 132 #
 133 # Process management
 134 #
 135
 136
 137 def start_honeynode(log_file: str, sim):
 138     executable = os.path.join(os.path.dirname(os.path.realpath(__file__)),
 139                               '..', '..', 'honeynode', sim[1], 'honeynode-simulator', 'honeycomb-tpce')
 140     sample_directory = os.path.join(os.path.dirname(os.path.realpath(__file__)),
 141                                     '..', '..', 'sample_configs', 'openroadm', sim[1])
 142     if os.path.isfile(executable):
 143         with open(log_file, 'w', encoding='utf-8') as outfile:
 144             return subprocess.Popen(
 145                 [executable, SIMS[sim]['port'], os.path.join(sample_directory, SIMS[sim]['configfile'])],
 146                 stdout=outfile, stderr=outfile)
 147     return None
 148
 149
 150 def start_lightynode(log_file: str, sim):
 151     executable = os.path.join(os.path.dirname(os.path.realpath(__file__)),
 152                               '..', '..', 'lightynode', 'lightynode-openroadm-device', 'start-device.sh')
 153     sample_directory = os.path.join(os.path.dirname(os.path.realpath(__file__)),
 154                                     '..', '..', 'sample_configs', 'openroadm', sim[1])
 155     if os.path.isfile(executable):
 156         with open(log_file, 'w', encoding='utf-8') as outfile:
 157             return subprocess.Popen(
 158                 [executable, "-v" + sim[1], "-p" + SIMS[sim]['port'], "-f" + os.path.join(sample_directory,
 159                                                                                           SIMS[sim]['configfile'])],
 160                 stdout=outfile, stderr=outfile)
 161     return None
 162
 163
 164 def start_sims(sims_list):
 165     if 'USE_SIMS' in os.environ:
 166         sims_to_use = os.environ['USE_SIMS']
 167         print(os.environ['USE_SIMS'] + ' ' + sims_to_use)
 168     else:
 169         sims_to_use = 'honeynode'
 170     if sims_to_use == 'None':
 171         return None
 172     if sims_to_use == 'lightynode':
 173         start_msg = LIGHTYNODE_OK_START_MSG
 174         start_method = start_lightynode
 175         print("lightynode used")
 176     else:
 177         start_msg = HONEYNODE_OK_START_MSG
 178         start_method = start_honeynode
 179     for sim in sims_list:
 180         print('starting simulator ' + sim[0] + ' in OpenROADM device version ' + sim[1] + '...')
 181         log_file = os.path.join(SIM_LOG_DIRECTORY, SIMS[sim]['logfile'])
 182         process = start_method(log_file, sim)
 183         if wait_until_log_contains(log_file, start_msg, 100):
 184             print('simulator for ' + sim[0] + ' started')
 185         else:
 186             print('simulator for ' + sim[0] + ' failed to start')
 187             shutdown_process(process)
 188             for pid in process_list:
 189                 shutdown_process(pid)
 190             sys.exit(3)
 191         process_list.append(process)
 192     return process_list
 193
 194
 195 def start_tpce():
 196     if 'NO_ODL_STARTUP' in os.environ:
 197         print('No OpenDaylight instance to start!')
 198         return []
 199     print('starting OpenDaylight...')
 200     if 'USE_LIGHTY' in os.environ and os.environ['USE_LIGHTY'] == 'True':
 201         process = start_lighty()
 202         start_msg = LIGHTY_OK_START_MSG
 203     else:
 204         process = start_karaf()
 205         start_msg = KARAF_OK_START_MSG
 206     if wait_until_log_contains(TPCE_LOG, start_msg, time_to_wait=100):
 207         print('OpenDaylight started !')
 208     else:
 209         print('OpenDaylight failed to start !')
 210         shutdown_process(process)
 211         for pid in process_list:
 212             shutdown_process(pid)
 213         sys.exit(1)
 214     process_list.append(process)
 215     return process_list
 216
 217
 218 def start_karaf():
 219     print('starting KARAF TransportPCE build...')
 220     executable = os.path.join(
 221         os.path.dirname(os.path.realpath(__file__)),
 222         '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'bin', 'karaf')
 223     with open('odl.log', 'w', encoding='utf-8') as outfile:
 224         return subprocess.Popen(
 225             ['sh', executable, 'server'], stdout=outfile, stderr=outfile, stdin=None)
 226
 227
 228 def start_lighty():
 229     print('starting LIGHTY.IO TransportPCE build...')
 230     executable = os.path.join(
 231         os.path.dirname(os.path.realpath(__file__)),
 232         '..', '..', '..', 'lighty', 'target', 'tpce',
 233         'clean-start-controller.sh')
 234     with open(TPCE_LOG, 'w', encoding='utf-8') as outfile:
 235         return subprocess.Popen(
 236             ['sh', executable], stdout=outfile, stderr=outfile, stdin=None)
 237
 238
 239 def install_karaf_feature(feature_name: str):
 240     print('installing feature ' + feature_name)
 241     executable = os.path.join(
 242         os.path.dirname(os.path.realpath(__file__)),
 243         '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'bin', 'client')
 244 # FIXME: https://jira.opendaylight.org/browse/TRNSPRTPCE-701
 245 # -b option needed below because of Karaf client bug reporte in the JIRA ticket mentioned above
 246     return subprocess.run([executable, '-b'],
 247                           input='feature:install ' + feature_name + '\n feature:list | grep '
 248                           + feature_name + ' \n logout \n',
 249                           universal_newlines=True, check=False)
 250
 251
 252 def shutdown_process(process):
 253     if process is not None:
 254         for child in psutil.Process(process.pid).children():
 255             child.send_signal(signal.SIGINT)
 256             child.wait()
 257         process.send_signal(signal.SIGINT)
 258
 259
 260 def wait_until_log_contains(log_file, regexp, time_to_wait=60):
 261     # pylint: disable=lost-exception
 262     # pylint: disable=consider-using-with
 263     stringfound = False
 264     filefound = False
 265     line = None
 266     try:
 267         with TimeOut(seconds=time_to_wait):
 268             while not os.path.exists(log_file):
 269                 time.sleep(0.2)
 270             filelogs = open(log_file, 'r', encoding='utf-8')
 271             filelogs.seek(0, 2)
 272             filefound = True
 273             print("Searching for pattern '" + regexp + "' in " + os.path.basename(log_file), end='... ', flush=True)
 274             compiled_regexp = re.compile(regexp)
 275             while True:
 276                 line = filelogs.readline()
 277                 if compiled_regexp.search(line):
 278                     print('Pattern found!', end=' ')
 279                     stringfound = True
 280                     break
 281                 if not line:
 282                     time.sleep(0.1)
 283     except TimeoutError:
 284         print('Pattern not found after ' + str(time_to_wait), end=' seconds! ', flush=True)
 285     except PermissionError:
 286         print('Permission Error when trying to access the log file', end=' ... ', flush=True)
 287     finally:
 288         if filefound:
 289             filelogs.close()
 290         else:
 291             print('log file does not exist or is not accessible... ', flush=True)
 292         return stringfound
 293
 294
 295 class TimeOut:
 296     def __init__(self, seconds=1, error_message='Timeout'):
 297         self.seconds = seconds
 298         self.error_message = error_message
 299
 300     def handle_timeout(self, signum, frame):
 301         raise TimeoutError(self.error_message)
 302
 303     def __enter__(self):
 304         signal.signal(signal.SIGALRM, self.handle_timeout)
 305         signal.alarm(self.seconds)
 306
 307     def __exit__(self, type, value, traceback):
 308         # pylint: disable=W0622
 309         signal.alarm(0)
 310
 311 #
 312 # Basic NetCONF device operations
 313 #
 314
 315
 316 def mount_device(node: str, sim: str):
 317     url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
 318            'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}'}
 319     body = {'node': [{
 320         'node-id': node,
 321         'netconf-node-topology:username': NODES_LOGIN,
 322         'netconf-node-topology:password': NODES_PWD,
 323         'netconf-node-topology:host': '127.0.0.1',
 324         'netconf-node-topology:port': SIMS[sim]['port'],
 325         'netconf-node-topology:tcp-only': 'false',
 326         'netconf-node-topology:pass-through': {}}]}
 327     response = put_request(url[RESTCONF_VERSION].format('{}', node), body)
 328     if wait_until_log_contains(TPCE_LOG, 'Triggering notification stream NETCONF for node ' + node, 180):
 329         print('Node ' + node + ' correctly added to tpce topology', end='... ', flush=True)
 330     else:
 331         print('Node ' + node + ' still not added to tpce topology', end='... ', flush=True)
 332         if response.status_code == requests.codes.ok:
 333             print('It was probably loaded at start-up', end='... ', flush=True)
 334         # TODO an else-clause to abort test would probably be nice here
 335     return response
 336
 337
 338 def unmount_device(node: str):
 339     url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
 340            'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}'}
 341     response = delete_request(url[RESTCONF_VERSION].format('{}', node))
 342     if wait_until_log_contains(TPCE_LOG, re.escape("onDeviceDisConnected: " + node), 180):
 343         print('Node ' + node + ' correctly deleted from tpce topology', end='... ', flush=True)
 344     else:
 345         print('Node ' + node + ' still not deleted from tpce topology', end='... ', flush=True)
 346     return response
 347
 348
 349 def check_device_connection(node: str):
 350     url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}?content=nonconfig',
 351            'draft-bierman02': '{}/operational/network-topology:network-topology/topology/topology-netconf/node/{}'}
 352     response = get_request(url[RESTCONF_VERSION].format('{}', node))
 353     res = response.json()
 354     return_key = {'rfc8040': 'network-topology:node',
 355                   'draft-bierman02': 'node'}
 356     if return_key[RESTCONF_VERSION] in res.keys():
 357         connection_status = res[return_key[RESTCONF_VERSION]][0]['netconf-node-topology:connection-status']
 358     else:
 359         connection_status = res['errors']['error'][0]
 360     return {'status_code': response.status_code,
 361             'connection-status': connection_status}
 362
 363
 364 def check_node_request(node: str):
 365     # pylint: disable=line-too-long
 366     url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device?content=config',  # nopep8
 367            'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device'}  # nopep8
 368     response = get_request(url[RESTCONF_VERSION].format('{}', node))
 369     res = response.json()
 370     return_key = {'rfc8040': 'org-openroadm-device:org-openroadm-device',
 371                   'draft-bierman02': 'org-openroadm-device'}
 372     if return_key[RESTCONF_VERSION] in res.keys():
 373         response_attribute = res[return_key[RESTCONF_VERSION]]
 374     else:
 375         response_attribute = res['errors']['error'][0]
 376     return {'status_code': response.status_code,
 377             'org-openroadm-device': response_attribute}
 378
 379
 380 def check_node_attribute_request(node: str, attribute: str, attribute_value: str):
 381     # pylint: disable=line-too-long
 382     url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}={}?content=nonconfig',  # nopep8
 383            'draft-bierman02': '{}/operational/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}/{}'}  # nopep8
 384     response = get_request(url[RESTCONF_VERSION].format('{}', node, attribute, attribute_value))
 385     res = response.json()
 386     return_key = {'rfc8040': 'org-openroadm-device:' + attribute,
 387                   'draft-bierman02': attribute}
 388     if return_key[RESTCONF_VERSION] in res.keys():
 389         response_attribute = res[return_key[RESTCONF_VERSION]]
 390     else:
 391         response_attribute = res['errors']['error'][0]
 392     return {'status_code': response.status_code,
 393             attribute: response_attribute}
 394
 395
 396 def check_node_attribute2_request(node: str, attribute: str, attribute_value: str, attribute2: str):
 397     # pylint: disable=line-too-long
 398     url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}={}/{}?content=config',  # nopep8
 399            'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}/{}/{}'}  # nopep8
 400     response = get_request(url[RESTCONF_VERSION].format('{}', node, attribute, attribute_value, attribute2))
 401     res = response.json()
 402     if attribute2 in res.keys():
 403         response_attribute = res[attribute2]
 404     else:
 405         response_attribute = res['errors']['error'][0]
 406     return {'status_code': response.status_code,
 407             attribute2: response_attribute}
 408
 409
 410 def del_node_attribute_request(node: str, attribute: str, attribute_value: str):
 411     # pylint: disable=line-too-long
 412     url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}={}',  # nopep8
 413            'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/{}/{}'}  # nopep8
 414     response = delete_request(url[RESTCONF_VERSION].format('{}', node, attribute, attribute_value))
 415     return response
 416
 417 #
 418 # Portmapping operations
 419 #
 420
 421
 422 def post_portmapping(payload: str):
 423     url = {'rfc8040': '{}/data/transportpce-portmapping:network',
 424            'draft-bierman02': '{}/config/transportpce-portmapping:network'}
 425     json_payload = json.loads(payload)
 426     response = post_request(url[RESTCONF_VERSION].format('{}'), json_payload)
 427     return {'status_code': response.status_code}
 428
 429
 430 def del_portmapping():
 431     url = {'rfc8040': '{}/data/transportpce-portmapping:network',
 432            'draft-bierman02': '{}/config/transportpce-portmapping:network'}
 433     response = delete_request(url[RESTCONF_VERSION].format('{}'))
 434     return {'status_code': response.status_code}
 435
 436
 437 def get_portmapping_node_attr(node: str, attr: str, value: str):
 438     # pylint: disable=consider-using-f-string
 439     url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}',
 440            'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}'}
 441     target_url = url[RESTCONF_VERSION].format('{}', node)
 442     if attr is not None:
 443         target_url = (target_url + '/{}').format('{}', attr)
 444         if value is not None:
 445             suffix = {'rfc8040': '={}', 'draft-bierman02': '/{}'}
 446             target_url = (target_url + suffix[RESTCONF_VERSION]).format('{}', value)
 447     else:
 448         attr = 'nodes'
 449     response = get_request(target_url)
 450     res = response.json()
 451     return_key = {'rfc8040': 'transportpce-portmapping:' + attr,
 452                   'draft-bierman02': attr}
 453     if return_key[RESTCONF_VERSION] in res.keys():
 454         return_output = res[return_key[RESTCONF_VERSION]]
 455     else:
 456         return_output = res['errors']['error'][0]
 457     return {'status_code': response.status_code,
 458             attr: return_output}
 459
 460 #
 461 # Topology operations
 462 #
 463
 464
 465 def get_ietf_network_request(network: str, content: str):
 466     url = {'rfc8040': '{}/data/ietf-network:networks/network={}?content={}',
 467            'draft-bierman02': '{}/{}/ietf-network:networks/network/{}'}
 468     if RESTCONF_VERSION in ('rfc8040'):
 469         format_args = ('{}', network, content)
 470     elif content == 'config':
 471         format_args = ('{}', content, network)
 472     else:
 473         format_args = ('{}', 'operational', network)
 474     response = get_request(url[RESTCONF_VERSION].format(*format_args))
 475     if bool(response):
 476         res = response.json()
 477         return_key = {'rfc8040': 'ietf-network:network',
 478                       'draft-bierman02': 'network'}
 479         networks = res[return_key[RESTCONF_VERSION]]
 480     else:
 481         networks = None
 482     return {'status_code': response.status_code,
 483             'network': networks}
 484
 485
 486 def put_ietf_network(network: str, payload: str):
 487     url = {'rfc8040': '{}/data/ietf-network:networks/network={}',
 488            'draft-bierman02': '{}/config/ietf-network:networks/network/{}'}
 489     json_payload = json.loads(payload)
 490     response = put_request(url[RESTCONF_VERSION].format('{}', network), json_payload)
 491     return {'status_code': response.status_code}
 492
 493
 494 def del_ietf_network(network: str):
 495     url = {'rfc8040': '{}/data/ietf-network:networks/network={}',
 496            'draft-bierman02': '{}/config/ietf-network:networks/network/{}'}
 497     response = delete_request(url[RESTCONF_VERSION].format('{}', network))
 498     return {'status_code': response.status_code}
 499
 500
 501 def get_ietf_network_link_request(network: str, link: str, content: str):
 502     url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}?content={}',
 503            'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
 504     if RESTCONF_VERSION in ('rfc8040'):
 505         format_args = ('{}', network, link, content)
 506     elif content == 'config':
 507         format_args = ('{}', content, network, link)
 508     else:
 509         format_args = ('{}', 'operational', network, link)
 510     response = get_request(url[RESTCONF_VERSION].format(*format_args))
 511     res = response.json()
 512     return_key = {'rfc8040': 'ietf-network-topology:link',
 513                   'draft-bierman02': 'ietf-network-topology:link'}
 514     link = res[return_key[RESTCONF_VERSION]][0]
 515     return {'status_code': response.status_code,
 516             'link': link}
 517
 518
 519 def del_ietf_network_link_request(network: str, link: str, content: str):
 520     url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}?content={}',
 521            'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
 522     if RESTCONF_VERSION in ('rfc8040'):
 523         format_args = ('{}', network, link, content)
 524     elif content == 'config':
 525         format_args = ('{}', content, network, link)
 526     else:
 527         format_args = ('{}', 'operational', network, link)
 528     response = delete_request(url[RESTCONF_VERSION].format(*format_args))
 529     return response
 530
 531
 532 def add_oms_attr_request(link: str, oms_attr: str):
 533     url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}',
 534            'draft-bierman02': '{}/config/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
 535     url2 = url[RESTCONF_VERSION] + '/org-openroadm-network-topology:OMS-attributes/span'
 536     network = 'openroadm-topology'
 537     response = put_request(url2.format('{}', network, link), oms_attr)
 538     return response
 539
 540
 541 def del_oms_attr_request(link: str,):
 542     url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}',
 543            'draft-bierman02': '{}/config/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
 544     url2 = url[RESTCONF_VERSION] + '/org-openroadm-network-topology:OMS-attributes/span'
 545     network = 'openroadm-topology'
 546     response = delete_request(url2.format('{}', network, link))
 547     return response
 548
 549
 550 def get_ietf_network_node_request(network: str, node: str, content: str):
 551     url = {'rfc8040': '{}/data/ietf-network:networks/network={}/node={}?content={}',
 552            'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/node/{}'}
 553     if RESTCONF_VERSION in ('rfc8040'):
 554         format_args = ('{}', network, node, content)
 555     elif content == 'config':
 556         format_args = ('{}', content, network, node)
 557     else:
 558         format_args = ('{}', 'operational', network, node)
 559     response = get_request(url[RESTCONF_VERSION].format(*format_args))
 560     if bool(response):
 561         res = response.json()
 562         return_key = {'rfc8040': 'ietf-network:node',
 563                       'draft-bierman02': 'node'}
 564         node = res[return_key[RESTCONF_VERSION]][0]
 565     else:
 566         node = None
 567     return {'status_code': response.status_code,
 568             'node': node}
 569
 570
 571 def del_ietf_network_node_request(network: str, node: str, content: str):
 572     url = {'rfc8040': '{}/data/ietf-network:networks/network={}/node={}?content={}',
 573            'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/node/{}'}
 574     if RESTCONF_VERSION in ('rfc8040'):
 575         format_args = ('{}', network, node, content)
 576     elif content == 'config':
 577         format_args = ('{}', content, network, node)
 578     else:
 579         format_args = ('{}', 'operational', network, node)
 580     response = delete_request(url[RESTCONF_VERSION].format(*format_args))
 581     return response
 582
 583
 584 #
 585 # Service list operations
 586 #
 587
 588
 589 def get_ordm_serv_list_request():
 590     url = {'rfc8040': '{}/data/org-openroadm-service:service-list?content=nonconfig',
 591            'draft-bierman02': '{}/operational/org-openroadm-service:service-list/'}
 592     response = get_request(url[RESTCONF_VERSION])
 593     res = response.json()
 594     return_key = {'rfc8040': 'org-openroadm-service:service-list',
 595                   'draft-bierman02': 'service-list'}
 596     if return_key[RESTCONF_VERSION] in res.keys():
 597         response_attribute = res[return_key[RESTCONF_VERSION]]
 598     else:
 599         response_attribute = res['errors']['error'][0]
 600     return {'status_code': response.status_code,
 601             'service-list': response_attribute}
 602
 603
 604 def get_ordm_serv_list_attr_request(attribute: str, value: str):
 605     url = {'rfc8040': '{}/data/org-openroadm-service:service-list/{}={}?content=nonconfig',
 606            'draft-bierman02': '{}/operational/org-openroadm-service:service-list/{}/{}'}
 607     format_args = ('{}', attribute, value)
 608     response = get_request(url[RESTCONF_VERSION].format(*format_args))
 609     res = response.json()
 610     return_key = {'rfc8040': 'org-openroadm-service:' + attribute,
 611                   'draft-bierman02': attribute}
 612     if return_key[RESTCONF_VERSION] in res.keys():
 613         response_attribute = res[return_key[RESTCONF_VERSION]]
 614     else:
 615         response_attribute = res['errors']['error'][0]
 616     return {'status_code': response.status_code,
 617             attribute: response_attribute}
 618
 619
 620 def get_serv_path_list_attr(attribute: str, value: str):
 621     url = {'rfc8040': '{}/data/transportpce-service-path:service-path-list/{}={}?content=nonconfig',
 622            'draft-bierman02': '{}/operational/transportpce-service-path:service-path-list/{}/{}'}
 623     response = get_request(url[RESTCONF_VERSION].format('{}', attribute, value))
 624     res = response.json()
 625     return_key = {'rfc8040': 'transportpce-service-path:' + attribute,
 626                   'draft-bierman02': attribute}
 627     if return_key[RESTCONF_VERSION] in res.keys():
 628         response_attribute = res[return_key[RESTCONF_VERSION]]
 629     else:
 630         response_attribute = res['errors']['error'][0]
 631     return {'status_code': response.status_code,
 632             attribute: response_attribute}
 633
 634
 635 #
 636 # TransportPCE internal API RPCs
 637 #
 638
 639
 640 def prepend_dict_keys(input_dict: dict, prefix: str):
 641     return_dict = {}
 642     for key, value in input_dict.items():
 643         newkey = prefix + key
 644         if isinstance(value, dict):
 645             return_dict[newkey] = prepend_dict_keys(value, prefix)
 646             # TODO: perhaps some recursion depth limit or another solution has to be considered here
 647             # even if recursion depth is given by the input_dict argument
 648             # direct (self-)recursive functions may carry unwanted side-effects such as ressource consumptions
 649         else:
 650             return_dict[newkey] = value
 651     return return_dict
 652
 653
 654 def transportpce_api_rpc_request(api_module: str, rpc: str, payload: dict):
 655     # pylint: disable=consider-using-f-string
 656     url = "{}/operations/{}:{}".format('{}', api_module, rpc)
 657     if payload is None:
 658         data = None
 659     elif RESTCONF_VERSION == 'draft-bierman02':
 660         data = prepend_dict_keys({'input': payload}, api_module + ':')
 661     else:
 662         data = {'input': payload}
 663     response = post_request(url, data)
 664     if response.status_code == requests.codes.no_content:
 665         return_output = None
 666     else:
 667         res = response.json()
 668         return_key = {'rfc8040': api_module + ':output',
 669                       'draft-bierman02': 'output'}
 670         if response.status_code == requests.codes.internal_server_error:
 671             return_output = res
 672         else:
 673             return_output = res[return_key[RESTCONF_VERSION]]
 674     return {'status_code': response.status_code,
 675             'output': return_output}