9936cdee15
This commit adds a new base test class for the cli testing framework. This differs from the previous version in the tempest repo because it uses an abstract method to initialize the client object. While in tempest this was done inside the test class itself and leveraged the config object. Since the config object is being decoupled from the library defining the test class this way allows any child test class to use whatever credentials and previous config options directly in setup.
204 lines
8.2 KiB
Python
204 lines
8.2 KiB
Python
# Copyright 2013 OpenStack Foundation
|
|
# 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 functools
|
|
import os
|
|
import shlex
|
|
import subprocess
|
|
|
|
import testtools
|
|
|
|
from tempest_lib import base
|
|
import tempest_lib.cli.output_parser
|
|
from tempest_lib import exceptions
|
|
from tempest_lib.openstack.common import log as logging
|
|
from tempest_lib.openstack.common import versionutils
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def execute(cmd, action, flags='', params='', fail_ok=False,
|
|
merge_stderr=False, cli_dir='/usr/bin'):
|
|
"""Executes specified command for the given action."""
|
|
cmd = ' '.join([os.path.join(cli_dir, cmd),
|
|
flags, action, params])
|
|
LOG.info("running: '%s'" % cmd)
|
|
cmd = shlex.split(cmd.encode('utf-8'))
|
|
result = ''
|
|
result_err = ''
|
|
stdout = subprocess.PIPE
|
|
stderr = subprocess.STDOUT if merge_stderr else subprocess.PIPE
|
|
proc = subprocess.Popen(cmd, stdout=stdout, stderr=stderr)
|
|
result, result_err = proc.communicate()
|
|
if not fail_ok and proc.returncode != 0:
|
|
raise exceptions.CommandFailed(proc.returncode,
|
|
cmd,
|
|
result,
|
|
result_err)
|
|
return result
|
|
|
|
|
|
def check_client_version(client, version):
|
|
"""Checks if the client's version is compatible with the given version
|
|
|
|
@param client: The client to check.
|
|
@param version: The version to compare against.
|
|
@return: True if the client version is compatible with the given version
|
|
parameter, False otherwise.
|
|
"""
|
|
current_version = execute(client, '', params='--version',
|
|
merge_stderr=True)
|
|
|
|
if not current_version.strip():
|
|
raise exceptions.TempestException('"%s --version" output was empty' %
|
|
client)
|
|
|
|
return versionutils.is_compatible(version, current_version,
|
|
same_major=False)
|
|
|
|
|
|
def min_client_version(*args, **kwargs):
|
|
"""A decorator to skip tests if the client used isn't of the right version.
|
|
|
|
@param client: The client command to run. For python-novaclient, this is
|
|
'nova', for python-cinderclient this is 'cinder', etc.
|
|
@param version: The minimum version required to run the CLI test.
|
|
"""
|
|
def decorator(func):
|
|
@functools.wraps(func)
|
|
def wrapper(*func_args, **func_kwargs):
|
|
if not check_client_version(kwargs['client'], kwargs['version']):
|
|
msg = "requires %s client version >= %s" % (kwargs['client'],
|
|
kwargs['version'])
|
|
raise testtools.TestCase.skipException(msg)
|
|
return func(*func_args, **func_kwargs)
|
|
return wrapper
|
|
return decorator
|
|
|
|
|
|
class CLIClientBase(object):
|
|
def __init__(self, username='', password='', tenant_name='', uri='',
|
|
cli_dir='', *args, **kwargs):
|
|
super(CLIClientBase, self).__init__()
|
|
self.cli_dir = cli_dir if cli_dir else '/usr/bin'
|
|
self.username = username
|
|
self.tenant_name = tenant_name
|
|
self.password = password
|
|
self.uri = uri
|
|
|
|
def nova(self, action, flags='', params='', admin=True, fail_ok=False,
|
|
endpoint_type='publicURL'):
|
|
"""Executes nova command for the given action."""
|
|
flags += ' --endpoint-type %s' % endpoint_type
|
|
return self.cmd_with_auth(
|
|
'nova', action, flags, params, admin, fail_ok)
|
|
|
|
def nova_manage(self, action, flags='', params='', fail_ok=False,
|
|
merge_stderr=False):
|
|
"""Executes nova-manage command for the given action."""
|
|
return execute(
|
|
'nova-manage', action, flags, params, fail_ok, merge_stderr)
|
|
|
|
def keystone(self, action, flags='', params='', admin=True, fail_ok=False):
|
|
"""Executes keystone command for the given action."""
|
|
return self.cmd_with_auth(
|
|
'keystone', action, flags, params, admin, fail_ok)
|
|
|
|
def glance(self, action, flags='', params='', admin=True, fail_ok=False,
|
|
endpoint_type='publicURL'):
|
|
"""Executes glance command for the given action."""
|
|
flags += ' --os-endpoint-type %s' % endpoint_type
|
|
return self.cmd_with_auth(
|
|
'glance', action, flags, params, admin, fail_ok)
|
|
|
|
def ceilometer(self, action, flags='', params='', admin=True,
|
|
fail_ok=False, endpoint_type='publicURL'):
|
|
"""Executes ceilometer command for the given action."""
|
|
flags += ' --os-endpoint-type %s' % endpoint_type
|
|
return self.cmd_with_auth(
|
|
'ceilometer', action, flags, params, admin, fail_ok)
|
|
|
|
def heat(self, action, flags='', params='', admin=True,
|
|
fail_ok=False, endpoint_type='publicURL'):
|
|
"""Executes heat command for the given action."""
|
|
flags += ' --os-endpoint-type %s' % endpoint_type
|
|
return self.cmd_with_auth(
|
|
'heat', action, flags, params, admin, fail_ok)
|
|
|
|
def cinder(self, action, flags='', params='', admin=True, fail_ok=False,
|
|
endpoint_type='publicURL'):
|
|
"""Executes cinder command for the given action."""
|
|
flags += ' --endpoint-type %s' % endpoint_type
|
|
return self.cmd_with_auth(
|
|
'cinder', action, flags, params, admin, fail_ok)
|
|
|
|
def swift(self, action, flags='', params='', admin=True, fail_ok=False,
|
|
endpoint_type='publicURL'):
|
|
"""Executes swift command for the given action."""
|
|
flags += ' --os-endpoint-type %s' % endpoint_type
|
|
return self.cmd_with_auth(
|
|
'swift', action, flags, params, admin, fail_ok)
|
|
|
|
def neutron(self, action, flags='', params='', admin=True, fail_ok=False,
|
|
endpoint_type='publicURL'):
|
|
"""Executes neutron command for the given action."""
|
|
flags += ' --endpoint-type %s' % endpoint_type
|
|
return self.cmd_with_auth(
|
|
'neutron', action, flags, params, admin, fail_ok)
|
|
|
|
def sahara(self, action, flags='', params='', admin=True,
|
|
fail_ok=False, merge_stderr=True, endpoint_type='publicURL'):
|
|
"""Executes sahara command for the given action."""
|
|
flags += ' --endpoint-type %s' % endpoint_type
|
|
return self.cmd_with_auth(
|
|
'sahara', action, flags, params, admin, fail_ok, merge_stderr)
|
|
|
|
def cmd_with_auth(self, cmd, action, flags='', params='',
|
|
fail_ok=False, merge_stderr=False):
|
|
"""Executes given command with auth attributes appended."""
|
|
# TODO(jogo) make admin=False work
|
|
creds = ('--os-username %s --os-tenant-name %s --os-password %s '
|
|
'--os-auth-url %s' %
|
|
(self.username,
|
|
self.tenant_name,
|
|
self.password,
|
|
self.uri))
|
|
flags = creds + ' ' + flags
|
|
return execute(cmd, action, flags, params, fail_ok, merge_stderr,
|
|
self.cli_dir)
|
|
|
|
def assertTableStruct(self, items, field_names):
|
|
"""Verify that all items has keys listed in field_names."""
|
|
for item in items:
|
|
for field in field_names:
|
|
self.assertIn(field, item)
|
|
|
|
def assertFirstLineStartsWith(self, lines, beginning):
|
|
self.assertTrue(lines[0].startswith(beginning),
|
|
msg=('Beginning of first line has invalid content: %s'
|
|
% lines[:3]))
|
|
|
|
|
|
class ClientTestBase(base.BaseTestCase):
|
|
|
|
def setUp(self):
|
|
super(ClientTestBase, self).setUp()
|
|
self.clients = self._get_clients()
|
|
self.parser = tempest_lib.cli.output_parser
|
|
|
|
def _get_clients(self):
|
|
raise NotImplementedError
|