8088a4db5f68ff11bc42dc976b98eb40637efde1
[functest.git] / functest / opnfv_tests / openstack / vping / vping_userdata.py
1 #!/usr/bin/env python
2 #
3 # Copyright (c) 2015 All rights reserved
4 # This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 #
8 # http://www.apache.org/licenses/LICENSE-2.0
9
10 import time
11
12 from snaps.openstack.utils import deploy_utils
13 from snaps.openstack.create_instance import VmInstanceSettings
14 from snaps.openstack.create_network import PortSettings
15
16 from functest.core.testcase import TestCase
17 from functest.opnfv_tests.openstack.vping import vping_base
18
19
20 class VPingUserdata(vping_base.VPingBase):
21     """
22     Class to execute the vPing test using userdata and the VM's console
23     """
24
25     def __init__(self, **kwargs):
26         if "case_name" not in kwargs:
27             kwargs["case_name"] = "vping_userdata"
28         super(VPingUserdata, self).__init__(**kwargs)
29
30     def run(self):
31         """
32         Sets up the OpenStack VM instance objects then executes the ping and
33         validates.
34         :return: the exit code from the super.execute() method
35         """
36         try:
37             super(VPingUserdata, self).run()
38
39             # Creating Instance 1
40             port1_settings = PortSettings(
41                 name=self.vm1_name + '-vPingPort',
42                 network_name=self.network_creator.network_settings.name)
43             instance1_settings = VmInstanceSettings(
44                 name=self.vm1_name,
45                 flavor=self.flavor_name,
46                 vm_boot_timeout=self.vm_boot_timeout,
47                 port_settings=[port1_settings])
48
49             self.logger.info(
50                 "Creating VM 1 instance with name: '%s'"
51                 % instance1_settings.name)
52             self.vm1_creator = deploy_utils.create_vm_instance(
53                 self.os_creds, instance1_settings,
54                 self.image_creator.image_settings)
55             self.creators.append(self.vm1_creator)
56
57             userdata = _get_userdata(
58                 self.vm1_creator.get_port_ip(port1_settings.name))
59             if userdata:
60                 # Creating Instance 2
61                 port2_settings = PortSettings(
62                     name=self.vm2_name + '-vPingPort',
63                     network_name=self.network_creator.network_settings.name)
64                 instance2_settings = VmInstanceSettings(
65                     name=self.vm2_name,
66                     flavor=self.flavor_name,
67                     vm_boot_timeout=self.vm_boot_timeout,
68                     port_settings=[port2_settings],
69                     userdata=userdata)
70
71                 self.logger.info(
72                     "Creating VM 2 instance with name: '%s'"
73                     % instance2_settings.name)
74                 self.vm2_creator = deploy_utils.create_vm_instance(
75                     self.os_creds, instance2_settings,
76                     self.image_creator.image_settings)
77                 self.creators.append(self.vm2_creator)
78             else:
79                 raise Exception('Userdata is None')
80
81             return self._execute()
82
83         finally:
84             self._cleanup()
85
86     def _do_vping(self, vm_creator, test_ip):
87         """
88         Override from super
89         """
90         self.logger.info("Waiting for ping...")
91         exit_code = -1
92         sec = 0
93         tries = 0
94
95         while True:
96             time.sleep(1)
97             p_console = vm_creator.get_console_output()
98             if "vPing OK" in p_console:
99                 self.logger.info("vPing detected!")
100                 exit_code = TestCase.EX_OK
101                 break
102             elif "failed to read iid from metadata" in p_console or tries > 5:
103                 exit_code = TestCase.EX_TESTCASE_FAILED
104                 break
105             elif sec == self.ping_timeout:
106                 self.logger.info("Timeout reached.")
107                 break
108             elif sec % 10 == 0:
109                 if "request failed" in p_console:
110                     self.logger.debug(
111                         "It seems userdata is not supported in nova boot. " +
112                         "Waiting a bit...")
113                     tries += 1
114                 else:
115                     self.logger.debug(
116                         "Pinging %s. Waiting for response..." % test_ip)
117             sec += 1
118
119         return exit_code
120
121
122 def _get_userdata(test_ip):
123     """
124     Returns the post VM creation script to be added into the VM's userdata
125     :param test_ip: the IP value to substitute into the script
126     :return: the bash script contents
127     """
128     if test_ip:
129         return ("#!/bin/sh\n\n"
130                 "while true; do\n"
131                 " ping -c 1 %s 2>&1 >/dev/null\n"
132                 " RES=$?\n"
133                 " if [ \"Z$RES\" = \"Z0\" ] ; then\n"
134                 "  echo 'vPing OK'\n"
135                 "  break\n"
136                 " else\n"
137                 "  echo 'vPing KO'\n"
138                 " fi\n"
139                 " sleep 1\n"
140                 "done\n" % test_ip)
141     return None