1 # Copyright (c) 2017 Cable Television Laboratories, Inc. and others.
3 # This program and the accompanying materials
4 # are made available under the terms of the Apache License, Version 2.0
5 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 """Define the parent class of vping_ssh and vping_userdata testcases."""
11 from datetime import datetime
16 from functest.core import testcase
17 from functest.opnfv_tests.openstack.snaps import snaps_utils
18 from functest.utils.constants import CONST
20 from snaps.config.flavor import FlavorConfig
21 from snaps.config.network import NetworkConfig, SubnetConfig
22 from snaps.config.router import RouterConfig
23 from snaps.openstack import create_flavor
24 from snaps.openstack.create_flavor import OpenStackFlavor
25 from snaps.openstack.tests import openstack_tests
26 from snaps.openstack.utils import deploy_utils
29 class VPingBase(testcase.TestCase):
32 Base class for vPing tests that check connectivity between two VMs shared
34 This class is responsible for creating the image, internal network.
36 # pylint: disable=too-many-instance-attributes
38 def __init__(self, **kwargs):
39 super(VPingBase, self).__init__(**kwargs)
41 self.logger = logging.getLogger(__name__)
43 if 'os_creds' in kwargs:
44 self.os_creds = kwargs['os_creds']
47 if hasattr(CONST, 'snaps_os_creds_override'):
48 creds_override = CONST.__getattribute__(
49 'snaps_os_creds_override')
51 self.os_creds = openstack_tests.get_credentials(
52 os_env_file=CONST.__getattribute__('openstack_creds'),
53 overrides=creds_override)
55 self.creators = list()
56 self.image_creator = None
57 self.network_creator = None
58 self.vm1_creator = None
59 self.vm2_creator = None
60 self.router_creator = None
63 self.guid = '-' + str(uuid.uuid4())
65 self.router_name = CONST.__getattribute__(
66 'vping_router_name') + self.guid
67 self.vm1_name = CONST.__getattribute__('vping_vm_name_1') + self.guid
68 self.vm2_name = CONST.__getattribute__('vping_vm_name_2') + self.guid
70 self.vm_boot_timeout = CONST.__getattribute__('vping_vm_boot_timeout')
71 self.vm_delete_timeout = CONST.__getattribute__(
72 'vping_vm_delete_timeout')
73 self.vm_ssh_connect_timeout = CONST.__getattribute__(
74 'vping_vm_ssh_connect_timeout')
75 self.ping_timeout = CONST.__getattribute__('vping_ping_timeout')
76 self.flavor_name = 'vping-flavor' + self.guid
78 # Move this configuration option up for all tests to leverage
79 if hasattr(CONST, 'snaps_images_cirros'):
80 self.cirros_image_config = CONST.__getattribute__(
81 'snaps_images_cirros')
83 self.cirros_image_config = None
87 Begins the test execution which should originate from the subclass
89 self.logger.info('Begin virtual environment setup')
91 self.start_time = time.time()
93 "vPing Start Time:'%s'",
94 datetime.fromtimestamp(self.start_time).strftime(
97 image_base_name = '{}-{}'.format(
98 CONST.__getattribute__('vping_image_name'),
100 os_image_settings = openstack_tests.cirros_image_settings(
101 image_base_name, image_metadata=self.cirros_image_config)
102 self.logger.info("Creating image with name: '%s'", image_base_name)
104 self.image_creator = deploy_utils.create_image(
105 self.os_creds, os_image_settings)
106 self.creators.append(self.image_creator)
108 private_net_name = CONST.__getattribute__(
109 'vping_private_net_name') + self.guid
110 private_subnet_name = CONST.__getattribute__(
111 'vping_private_subnet_name') + self.guid
112 private_subnet_cidr = CONST.__getattribute__(
113 'vping_private_subnet_cidr')
115 vping_network_type = None
116 vping_physical_network = None
117 vping_segmentation_id = None
119 if hasattr(CONST, 'vping_network_type'):
120 vping_network_type = CONST.__getattribute__(
121 'vping_network_type')
122 if hasattr(CONST, 'vping_physical_network'):
123 vping_physical_network = CONST.__getattribute__(
124 'vping_physical_network')
125 if hasattr(CONST, 'vping_segmentation_id'):
126 vping_segmentation_id = CONST.__getattribute__(
127 'vping_segmentation_id')
130 "Creating network with name: '%s'", private_net_name)
131 self.network_creator = deploy_utils.create_network(
134 name=private_net_name,
135 network_type=vping_network_type,
136 physical_network=vping_physical_network,
137 segmentation_id=vping_segmentation_id,
138 subnet_settings=[SubnetConfig(
139 name=private_subnet_name,
140 cidr=private_subnet_cidr)]))
141 self.creators.append(self.network_creator)
143 # Creating router to external network
144 log = "Creating router with name: '%s'" % self.router_name
145 self.logger.info(log)
146 ext_net_name = snaps_utils.get_ext_net_name(self.os_creds)
147 self.router_creator = deploy_utils.create_router(
150 name=self.router_name,
151 external_gateway=ext_net_name,
152 internal_subnets=[private_subnet_name]))
153 self.creators.append(self.router_creator)
156 "Creating flavor with name: '%s'", self.flavor_name)
157 scenario = CONST.__getattribute__('DEPLOY_SCENARIO')
158 flavor_metadata = None
160 if 'ovs' in scenario or 'fdio' in scenario:
161 flavor_metadata = create_flavor.MEM_PAGE_SIZE_LARGE
163 flavor_creator = OpenStackFlavor(
165 FlavorConfig(name=self.flavor_name, ram=flavor_ram, disk=1,
166 vcpus=1, metadata=flavor_metadata))
167 flavor_creator.create()
168 self.creators.append(flavor_creator)
172 Method called by subclasses after environment has been setup
173 :return: the exit code
175 self.logger.info('Begin test execution')
177 test_ip = self.vm1_creator.get_port_ip(
178 self.vm1_creator.instance_settings.port_settings[0].name)
180 if self.vm1_creator.vm_active(
181 block=True) and self.vm2_creator.vm_active(block=True):
182 result = self._do_vping(self.vm2_creator, test_ip)
184 raise Exception('VMs never became active')
186 self.stop_time = time.time()
188 if result != testcase.TestCase.EX_OK:
190 return testcase.TestCase.EX_RUN_ERROR
193 return testcase.TestCase.EX_OK
197 Cleanup all OpenStack objects. Should be called on completion
200 if CONST.__getattribute__('vping_cleanup_objects') == 'True':
201 for creator in reversed(self.creators):
204 except Exception as error: # pylint: disable=broad-except
205 self.logger.error('Unexpected error cleaning - %s', error)
207 def _do_vping(self, vm_creator, test_ip):
209 Method to be implemented by subclasses
210 Begins the real test after the OpenStack environment has been setup
211 :param vm_creator: the SNAPS VM instance creator object
212 :param test_ip: the IP to which the VM needs to issue the ping
215 raise NotImplementedError('vping execution is not implemented')