review sims/tpce start-up sequence in 2.2.1 tests
[transportpce.git] / tests / transportpce_tests / 2.2.1 / test_utils.py
index ec577ad0743090969f50aeac59158157f419d398..79d8fdbaffe383828a7cbe777305215cf1221de9 100644 (file)
+#!/usr/bin/env python
+##############################################################################
+# Copyright (c) 2020 Orange, Inc. and others.  All rights reserved.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+import json
 import os
+import re
+import signal
 import subprocess
 
-def start_xpdra_honeynode():
-    executable = ("./honeynode/2.2.1/honeynode-distribution/target/honeynode-distribution-1.19.04-hc"
-                  "/honeynode-distribution-1.19.04/honeycomb-tpce")
-    if os.path.isfile(executable):
-        with open('honeynode1.log', 'w') as outfile:
-            return subprocess.Popen(
-                [executable, "17840", "sample_configs/openroadm/2.2.1/oper-XPDRA.xml"],
-                stdout=outfile, stderr=outfile)
+import psutil
+import requests
 
-def start_roadma_honeynode():
-    executable = ("./honeynode/2.2.1/honeynode-distribution/target/honeynode-distribution-1.19.04-hc"
-                  "/honeynode-distribution-1.19.04/honeycomb-tpce")
-    if os.path.isfile(executable):
-        with open('honeynode2.log', 'w') as outfile:
-            return subprocess.Popen(
-                [executable, "17841", "sample_configs/openroadm/2.2.1/oper-ROADMA.xml"],
-                stdout=outfile, stderr=outfile)
+sims = {
+    'xpdra': {'port': '17840', 'configfile': 'oper-XPDRA.xml', 'logfile': 'oper-XPDRA.log'},
+    'roadma': {'port': '17841', 'configfile': 'oper-ROADMA.xml', 'logfile': 'oper-ROADMA.log'},
+    'roadmb': {'port': '17842', 'configfile': 'oper-ROADMB.xml', 'logfile': 'oper-ROADMB.log'},
+    'roadmc': {'port': '17843', 'configfile': 'oper-ROADMC.xml', 'logfile': 'oper-ROADMC.log'},
+    'xpdrc': {'port': '17844', 'configfile': 'oper-XPDRC.xml', 'logfile': 'oper-XPDRC.log'},
+    'spdrav2': {'port': '17845', 'configfile': 'oper-SPDRAv2.xml', 'logfile': 'oper-SPDRAv2.log'},
+    'spdrav1': {'port': '17846', 'configfile': 'oper-SPDRAv1.xml', 'logfile': 'oper-SPDRAv1.log'}
+}
 
-def start_roadmb_honeynode():
-    executable = ("./honeynode/2.2.1/honeynode-distribution/target/honeynode-distribution-1.19.04-hc"
-                  "/honeynode-distribution-1.19.04/honeycomb-tpce")
-    if os.path.isfile(executable):
-        with open('honeynode5.log', 'w') as outfile:
-            return subprocess.Popen(
-                [executable, "17842", "sample_configs/openroadm/2.2.1/oper-ROADMB.xml"],
-                stdout=outfile, stderr=outfile)
+HONEYNODE_OK_START_MSG = re.escape("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"
 
-def start_roadmc_honeynode():
-    executable = ("./honeynode/2.2.1/honeynode-distribution/target/honeynode-distribution-1.19.04-hc"
-                  "/honeynode-distribution-1.19.04/honeycomb-tpce")
-    if os.path.isfile(executable):
-        with open('honeynode3.log', 'w') as outfile:
-            return subprocess.Popen(
-                [executable, "17843", "sample_configs/openroadm/2.2.1/oper-ROADMC.xml"],
-                stdout=outfile, stderr=outfile)
+TYPE_APPLICATION_JSON = {'content-type': 'application/json'}
 
-def start_xpdrc_honeynode():
-    executable = ("./honeynode/2.2.1/honeynode-distribution/target/honeynode-distribution-1.19.04-hc"
-                  "/honeynode-distribution-1.19.04/honeycomb-tpce")
-    if os.path.isfile(executable):
-        with open('honeynode4.log', 'w') as outfile:
-            return subprocess.Popen(
-                [executable, "17844", "sample_configs/openroadm/2.2.1/oper-XPDRC.xml"],
-                stdout=outfile, stderr=outfile)
+honeynode_executable = os.path.join(
+    os.path.dirname(os.path.realpath(__file__)),
+    "..", "..", "honeynode", "2.2.1", "honeynode-simulator", "honeycomb-tpce")
+samples_directory = os.path.join(
+    os.path.dirname(os.path.realpath(__file__)),
+    "..", "..", "sample_configs", "openroadm", "2.2.1")
+
+log_directory = os.path.dirname(os.path.realpath(__file__))
+
+karaf_log = os.path.join(
+    os.path.dirname(os.path.realpath(__file__)),
+    "..", "..", "..", "karaf", "target", "assembly", "data", "log", "karaf.log")
+
+
+def start_sim(sim):
+    print("starting simulator for " + sim + "...")
+    log_file = os.path.join(log_directory, sims[sim]['logfile'])
+    process = start_honeynode(log_file, sims[sim]['port'], sims[sim]['configfile'])
+    if wait_until_log_contains(log_file, HONEYNODE_OK_START_MSG, 5000):
+        print("simulator for " + sim + " started")
+    else:
+        print("simulator for " + sim + "failed to start")
+    return process
 
-def start_spdra_honeynode():
-    executable = ("./honeynode/2.2.1/honeynode-distribution/target/honeynode-distribution-1.19.04-hc"
-                  "/honeynode-distribution-1.19.04/honeycomb-tpce")
-    if os.path.isfile(executable):
-        with open('honeynode6.log', 'w') as outfile:
-            return subprocess.Popen(
-                [executable, "17845", "sample_configs/openroadm/2.2.1/oper-SPDRAv2.xml"],
-                stdout=outfile, stderr=outfile)
 
 def start_tpce():
+    print("starting opendaylight...")
     if "USE_LIGHTY" in os.environ and os.environ['USE_LIGHTY'] == 'True':
-        print ("starting LIGHTY.IO TransportPCE build...")
-        executable = "../lighty/target/lighty-transportpce-12.0.0-SNAPSHOT/clean-start-controller.sh"
-        with open('odl.log', 'w') as outfile:
-            return subprocess.Popen(
-                ["sh", executable], stdout=outfile, stderr=outfile,
-                stdin=open(os.devnull))
+        process = start_lighty()
+        # TODO: add some sort of health check similar to Karaf below
     else:
-        print ("starting KARAF TransportPCE build...")
-        executable = "../karaf/target/assembly/bin/karaf"
-        with open('odl.log', 'w') as outfile:
+        process = start_karaf()
+        if wait_until_log_contains(karaf_log, KARAF_OK_START_MSG, time_to_wait=60):
+            print("opendaylight started")
+        else:
+            print("opendaylight failed to start")
+            shutdown_process(process)
+            exit(1)
+    return process
+
+
+def start_karaf():
+    print("starting KARAF TransportPCE build...")
+    executable = os.path.join(
+        os.path.dirname(os.path.realpath(__file__)),
+        "..", "..", "..", "karaf", "target", "assembly", "bin", "karaf")
+    with open('odl.log', 'w') as outfile:
+        return subprocess.Popen(
+            ["sh", executable, "server"], stdout=outfile, stderr=outfile, stdin=None)
+
+
+def start_lighty():
+    print("starting LIGHTY.IO TransportPCE build...")
+    executable = os.path.join(
+        os.path.dirname(os.path.realpath(__file__)),
+        "..", "..", "..", "lighty", "target", "tpce",
+        "clean-start-controller.sh")
+    with open('odl.log', 'w') as outfile:
+        return subprocess.Popen(
+            ["sh", executable], stdout=outfile, stderr=outfile, stdin=None)
+
+
+def install_karaf_feature(feature_name: str):
+    print("installing feature " + feature_name)
+    executable = os.path.join(
+        os.path.dirname(os.path.realpath(__file__)),
+        "..", "..", "..", "karaf", "target", "assembly", "bin", "client")
+    return subprocess.run([executable],
+                          input='feature:install ' + feature_name + '\n feature:list | grep tapi \n logout \n',
+                          universal_newlines=True)
+
+
+def post_request(url, data, username, password):
+    return requests.request(
+        "POST", url, data=json.dumps(data),
+        headers=TYPE_APPLICATION_JSON, auth=(username, password))
+
+
+def put_request(url, data, username, password):
+    return requests.request(
+        "PUT", url, data=json.dumps(data), headers=TYPE_APPLICATION_JSON,
+        auth=(username, password))
+
+
+def delete_request(url, username, password):
+    return requests.request(
+        "DELETE", url, headers=TYPE_APPLICATION_JSON,
+        auth=(username, password))
+
+
+def generate_connect_data(node_id: str, node_port: str):
+    data = {"node": [{
+        "node-id": node_id,
+        "netconf-node-topology:username": "admin",
+        "netconf-node-topology:password": "admin",
+        "netconf-node-topology:host": "127.0.0.1",
+        "netconf-node-topology:port": node_port,
+        "netconf-node-topology:tcp-only": "false",
+        "netconf-node-topology:pass-through": {}}]}
+    return data
+
+
+def generate_link_data(xpdr_node: str, xpdr_num: str, network_num: str, rdm_node: str, srg_num: str,
+                       termination_num: str):
+    data = {
+        "networkutils:input": {
+            "networkutils:links-input": {
+                "networkutils:xpdr-node": xpdr_node,
+                "networkutils:xpdr-num": xpdr_num,
+                "networkutils:network-num": network_num,
+                "networkutils:rdm-node": rdm_node,
+                "networkutils:srg-num": srg_num,
+                "networkutils:termination-point-num": termination_num
+            }
+        }
+    }
+    return data
+
+
+def shutdown_process(process):
+    if process is not None:
+        for child in psutil.Process(process.pid).children():
+            child.send_signal(signal.SIGINT)
+            child.wait()
+        process.send_signal(signal.SIGINT)
+
+
+def start_honeynode(log_file: str, node_port: str, node_config_file_name: str):
+    if os.path.isfile(honeynode_executable):
+        with open(log_file, 'w') as outfile:
             return subprocess.Popen(
-                ["sh", executable, "server"], stdout=outfile, stderr=outfile,
-                stdin=open(os.devnull))
+                [honeynode_executable, node_port, os.path.join(samples_directory, node_config_file_name)],
+                stdout=outfile, stderr=outfile)
+
+
+def wait_until_log_contains(log_file, searched_string, time_to_wait=20):
+    found = False
+    tail = None
+    try:
+        with timeout(seconds=time_to_wait):
+            print("Waiting for " + searched_string)
+            tail = subprocess.Popen(['tail', '-F', log_file], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            regexp = re.compile(searched_string)
+            while True:
+                line = tail.stdout.readline().decode('utf-8')
+                if regexp.search(line):
+                    print("Searched string found.")
+                    found = True
+                    break
+    except TimeoutError:
+        print("Cannot find string "+searched_string+" after waiting for "+str(time_to_wait))
+    finally:
+        if tail is not None:
+            print("Stopping tail command")
+            tail.stderr.close()
+            tail.stdout.close()
+            tail.kill()
+            tail.wait()
+        return found
+
+
+class timeout:
+    def __init__(self, seconds=1, error_message='Timeout'):
+        self.seconds = seconds
+        self.error_message = error_message
+
+    def handle_timeout(self, signum, frame):
+        raise TimeoutError(self.error_message)
+
+    def __enter__(self):
+        signal.signal(signal.SIGALRM, self.handle_timeout)
+        signal.alarm(self.seconds)
+
+    def __exit__(self, type, value, traceback):
+        signal.alarm(0)