#!/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

import logging
import os
import unittest

import mock

from functest.opnfv_tests.openstack.rally import rally
from functest.opnfv_tests.openstack.tempest import conf_utils
from functest.utils import config


class OSTempestConfUtilsTesting(unittest.TestCase):
    # pylint: disable=too-many-public-methods

    @mock.patch('functest.opnfv_tests.openstack.tempest.conf_utils'
                '.LOGGER.debug')
    def test_create_verifier(self, mock_logger_debug):
        mock_popen = mock.Mock()
        attrs = {'poll.return_value': None,
                 'stdout.readline.return_value': '0'}
        mock_popen.configure_mock(**attrs)

        setattr(config.CONF, 'tempest_verifier_name', 'test_verifier_name')
        with mock.patch('subprocess.Popen', side_effect=Exception), \
                self.assertRaises(Exception):
            conf_utils.create_verifier()
            mock_logger_debug.assert_any_call("Tempest test_verifier_name"
                                              " does not exist")

    @mock.patch('functest.opnfv_tests.openstack.tempest.conf_utils.'
                'create_verifier', return_value=mock.Mock())
    @mock.patch('functest.opnfv_tests.openstack.rally.rally.'
                'RallyBase.create_rally_deployment', return_value=mock.Mock())
    def test_get_verifier_id_default(self, mock_rally, mock_tempest):
        # pylint: disable=unused-argument
        setattr(config.CONF, 'tempest_verifier_name', 'test_verifier_name')
        with mock.patch('functest.opnfv_tests.openstack.tempest.'
                        'conf_utils.subprocess.Popen') as mock_popen:
            mock_stdout = mock.Mock()
            attrs = {'stdout.readline.return_value': 'test_deploy_id'}
            mock_stdout.configure_mock(**attrs)
            mock_popen.return_value = mock_stdout

            self.assertEqual(conf_utils.get_verifier_id(),
                             'test_deploy_id')

    def test_get_depl_id_default(self):
        setattr(config.CONF, 'tempest_verifier_name', 'test_deploy_name')
        with mock.patch('functest.opnfv_tests.openstack.tempest.'
                        'conf_utils.subprocess.Popen') as mock_popen:
            mock_stdout = mock.Mock()
            attrs = {'stdout.readline.return_value': 'test_deploy_id'}
            mock_stdout.configure_mock(**attrs)
            mock_popen.return_value = mock_stdout

            self.assertEqual(rally.RallyBase.get_verifier_deployment_id(),
                             'test_deploy_id')

    def test_get_verif_repo_dir_default(self):
        with mock.patch('functest.opnfv_tests.openstack.tempest.'
                        'conf_utils.os.path.join',
                        return_value='test_verifier_repo_dir'):
            self.assertEqual(conf_utils.get_verifier_repo_dir(''),
                             'test_verifier_repo_dir')

    def test_get_depl_dir_default(self):
        with mock.patch('functest.opnfv_tests.openstack.tempest.'
                        'conf_utils.os.path.join',
                        return_value='test_verifier_repo_dir'):
            self.assertEqual(conf_utils.get_verifier_deployment_dir('', ''),
                             'test_verifier_repo_dir')

    def _test_missing_param(self, params, image_id, flavor_id, alt=False):
        with mock.patch('six.moves.configparser.RawConfigParser.'
                        'set') as mset, \
            mock.patch('six.moves.configparser.RawConfigParser.'
                       'read') as mread, \
            mock.patch('six.moves.configparser.RawConfigParser.'
                       'write') as mwrite, \
            mock.patch('six.moves.builtins.open', mock.mock_open()), \
            mock.patch('functest.utils.functest_utils.yaml.safe_load',
                       return_value={'validation': {'ssh_timeout': 300}}):
            os.environ['OS_INTERFACE'] = ''
            if not alt:
                conf_utils.configure_tempest_update_params(
                    'test_conf_file', image_id=image_id,
                    flavor_id=flavor_id)
                mset.assert_any_call(params[0], params[1], params[2])
            else:
                conf_utils.configure_tempest_update_params(
                    'test_conf_file', image_alt_id=image_id,
                    flavor_alt_id=flavor_id)
                mset.assert_any_call(params[0], params[1], params[2])
            self.assertTrue(mread.called)
            self.assertTrue(mwrite.called)

    def test_upd_missing_image_id(self):
        self._test_missing_param(('compute', 'image_ref', 'test_image_id'),
                                 'test_image_id', None)

    def test_upd_missing_image_id_alt(self):
        self._test_missing_param(
            ('compute', 'image_ref_alt', 'test_image_id_alt'),
            'test_image_id_alt', None, alt=True)

    def test_upd_missing_flavor_id(self):
        self._test_missing_param(('compute', 'flavor_ref', 'test_flavor_id'),
                                 None, 'test_flavor_id')

    def test_upd_missing_flavor_id_alt(self):
        self._test_missing_param(
            ('compute', 'flavor_ref_alt', 'test_flavor_id_alt'),
            None, 'test_flavor_id_alt', alt=True)

    def test_verif_missing_conf_file(self):
        with mock.patch('functest.opnfv_tests.openstack.tempest.'
                        'conf_utils.os.path.isfile',
                        return_value=False), \
                mock.patch('subprocess.check_output') as mexe, \
                self.assertRaises(Exception) as context:
            conf_utils.configure_verifier('test_dep_dir')
            mexe.assert_called_once_with("rally verify configure-verifier")
            msg = ("Tempest configuration file 'test_dep_dir/tempest.conf'"
                   " NOT found.")
            self.assertTrue(msg in context.exception)

    def test_configure_verifier_default(self):
        with mock.patch('functest.opnfv_tests.openstack.tempest.'
                        'conf_utils.os.path.isfile',
                        return_value=True), \
                mock.patch('subprocess.check_output') as mexe:
            self.assertEqual(conf_utils.configure_verifier('test_dep_dir'),
                             'test_dep_dir/tempest.conf')
            mexe.assert_called_once_with(
                ['rally', 'verify', 'configure-verifier', '--reconfigure',
                 '--id', str(getattr(config.CONF, 'tempest_verifier_name'))])


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