3 ##############################################################################
4 # Copyright (c) 2021 Orange, Inc. and others. All rights reserved.
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 ##############################################################################
12 # pylint: disable=no-member
16 # pylint: disable=wrong-import-order
26 # pylint: disable=import-error
29 SIMS = simulators.SIMS
31 HONEYNODE_OK_START_MSG = 'Netconf SSH endpoint started successfully at 0.0.0.0'
32 KARAF_OK_START_MSG = re.escape(
33 "Blueprint container for bundle org.opendaylight.netconf.restconf")+".* was successfully created"
34 LIGHTY_OK_START_MSG = re.escape("lighty.io and RESTCONF-NETCONF started")
41 TYPE_APPLICATION_JSON = {'Content-Type': 'application/json', 'Accept': 'application/json'}
42 TYPE_APPLICATION_XML = {'Content-Type': 'application/xml', 'Accept': 'application/xml'}
44 CODE_SHOULD_BE_200 = 'Http status code should be 200'
45 CODE_SHOULD_BE_201 = 'Http status code should be 201'
47 SIM_LOG_DIRECTORY = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'log')
51 if 'USE_ODL_ALT_RESTCONF_PORT' in os.environ:
52 RESTCONF_PORT = os.environ['USE_ODL_ALT_RESTCONF_PORT']
56 RESTCONF_PATH_PREFIX = {'rfc8040': '/rests',
57 'draft-bierman02': '/restconf'}
58 if 'USE_ODL_RESTCONF_VERSION' in os.environ:
59 RESTCONF_VERSION = os.environ['USE_ODL_RESTCONF_VERSION']
60 if RESTCONF_VERSION not in RESTCONF_PATH_PREFIX:
61 print('unsupported RESTCONF version ' + RESTCONF_VERSION)
64 RESTCONF_VERSION = 'rfc8040'
66 RESTCONF_BASE_URL = 'http://localhost:' + RESTCONF_PORT + RESTCONF_PATH_PREFIX[RESTCONF_VERSION]
68 if 'USE_ODL_ALT_KARAF_INSTALL_DIR' in os.environ:
69 KARAF_INSTALLDIR = os.environ['USE_ODL_ALT_KARAF_INSTALL_DIR']
71 KARAF_INSTALLDIR = 'karaf'
73 KARAF_LOG = os.path.join(
74 os.path.dirname(os.path.realpath(__file__)),
75 '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'data', 'log', 'karaf.log')
77 if 'USE_LIGHTY' in os.environ and os.environ['USE_LIGHTY'] == 'True':
78 TPCE_LOG = 'odl-' + str(os.getpid()) + '.log'
83 # Basic HTTP operations
88 return requests.request(
89 'GET', url.format(RESTCONF_BASE_URL),
90 headers=TYPE_APPLICATION_JSON,
91 auth=(ODL_LOGIN, ODL_PWD))
94 def put_request(url, data):
95 return requests.request(
96 'PUT', url.format(RESTCONF_BASE_URL),
97 data=json.dumps(data),
98 headers=TYPE_APPLICATION_JSON,
99 auth=(ODL_LOGIN, ODL_PWD))
102 def delete_request(url):
103 return requests.request(
104 'DELETE', url.format(RESTCONF_BASE_URL),
105 headers=TYPE_APPLICATION_JSON,
106 auth=(ODL_LOGIN, ODL_PWD))
109 def post_request(url, data):
111 print(json.dumps(data))
112 return requests.request(
113 "POST", url.format(RESTCONF_BASE_URL),
114 data=json.dumps(data),
115 headers=TYPE_APPLICATION_JSON,
116 auth=(ODL_LOGIN, ODL_PWD))
117 return requests.request(
118 "POST", url.format(RESTCONF_BASE_URL),
119 headers=TYPE_APPLICATION_JSON,
120 auth=(ODL_LOGIN, ODL_PWD))
127 def start_sims(sims_list):
128 for sim in sims_list:
129 print('starting simulator ' + sim[0] + ' in OpenROADM device version ' + sim[1] + '...')
130 log_file = os.path.join(SIM_LOG_DIRECTORY, SIMS[sim]['logfile'])
131 process = start_honeynode(log_file, sim)
132 if wait_until_log_contains(log_file, HONEYNODE_OK_START_MSG, 100):
133 print('simulator for ' + sim[0] + ' started')
135 print('simulator for ' + sim[0] + ' failed to start')
136 shutdown_process(process)
137 for pid in process_list:
138 shutdown_process(pid)
140 process_list.append(process)
145 print('starting OpenDaylight...')
146 if 'USE_LIGHTY' in os.environ and os.environ['USE_LIGHTY'] == 'True':
147 process = start_lighty()
148 start_msg = LIGHTY_OK_START_MSG
150 process = start_karaf()
151 start_msg = KARAF_OK_START_MSG
152 if wait_until_log_contains(TPCE_LOG, start_msg, time_to_wait=300):
153 print('OpenDaylight started !')
155 print('OpenDaylight failed to start !')
156 shutdown_process(process)
157 for pid in process_list:
158 shutdown_process(pid)
160 process_list.append(process)
165 print('starting KARAF TransportPCE build...')
166 executable = os.path.join(
167 os.path.dirname(os.path.realpath(__file__)),
168 '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'bin', 'karaf')
169 with open('odl.log', 'w', encoding='utf-8') as outfile:
170 return subprocess.Popen(
171 ['sh', executable, 'server'], stdout=outfile, stderr=outfile, stdin=None)
175 print('starting LIGHTY.IO TransportPCE build...')
176 executable = os.path.join(
177 os.path.dirname(os.path.realpath(__file__)),
178 '..', '..', '..', 'lighty', 'target', 'tpce',
179 'clean-start-controller.sh')
180 with open(TPCE_LOG, 'w', encoding='utf-8') as outfile:
181 return subprocess.Popen(
182 ['sh', executable], stdout=outfile, stderr=outfile, stdin=None)
185 def install_karaf_feature(feature_name: str):
186 print('installing feature ' + feature_name)
187 executable = os.path.join(
188 os.path.dirname(os.path.realpath(__file__)),
189 '..', '..', '..', KARAF_INSTALLDIR, 'target', 'assembly', 'bin', 'client')
190 return subprocess.run([executable],
191 input='feature:install ' + feature_name + '\n feature:list | grep '
192 + feature_name + ' \n logout \n',
193 universal_newlines=True, check=False)
196 def shutdown_process(process):
197 if process is not None:
198 for child in psutil.Process(process.pid).children():
199 child.send_signal(signal.SIGINT)
201 process.send_signal(signal.SIGINT)
204 def start_honeynode(log_file: str, sim):
205 executable = os.path.join(os.path.dirname(os.path.realpath(__file__)),
206 '..', '..', 'honeynode', sim[1], 'honeynode-simulator', 'honeycomb-tpce')
207 sample_directory = os.path.join(os.path.dirname(os.path.realpath(__file__)),
208 '..', '..', 'sample_configs', 'openroadm', sim[1])
209 if os.path.isfile(executable):
210 with open(log_file, 'w', encoding='utf-8') as outfile:
211 return subprocess.Popen(
212 [executable, SIMS[sim]['port'], os.path.join(sample_directory, SIMS[sim]['configfile'])],
213 stdout=outfile, stderr=outfile)
217 def wait_until_log_contains(log_file, regexp, time_to_wait=60):
218 # pylint: disable=lost-exception
219 # pylint: disable=consider-using-with
224 with TimeOut(seconds=time_to_wait):
225 while not os.path.exists(log_file):
227 filelogs = open(log_file, 'r', encoding='utf-8')
230 print("Searching for pattern '" + regexp + "' in " + os.path.basename(log_file), end='... ', flush=True)
231 compiled_regexp = re.compile(regexp)
233 line = filelogs.readline()
234 if compiled_regexp.search(line):
235 print('Pattern found!', end=' ')
241 print('Pattern not found after ' + str(time_to_wait), end=' seconds! ', flush=True)
242 except PermissionError:
243 print('Permission Error when trying to access the log file', end=' ... ', flush=True)
248 print('log file does not exist or is not accessible... ', flush=True)
253 def __init__(self, seconds=1, error_message='Timeout'):
254 self.seconds = seconds
255 self.error_message = error_message
257 def handle_timeout(self, signum, frame):
258 raise TimeoutError(self.error_message)
261 signal.signal(signal.SIGALRM, self.handle_timeout)
262 signal.alarm(self.seconds)
264 def __exit__(self, type, value, traceback):
265 # pylint: disable=W0622
269 # Basic NetCONF device operations
273 def mount_device(node: str, sim: str):
274 url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
275 'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}'}
278 'netconf-node-topology:username': NODES_LOGIN,
279 'netconf-node-topology:password': NODES_PWD,
280 'netconf-node-topology:host': '127.0.0.1',
281 'netconf-node-topology:port': SIMS[sim]['port'],
282 'netconf-node-topology:tcp-only': 'false',
283 'netconf-node-topology:pass-through': {}}]}
284 response = put_request(url[RESTCONF_VERSION].format('{}', node), body)
285 if wait_until_log_contains(TPCE_LOG, re.escape('Triggering notification stream NETCONF for node ' + node), 180):
286 print('Node ' + node + ' correctly added to tpce topology', end='... ', flush=True)
288 print('Node ' + node + ' still not added to tpce topology', end='... ', flush=True)
289 if response.status_code == requests.codes.ok:
290 print('It was probably loaded at start-up', end='... ', flush=True)
291 # TODO an else-clause to abort test would probably be nice here
295 def unmount_device(node: str):
296 url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
297 'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}'}
298 response = delete_request(url[RESTCONF_VERSION].format('{}', node))
299 if wait_until_log_contains(TPCE_LOG, re.escape("onDeviceDisConnected: " + node), 180):
300 print('Node ' + node + ' correctly deleted from tpce topology', end='... ', flush=True)
302 print('Node ' + node + ' still not deleted from tpce topology', end='... ', flush=True)
306 def check_device_connection(node: str):
307 url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}',
308 'draft-bierman02': '{}/operational/network-topology:network-topology/topology/topology-netconf/node/{}'}
309 response = get_request(url[RESTCONF_VERSION].format('{}', node))
310 res = response.json()
311 return_key = {'rfc8040': 'network-topology:node',
312 'draft-bierman02': 'node'}
313 if return_key[RESTCONF_VERSION] in res.keys():
314 connection_status = res[return_key[RESTCONF_VERSION]][0]['netconf-node-topology:connection-status']
316 connection_status = res['errors']['error'][0]
317 return {'status_code': response.status_code,
318 'connection-status': connection_status}
321 def check_interface_request(node: str, interface: str):
322 # pylint: disable=line-too-long
323 url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/interface={}', # nopep8
324 'draft-bierman02': '{}/operational/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/interface/{}'} # nopep8
325 response = get_request(url[RESTCONF_VERSION].format('{}', node, interface))
326 res = response.json()
327 return_key = {'rfc8040': 'org-openroadm-device:interface',
328 'draft-bierman02': 'interface'}
329 if return_key[RESTCONF_VERSION] in res.keys():
330 interface = res[return_key[RESTCONF_VERSION]]
332 interface = res['errors']['error'][0]
333 return {'status_code': response.status_code,
334 'interface': interface}
337 def del_interface_request(node: str, interface: str):
338 # pylint: disable=line-too-long
339 url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/interface={}', # nopep8
340 'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/interface/{}'} # nopep8
341 # draft-bierman02: note this is config here and not operational as previously in check_interface_request
342 response = delete_request(url[RESTCONF_VERSION].format('{}', node, interface))
346 def check_roadm_connections_request(node: str, connections: str):
347 # pylint: disable=line-too-long
348 url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/roadm-connections={}', # nopep8
349 'draft-bierman02': '{}/operational/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/roadm-connections/{}'} # nopep8
350 response = get_request(url[RESTCONF_VERSION].format('{}', node, connections))
351 res = response.json()
352 return_key = {'rfc8040': 'org-openroadm-device:roadm-connections',
353 'draft-bierman02': 'roadm-connections'}
354 if return_key[RESTCONF_VERSION] in res.keys():
355 roadm_connections = res[return_key[RESTCONF_VERSION]]
357 roadm_connections = res['errors']['error'][0]
358 return {'status_code': response.status_code,
359 'roadm-connections': roadm_connections}
362 def del_roadm_connections_request(node: str, connections: str):
363 # pylint: disable=line-too-long
364 url = {'rfc8040': '{}/data/network-topology:network-topology/topology=topology-netconf/node={}/yang-ext:mount/org-openroadm-device:org-openroadm-device/roadm-connections={}', # nopep8
365 'draft-bierman02': '{}/config/network-topology:network-topology/topology/topology-netconf/node/{}/yang-ext:mount/org-openroadm-device:org-openroadm-device/roadm-connections/{}'} # nopep8
366 # draft-bierman02: note this is config here and not operational as previously in check_interface_request
367 response = delete_request(url[RESTCONF_VERSION].format('{}', node, connections))
371 # Portmapping operations
375 def get_portmapping(node: str):
376 url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}',
377 'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}'}
378 response = get_request(url[RESTCONF_VERSION].format('{}', node))
379 res = response.json()
380 return_key = {'rfc8040': 'transportpce-portmapping:nodes',
381 'draft-bierman02': 'nodes'}
382 nodes = res[return_key[RESTCONF_VERSION]]
383 return {'status_code': response.status_code,
387 def get_portmapping_node_info(node: str):
388 url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}/node-info',
389 'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}/node-info'}
390 response = get_request(url[RESTCONF_VERSION].format('{}', node))
391 res = response.json()
392 return_key = {'rfc8040': 'transportpce-portmapping:node-info',
393 'draft-bierman02': 'node-info'}
394 if return_key[RESTCONF_VERSION] in res.keys():
395 node_info = res[return_key[RESTCONF_VERSION]]
397 node_info = res['errors']['error'][0]
398 return {'status_code': response.status_code,
399 'node-info': node_info}
402 def portmapping_request(node: str, mapping: str):
403 url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}/mapping={}',
404 'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}/mapping/{}'}
405 response = get_request(url[RESTCONF_VERSION].format('{}', node, mapping))
406 res = response.json()
407 return_key = {'rfc8040': 'transportpce-portmapping:mapping',
408 'draft-bierman02': 'mapping'}
409 mapping = res[return_key[RESTCONF_VERSION]]
410 return {'status_code': response.status_code,
414 def portmapping_mc_capa_request(node: str, mc_capa: str):
415 url = {'rfc8040': '{}/data/transportpce-portmapping:network/nodes={}/mc-capabilities={}',
416 'draft-bierman02': '{}/config/transportpce-portmapping:network/nodes/{}/mc-capabilities/{}'}
417 response = get_request(url[RESTCONF_VERSION].format('{}', node, mc_capa))
418 res = response.json()
419 return_key = {'rfc8040': 'transportpce-portmapping:mc-capabilities',
420 'draft-bierman02': 'mc-capabilities'}
421 capabilities = res[return_key[RESTCONF_VERSION]]
422 return {'status_code': response.status_code,
423 'mc-capabilities': capabilities}
426 # Topology operations
430 def get_ietf_network_request(network: str, content: str):
431 url = {'rfc8040': '{}/data/ietf-network:networks/network={}?content={}',
432 'draft-bierman02': '{}/{}/ietf-network:networks/network/{}'}
433 if RESTCONF_VERSION == 'rfc8040':
434 format_args = ('{}', network, content)
435 elif content == 'config':
436 format_args = ('{}', content, network)
438 format_args = ('{}', 'operational', network)
439 response = get_request(url[RESTCONF_VERSION].format(*format_args))
440 res = response.json()
441 return_key = {'rfc8040': 'ietf-network:network',
442 'draft-bierman02': 'network'}
443 networks = res[return_key[RESTCONF_VERSION]]
444 return {'status_code': response.status_code,
448 def get_ietf_network_link_request(network: str, link: str, content: str):
449 url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}?content={}',
450 'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
451 if RESTCONF_VERSION == 'rfc8040':
452 format_args = ('{}', network, link, content)
453 elif content == 'config':
454 format_args = ('{}', content, network, link)
456 format_args = ('{}', 'operational', network, link)
457 response = get_request(url[RESTCONF_VERSION].format(*format_args))
458 res = response.json()
459 return_key = {'rfc8040': 'ietf-network-topology:link',
460 'draft-bierman02': 'ietf-network-topology:link'}
461 link = res[return_key[RESTCONF_VERSION]][0]
462 return {'status_code': response.status_code,
466 def del_ietf_network_link_request(network: str, link: str, content: str):
467 url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}?content={}',
468 'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
469 if RESTCONF_VERSION == 'rfc8040':
470 format_args = ('{}', network, link, content)
471 elif content == 'config':
472 format_args = ('{}', content, network, link)
474 format_args = ('{}', 'operational', network, link)
475 response = delete_request(url[RESTCONF_VERSION].format(*format_args))
479 def add_oms_attr_request(link: str, oms_attr: str):
480 url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}',
481 'draft-bierman02': '{}/config/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
482 url2 = url[RESTCONF_VERSION] + '/org-openroadm-network-topology:OMS-attributes/span'
483 network = 'openroadm-topology'
484 response = put_request(url2.format('{}', network, link), oms_attr)
488 def del_oms_attr_request(link: str,):
489 url = {'rfc8040': '{}/data/ietf-network:networks/network={}/ietf-network-topology:link={}',
490 'draft-bierman02': '{}/config/ietf-network:networks/network/{}/ietf-network-topology:link/{}'}
491 url2 = url[RESTCONF_VERSION] + '/org-openroadm-network-topology:OMS-attributes/span'
492 network = 'openroadm-topology'
493 response = delete_request(url2.format('{}', network, link))
497 def del_ietf_network_node_request(network: str, node: str, content: str):
498 url = {'rfc8040': '{}/data/ietf-network:networks/network={}/node={}?content={}',
499 'draft-bierman02': '{}/{}/ietf-network:networks/network/{}/node/{}'}
500 if RESTCONF_VERSION == 'rfc8040':
501 format_args = ('{}', network, node, content)
502 elif content == 'config':
503 format_args = ('{}', content, network, node)
505 format_args = ('{}', 'operational', network, node)
506 response = delete_request(url[RESTCONF_VERSION].format(*format_args))
510 # TransportPCE network utils operations
514 def connect_xpdr_to_rdm_request(payload: dict):
515 url = "{}/operations/transportpce-networkutils:init-xpdr-rdm-links"
516 payload_prefix = {'rfc8040': '', 'draft-bierman02': 'networkutils:'}
518 payload_prefix[RESTCONF_VERSION] + "input": {
519 payload_prefix[RESTCONF_VERSION] + "links-input": {
520 payload_prefix[RESTCONF_VERSION] + "xpdr-node": payload['xpdr-node'],
521 payload_prefix[RESTCONF_VERSION] + "xpdr-num": payload['xpdr-num'],
522 payload_prefix[RESTCONF_VERSION] + "network-num": payload['network-num'],
523 payload_prefix[RESTCONF_VERSION] + "rdm-node": payload['rdm-node'],
524 payload_prefix[RESTCONF_VERSION] + "srg-num": payload['srg-num'],
525 payload_prefix[RESTCONF_VERSION] + "termination-point-num": payload['termination-point-num']
529 return post_request(url, data)
532 def connect_rdm_to_xpdr_request(payload: dict):
533 url = "{}/operations/transportpce-networkutils:init-rdm-xpdr-links"
534 payload_prefix = {'rfc8040': '', 'draft-bierman02': 'networkutils:'}
536 payload_prefix[RESTCONF_VERSION] + "input": {
537 payload_prefix[RESTCONF_VERSION] + "links-input": {
538 payload_prefix[RESTCONF_VERSION] + "xpdr-node": payload['xpdr-node'],
539 payload_prefix[RESTCONF_VERSION] + "xpdr-num": payload['xpdr-num'],
540 payload_prefix[RESTCONF_VERSION] + "network-num": payload['network-num'],
541 payload_prefix[RESTCONF_VERSION] + "rdm-node": payload['rdm-node'],
542 payload_prefix[RESTCONF_VERSION] + "srg-num": payload['srg-num'],
543 payload_prefix[RESTCONF_VERSION] + "termination-point-num": payload['termination-point-num']
547 return post_request(url, data)
551 # TransportPCE device renderer service path operations
554 def prepend_dict_keys(input_dict: dict, prefix: str):
556 for key, value in input_dict.items():
557 newkey = prefix + key
558 if isinstance(value, dict):
559 return_dict[newkey] = prepend_dict_keys(value, prefix)
560 # TODO: perhaps some recursion depth limit or another solution has to be considered here
561 # even if recursion depth is given by the input_dict argument
562 # direct (self-)recursive functions may carry unwanted side-effects such as ressource consumptions
564 return_dict[newkey] = value
568 def device_renderer_service_path_request(payload: dict):
569 url = "{}/operations/transportpce-device-renderer:service-path"
570 payload_prefix = {'rfc8040': '', 'draft-bierman02': 'transportpce-device-renderer:'}
571 if RESTCONF_VERSION == 'draft-bierman02':
572 data = prepend_dict_keys(payload, payload_prefix[RESTCONF_VERSION])
575 return post_request(url, data)