summaryrefslogtreecommitdiffstats
path: root/test/functest/testcase_4.py
blob: c7d222e2dfa27807a0b52fd26f15219e5336e23a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
#!/usr/bin/python
#
# Copyright (c) 2015 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 argparse
import os
from random import randint
import sys
import time

import functest.utils.functest_logger as ft_logger
import functest.utils.functest_utils as ft_utils
import functest.utils.openstack_utils as os_utils


parser = argparse.ArgumentParser()

parser.add_argument("-r", "--report",
                    help="Create json result file",
                    action="store_true")

args = parser.parse_args()

logger = ft_logger.Logger("sdnvpn-testcase-4").getLogger()

REPO_PATH = os.environ['repos_dir'] + '/sdnvpn/'

VM_BOOT_TIMEOUT = 180

config_file = REPO_PATH + 'test/functest/config.yaml'

INSTANCE_1_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.instance_1_name", config_file)
INSTANCE_2_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.instance_2_name", config_file)
INSTANCE_3_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.instance_3_name", config_file)
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_parameter_from_yaml(
    "general.openstack.image_file_name")
IMAGE_FORMAT = ft_utils.get_parameter_from_yaml(
    "general.openstack.image_disk_format")
IMAGE_PATH = ft_utils.get_parameter_from_yaml(
    "general.directories.dir_functest_data") + "/" + IMAGE_FILENAME

# NEUTRON Private Network parameters

NET_1_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.net_1_name", config_file)
SUBNET_1_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.subnet_1_name", config_file)
SUBNET_1_CIDR = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.subnet_1_cidr", config_file)
ROUTER_1_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.router_1_name", config_file)
NET_2_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.net_2_name", config_file)
SUBNET_2_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.subnet_2_name", config_file)
SUBNET_2_CIDR = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.subnet_2_cidr", config_file)
ROUTER_2_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.router_2_name", config_file)
SECGROUP_NAME = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.sdnvpn_sg_name", config_file)
SECGROUP_DESCR = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.sdnvpn_sg_descr", config_file)
TARGETS_1 = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.targets1", config_file)
TARGETS_2 = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.targets2", config_file)
SUCCESS_CRITERIA = ft_utils.get_parameter_from_yaml(
    "testcases.testcase_4.succes_criteria", config_file)
TEST_DB = ft_utils.get_parameter_from_yaml("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 create_network(neutron_client, net, subnet, router, cidr):
    network_dic = os_utils.create_network_full(neutron_client,
                                               net,
                                               subnet,
                                               router,
                                               cidr)
    if not network_dic:
        logger.error(
            "There has been a problem when creating the neutron network")
        sys.exit(-1)
    return network_dic["net_id"], \
        network_dic["subnet_id"], \
        network_dic["router_id"]


def create_instance(nova_client,
                    name,
                    flavor,
                    image_id,
                    network_id,
                    sg_id,
                    compute_node='',
                    userdata=None):
    logger.info("Creating instance '%s'..." % name)
    logger.debug(
        "Configuration:\n name=%s \n flavor=%s \n image=%s \n "
        "network=%s \n secgroup=%s \n hypervisor=%s \n userdata=%s\n"
        % (name, flavor, image_id, network_id, sg_id, compute_node, userdata))
    instance = os_utils.create_instance_and_wait_for_active(
        flavor,
        image_id,
        network_id,
        name,
        config_drive=True,
        userdata=userdata,
        av_zone=compute_node)

    if instance is None:
        logger.error("Error while booting instance.")
        sys.exit(-1)
    # Retrieve IP of INSTANCE
    # instance_ip = instance.networks.get(network_id)[0]

    logger.debug("Adding '%s' to security group '%s'..."
                 % (name, SECGROUP_NAME))
    os_utils.add_secgroup_to_instance(nova_client, instance.id, sg_id)

    return instance


def generate_ping_userdata(ips_array):
    ips = ""
    for ip in ips_array:
        ips = ("%s %s" % (ips, ip))

    ips = ips.replace('  ', ' ')
    return ("#!/bin/sh\n"
            "set%s\n"
            "while true; do\n"
            " for i do\n"
            "  ip=$i\n"
            "  ping -c 1 $ip 2>&1 >/dev/null\n"
            "  RES=$?\n"
            "  if [ \"Z$RES\" = \"Z0\" ] ; then\n"
            "   echo ping $ip OK\n"
            "  else echo ping $ip KO\n"
            "  fi\n"
            " done\n"
            " sleep 1\n"
            "done\n"
            % ips)


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

    add_to_summary(0, "=")
    add_to_summary(2, "STATUS", "SUBTEST")
    add_to_summary(0, "=")

    nova_client = os_utils.get_nova_client()
    neutron_client = os_utils.get_neutron_client()
    glance_client = os_utils.get_glance_client()

    image_id = os_utils.create_glance_image(glance_client,
                                            IMAGE_NAME,
                                            IMAGE_PATH,
                                            disk=IMAGE_FORMAT,
                                            container="bare",
                                            public=True)
    network_1_id, _, router_1_id = create_network(neutron_client,
                                                  NET_1_NAME,
                                                  SUBNET_1_NAME,
                                                  ROUTER_1_NAME,
                                                  SUBNET_1_CIDR)
    network_2_id, _, router_2_id = create_network(neutron_client,
                                                  NET_2_NAME,
                                                  SUBNET_2_NAME,
                                                  ROUTER_2_NAME,
                                                  SUBNET_2_CIDR)
    sg_id = os_utils.create_security_group_full(neutron_client,
                                                SECGROUP_NAME, SECGROUP_DESCR)

    # Get hypervisors zones
    compute_nodes = os_utils.get_hypervisors(nova_client)
    num_compute_nodes = len(compute_nodes)
    if num_compute_nodes < 2:
        logger.error("There are %s compute nodes in the deployment. "
                     "Minimum number of nodes to complete the test is 2."
                     % num_compute_nodes)
        sys.exit(-1)

    logger.debug("Compute nodes: %s" % compute_nodes)
    av_zone_1 = "nova:" + compute_nodes[0]
    av_zone_2 = "nova:" + compute_nodes[1]

    # boot INTANCES
    vm_2 = create_instance(nova_client,
                           INSTANCE_2_NAME,
                           FLAVOR,
                           image_id,
                           network_1_id,
                           sg_id,
                           av_zone_1)
    vm_2_ip = vm_2.networks.itervalues().next()[0]
    logger.debug("Instance '%s' booted successfully. IP='%s'." %
                 (INSTANCE_2_NAME, vm_2_ip))

    vm_3 = create_instance(nova_client,
                           INSTANCE_3_NAME,
                           FLAVOR, image_id,
                           network_1_id,
                           sg_id,
                           av_zone_2)
    vm_3_ip = vm_3.networks.itervalues().next()[0]
    logger.debug("Instance '%s' booted successfully. IP='%s'." %
                 (INSTANCE_3_NAME, vm_3_ip))

    vm_5 = create_instance(nova_client,
                           INSTANCE_5_NAME,
                           FLAVOR,
                           image_id,
                           network_2_id,
                           sg_id,
                           av_zone_2)
    vm_5_ip = vm_5.networks.itervalues().next()[0]
    logger.debug("Instance '%s' booted successfully. IP='%s'." %
                 (INSTANCE_5_NAME, vm_5_ip))

    # We boot vm5 first because we need vm5_ip for vm4 userdata
    u4 = generate_ping_userdata([vm_5_ip])
    vm_4 = create_instance(nova_client,
                           INSTANCE_4_NAME,
                           FLAVOR,
                           image_id,
                           network_2_id,
                           sg_id,
                           av_zone_1,
                           userdata=u4)
    vm_4_ip = vm_4.networks.itervalues().next()[0]
    logger.debug("Instance '%s' booted successfully. IP='%s'." %
                 (INSTANCE_4_NAME, vm_4_ip))

    # We boot VM1 at the end because we need to get the IPs first to generate
    # the userdata
    u1 = generate_ping_userdata([vm_2_ip, vm_3_ip, vm_4_ip, vm_5_ip])
    vm_1 = create_instance(nova_client,
                           INSTANCE_1_NAME,
                           FLAVOR,
                           image_id,
                           network_1_id,
                           sg_id,
                           av_zone_1,
                           userdata=u1)
    vm_1_ip = vm_1.networks.itervalues().next()[0]
    logger.debug("Instance '%s' booted successfully. IP='%s'." %
                 (INSTANCE_1_NAME, vm_1_ip))
    msg = ("Create VPN with eRT<>iRT")
    logger.info(msg)
    add_to_summary(1, msg)
    vpn_name = "sdnvpn-" + str(randint(100000, 999999))
    kwargs = {"import_targets": TARGETS_1,
              "export_targets": TARGETS_2,
              "name": vpn_name}
    bgpvpn = os_utils.create_bgpvpn(neutron_client, **kwargs)
    bgpvpn_id = bgpvpn['bgpvpn']['id']
    logger.debug("VPN created details: %s" % bgpvpn)

    msg = ("Associate router '%s' to the VPN." % ROUTER_1_NAME)
    logger.info(msg)
    add_to_summary(1, msg)
    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)

    # Ping from VM1 to VM2 should work
    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)
    # 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)

    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, "-")
    os_utils.create_network_association(
        neutron_client, bgpvpn_id, network_2_id)

    # Wait a bit for this to take effect
    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)
    # 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)
    # 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)

    msg = ("Update VPN with eRT=iRT ...")
    logger.info(msg)
    add_to_summary(0, "-")
    add_to_summary(1, msg)
    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
    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)
    # Ping from VM1 to VM5 should work
    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)

    if 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))
    if success < int(SUCCESS_CRITERIA):
        status = "FAILED"

    return {"status": status, "details": DETAILS}


if __name__ == '__main__':
    main()