9551c4b5de9a770f2347bba2895b713c137c87c4
[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 """vping_userdata testcase."""
11
12 import logging
13 import time
14
15 from xtesting.core import testcase
16
17 from functest.opnfv_tests.openstack.vping import vping_base
18 from functest.utils import config
19
20
21 class VPingUserdata(vping_base.VPingBase):
22     """
23     Class to execute the vPing test using userdata and the VM's console
24     """
25
26     def __init__(self, **kwargs):
27         if "case_name" not in kwargs:
28             kwargs["case_name"] = "vping_userdata"
29         super(VPingUserdata, self).__init__(**kwargs)
30         self.logger = logging.getLogger(__name__)
31         self.vm2 = None
32
33     def run(self, **kwargs):
34         """
35         Sets up the OpenStack VM instance objects then executes the ping and
36         validates.
37         :return: the exit code from the super.execute() method
38         """
39         try:
40             assert self.cloud
41             super(VPingUserdata, self).run()
42
43             vm2_name = "{}-{}-{}".format(
44                 getattr(config.CONF, 'vping_vm_name_2'), "userdata", self.guid)
45             self.logger.info(
46                 "Creating VM 2 instance with name: '%s'", vm2_name)
47             self.vm2 = self.cloud.create_server(
48                 vm2_name, image=self.image.id, flavor=self.flavor.id,
49                 auto_ip=False, wait=True,
50                 timeout=getattr(config.CONF, 'vping_vm_boot_timeout'),
51                 network=self.network.id,
52                 userdata=self._get_userdata())
53             self.logger.debug("vm2: %s", self.vm2)
54             self.vm2 = self.cloud.wait_for_server(self.vm2, auto_ip=False)
55
56             return self._execute()
57         except Exception:  # pylint: disable=broad-except
58             self.logger.exception('Unexpected error running vping_userdata')
59             return testcase.TestCase.EX_RUN_ERROR
60
61     def _do_vping(self):
62         """
63         Override from super
64         """
65         self.logger.info("Waiting for ping...")
66         exit_code = testcase.TestCase.EX_TESTCASE_FAILED
67         sec = 0
68         tries = 0
69
70         while True:
71             time.sleep(1)
72             p_console = self.cloud.get_server_console(self.vm2.id)
73             self.logger.debug("console: \n%s", p_console)
74             if "vPing OK" in p_console:
75                 self.logger.info("vPing detected!")
76                 exit_code = testcase.TestCase.EX_OK
77                 break
78             elif "failed to read iid from metadata" in p_console or tries > 5:
79                 self.logger.info("Failed to read iid from metadata")
80                 break
81             elif sec == getattr(config.CONF, 'vping_ping_timeout'):
82                 self.logger.info("Timeout reached.")
83                 break
84             elif sec % 10 == 0:
85                 if "request failed" in p_console:
86                     self.logger.debug(
87                         "It seems userdata is not supported in nova boot. " +
88                         "Waiting a bit...")
89                     tries += 1
90                 else:
91                     self.logger.debug(
92                         "Pinging %s. Waiting for response...",
93                         self.vm1.private_v4)
94             sec += 1
95
96         return exit_code
97
98     def _get_userdata(self):
99         """
100         Returns the post VM creation script to be added into the VM's userdata
101         :param test_ip: the IP value to substitute into the script
102         :return: the bash script contents
103         """
104         if self.vm1.private_v4:
105             return ("#!/bin/sh\n\n"
106                     "while true; do\n"
107                     " ping -c 1 %s 2>&1 >/dev/null\n"
108                     " RES=$?\n"
109                     " if [ \"Z$RES\" = \"Z0\" ] ; then\n"
110                     "  echo 'vPing OK'\n"
111                     "  break\n"
112                     " else\n"
113                     "  echo 'vPing KO'\n"
114                     " fi\n"
115                     " sleep 1\n"
116                     "done\n" % str(self.vm1.private_v4))
117         return None
118
119     def clean(self):
120         assert self.cloud
121         self.cloud.delete_server(
122             self.vm2, wait=True,
123             timeout=getattr(config.CONF, 'vping_vm_delete_timeout'))
124         self.cloud.delete_server(self.vm2, wait=True)
125         super(VPingUserdata, self).clean()