kolla-cli/kolla_cli/tests/functional/common.py

208 lines
7.0 KiB
Python

# Copyright(c) 2016, Oracle and/or its affiliates. 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 logging
import os
import shutil
import subprocess
import sys
import testtools
import kolla_cli.common.utils as utils
from copy import copy
from shutil import copyfile
from kolla_cli.api.client import ClientApi
from kolla_cli.api.exceptions import InvalidArgument
CLIENT = ClientApi()
CLIENT.enable_console_logging(logging.DEBUG)
ARG_LIST = {
bool: False,
list: [1, 2, 3],
str: 'qwerty',
dict: {'a': 1},
int: 0,
}
KOLLACLI_CMD_PATH = 'kolla_cli/shell.py'
class KollaCliTest(testtools.TestCase):
saved_kolla_etc = ''
log = logging.getLogger(__name__)
def setUp(self):
super(KollaCliTest, self).setUp()
logging.basicConfig(stream=sys.stderr)
self.log.setLevel(logging.DEBUG)
self.log.info('\nStarting test: %s ***********************************'
% self._testMethodName)
# switch to test path
etc_path = utils.get_kolla_cli_etc()
self.log.debug('etc for tests: %s' % etc_path)
self._save_config()
def tearDown(self):
super(KollaCliTest, self).tearDown()
self._restore_config()
def run_cli_cmd(self, cmd, expect_error=False):
full_cmd = ('python %s %s' % (KOLLACLI_CMD_PATH, cmd))
self.log.debug('running command: %s' % cmd)
(retval, msg) = self.run_command(full_cmd)
if not expect_error:
self.assertEqual(0, retval, ('command failed: (%s), cmd: %s'
% (msg, full_cmd)))
return msg
def run_command(self, cmd):
"""run bash command
return (retval, msg)
"""
# self.log.debug('run cmd: %s' % cmd)
msg = ''
process = subprocess.Popen(cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
shell=True)
(out, err) = process.communicate()
retval = process.returncode
# the py dev debugger adds a string at the line start, remove it
if err:
msg = utils.safe_decode(err)
if out:
msg = msg + '\n' + utils.safe_decode(out)
if msg.startswith('pydev debugger'):
msg = msg.split('\n', 1)[1]
return (retval, msg)
def check_types(self, method, expected_types):
# expected type is a list:
args = []
for arg_type in expected_types:
args.append((arg_type, ARG_LIST[arg_type]))
for i in range(0, len(args)):
arg_type, _ = args[i]
for new_arg in ARG_LIST.values():
new_args = copy(args)
if isinstance(new_arg, arg_type):
# this new type is the correct arg type, skip
continue
# substitute a valid type for an invalid one
new_args[i] = new_arg
self._check_invalid_arg(method, new_args)
def _check_invalid_arg(self, method, args):
assert(len(args) <= 5)
try:
if len(args) == 1:
method(args[0])
elif len(args) == 2:
method(args[0], args[1])
elif len(args) == 3:
method(args[0], args[1], args[2])
elif len(args) == 4:
method(args[0], args[1], args[2], args[3])
elif len(args) == 5:
method(args[0], args[1], args[2], args[3], args[4])
except InvalidArgument:
# success
return
except Exception as e:
self.assertTrue(False,
'method: %s, arg: %s ' % (method, args) +
'failed with the wrong exception: '
'%s' % str(e))
self.assertTrue(False, 'method: %s, arg: %s did not fail'
% (method, args))
# PRIVATE FUNCTIONS ----------------------------------------------------
def _save_config(self):
"""save config"""
# save inventory
src_path = os.path.join(utils.get_kolla_cli_etc(),
'ansible', 'inventory.json')
dst_path = os.path.join('/tmp', 'inventory.json.utest.save')
copyfile(src_path, dst_path)
# save group vars
ansible_dir = os.path.join(utils.get_kolla_ansible_home(), 'ansible')
groupdir = os.path.join(ansible_dir, 'group_vars')
self._save_dir(groupdir)
# save host vars
hostdir = os.path.join(ansible_dir, 'host_vars')
self._save_dir(hostdir)
def _restore_config(self):
"""restore config"""
# restore inventory
dst_path = os.path.join(utils.get_kolla_cli_etc(),
'ansible', 'inventory.json')
src_path = os.path.join('/tmp', 'inventory.json.utest.save')
copyfile(src_path, dst_path)
# restore group vars
ansible_dir = os.path.join(utils.get_kolla_ansible_home(), 'ansible')
groupdir = os.path.join(ansible_dir, 'group_vars')
self._restore_dir(groupdir)
# restore host vars
hostdir = os.path.join(ansible_dir, 'host_vars')
self._restore_dir(hostdir)
def _save_dir(self, src_dir):
if not os.path.exists(src_dir):
return
dirname = os.path.basename(src_dir)
save_dir = os.path.join('/tmp', dirname + '.utest.save')
if os.path.exists(save_dir):
shutil.rmtree(save_dir)
os.mkdir(save_dir)
fnames = os.listdir(src_dir)
for fname in fnames:
src_path = os.path.join(src_dir, fname)
dst_path = os.path.join(save_dir, fname)
copyfile(src_path, dst_path)
def _restore_dir(self, dst_dir):
# we do not have privs to write these files
ignore_list = ['all.yml']
dirname = os.path.basename(dst_dir)
save_dir = os.path.join('/tmp', dirname + '.utest.save')
sv_fnames = os.listdir(save_dir)
fnames = os.listdir(dst_dir)
# remove any new var files created by tests
for fname in fnames:
if fname not in sv_fnames:
os.remove(os.path.join(dst_dir, fname))
# restore saved files
for sv_fname in sv_fnames:
if sv_fname in ignore_list:
continue
src_path = os.path.join(save_dir, sv_fname)
dst_path = os.path.join(dst_dir, sv_fname)
copyfile(src_path, dst_path)