3 # Copyright (c) 2017 Cable Television Laboratories, Inc. and others.
5 # This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 """Define the parent class of vping_ssh and vping_userdata testcases."""
13 from datetime import datetime
18 import os_client_config
19 from xtesting.core import testcase
21 from functest.utils import config
22 from functest.utils import env
23 from functest.utils import functest_utils
26 class VPingBase(testcase.TestCase):
29 Base class for vPing tests that check connectivity between two VMs shared
31 This class is responsible for creating the image, internal network.
33 # pylint: disable=too-many-instance-attributes
35 def __init__(self, **kwargs):
36 super(VPingBase, self).__init__(**kwargs)
37 self.logger = logging.getLogger(__name__)
38 self.cloud = os_client_config.make_shade()
39 self.ext_net = functest_utils.get_external_network(self.cloud)
40 self.logger.debug("ext_net: %s", self.ext_net)
41 self.guid = '-' + str(uuid.uuid4())
50 def run(self, **kwargs): # pylint: disable=too-many-locals
52 Begins the test execution which should originate from the subclass
56 self.logger.info('Begin virtual environment setup')
58 self.start_time = time.time()
60 "vPing Start Time:'%s'",
61 datetime.fromtimestamp(self.start_time).strftime(
64 image_base_name = '{}-{}'.format(
65 getattr(config.CONF, 'vping_image_name'), self.guid)
66 self.logger.info("Creating image with name: '%s'", image_base_name)
67 meta = getattr(config.CONF, 'openstack_extra_properties', None)
68 self.logger.info("Image metadata: %s", meta)
69 self.image = self.cloud.create_image(
71 filename=getattr(config.CONF, 'openstack_image_url'),
73 self.logger.debug("image: %s", self.image)
75 private_net_name = getattr(
76 config.CONF, 'vping_private_net_name') + self.guid
77 private_subnet_name = str(getattr(
78 config.CONF, 'vping_private_subnet_name') + self.guid)
79 private_subnet_cidr = getattr(config.CONF, 'vping_private_subnet_cidr')
82 if hasattr(config.CONF, 'vping_network_type'):
83 provider["network_type"] = getattr(
84 config.CONF, 'vping_network_type')
85 if hasattr(config.CONF, 'vping_physical_network'):
86 provider["physical_network"] = getattr(
87 config.CONF, 'vping_physical_network')
88 if hasattr(config.CONF, 'vping_segmentation_id'):
89 provider["segmentation_id"] = getattr(
90 config.CONF, 'vping_segmentation_id')
92 "Creating network with name: '%s'", private_net_name)
93 self.network = self.cloud.create_network(
96 self.logger.debug("network: %s", self.network)
98 self.subnet = self.cloud.create_subnet(
100 subnet_name=private_subnet_name,
101 cidr=private_subnet_cidr,
103 dns_nameservers=[env.get('NAMESERVER')])
104 self.logger.debug("subnet: %s", self.subnet)
106 router_name = getattr(config.CONF, 'vping_router_name') + self.guid
107 self.logger.info("Creating router with name: '%s'", router_name)
108 self.router = self.cloud.create_router(
110 ext_gateway_net_id=self.ext_net.id)
111 self.logger.debug("router: %s", self.router)
112 self.cloud.add_router_interface(self.router, subnet_id=self.subnet.id)
114 flavor_name = 'vping-flavor' + self.guid
116 "Creating flavor with name: '%s'", flavor_name)
117 self.flavor = self.cloud.create_flavor(
118 flavor_name, getattr(config.CONF, 'openstack_flavor_ram'),
119 getattr(config.CONF, 'openstack_flavor_vcpus'),
120 getattr(config.CONF, 'openstack_flavor_disk'))
121 self.logger.debug("flavor: %s", self.flavor)
122 self.cloud.set_flavor_specs(
123 self.flavor.id, getattr(config.CONF, 'flavor_extra_specs', {}))
125 self.sec1 = self.cloud.create_security_group(
126 getattr(config.CONF, 'vping_sg_name') + self.guid,
127 getattr(config.CONF, 'vping_sg_desc'))
128 self.cloud.create_security_group_rule(
129 self.sec1.id, protocol='icmp', direction='ingress')
131 vm1_name = getattr(config.CONF, 'vping_vm_name_1') + self.guid
133 "Creating VM 1 instance with name: '%s'", vm1_name)
134 self.vm1 = self.cloud.create_server(
135 vm1_name, image=self.image.id,
136 flavor=self.flavor.id,
137 auto_ip=False, wait=True,
138 timeout=getattr(config.CONF, 'vping_vm_boot_timeout'),
139 network=self.network.id,
140 security_groups=[self.sec1.id])
141 self.logger.debug("vm1: %s", self.vm1)
142 self.vm1 = self.cloud.wait_for_server(self.vm1, auto_ip=False)
143 p_console = self.cloud.get_server_console(self.vm1.id)
144 self.logger.debug("vm1 console: \n%s", p_console)
148 Method called by subclasses after environment has been setup
149 :return: the exit code
151 self.logger.info('Begin test execution')
152 result = self._do_vping()
153 self.stop_time = time.time()
154 if result != testcase.TestCase.EX_OK:
156 return testcase.TestCase.EX_RUN_ERROR
158 return testcase.TestCase.EX_OK
162 Cleanup all OpenStack objects. Should be called on completion
166 self.cloud.delete_server(self.vm1, wait=True)
167 self.cloud.delete_security_group(self.sec1.id)
168 self.cloud.delete_image(self.image)
169 self.cloud.remove_router_interface(self.router, self.subnet.id)
170 self.cloud.delete_router(self.router.id)
171 self.cloud.delete_network(self.network.id)
172 self.cloud.delete_flavor(self.flavor.id)
176 Method to be implemented by subclasses
177 Begins the real test after the OpenStack environment has been setup
180 raise NotImplementedError('vping execution is not implemented')