# Copyright (c) 2016-2017 Intel Corporation
#
# 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 copy
import os
import uuid

import mock
import unittest
from xml.etree import ElementTree

from yardstick import ssh
from yardstick.benchmark.contexts.standalone import model
from yardstick.common import exceptions
from yardstick import constants
from yardstick.network_services import utils


XML_SAMPLE = """<?xml version="1.0"?>
<domain type="kvm">
    <devices>
    </devices>
</domain>
"""

XML_SAMPLE_INTERFACE = """<?xml version="1.0"?>
<domain type="kvm">
    <devices>
        <interface>
        </interface>
    </devices>
</domain>
"""


class ModelLibvirtTestCase(unittest.TestCase):

    def setUp(self):
        self.pci_address_str = '0001:04:03.2'
        self.pci_address = utils.PciAddress(self.pci_address_str)
        self.mac = '00:00:00:00:00:01'
        self._mock_ssh = mock.Mock()
        self.mock_ssh = self._mock_ssh.start()
        self.addCleanup(self._cleanup)

    def _cleanup(self):
        self._mock_ssh.stop()

    # TODO: Remove mocking of yardstick.ssh.SSH (here and elsewhere)
    # In this case, we are mocking a param to be passed into other methods
    # It can be a generic Mock() with return values set for the right methods
    def test_check_if_vm_exists_and_delete(self):
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = mock.Mock(return_value=(0, "a", ""))
            ssh.return_value = ssh_mock
        # NOTE(ralonsoh): this test doesn't cover function execution.
        model.Libvirt.check_if_vm_exists_and_delete("vm_0", ssh_mock)

    def test_virsh_create_vm(self):
        self.mock_ssh.execute = mock.Mock(return_value=(0, 0, 0))
        model.Libvirt.virsh_create_vm(self.mock_ssh, 'vm_0')
        self.mock_ssh.execute.assert_called_once_with('virsh create vm_0')

    def test_virsh_create_vm_error(self):
        self.mock_ssh.execute = mock.Mock(return_value=(1, 0, 'error_create'))
        with self.assertRaises(exceptions.LibvirtCreateError) as exc:
            model.Libvirt.virsh_create_vm(self.mock_ssh, 'vm_0')
        self.assertEqual('Error creating the virtual machine. Error: '
                         'error_create.', str(exc.exception))
        self.mock_ssh.execute.assert_called_once_with('virsh create vm_0')

    def test_virsh_destroy_vm(self):
        self.mock_ssh.execute = mock.Mock(return_value=(0, 0, 0))
        model.Libvirt.virsh_destroy_vm('vm_0', self.mock_ssh)
        self.mock_ssh.execute.assert_called_once_with('virsh destroy vm_0')

    @mock.patch.object(model, 'LOG')
    def test_virsh_destroy_vm_error(self, mock_logger):
        self.mock_ssh.execute = mock.Mock(return_value=(1, 0, 'error_destroy'))
        mock_logger.warning = mock.Mock()
        model.Libvirt.virsh_destroy_vm('vm_0', self.mock_ssh)
        mock_logger.warning.assert_called_once_with(
            'Error destroying VM %s. Error: %s', 'vm_0', 'error_destroy')
        self.mock_ssh.execute.assert_called_once_with('virsh destroy vm_0')

    def test_add_interface_address(self):
        xml = ElementTree.ElementTree(
            element=ElementTree.fromstring(XML_SAMPLE_INTERFACE))
        interface = xml.find('devices').find('interface')
        result = model.Libvirt._add_interface_address(interface, self.pci_address)
        self.assertEqual('pci', result.get('type'))
        self.assertEqual('0x{}'.format(self.pci_address.domain),
                         result.get('domain'))
        self.assertEqual('0x{}'.format(self.pci_address.bus),
                         result.get('bus'))
        self.assertEqual('0x{}'.format(self.pci_address.slot),
                         result.get('slot'))
        self.assertEqual('0x{}'.format(self.pci_address.function),
                         result.get('function'))

    def test_add_ovs_interfaces(self):
        xml_input = copy.deepcopy(XML_SAMPLE)
        xml_output = model.Libvirt.add_ovs_interface(
            '/usr/local', 0, self.pci_address_str, self.mac, xml_input)

        root = ElementTree.fromstring(xml_output)
        et_out = ElementTree.ElementTree(element=root)
        interface = et_out.find('devices').find('interface')
        self.assertEqual('vhostuser', interface.get('type'))
        mac = interface.find('mac')
        self.assertEqual(self.mac, mac.get('address'))
        source = interface.find('source')
        self.assertEqual('unix', source.get('type'))
        self.assertEqual('/usr/local/var/run/openvswitch/dpdkvhostuser0',
                         source.get('path'))
        self.assertEqual('client', source.get('mode'))
        _model = interface.find('model')
        self.assertEqual('virtio', _model.get('type'))
        driver = interface.find('driver')
        self.assertEqual('4', driver.get('queues'))
        host = driver.find('host')
        self.assertEqual('off', host.get('mrg_rxbuf'))
        self.assertIsNotNone(interface.find('address'))

    def test_add_sriov_interfaces(self):
        xml_input = copy.deepcopy(XML_SAMPLE)
        vm_pci = '0001:05:04.2'
        xml_output = model.Libvirt.add_sriov_interfaces(
            vm_pci, self.pci_address_str, self.mac, xml_input)
        root = ElementTree.fromstring(xml_output)
        et_out = ElementTree.ElementTree(element=root)
        interface = et_out.find('devices').find('interface')
        self.assertEqual('yes', interface.get('managed'))
        self.assertEqual('hostdev', interface.get('type'))
        mac = interface.find('mac')
        self.assertEqual(self.mac, mac.get('address'))
        source = interface.find('source')
        source_address = source.find('address')
        self.assertIsNotNone(source.find('address'))

        self.assertEqual('pci', source_address.get('type'))
        self.assertEqual('0x' + self.pci_address_str.split(':')[0],
                         source_address.get('domain'))
        self.assertEqual('0x' + self.pci_address_str.split(':')[1],
                         source_address.get('bus'))
        self.assertEqual('0x' + self.pci_address_str.split(':')[2].split('.')[0],
                         source_address.get('slot'))
        self.assertEqual('0x' + self.pci_address_str.split(':')[2].split('.')[1],
                         source_address.get('function'))

        interface_address = interface.find('address')
        self.assertEqual('pci', interface_address.get('type'))
        self.assertEqual('0x' + vm_pci.split(':')[0],
                         interface_address.get('domain'))
        self.assertEqual('0x' + vm_pci.split(':')[1],
                         interface_address.get('bus'))
        self.assertEqual('0x' + vm_pci.split(':')[2].split('.')[0],
                         interface_address.get('slot'))
        self.assertEqual('0x' + vm_pci.split(':')[2].split('.')[1],
                         interface_address.get('function'))

    def test_create_snapshot_qemu(self):
        self.mock_ssh.execute = mock.Mock(return_value=(0, 0, 0))
        index = 1
        vm_image = '/var/lib/libvirt/images/%s.qcow2' % index
        base_image = '/tmp/base_image'

        model.Libvirt.create_snapshot_qemu(self.mock_ssh, index, base_image)
        self.mock_ssh.execute.assert_has_calls([
            mock.call('rm -- "%s"' % vm_image),
            mock.call('test -r %s' % base_image),
            mock.call('qemu-img create -f qcow2 -o backing_file=%s %s' %
                      (base_image, vm_image))
        ])

    @mock.patch.object(os.path, 'basename', return_value='base_image')
    @mock.patch.object(os.path, 'normpath')
    @mock.patch.object(os, 'access', return_value=True)
    def test_create_snapshot_qemu_no_image_remote(self,
            mock_os_access, mock_normpath, mock_basename):
        self.mock_ssh.execute = mock.Mock(
            side_effect=[(0, 0, 0), (1, 0, 0), (0, 0, 0), (0, 0, 0)])
        index = 1
        vm_image = '/var/lib/libvirt/images/%s.qcow2' % index
        base_image = '/tmp/base_image'
        mock_normpath.return_value = base_image

        model.Libvirt.create_snapshot_qemu(self.mock_ssh, index, base_image)
        self.mock_ssh.execute.assert_has_calls([
            mock.call('rm -- "%s"' % vm_image),
            mock.call('test -r %s' % base_image),
            mock.call('mv -- "/tmp/%s" "%s"' % ('base_image', base_image)),
            mock.call('qemu-img create -f qcow2 -o backing_file=%s %s' %
                      (base_image, vm_image))
        ])
        mock_os_access.assert_called_once_with(base_image, os.R_OK)
        mock_normpath.assert_called_once_with(base_image)
        mock_basename.assert_has_calls([mock.call(base_image)])
        self.mock_ssh.put_file.assert_called_once_with(base_image,
                                                       '/tmp/base_image')

    @mock.patch.object(os, 'access', return_value=False)
    def test_create_snapshot_qemu_no_image_local(self, mock_os_access):
        self.mock_ssh.execute = mock.Mock(side_effect=[(0, 0, 0), (1, 0, 0)])
        base_image = '/tmp/base_image'

        with self.assertRaises(exceptions.LibvirtQemuImageBaseImageNotPresent):
            model.Libvirt.create_snapshot_qemu(self.mock_ssh, 3, base_image)
        mock_os_access.assert_called_once_with(base_image, os.R_OK)

    def test_create_snapshot_qemu_error_qemuimg_command(self):
        self.mock_ssh.execute = mock.Mock(
            side_effect=[(0, 0, 0), (0, 0, 0), (1, 0, 0)])
        index = 1
        vm_image = '/var/lib/libvirt/images/%s.qcow2' % index
        base_image = '/tmp/base_image'

        with self.assertRaises(exceptions.LibvirtQemuImageCreateError):
            model.Libvirt.create_snapshot_qemu(self.mock_ssh, index,
                                               base_image)
        self.mock_ssh.execute.assert_has_calls([
            mock.call('rm -- "%s"' % vm_image),
            mock.call('test -r %s' % base_image),
            mock.call('qemu-img create -f qcow2 -o backing_file=%s %s' %
                      (base_image, vm_image))
        ])

    @mock.patch.object(model.Libvirt, 'pin_vcpu_for_perf', return_value='4,5')
    @mock.patch.object(model.Libvirt, 'create_snapshot_qemu',
                       return_value='qemu_image')
    def test_build_vm_xml(self, mock_create_snapshot_qemu,
                          mock_pin_vcpu_for_perf):
        extra_specs = {'hw:cpu_cores': '4',
                       'hw:cpu_sockets': '3',
                       'hw:cpu_threads': '2',
                       'cputune': 'cool'}
        flavor = {'ram': '1024',
                  'extra_specs': extra_specs,
                  'hw_socket': '1',
                  'images': 'images'}
        mac = model.StandaloneContextHelper.get_mac_address(0x00)
        _uuid = uuid.uuid4()
        connection = mock.Mock()
        with mock.patch.object(model.StandaloneContextHelper,
                               'get_mac_address', return_value=mac) as \
                mock_get_mac_address, \
                mock.patch.object(uuid, 'uuid4', return_value=_uuid):
            xml_out, mac = model.Libvirt.build_vm_xml(
                connection, flavor, 'vm_name', 100)

        xml_ref = model.VM_TEMPLATE.format(vm_name='vm_name',
            random_uuid=_uuid, mac_addr=mac, memory='1024', vcpu='8', cpu='4',
            numa_cpus='0-7', socket='3', threads='2',
            vm_image='qemu_image', cpuset='4,5', cputune='cool')
        self.assertEqual(xml_ref, xml_out)
        mock_get_mac_address.assert_called_once_with(0x00)
        mock_create_snapshot_qemu.assert_called_once_with(
            connection, 100, 'images')
        mock_pin_vcpu_for_perf.assert_called_once_with(connection, '1')

    # TODO: Edit this test to test state instead of output
    # update_interrupts_hugepages_perf does not return anything
    def test_update_interrupts_hugepages_perf(self):
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = \
                mock.Mock(return_value=(0, "a", ""))
            ssh.return_value = ssh_mock
        # NOTE(ralonsoh): 'update_interrupts_hugepages_perf' always return
        # None, this check is trivial.
        #status = Libvirt.update_interrupts_hugepages_perf(ssh_mock)
        #self.assertIsNone(status)
        model.Libvirt.update_interrupts_hugepages_perf(ssh_mock)

    @mock.patch.object(model, 'CpuSysCores')
    @mock.patch.object(model.Libvirt, 'update_interrupts_hugepages_perf')
    def test_pin_vcpu_for_perf(self, *args):
        # NOTE(ralonsoh): test mocked methods/variables.
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = \
                mock.Mock(return_value=(0, "a", ""))
            ssh.return_value = ssh_mock
        status = model.Libvirt.pin_vcpu_for_perf(ssh_mock, 4)
        self.assertIsNotNone(status)

class StandaloneContextHelperTestCase(unittest.TestCase):

    NODE_SAMPLE = "nodes_sample.yaml"
    NODE_SRIOV_SAMPLE = "nodes_sriov_sample.yaml"

    NETWORKS = {
        'mgmt': {'cidr': '152.16.100.10/24'},
        'private_0': {
            'phy_port': "0000:05:00.0",
            'vpci': "0000:00:07.0",
            'cidr': '152.16.100.10/24',
            'gateway_ip': '152.16.100.20'},
        'public_0': {
            'phy_port': "0000:05:00.1",
            'vpci': "0000:00:08.0",
            'cidr': '152.16.40.10/24',
            'gateway_ip': '152.16.100.20'}
    }

    def setUp(self):
        self.helper = model.StandaloneContextHelper()

    def test___init__(self):
        self.assertIsNone(self.helper.file_path)

    def test_install_req_libs(self):
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = \
                mock.Mock(return_value=(1, "a", ""))
            ssh.return_value = ssh_mock
        # NOTE(ralonsoh): this test doesn't cover function execution. This test
        # should also check mocked function calls.
        model.StandaloneContextHelper.install_req_libs(ssh_mock)

    def test_get_kernel_module(self):
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = \
                mock.Mock(return_value=(1, "i40e", ""))
            ssh.return_value = ssh_mock
        # NOTE(ralonsoh): this test doesn't cover function execution. This test
        # should also check mocked function calls.
        model.StandaloneContextHelper.get_kernel_module(
            ssh_mock, "05:00.0", None)

    @mock.patch.object(model.StandaloneContextHelper, 'get_kernel_module')
    def test_get_nic_details(self, mock_get_kernel_module):
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = mock.Mock(return_value=(1, "i40e ixgbe", ""))
            ssh.return_value = ssh_mock
        mock_get_kernel_module.return_value = "i40e"
        # NOTE(ralonsoh): this test doesn't cover function execution. This test
        # should also check mocked function calls.
        model.StandaloneContextHelper.get_nic_details(
            ssh_mock, self.NETWORKS, 'dpdk-devbind.py')

    def test_get_virtual_devices(self):
        pattern = "PCI_SLOT_NAME=0000:05:00.0"
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = \
                mock.Mock(return_value=(1, pattern, ""))
            ssh.return_value = ssh_mock
        # NOTE(ralonsoh): this test doesn't cover function execution. This test
        # should also check mocked function calls.
        model.StandaloneContextHelper.get_virtual_devices(
            ssh_mock, '0000:00:05.0')

    def _get_file_abspath(self, filename):
        curr_path = os.path.dirname(os.path.abspath(__file__))
        file_path = os.path.join(curr_path, filename)
        return file_path

    def test_parse_pod_file(self):
        self.helper.file_path = self._get_file_abspath("dummy")
        self.assertRaises(IOError, self.helper.parse_pod_file,
                          self.helper.file_path)

        self.helper.file_path = self._get_file_abspath(self.NODE_SAMPLE)
        self.assertRaises(TypeError, self.helper.parse_pod_file,
                          self.helper.file_path)

        self.helper.file_path = self._get_file_abspath(self.NODE_SRIOV_SAMPLE)
        self.assertIsNotNone(self.helper.parse_pod_file(self.helper.file_path))

    def test_get_mac_address(self):
        status = model.StandaloneContextHelper.get_mac_address()
        self.assertIsNotNone(status)

    @mock.patch('yardstick.ssh.SSH')
    def test_get_mgmt_ip(self, *args):
        # NOTE(ralonsoh): test mocked methods/variables.
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = mock.Mock(
                return_value=(1, "1.2.3.4 00:00:00:00:00:01", ""))
            ssh.return_value = ssh_mock
        # NOTE(ralonsoh): this test doesn't cover function execution. This test
        # should also check mocked function calls.
        status = model.StandaloneContextHelper.get_mgmt_ip(
            ssh_mock, "00:00:00:00:00:01", "1.1.1.1/24", {})
        self.assertIsNotNone(status)

    @mock.patch('yardstick.ssh.SSH')
    def test_get_mgmt_ip_no(self, *args):
        # NOTE(ralonsoh): test mocked methods/variables.
        with mock.patch("yardstick.ssh.SSH") as ssh:
            ssh_mock = mock.Mock(autospec=ssh.SSH)
            ssh_mock.execute = \
                mock.Mock(return_value=(1, "", ""))
            ssh.return_value = ssh_mock
        # NOTE(ralonsoh): this test doesn't cover function execution. This test
        # should also check mocked function calls.
        model.WAIT_FOR_BOOT = 0
        status = model.StandaloneContextHelper.get_mgmt_ip(
            ssh_mock, "99", "1.1.1.1/24", {})
        self.assertIsNone(status)


class ServerTestCase(unittest.TestCase):

    NETWORKS = {
        'mgmt': {'cidr': '152.16.100.10/24'},
        'private_0': {
            'phy_port': "0000:05:00.0",
            'vpci': "0000:00:07.0",
            'driver': 'i40e',
            'mac': '',
            'cidr': '152.16.100.10/24',
            'gateway_ip': '152.16.100.20'},
        'public_0': {
            'phy_port': "0000:05:00.1",
            'vpci': "0000:00:08.0",
            'driver': 'i40e',
            'mac': '',
            'cidr': '152.16.40.10/24',
            'gateway_ip': '152.16.100.20'}
    }

    def setUp(self):
        self.server = model.Server()

    def test___init__(self):
        self.assertIsNotNone(self.server)

    def test_build_vnf_interfaces(self):
        vnf = {
            "network_ports": {
                'mgmt': {'cidr': '152.16.100.10/24'},
                'xe0': ['private_0'],
                'xe1': ['public_0'],
            }
        }
        status = model.Server.build_vnf_interfaces(vnf, self.NETWORKS)
        self.assertIsNotNone(status)

    def test_generate_vnf_instance(self):
        vnf = {
            "network_ports": {
                'mgmt': {'cidr': '152.16.100.10/24'},
                'xe0': ['private_0'],
                'xe1': ['public_0'],
            }
        }
        status = self.server.generate_vnf_instance(
            {}, self.NETWORKS, '1.1.1.1/24', 'vm_0', vnf, '00:00:00:00:00:01')
        self.assertIsNotNone(status)


class OvsDeployTestCase(unittest.TestCase):

    OVS_DETAILS = {'version': {'ovs': 'ovs_version', 'dpdk': 'dpdk_version'}}

    def setUp(self):
        self._mock_ssh = mock.patch.object(ssh, 'SSH')
        self.mock_ssh = self._mock_ssh.start()
        self.ovs_deploy = model.OvsDeploy(self.mock_ssh,
                                          '/tmp/dpdk-devbind.py',
                                          self.OVS_DETAILS)
        self._mock_path_isfile = mock.patch.object(os.path, 'isfile')
        self._mock_path_join = mock.patch.object(os.path, 'join')
        self.mock_path_isfile = self._mock_path_isfile.start()
        self.mock_path_join = self._mock_path_join.start()

        self.addCleanup(self._stop_mock)

    def _stop_mock(self):
        self._mock_ssh.stop()
        self._mock_path_isfile.stop()
        self._mock_path_join.stop()

    @mock.patch.object(model.StandaloneContextHelper, 'install_req_libs')
    def test_prerequisite(self, mock_install_req_libs):
        pkgs = ["git", "build-essential", "pkg-config", "automake",
                "autotools-dev", "libltdl-dev", "cmake", "libnuma-dev",
                "libpcap-dev"]
        self.ovs_deploy.prerequisite()
        mock_install_req_libs.assert_called_once_with(
            self.ovs_deploy.connection, pkgs)

    def test_ovs_deploy_no_file(self):
        self.mock_path_isfile.return_value = False
        mock_file = mock.Mock()
        self.mock_path_join.return_value = mock_file

        self.ovs_deploy.ovs_deploy()
        self.mock_path_isfile.assert_called_once_with(mock_file)
        self.mock_path_join.assert_called_once_with(
            constants.YARDSTICK_ROOT_PATH,
            'yardstick/resources/scripts/install/',
            self.ovs_deploy.OVS_DEPLOY_SCRIPT)

    @mock.patch.object(os.environ, 'get', return_value='test_proxy')
    def test_ovs_deploy(self, mock_env_get):
        self.mock_path_isfile.return_value = True
        mock_deploy_file = mock.Mock()
        mock_remove_ovs_deploy = mock.Mock()
        self.mock_path_join.side_effect = [mock_deploy_file,
                                           mock_remove_ovs_deploy]
        dpdk_version = self.OVS_DETAILS['version']['dpdk']
        ovs_version = self.OVS_DETAILS['version']['ovs']

        with mock.patch.object(self.ovs_deploy.connection, 'put') as \
                mock_put, \
                mock.patch.object(self.ovs_deploy.connection, 'execute') as \
                mock_execute, \
                mock.patch.object(self.ovs_deploy, 'prerequisite'):
            mock_execute.return_value = (0, 0, 0)
            self.ovs_deploy.ovs_deploy()

            self.mock_path_isfile.assert_called_once_with(mock_deploy_file)
            self.mock_path_join.assert_has_calls([
                mock.call(constants.YARDSTICK_ROOT_PATH,
                          'yardstick/resources/scripts/install/',
                          self.ovs_deploy.OVS_DEPLOY_SCRIPT),
                mock.call(self.ovs_deploy.bin_path,
                          self.ovs_deploy.OVS_DEPLOY_SCRIPT)
            ])
            mock_put.assert_called_once_with(mock_deploy_file,
                                             mock_remove_ovs_deploy)
            cmd = ("sudo -E %(remote_ovs_deploy)s --ovs='%(ovs_version)s' "
                   "--dpdk='%(dpdk_version)s' -p='%(proxy)s'" %
                   {'remote_ovs_deploy': mock_remove_ovs_deploy,
                    'ovs_version': ovs_version,
                    'dpdk_version': dpdk_version,
                    'proxy': 'test_proxy'})
            mock_execute.assert_called_once_with(cmd)
            mock_env_get.assert_has_calls([mock.call('http_proxy', '')])