Refactoring

- Wrap common methods that use globals in a Class
 `get_ping_status` and `add_to_summary` depended on globals for
  statefulness. The easiest way to refactor them was to convert them
  into methods and the globals they used into instance variables.
- Move `generate_userdata_common` and `generate_userdata_with_ssh` to
  the utils module.
- Make flavor a kwarg in create_instance.
  Add a defaults section in config.yaml with flavor. This value is used
  if flavor is not passed via kwargs.
- Substitute some sleeps with `wait_for_instances_up` which will
  wait until a dhcp lease success message appears in the instance's log.
- Add functions that wait until router and network association is
  completed. These do not replace the sleeps but make the tests more
  deterministic.
- Remove unused ping_timeout from config.yaml

Change-Id: Ia68ebf47aaa5a58c4e20267f1476db626f015a7c
Signed-off-by: Romanos Skiadas <rski@intracom-telecom.com>
Co-Authored-by: George Paraskevopoulos <geopar@intracom-telecom.com>

1 files changed, 55 insertions, 117 deletions

diff --git a/test/functest/testcase_4.py b/test/functest/testcase_4.py
index 3419182..13f531f 100644
--- a/test/functest/testcase_4.py
+++ b/test/functest/testcase_4.py
@@ -19,6 +19,7 @@ import functest.utils.functest_utils as ft_utils
 import functest.utils.openstack_utils as os_utils
 
 import utils as test_utils
+from results import Results
 
 parser = argparse.ArgumentParser()
 
@@ -46,8 +47,6 @@ INSTANCE_4_NAME = ft_utils.get_parameter_from_yaml(
     "testcases.testcase_4.instance_4_name", config_file)
 INSTANCE_5_NAME = ft_utils.get_parameter_from_yaml(
     "testcases.testcase_4.instance_5_name", config_file)
-FLAVOR = ft_utils.get_parameter_from_yaml(
-    "testcases.testcase_4.flavor", config_file)
 IMAGE_NAME = ft_utils.get_parameter_from_yaml(
     "testcases.testcase_4.image_name", config_file)
 IMAGE_FILENAME = ft_utils.get_functest_config(
@@ -87,96 +86,17 @@ SUCCESS_CRITERIA = ft_utils.get_parameter_from_yaml(
     "testcases.testcase_4.succes_criteria", config_file)
 TEST_DB = ft_utils.get_functest_config("results.test_db_url")
 
-TEST_RESULT = "PASS"
-SUMMARY = ""
 LINE_LENGTH = 60  # length for the summary table
-DETAILS = []
-NUM_TESTS = 0
-NUM_TESTS_FAILED = 0
-
-
-def get_ping_status(vm_source, ip_source,
-                    vm_target, ip_target,
-                    expected="PASS", timeout=30):
-    console_log = vm_source.get_console_output()
-
-    global TEST_RESULT
-
-    if "request failed" in console_log:
-        # Normally, cirros displays this message when userdata fails
-        logger.debug("It seems userdata is not supported in "
-                     "nova boot...")
-        return False
-    else:
-        tab = ("%s" % (" " * 53))
-        expected_result = 'can ping' if expected == 'PASS' else 'cannot ping'
-        test_case_name = ("'%s' %s '%s'" %
-                          (vm_source.name, expected_result, vm_target.name))
-        logger.debug("%sPing\n%sfrom '%s' (%s)\n%sto '%s' (%s).\n"
-                     "%s-->Expected result: %s.\n"
-                     % (tab, tab, vm_source.name, ip_source,
-                        tab, vm_target.name, ip_target,
-                        tab, expected_result))
-        while True:
-            console_log = vm_source.get_console_output()
-            # the console_log is a long string, we want to take
-            # the last 4 lines (for example)
-            lines = console_log.split('\n')
-            last_n_lines = lines[-5:]
-            if ("ping %s OK" % ip_target) in last_n_lines:
-                msg = ("'%s' can ping '%s'" % (vm_source.name, vm_target.name))
-                if expected == "PASS":
-                    logger.debug("[PASS] %s" % msg)
-                    add_to_summary(2, "PASS", test_case_name)
-                else:
-                    logger.debug("[FAIL] %s" % msg)
-                    TEST_RESULT = "FAIL"
-                    add_to_summary(2, "FAIL", test_case_name)
-                    logger.debug("\n%s" % last_n_lines)
-                break
-            elif ("ping %s KO" % ip_target) in last_n_lines:
-                msg = ("'%s' cannot ping '%s'" %
-                       (vm_source.name, vm_target.name))
-                if expected == "FAIL":
-                    logger.debug("[PASS] %s" % msg)
-                    add_to_summary(2, "PASS", test_case_name)
-                else:
-                    logger.debug("[FAIL] %s" % msg)
-                    TEST_RESULT = "FAIL"
-                    add_to_summary(2, "FAIL", test_case_name)
-                break
-            time.sleep(1)
-            timeout -= 1
-            if timeout == 0:
-                TEST_RESULT = "FAIL"
-                logger.debug("[FAIL] Timeout reached for '%s'. No ping output "
-                             "captured in the console log" % vm_source.name)
-                add_to_summary(2, "FAIL", test_case_name)
-                break
-
-
-def add_to_summary(num_cols, col1, col2=""):
-    global SUMMARY, LINE_LENGTH, DETAILS, NUM_TESTS, NUM_TESTS_FAILED
-    if num_cols == 0:
-        SUMMARY += ("+%s+\n" % (col1 * (LINE_LENGTH - 2)))
-    elif num_cols == 1:
-        SUMMARY += ("| " + col1.ljust(LINE_LENGTH - 3) + "|\n")
-    elif num_cols == 2:
-        SUMMARY += ("| %s" % col1.ljust(7) + "| ")
-        SUMMARY += (col2.ljust(LINE_LENGTH - 12) + "|\n")
-        if col1 in ("FAIL", "PASS"):
-            DETAILS.append({col2: col1})
-            NUM_TESTS += 1
-            if col1 == "FAIL":
-                NUM_TESTS_FAILED += 1
 
 
 def main():
-    global TEST_RESULT, SUMMARY
+    global LINE_LENGTH
+
+    results = Results(LINE_LENGTH)
 
-    add_to_summary(0, "=")
-    add_to_summary(2, "STATUS", "SUBTEST")
-    add_to_summary(0, "=")
+    results.add_to_summary(0, "=")
+    results.add_to_summary(2, "STATUS", "SUBTEST")
+    results.add_to_summary(0, "=")
 
     nova_client = os_utils.get_nova_client()
     neutron_client = os_utils.get_neutron_client()
@@ -217,7 +137,6 @@ def main():
     # boot INTANCES
     vm_2 = test_utils.create_instance(nova_client,
                                       INSTANCE_2_NAME,
-                                      FLAVOR,
                                       image_id,
                                       network_1_id,
                                       sg_id,
@@ -229,7 +148,6 @@ def main():
 
     vm_3 = test_utils.create_instance(nova_client,
                                       INSTANCE_3_NAME,
-                                      FLAVOR,
                                       image_id,
                                       network_1_id,
                                       sg_id,
@@ -241,7 +159,6 @@ def main():
 
     vm_5 = test_utils.create_instance(nova_client,
                                       INSTANCE_5_NAME,
-                                      FLAVOR,
                                       image_id,
                                       network_2_id,
                                       sg_id,
@@ -255,7 +172,6 @@ def main():
     u4 = test_utils.generate_ping_userdata([vm_5_ip])
     vm_4 = test_utils.create_instance(nova_client,
                                       INSTANCE_4_NAME,
-                                      FLAVOR,
                                       image_id,
                                       network_2_id,
                                       sg_id,
@@ -274,7 +190,6 @@ def main():
                                             vm_5_ip])
     vm_1 = test_utils.create_instance(nova_client,
                                       INSTANCE_1_NAME,
-                                      FLAVOR,
                                       image_id,
                                       network_1_id,
                                       sg_id,
@@ -286,7 +201,7 @@ def main():
                  (INSTANCE_1_NAME, vm_1_ip))
     msg = ("Create VPN with eRT<>iRT")
     logger.info(msg)
-    add_to_summary(1, msg)
+    results.add_to_summary(1, msg)
     vpn_name = "sdnvpn-" + str(randint(100000, 999999))
     kwargs = {"import_targets": TARGETS_1,
               "export_targets": TARGETS_2,
@@ -297,71 +212,94 @@ def main():
 
     msg = ("Associate router '%s' to the VPN." % ROUTER_1_NAME)
     logger.info(msg)
-    add_to_summary(1, msg)
-    add_to_summary(0, "-")
+    results.add_to_summary(1, msg)
+    results.add_to_summary(0, "-")
 
     os_utils.create_router_association(
         neutron_client, bgpvpn_id, router_1_id)
 
     # Wait for VMs to get ips.
-    time.sleep(80)
+    instances_up = test_utils.wait_for_instances_up(vm_1, vm_2,
+                                                    vm_3, vm_4,
+                                                    vm_5)
+
+    if not instances_up:
+        logger.error("One or more instances is down")
+        # TODO Handle appropriately
 
     # Ping from VM1 to VM2 should work
-    get_ping_status(vm_1, vm_1_ip, vm_2, vm_2_ip, expected="PASS", timeout=200)
+    results.get_ping_status(vm_1, vm_1_ip, vm_2, vm_2_ip,
+                            expected="PASS", timeout=200)
     # Ping from VM1 to VM3 should work
-    get_ping_status(vm_1, vm_1_ip, vm_3, vm_3_ip, expected="PASS", timeout=30)
+    results.get_ping_status(vm_1, vm_1_ip, vm_3, vm_3_ip,
+                            expected="PASS", timeout=30)
     # Ping from VM1 to VM4 should not work
-    get_ping_status(vm_1, vm_1_ip, vm_4, vm_4_ip, expected="FAIL", timeout=30)
+    results.get_ping_status(vm_1, vm_1_ip, vm_4, vm_4_ip,
+                            expected="FAIL", timeout=30)
 
     msg = ("Associate network '%s' to the VPN." % NET_2_NAME)
     logger.info(msg)
-    add_to_summary(0, "-")
-    add_to_summary(1, msg)
-    add_to_summary(0, "-")
+    results.add_to_summary(0, "-")
+    results.add_to_summary(1, msg)
+    results.add_to_summary(0, "-")
     os_utils.create_network_association(
         neutron_client, bgpvpn_id, network_2_id)
 
-    # Wait a bit for this to take effect
+    test_utils.wait_for_bgp_router_assoc(
+        neutron_client, bgpvpn_id, router_1_id)
+    test_utils.wait_for_bgp_net_assoc(
+        neutron_client, bgpvpn_id, network_2_id)
+
+    logger.info("Waiting for the VMs to connect to each other using the"
+                " updated network configuration")
     time.sleep(30)
 
     # Ping from VM4 to VM5 should work
-    get_ping_status(vm_4, vm_4_ip, vm_5, vm_5_ip, expected="PASS", timeout=30)
+    results.get_ping_status(vm_4, vm_4_ip, vm_5, vm_5_ip,
+                            expected="PASS", timeout=30)
     # Ping from VM1 to VM4 should not work
-    get_ping_status(vm_1, vm_1_ip, vm_4, vm_4_ip, expected="FAIL", timeout=30)
+    results.get_ping_status(vm_1, vm_1_ip, vm_4, vm_4_ip,
+                            expected="FAIL", timeout=30)
     # Ping from VM1 to VM5 should not work
-    get_ping_status(vm_1, vm_1_ip, vm_5, vm_5_ip, expected="FAIL", timeout=30)
+    results.get_ping_status(vm_1, vm_1_ip, vm_5, vm_5_ip,
+                            expected="FAIL", timeout=30)
 
     msg = ("Update VPN with eRT=iRT ...")
     logger.info(msg)
-    add_to_summary(0, "-")
-    add_to_summary(1, msg)
-    add_to_summary(0, "-")
+    results.add_to_summary(0, "-")
+    results.add_to_summary(1, msg)
+    results.add_to_summary(0, "-")
     kwargs = {"import_targets": TARGETS_1,
               "export_targets": TARGETS_1,
               "name": vpn_name}
     bgpvpn = os_utils.update_bgpvpn(neutron_client, bgpvpn_id, **kwargs)
-    # Wait a bit for this to take effect
+
+    logger.info("Waiting for the VMs to connect to each other using the"
+                " updated network configuration")
     time.sleep(30)
 
     # Ping from VM1 to VM4 should work
-    get_ping_status(vm_1, vm_1_ip, vm_4, vm_4_ip, expected="PASS", timeout=30)
+    results.get_ping_status(vm_1, vm_1_ip, vm_4, vm_4_ip,
+                            expected="PASS", timeout=30)
     # Ping from VM1 to VM5 should work
-    get_ping_status(vm_1, vm_1_ip, vm_5, vm_5_ip, expected="PASS", timeout=30)
+    results.get_ping_status(vm_1, vm_1_ip, vm_5, vm_5_ip,
+                            expected="PASS", timeout=30)
 
-    add_to_summary(0, "=")
-    logger.info("\n%s" % SUMMARY)
+    results.add_to_summary(0, "=")
+    logger.info("\n%s" % results.summary)
 
-    if TEST_RESULT == "PASS":
+    if results.test_result == "PASS":
         logger.info("All the ping tests have passed as expected.")
     else:
         logger.info("One or more ping tests have failed.")
 
     status = "PASS"
-    success = 100 - (100 * int(NUM_TESTS_FAILED) / int(NUM_TESTS))
+    success = 100 - \
+        (100 * int(results.num_tests_failed) / int(results.num_tests_failed))
     if success < int(SUCCESS_CRITERIA):
         status = "FAILED"
 
-    return {"status": status, "details": DETAILS}
+    return {"status": status, "details": results.details}
 
 
 if __name__ == '__main__':