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