path: root/functest/tests/unit/openstack/rally/test_rally.py

#!/usr/bin/env python

# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0

# pylint: disable=missing-docstring,protected-access,invalid-name

import json
import logging
import os
import unittest

import mock

from functest.core import testcase
from functest.opnfv_tests.openstack.rally import rally

from snaps.openstack.os_credentials import OSCreds


class OSRallyTesting(unittest.TestCase):
    # pylint: disable=too-many-public-methods
    def setUp(self):
        os_creds = OSCreds(
            username='user', password='pass',
            auth_url='http://foo.com:5000/v3', project_name='bar')
        with mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                        'get_credentials',
                        return_value=os_creds) as mock_get_creds:
            self.rally_base = rally.RallyBase()
        self.assertTrue(mock_get_creds.called)

    def test_build_task_args_missing_floating_network(self):
        os.environ['OS_AUTH_URL'] = ''
        self.rally_base.ext_net_name = ''
        task_args = self.rally_base._build_task_args('test_file_name')
        self.assertEqual(task_args['floating_network'], '')

    def test_build_task_args_missing_net_id(self):
        os.environ['OS_AUTH_URL'] = ''
        self.rally_base.priv_net_id = ''
        task_args = self.rally_base._build_task_args('test_file_name')
        self.assertEqual(task_args['netid'], '')

    @staticmethod
    def check_scenario_file(value):
        yaml_file = 'opnfv-{}.yaml'.format('test_file_name')
        if yaml_file in value:
            return False
        return True

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.path.exists')
    def test_prepare_test_list_missing_scenario_file(self, mock_func):
        mock_func.side_effect = self.check_scenario_file
        with self.assertRaises(Exception):
            self.rally_base._prepare_test_list('test_file_name')
        mock_func.assert_called()

    @staticmethod
    def check_temp_dir(value):
        yaml_file = 'opnfv-{}.yaml'.format('test_file_name')
        if yaml_file in value:
            return True
        return False

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.path.exists')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.makedirs')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_apply_blacklist')
    def test_prepare_test_list_missing_temp_dir(
            self, mock_method, mock_os_makedirs, mock_path_exists):
        mock_path_exists.side_effect = self.check_temp_dir

        yaml_file = 'opnfv-{}.yaml'.format('test_file_name')
        ret_val = os.path.join(self.rally_base.TEMP_DIR, yaml_file)
        self.assertEqual(self.rally_base._prepare_test_list('test_file_name'),
                         ret_val)
        mock_path_exists.assert_called()
        mock_method.assert_called()
        mock_os_makedirs.assert_called()

    def test_get_task_id_default(self):
        cmd_raw = 'Task 1: started'
        self.assertEqual(self.rally_base.get_task_id(cmd_raw),
                         '1')

    def test_get_task_id_missing_id(self):
        cmd_raw = ''
        self.assertEqual(self.rally_base.get_task_id(cmd_raw),
                         None)

    def test_task_succeed_fail(self):
        json_raw = json.dumps([None])
        self.assertEqual(self.rally_base.task_succeed(json_raw),
                         False)
        json_raw = json.dumps([{'result': [{'error': ['test_error']}]}])
        self.assertEqual(self.rally_base.task_succeed(json_raw),
                         False)

    def test_task_succeed_success(self):
        json_raw = json.dumps('')
        self.assertEqual(self.rally_base.task_succeed(json_raw),
                         True)

    def test_get_cmd_output(self):
        proc = mock.Mock()
        proc.stdout.__iter__ = mock.Mock(return_value=iter(['line1', 'line2']))
        self.assertEqual(self.rally_base.get_cmd_output(proc),
                         'line1line2')

    @mock.patch('__builtin__.open', mock.mock_open())
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.yaml.safe_load',
                return_value={'scenario': [
                    {'scenarios': ['test_scenario'],
                     'installers': ['test_installer'],
                     'tests': ['test']},
                    {'scenarios': ['other_scenario'],
                     'installers': ['test_installer'],
                     'tests': ['other_test']}]})
    def test_excl_scenario_default(self, mock_func):
        os.environ['INSTALLER_TYPE'] = 'test_installer'
        os.environ['DEPLOY_SCENARIO'] = 'test_scenario'
        self.assertEqual(self.rally_base.excl_scenario(), ['test'])
        mock_func.assert_called()

    @mock.patch('__builtin__.open', mock.mock_open())
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.yaml.safe_load',
                return_value={'scenario': [
                    {'scenarios': ['^os-[^-]+-featT-modeT$'],
                     'installers': ['test_installer'],
                     'tests': ['test1']},
                    {'scenarios': ['^os-ctrlT-[^-]+-modeT$'],
                     'installers': ['test_installer'],
                     'tests': ['test2']},
                    {'scenarios': ['^os-ctrlT-featT-[^-]+$'],
                     'installers': ['test_installer'],
                     'tests': ['test3']},
                    {'scenarios': ['^os-'],
                     'installers': ['test_installer'],
                     'tests': ['test4']},
                    {'scenarios': ['other_scenario'],
                     'installers': ['test_installer'],
                     'tests': ['test0a']},
                    {'scenarios': [''],  # empty scenario
                     'installers': ['test_installer'],
                     'tests': ['test0b']}]})
    def test_excl_scenario_regex(self, mock_func):
        os.environ['INSTALLER_TYPE'] = 'test_installer'
        os.environ['DEPLOY_SCENARIO'] = 'os-ctrlT-featT-modeT'
        self.assertEqual(self.rally_base.excl_scenario(),
                         ['test1', 'test2', 'test3', 'test4'])
        mock_func.assert_called()

    @mock.patch('__builtin__.open', side_effect=Exception)
    def test_excl_scenario_exception(self, mock_open):
        self.assertEqual(self.rally_base.excl_scenario(), [])
        mock_open.assert_called()

    @mock.patch('__builtin__.open', mock.mock_open())
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.yaml.safe_load',
                return_value={'functionality': [
                    {'functions': ['no_migration'], 'tests': ['test']}]})
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_migration_supported', return_value=False)
    def test_excl_func_default(self, mock_func, mock_yaml_load):
        os.environ['INSTALLER_TYPE'] = 'test_installer'
        os.environ['DEPLOY_SCENARIO'] = 'test_scenario'
        self.assertEqual(self.rally_base.excl_func(), ['test'])
        mock_func.assert_called()
        mock_yaml_load.assert_called()

    @mock.patch('__builtin__.open', side_effect=Exception)
    def test_excl_func_exception(self, mock_open):
        self.assertEqual(self.rally_base.excl_func(), [])
        mock_open.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.stat')
    def test_file_is_empty_default(self, mock_os_stat):
        attrs = {'st_size': 10}
        mock_os_stat.return_value.configure_mock(**attrs)
        self.assertEqual(self.rally_base.file_is_empty('test_file_name'),
                         False)
        mock_os_stat.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.stat',
                side_effect=Exception)
    def test_file_is_empty_exception(self, mock_os_stat):
        self.assertEqual(self.rally_base.file_is_empty('test_file_name'), True)
        mock_os_stat.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.path.exists',
                return_value=False)
    def test_run_task_missing_task_file(self, mock_path_exists):
        with self.assertRaises(Exception):
            self.rally_base._run_task('test_name')
        mock_path_exists.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.path.exists',
                return_value=True)
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_prepare_test_list', return_value='test_file_name')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                'file_is_empty', return_value=True)
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.LOGGER.info')
    def test_run_task_no_tests_for_scenario(self, mock_logger_info,
                                            mock_file_empty, mock_prep_list,
                                            mock_path_exists):
        self.rally_base._run_task('test_name')
        mock_logger_info.assert_any_call('No tests for scenario \"%s\"',
                                         'test_name')
        mock_file_empty.assert_called()
        mock_prep_list.assert_called()
        mock_path_exists.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_prepare_test_list', return_value='test_file_name')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                'file_is_empty', return_value=False)
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_build_task_args', return_value={})
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_append_summary')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                'get_task_id', return_value=None)
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                'get_cmd_output', return_value='')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.path.exists',
                return_value=True)
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.subprocess.Popen')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.LOGGER.error')
    def test_run_task_taskid_missing(self, mock_logger_error, *args):
        # pylint: disable=unused-argument
        self.rally_base._run_task('test_name')
        text = 'Failed to retrieve task_id, validating task...'
        mock_logger_error.assert_any_call(text)

    @mock.patch('__builtin__.open', mock.mock_open())
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_prepare_test_list', return_value='test_file_name')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                'file_is_empty', return_value=False)
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_build_task_args', return_value={})
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_append_summary')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                'get_task_id', return_value='1')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                'get_cmd_output', return_value='')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                'task_succeed', return_value=True)
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.path.exists',
                return_value=True)
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.subprocess.Popen')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.os.makedirs')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.LOGGER.info')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.LOGGER.error')
    def test_run_task_default(self, mock_logger_error, mock_logger_info,
                              *args):
        # pylint: disable=unused-argument
        self.rally_base._run_task('test_name')
        text = 'Test scenario: "test_name" OK.\n'
        mock_logger_info.assert_any_call(text)
        mock_logger_error.assert_not_called()

    def test_prepare_env_testname_invalid(self):
        self.rally_base.TESTS = ['test1', 'test2']
        self.rally_base.test_name = 'test'
        with self.assertRaises(Exception):
            self.rally_base._prepare_env()

    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_active_compute_cnt')
    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_ext_net_name', return_value='test_net_name')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_image',
                return_value=None)
    def test_prepare_env_image_missing(
            self, mock_get_img, mock_get_net, mock_get_comp_cnt):
        self.rally_base.TESTS = ['test1', 'test2']
        self.rally_base.test_name = 'test1'
        with self.assertRaises(Exception):
            self.rally_base._prepare_env()
        mock_get_img.assert_called()
        mock_get_net.assert_called()
        mock_get_comp_cnt.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_active_compute_cnt')
    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_ext_net_name', return_value='test_net_name')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_image')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_network',
                return_value=None)
    def test_prepare_env_network_creation_failed(
            self, mock_create_net, mock_get_img, mock_get_net,
            mock_get_comp_cnt):
        self.rally_base.TESTS = ['test1', 'test2']
        self.rally_base.test_name = 'test1'
        with self.assertRaises(Exception):
            self.rally_base._prepare_env()
        mock_create_net.assert_called()
        mock_get_img.assert_called()
        mock_get_net.assert_called()
        mock_get_comp_cnt.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_active_compute_cnt')
    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_ext_net_name', return_value='test_net_name')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_image')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_network')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_router',
                return_value=None)
    def test_prepare_env_router_creation_failed(self, *args):
        self.rally_base.TESTS = ['test1', 'test2']
        self.rally_base.test_name = 'test1'
        with self.assertRaises(Exception):
            self.rally_base._prepare_env()
        for func in args:
            func.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_active_compute_cnt')
    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_ext_net_name', return_value='test_net_name')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_image')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_network')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_router')
    @mock.patch('snaps.openstack.utils.keystone_utils.keystone_client')
    @mock.patch('snaps.openstack.utils.keystone_utils.get_project')
    @mock.patch('snaps.openstack.create_flavor.OpenStackFlavor.create',
                return_value=None)
    def test_prepare_env_flavor_creation_failed(self, mock_create_flavor,
                                                *args):
        self.rally_base.TESTS = ['test1', 'test2']
        self.rally_base.test_name = 'test1'
        with self.assertRaises(Exception):
            self.rally_base._prepare_env()
        for func in args:
            func.assert_called()
        mock_create_flavor.assert_called_once()

    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_active_compute_cnt')
    @mock.patch('functest.opnfv_tests.openstack.snaps.snaps_utils.'
                'get_ext_net_name', return_value='test_net_name')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_image')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_network')
    @mock.patch('snaps.openstack.utils.deploy_utils.create_router')
    @mock.patch('snaps.openstack.utils.keystone_utils.keystone_client')
    @mock.patch('snaps.openstack.utils.keystone_utils.get_project')
    @mock.patch('snaps.openstack.create_flavor.OpenStackFlavor.create',
                side_effect=[mock.Mock, None])
    def test_prepare_env_flavor_alt_creation_failed(self, mock_create_flavor,
                                                    *args):
        self.rally_base.TESTS = ['test1', 'test2']
        self.rally_base.test_name = 'test1'
        with self.assertRaises(Exception):
            self.rally_base._prepare_env()
        for func in args:
            func.assert_called()
        self.assertEqual(mock_create_flavor.call_count, 2)

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_run_task')
    def test_run_tests_all(self, mock_run_task):
        self.rally_base.TESTS = ['test1', 'test2']
        self.rally_base.test_name = 'all'
        self.rally_base._run_tests()
        mock_run_task.assert_any_call('test1')
        mock_run_task.assert_any_call('test2')

    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_run_task')
    def test_run_tests_default(self, mock_run_task):
        self.rally_base.TESTS = ['test1', 'test2']
        self.rally_base.test_name = 'test1'
        self.rally_base._run_tests()
        mock_run_task.assert_any_call('test1')

    def test_clean_up_default(self):
        creator1 = mock.Mock()
        creator2 = mock.Mock()
        self.rally_base.creators = [creator1, creator2]
        self.rally_base._clean_up()
        self.assertTrue(creator1.clean.called)
        self.assertTrue(creator2.clean.called)

    @mock.patch('functest.opnfv_tests.openstack.tempest.conf_utils.'
                'create_rally_deployment')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_prepare_env')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_run_tests')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_generate_report')
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_clean_up')
    def test_run_default(self, *args):
        self.assertEqual(self.rally_base.run(), testcase.TestCase.EX_OK)
        for func in args:
            func.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.tempest.conf_utils.'
                'create_rally_deployment', side_effect=Exception)
    def test_run_exception_create_rally_dep(self, mock_create_rally_dep):
        self.assertEqual(self.rally_base.run(), testcase.TestCase.EX_RUN_ERROR)
        mock_create_rally_dep.assert_called()

    @mock.patch('functest.opnfv_tests.openstack.tempest.conf_utils.'
                'create_rally_deployment', return_value=mock.Mock())
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.RallyBase.'
                '_prepare_env', side_effect=Exception)
    def test_run_exception_prepare_env(self, mock_prep_env, *args):
        # pylint: disable=unused-argument
        self.assertEqual(self.rally_base.run(), testcase.TestCase.EX_RUN_ERROR)
        mock_prep_env.assert_called()

    def test_append_summary(self):
        text = '[{"result":[{"error":[]},{"error":["err"]}],' \
               '"full_duration": 17.312026}]'
        self.rally_base._append_summary(text, "foo_test")
        self.assertEqual(self.rally_base.summary[0]['test_name'], "foo_test")
        self.assertEqual(self.rally_base.summary[0]['overall_duration'],
                         17.312026)
        self.assertEqual(self.rally_base.summary[0]['nb_tests'], 2)
        self.assertEqual(self.rally_base.summary[0]['nb_success'], 1)


if __name__ == "__main__":
    logging.disable(logging.CRITICAL)
    unittest.main(verbosity=2)