summaryrefslogtreecommitdiffstats
path: root/functest/opnfv_tests/openstack/vping/vping_base.py
blob: e467dd9f5fef9463a8b5f1e02b00dac914bd3911 (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
#!/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 os
import pprint
import time
from datetime import datetime

import functest.utils.functest_utils as ft_utils
import functest.utils.functest_constants as ft_constants
import functest.utils.openstack_utils as os_utils
import functest.core.testcase_base as testcase_base


class VPingBase(testcase_base.TestcaseBase):
    def __init__(self):
        def get_conf(parameter):
            return ft_utils.get_functest_config(parameter)

        super(VPingBase, self).__init__()
        self.logger = None
        self.functest_repo = ft_constants.FUNCTEST_REPO_DIR
        self.repo = get_conf('general.directories.dir_vping')
        self.vm1_name = get_conf('vping.vm_name_1')
        self.vm2_name = get_conf('vping.vm_name_2')
        self.vm_boot_timeout = 180
        self.vm_delete_timeout = 100
        self.ping_timeout = get_conf('vping.ping_timeout')

        self.image_name = get_conf('vping.image_name')
        self.image_filename = get_conf('general.openstack.image_file_name')
        self.image_format = get_conf('general.openstack.image_disk_format')
        self.image_path = ("%s/%s" %
                           (get_conf('general.directories.dir_functest_data'),
                            self.image_filename))

        self.flavor_name = get_conf('vping.vm_flavor')

        # NEUTRON Private Network parameters
        self.private_net_name = get_conf('vping.vping_private_net_name')
        self.private_subnet_name = get_conf('vping.vping_private_subnet_name')
        self.private_subnet_cidr = get_conf('vping.vping_private_subnet_cidr')
        self.router_name = get_conf('vping.vping_router_name')
        self.sg_name = get_conf('vping.vping_sg_name')
        self.sg_desc = get_conf('vping.vping_sg_descr')
        self.neutron_client = os_utils.get_neutron_client()
        self.glance_client = os_utils.get_glance_client()
        self.nova_client = os_utils.get_nova_client()

    def run(self, **kwargs):
        if not self.check_repo_exist():
            return testcase_base.TestcaseBase.EX_RUN_ERROR

        image_id = self.create_image()
        if not image_id:
            return testcase_base.TestcaseBase.EX_RUN_ERROR

        flavor = self.get_flavor()
        if not flavor:
            return testcase_base.TestcaseBase.EX_RUN_ERROR

        network_id = self.create_network_full()
        if not network_id:
            return testcase_base.TestcaseBase.EX_RUN_ERROR

        sg_id = self.create_security_group()
        if not sg_id:
            return testcase_base.TestcaseBase.EX_RUN_ERROR

        self.delete_exist_vms()

        self.start_time = time.time()
        self.logger.info("vPing Start Time:'%s'" % (
            datetime.fromtimestamp(self.start_time).strftime(
                '%Y-%m-%d %H:%M:%S')))

        vm1 = self.boot_vm(self.vm1_name,
                           image_id,
                           flavor,
                           network_id,
                           None,
                           sg_id)
        if not vm1:
            return testcase_base.TestcaseBase.EX_RUN_ERROR

        test_ip = self.get_test_ip(vm1)
        vm2 = self.boot_vm(self.vm2_name,
                           image_id,
                           flavor,
                           network_id,
                           test_ip,
                           sg_id)
        if not vm2:
            return testcase_base.TestcaseBase.EX_RUN_ERROR

        EXIT_CODE = self.do_vping(vm2, test_ip)
        if EXIT_CODE == testcase_base.TestcaseBase.EX_RUN_ERROR:
            return EXIT_CODE

        self.stop_time = time.time()
        self.parse_result(EXIT_CODE,
                          self.start_time,
                          self.stop_time)
        return testcase_base.TestcaseBase.EX_OK

    def boot_vm_preparation(self, config, vmname, test_ip):
        pass

    def do_vping(self, vm, test_ip):
        raise NotImplementedError('vping execution is not implemented')

    def check_repo_exist(self):
        if not os.path.exists(self.functest_repo):
            self.logger.error("Functest repository not found '%s'"
                              % self.functest_repo)
            return False
        return True

    def create_image(self):
        _, image_id = os_utils.get_or_create_image(self.image_name,
                                                   self.image_path,
                                                   self.image_format)
        if not image_id:
            return None

        return image_id

    def get_flavor(self):
        try:
            flavor = self.nova_client.flavors.find(name=self.flavor_name)
            self.logger.info("Using existing Flavor '%s'..."
                             % self.flavor_name)
            return flavor
        except:
            self.logger.error("Flavor '%s' not found." % self.flavor_name)
            self.logger.info("Available flavors are: ")
            self.pMsg(self.nova_client.flavor.list())
            return None

    def create_network_full(self):
        network_dic = os_utils.create_network_full(self.neutron_client,
                                                   self.private_net_name,
                                                   self.private_subnet_name,
                                                   self.router_name,
                                                   self.private_subnet_cidr)

        if not network_dic:
            self.logger.error(
                "There has been a problem when creating the neutron network")
            return None
        network_id = network_dic["net_id"]
        return network_id

    def create_security_group(self):
        sg_id = os_utils.get_security_group_id(self.neutron_client,
                                               self.sg_name)
        if sg_id != '':
            self.logger.info("Using existing security group '%s'..."
                             % self.sg_name)
        else:
            self.logger.info("Creating security group  '%s'..."
                             % self.sg_name)
            SECGROUP = os_utils.create_security_group(self.neutron_client,
                                                      self.sg_name,
                                                      self.sg_desc)
            if not SECGROUP:
                self.logger.error("Failed to create the security group...")
                return None

            sg_id = SECGROUP['id']

            self.logger.debug("Security group '%s' with ID=%s created "
                              "successfully." % (SECGROUP['name'], sg_id))

            self.logger.debug("Adding ICMP rules in security group '%s'..."
                              % self.sg_name)
            if not os_utils.create_secgroup_rule(self.neutron_client, sg_id,
                                                 'ingress', 'icmp'):
                self.logger.error("Failed to create security group rule...")
                return None

            self.logger.debug("Adding SSH rules in security group '%s'..."
                              % self.sg_name)
            if not os_utils.create_secgroup_rule(self.neutron_client, sg_id,
                                                 'ingress', 'tcp',
                                                 '22', '22'):
                self.logger.error("Failed to create security group rule...")
                return None

            if not os_utils.create_secgroup_rule(
                    self.neutron_client, sg_id, 'egress', 'tcp', '22', '22'):
                self.logger.error("Failed to create security group rule...")
                return None
        return sg_id

    def delete_exist_vms(self):
        servers = self.nova_client.servers.list()
        for server in servers:
            if server.name == self.vm1_name or server.name == self.vm2_name:
                self.logger.info("Deleting instance %s..." % server.name)
                server.delete()

    def boot_vm(self, vmname, image_id, flavor, network_id, test_ip, sg_id):
        config = dict()
        config['name'] = vmname
        config['flavor'] = flavor
        config['image'] = image_id
        config['nics'] = [{"net-id": network_id}]
        self.boot_vm_preparation(config, vmname, test_ip)
        self.logger.info("Creating instance '%s'..." % vmname)
        self.logger.debug("Configuration: %s" % config)
        vm = self.nova_client.servers.create(**config)

        # wait until VM status is active
        if not self.waitVmActive(self.nova_client, vm):
            vm_status = os_utils.get_instance_status(self.nova_client, vm)
            self.logger.error("Instance '%s' cannot be booted. Status is '%s'"
                              % (vmname, vm_status))
            return None
        else:
            self.logger.info("Instance '%s' is ACTIVE." % vmname)

        self.add_secgroup(vmname, vm.id, sg_id)

        return vm

    def waitVmActive(self, nova, vm):
        # sleep and wait for VM status change
        sleep_time = 3
        count = self.vm_boot_timeout / sleep_time
        while True:
            status = os_utils.get_instance_status(nova, vm)
            self.logger.debug("Status: %s" % status)
            if status == "ACTIVE":
                return True
            if status == "ERROR" or status == "error":
                return False
            if count == 0:
                self.logger.debug("Booting a VM timed out...")
                return False
            count -= 1
            time.sleep(sleep_time)
        return False

    def add_secgroup(self, vmname, vm_id, sg_id):
        self.logger.info("Adding '%s' to security group '%s'..." %
                         (vmname, self.sg_name))
        os_utils.add_secgroup_to_instance(self.nova_client, vm_id, sg_id)

    def get_test_ip(self, vm):
        test_ip = vm.networks.get(self.private_net_name)[0]
        self.logger.debug("Instance '%s' got %s" % (vm.name, test_ip))
        return test_ip

    def parse_result(self, code, start_time, stop_time):
        test_status = "FAIL"
        if code == 0:
            self.logger.info("vPing OK")
            duration = round(stop_time - start_time, 1)
            self.logger.info("vPing duration:'%s'" % duration)
            test_status = "PASS"
        elif code == -2:
            duration = 0
            self.logger.info("Userdata is not supported in nova boot. "
                             "Aborting test...")
        else:
            duration = 0
            self.logger.error("vPing FAILED")

        self.details = {'timestart': start_time,
                        'duration': duration,
                        'status': test_status}
        self.criteria = test_status

    @staticmethod
    def pMsg(msg):
        """pretty printing"""
        pprint.PrettyPrinter(indent=4).pprint(msg)


class VPingMain(object):
    def __init__(self, vping_cls):
        self.vping = vping_cls()

    def main(self, **kwargs):
        try:
            result = self.vping.run(**kwargs)
            if result != VPingBase.EX_OK:
                return result
            if kwargs['report']:
                return self.vping.push_to_db()
        except Exception:
            return VPingBase.EX_RUN_ERROR