486 lines
21 KiB
Python
486 lines
21 KiB
Python
# Copyright 2012 OpenStack Foundation
|
|
# Copyright 2013 IBM Corp.
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import os
|
|
from oslo_log import log
|
|
|
|
from tempest.common import image as common_image
|
|
from tempest.common.utils.linux import remote_client
|
|
from tempest.common import waiters
|
|
from tempest import config
|
|
from tempest import exceptions
|
|
from tempest.lib.common.utils import data_utils
|
|
from tempest.lib.common.utils import test_utils
|
|
from tempest.lib import exceptions as lib_exc
|
|
import tempest.test
|
|
|
|
CONF = config.CONF
|
|
|
|
LOG = log.getLogger(__name__)
|
|
|
|
|
|
class ScenarioTest(tempest.test.BaseTestCase):
|
|
"""Base class for scenario tests. Uses tempest own clients. """
|
|
|
|
credentials = ['primary', 'admin']
|
|
|
|
@classmethod
|
|
def setup_clients(cls):
|
|
super(ScenarioTest, cls).setup_clients()
|
|
# Clients (in alphabetical order)
|
|
cls.flavors_client = cls.os_admin.flavors_client
|
|
cls.compute_floating_ips_client = (
|
|
cls.os_admin.compute_floating_ips_client)
|
|
if CONF.service_available.glance:
|
|
# Check if glance v1 is available to determine which client to use.
|
|
if CONF.image_feature_enabled.api_v1:
|
|
cls.image_client = cls.os_admin.image_client
|
|
elif CONF.image_feature_enabled.api_v2:
|
|
cls.image_client = cls.os_admin.image_client_v2
|
|
else:
|
|
raise lib_exc.InvalidConfiguration(
|
|
'Either api_v1 or api_v2 must be True in '
|
|
'[image-feature-enabled].')
|
|
# Compute image client
|
|
cls.compute_images_client = cls.os_admin.compute_images_client
|
|
cls.keypairs_client = cls.os_admin.keypairs_client
|
|
# Nova security groups client
|
|
cls.compute_security_groups_client = (
|
|
cls.os_admin.compute_security_groups_client)
|
|
cls.compute_security_group_rules_client = (
|
|
cls.os_admin.compute_security_group_rules_client)
|
|
cls.servers_client = cls.os_admin.servers_client
|
|
# Neutron network client
|
|
cls.networks_client = cls.os_admin.networks_client
|
|
cls.ports_client = cls.os_admin.ports_client
|
|
cls.routers_client = cls.os_admin.routers_client
|
|
cls.subnets_client = cls.os_admin.subnets_client
|
|
cls.floating_ips_client = cls.os_admin.floating_ips_client
|
|
cls.security_groups_client = cls.os_admin.security_groups_client
|
|
cls.security_group_rules_client = (
|
|
cls.os_admin.security_group_rules_client)
|
|
|
|
cls.volumes_client = cls.os_admin.volumes_client_latest
|
|
cls.snapshots_client = cls.os_admin.snapshots_client_latest
|
|
|
|
# ## Test functions library
|
|
#
|
|
# The create_[resource] functions only return body and discard the
|
|
# resp part which is not used in scenario tests
|
|
|
|
def _create_port(self, network_id, client=None, namestart='port-quotatest',
|
|
**kwargs):
|
|
if not client:
|
|
client = self.ports_client
|
|
name = data_utils.rand_name(namestart)
|
|
result = client.create_port(
|
|
name=name,
|
|
network_id=network_id,
|
|
**kwargs)
|
|
self.assertIsNotNone(result, 'Unable to allocate port')
|
|
port = result['port']
|
|
self.addCleanup(test_utils.call_and_ignore_notfound_exc,
|
|
client.delete_port, port['id'])
|
|
return port
|
|
|
|
def create_keypair(self, client=None):
|
|
if not client:
|
|
client = self.keypairs_client
|
|
name = data_utils.rand_name(self.__class__.__name__)
|
|
# We don't need to create a keypair by pubkey in scenario
|
|
body = client.create_keypair(name=name)
|
|
return body['keypair']
|
|
|
|
def create_server(self, name=None, image_id=None, flavor=None,
|
|
net_id=None, key=None, wait_until='ACTIVE',
|
|
sec_grps=[], metadata={}, **kwargs):
|
|
networks = [{'uuid': net_id}]
|
|
server = self.servers_client.create_server(name=name,
|
|
imageRef=image_id,
|
|
flavorRef=flavor,
|
|
key_name=key,
|
|
security_groups=sec_grps,
|
|
networks=networks,
|
|
metadata=metadata,
|
|
**kwargs)['server']
|
|
server_id = server['id']
|
|
waiters.wait_for_server_status(self.servers_client, server_id,
|
|
'ACTIVE')
|
|
return server
|
|
|
|
def create_volume(self, size=None, name=None, snapshot_id=None,
|
|
imageRef=None, volume_type=None):
|
|
if size is None:
|
|
size = CONF.volume.volume_size
|
|
if imageRef:
|
|
image = self.compute_images_client.show_image(imageRef)['image']
|
|
min_disk = image.get('minDisk')
|
|
size = max(size, min_disk)
|
|
if name is None:
|
|
name = data_utils.rand_name(self.__class__.__name__ + "-volume")
|
|
kwargs = {'display_name': name,
|
|
'snapshot_id': snapshot_id,
|
|
'imageRef': imageRef,
|
|
'volume_type': volume_type,
|
|
'size': size}
|
|
volume = self.volumes_client.create_volume(**kwargs)['volume']
|
|
|
|
self.addCleanup(self.volumes_client.wait_for_resource_deletion,
|
|
volume['id'])
|
|
self.addCleanup(test_utils.call_and_ignore_notfound_exc,
|
|
self.volumes_client.delete_volume, volume['id'])
|
|
|
|
# NOTE(e0ne): Cinder API v2 uses name instead of display_name
|
|
if 'display_name' in volume:
|
|
self.assertEqual(name, volume['display_name'])
|
|
else:
|
|
self.assertEqual(name, volume['name'])
|
|
waiters.wait_for_volume_resource_status(self.volumes_client,
|
|
volume['id'], 'available')
|
|
# The volume retrieved on creation has a non-up-to-date status.
|
|
# Retrieval after it becomes active ensures correct details.
|
|
volume = self.volumes_client.show_volume(volume['id'])['volume']
|
|
return volume
|
|
|
|
def create_volume_type(self, client=None, name=None, backend_name=None):
|
|
if not client:
|
|
client = self.admin_volume_types_client
|
|
if not name:
|
|
class_name = self.__class__.__name__
|
|
name = data_utils.rand_name(class_name + '-volume-type')
|
|
randomized_name = data_utils.rand_name('scenario-type-' + name)
|
|
|
|
LOG.debug("Creating a volume type: %s on backend %s",
|
|
randomized_name, backend_name)
|
|
extra_specs = {}
|
|
if backend_name:
|
|
extra_specs = {"volume_backend_name": backend_name}
|
|
|
|
body = client.create_volume_type(name=randomized_name,
|
|
extra_specs=extra_specs)
|
|
volume_type = body['volume_type']
|
|
self.assertIn('id', volume_type)
|
|
self.addCleanup(client.delete_volume_type, volume_type['id'])
|
|
return volume_type
|
|
|
|
def image_create(self, name, fmt,
|
|
disk_format=None, properties=None):
|
|
if properties is None:
|
|
properties = {}
|
|
name = data_utils.rand_name('%s-' % name)
|
|
params = {
|
|
'name': name,
|
|
'container_format': fmt,
|
|
'disk_format': disk_format or fmt,
|
|
}
|
|
if CONF.image_feature_enabled.api_v1:
|
|
params['is_public'] = 'False'
|
|
params['properties'] = properties
|
|
params = {'headers': common_image.image_meta_to_headers(**params)}
|
|
else:
|
|
params['visibility'] = 'private'
|
|
# Additional properties are flattened out in the v2 API.
|
|
params.update(properties)
|
|
body = self.image_client.create_image(**params)
|
|
image = body['image'] if 'image' in body else body
|
|
# self.addCleanup(self.image_client.delete_image, image['id'])
|
|
self.assertEqual("queued", image['status'])
|
|
|
|
img_path = CONF.scenario.img_file
|
|
if not os.path.exists(img_path):
|
|
# TODO(kopecmartin): replace LOG.warning for raising
|
|
# InvalidConfiguration exception when this plugin is meant to be
|
|
# used with only Tempest 27.0.0 and higher
|
|
LOG.warning(
|
|
'Starting Tempest 25.0.0 release, CONF.scenario.img_file need '
|
|
'a full path for the image. CONF.scenario.img_dir was '
|
|
'deprecated and is removed in 27.0.0 release. Till Tempest '
|
|
'27.0.0 (excluding), old behavior is maintained and kept '
|
|
'working but starting Tempest 27.0.0, only full path '
|
|
'CONF.scenario.img_file config option is accepted by the '
|
|
'Tempest.')
|
|
img_path = os.path.join(CONF.scenario.img_dir, img_path)
|
|
|
|
with open(img_path, 'rb') as image_file:
|
|
if CONF.image_feature_enabled.api_v1:
|
|
self.image_client.update_image(image['id'], data=image_file)
|
|
else:
|
|
self.image_client.store_image_file(image['id'], image_file)
|
|
return image['id']
|
|
|
|
def rebuild_server(self, server_id, image=None,
|
|
preserve_ephemeral=False, wait=True,
|
|
rebuild_kwargs=None):
|
|
if image is None:
|
|
image = CONF.compute.image_ref
|
|
|
|
rebuild_kwargs = rebuild_kwargs or {}
|
|
|
|
LOG.debug("Rebuilding server (id: %s, image: %s, preserve eph: %s)",
|
|
server_id, image, preserve_ephemeral)
|
|
self.servers_client.rebuild_server(
|
|
server_id=server_id, image_ref=image,
|
|
preserve_ephemeral=preserve_ephemeral,
|
|
**rebuild_kwargs)
|
|
if wait:
|
|
waiters.wait_for_server_status(self.servers_client,
|
|
server_id, 'ACTIVE')
|
|
|
|
def create_floating_ip(self, thing, pool_name=None):
|
|
"""Create a floating IP and associates to a server on Nova"""
|
|
|
|
if not pool_name:
|
|
pool_name = CONF.network.floating_network_name
|
|
floating_ip = (self.compute_floating_ips_client.
|
|
create_floating_ip(pool=pool_name)['floating_ip'])
|
|
self.addCleanup(test_utils.call_and_ignore_notfound_exc,
|
|
self.compute_floating_ips_client.delete_floating_ip,
|
|
floating_ip['id'])
|
|
self.compute_floating_ips_client.associate_floating_ip_to_server(
|
|
floating_ip['ip'], thing['id'])
|
|
return floating_ip
|
|
|
|
def nova_volume_attach(self, server, volume_to_attach):
|
|
volume = self.servers_client.attach_volume(
|
|
server['id'], volumeId=volume_to_attach['id'], device='/dev/%s'
|
|
% CONF.compute.volume_device_name)['volumeAttachment']
|
|
self.assertEqual(volume_to_attach['id'], volume['id'])
|
|
waiters.wait_for_volume_resource_status(self.volumes_client,
|
|
volume['id'], 'in-use')
|
|
|
|
# Return the updated volume after the attachment
|
|
return self.volumes_client.show_volume(volume['id'])['volume']
|
|
|
|
def nova_volume_detach(self, server, volume):
|
|
self.servers_client.detach_volume(server['id'], volume['id'])
|
|
waiters.wait_for_volume_resource_status(self.volumes_client,
|
|
volume['id'], 'available')
|
|
|
|
volume = self.volumes_client.show_volume(volume['id'])['volume']
|
|
self.assertEqual('available', volume['status'])
|
|
|
|
def create_timestamp(self, ip_address, dev_name=None, mount_path='/mnt',
|
|
private_key=None):
|
|
ssh_client = self.get_remote_client(ip_address,
|
|
private_key=private_key)
|
|
if dev_name is not None:
|
|
ssh_client.make_fs(dev_name)
|
|
ssh_client.exec_command('sudo mount /dev/%s %s' % (dev_name,
|
|
mount_path))
|
|
cmd_timestamp = 'sudo sh -c "date > %s/timestamp; sync"' % mount_path
|
|
ssh_client.exec_command(cmd_timestamp)
|
|
timestamp = ssh_client.exec_command('sudo cat %s/timestamp'
|
|
% mount_path)
|
|
if dev_name is not None:
|
|
ssh_client.exec_command('sudo umount %s' % mount_path)
|
|
return timestamp
|
|
|
|
def get_timestamp(self, ip_address, dev_name=None, mount_path='/mnt',
|
|
private_key=None):
|
|
ssh_client = self.get_remote_client(ip_address,
|
|
private_key=private_key)
|
|
if dev_name is not None:
|
|
ssh_client.mount(dev_name, mount_path)
|
|
timestamp = ssh_client.exec_command('sudo cat %s/timestamp'
|
|
% mount_path)
|
|
if dev_name is not None:
|
|
ssh_client.exec_command('sudo umount %s' % mount_path)
|
|
return timestamp
|
|
|
|
def get_server_ip(self, server):
|
|
"""Get the server fixed or floating IP.
|
|
|
|
Based on the configuration we're in, return a correct ip
|
|
address for validating that a guest is up.
|
|
"""
|
|
if CONF.validation.connect_method == 'floating':
|
|
# The tests calling this method don't have a floating IP
|
|
# and can't make use of the validation resources. So the
|
|
# method is creating the floating IP there.
|
|
return self.create_floating_ip(server)['ip']
|
|
elif CONF.validation.connect_method == 'fixed':
|
|
# Determine the network name to look for based on config or creds
|
|
# provider network resources.
|
|
if CONF.validation.network_for_ssh:
|
|
addresses = server['addresses'][
|
|
CONF.validation.network_for_ssh]
|
|
else:
|
|
creds_provider = self._get_credentials_provider()
|
|
net_creds = creds_provider.get_primary_creds()
|
|
network = getattr(net_creds, 'network', None)
|
|
addresses = (server['addresses'][network['name']]
|
|
if network else [])
|
|
for addr in addresses:
|
|
if (addr['version'] == CONF.validation.ip_version_for_ssh and
|
|
addr['OS-EXT-IPS:type'] == 'fixed'):
|
|
return addr['addr']
|
|
raise exceptions.ServerUnreachable(server_id=server['id'])
|
|
else:
|
|
raise lib_exc.InvalidConfiguration()
|
|
|
|
def get_remote_client(self, ip_address, username=None, private_key=None):
|
|
"""Get a SSH client to a remote server
|
|
|
|
@param ip_address the server floating or fixed IP address to use
|
|
for ssh validation
|
|
@param username name of the Linux account on the remote server
|
|
@param private_key the SSH private key to use
|
|
@return a RemoteClient object
|
|
"""
|
|
|
|
if username is None:
|
|
username = CONF.validation.image_ssh_user
|
|
# Set this with 'keypair' or others to log in with keypair or
|
|
# username/password.
|
|
if CONF.validation.auth_method == 'keypair':
|
|
password = None
|
|
if private_key is None:
|
|
private_key = self.keypair['private_key']
|
|
else:
|
|
password = CONF.validation.image_ssh_password
|
|
private_key = None
|
|
linux_client = remote_client.RemoteClient(ip_address, username,
|
|
pkey=private_key,
|
|
password=password)
|
|
try:
|
|
linux_client.validate_authentication()
|
|
except Exception as e:
|
|
message = ('Initializing SSH connection to %(ip)s failed. '
|
|
'Error: %(error)s' % {'ip': ip_address,
|
|
'error': e})
|
|
caller = test_utils.find_test_caller()
|
|
if caller:
|
|
message = '(%s) %s' % (caller, message)
|
|
LOG.exception(message)
|
|
self._log_console_output()
|
|
raise
|
|
|
|
return linux_client
|
|
|
|
def _default_security_group(self, client=None, tenant_id=None):
|
|
"""Get default secgroup for given tenant_id.
|
|
|
|
:returns: default secgroup for given tenant
|
|
"""
|
|
if client is None:
|
|
client = self.security_groups_client
|
|
if not tenant_id:
|
|
tenant_id = client.tenant_id
|
|
sgs = [
|
|
sg for sg in list(client.list_security_groups().values())[0]
|
|
if sg['tenant_id'] == tenant_id and sg['name'] == 'default'
|
|
]
|
|
msg = "No default security group for tenant %s." % tenant_id
|
|
self.assertGreater(len(sgs), 0, msg)
|
|
return sgs[0]
|
|
|
|
def _create_security_group(self):
|
|
# Create security group
|
|
sg_name = data_utils.rand_name(self.__class__.__name__)
|
|
sg_desc = sg_name + " description"
|
|
secgroup = self.compute_security_groups_client.create_security_group(
|
|
name=sg_name, description=sg_desc)['security_group']
|
|
self.assertEqual(secgroup['name'], sg_name)
|
|
self.assertEqual(secgroup['description'], sg_desc)
|
|
self.addCleanup(
|
|
test_utils.call_and_ignore_notfound_exc,
|
|
self.compute_security_groups_client.delete_security_group,
|
|
secgroup['id'])
|
|
|
|
# Add rules to the security group
|
|
self._create_loginable_secgroup_rule(secgroup['id'])
|
|
|
|
return secgroup
|
|
|
|
def _create_loginable_secgroup_rule(self, secgroup_id=None):
|
|
_client = self.compute_security_groups_client
|
|
_client_rules = self.compute_security_group_rules_client
|
|
if secgroup_id is None:
|
|
sgs = _client.list_security_groups()['security_groups']
|
|
for sg in sgs:
|
|
if sg['name'] == 'default':
|
|
secgroup_id = sg['id']
|
|
|
|
# These rules are intended to permit inbound ssh and icmp
|
|
# traffic from all sources, so no group_id is provided.
|
|
# Setting a group_id would only permit traffic from ports
|
|
# belonging to the same security group.
|
|
rulesets = [
|
|
{
|
|
# ssh
|
|
'ip_protocol': 'tcp',
|
|
'from_port': 22,
|
|
'to_port': 22,
|
|
'cidr': '0.0.0.0/0',
|
|
},
|
|
{
|
|
# ping
|
|
'ip_protocol': 'icmp',
|
|
'from_port': -1,
|
|
'to_port': -1,
|
|
'cidr': '0.0.0.0/0',
|
|
}
|
|
]
|
|
rules = list()
|
|
for ruleset in rulesets:
|
|
sg_rule = _client_rules.create_security_group_rule(
|
|
parent_group_id=secgroup_id, **ruleset)['security_group_rule']
|
|
rules.append(sg_rule)
|
|
return rules
|
|
|
|
def _create_security_group_rule(self, secgroup=None,
|
|
sec_group_rules_client=None,
|
|
tenant_id=None,
|
|
security_groups_client=None, **kwargs):
|
|
"""Create a rule from a dictionary of rule parameters.
|
|
|
|
Create a rule in a secgroup. if secgroup not defined will search for
|
|
default secgroup in tenant_id.
|
|
|
|
:param secgroup: the security group.
|
|
:param tenant_id: if secgroup not passed -- the tenant in which to
|
|
search for default secgroup
|
|
:param kwargs: a dictionary containing rule parameters:
|
|
for example, to allow incoming ssh:
|
|
rule = {
|
|
direction: 'ingress'
|
|
protocol:'tcp',
|
|
port_range_min: 22,
|
|
port_range_max: 22
|
|
}
|
|
"""
|
|
if sec_group_rules_client is None:
|
|
sec_group_rules_client = self.security_group_rules_client
|
|
if security_groups_client is None:
|
|
security_groups_client = self.security_groups_client
|
|
if not tenant_id:
|
|
tenant_id = security_groups_client.tenant_id
|
|
if secgroup is None:
|
|
secgroup = self._default_security_group(
|
|
client=security_groups_client, tenant_id=tenant_id)
|
|
|
|
ruleset = dict(security_group_id=secgroup['id'],
|
|
tenant_id=secgroup['tenant_id'])
|
|
ruleset.update(kwargs)
|
|
|
|
sg_rule = sec_group_rules_client.create_security_group_rule(**ruleset)
|
|
sg_rule = sg_rule['security_group_rule']
|
|
|
|
self.assertEqual(secgroup['tenant_id'], sg_rule['tenant_id'])
|
|
self.assertEqual(secgroup['id'], sg_rule['security_group_id'])
|
|
|
|
return sg_rule
|