path: root/tests/unit/benchmark/contexts/standalone/test_ovs_dpdk.py

# 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.

# Unittest for yardstick.benchmark.contexts.standalone.standaloneovs

from __future__ import absolute_import
import os
import unittest
import mock

from yardstick.benchmark.contexts.standalone import ovs_dpdk


class OvsDpdkContextTestCase(unittest.TestCase):

    NODES_SAMPLE = "nodes_sample.yaml"
    NODES_ovs_dpdk_SAMPLE = "nodes_ovs_dpdk_sample.yaml"
    NODES_DUPLICATE_SAMPLE = "nodes_duplicate_sample.yaml"

    ATTRS = {
        'name': 'StandaloneOvsDpdk',
        'file': 'pod',
        'flavor': {},
        'servers': {},
        'networks': {},
    }

    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',
         'interface': 'if0',
         'mac': "00:00:00:00:00:01",
         'vf_pci': {'vf_pci': 0},
         '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',
         'interface': 'if0',
         'vf_pci': {'vf_pci': 0},
         'mac': "00:00:00:00:00:01",
         'gateway_ip': '152.16.100.20'},
    }

    def setUp(self):
        self.ovs_dpdk = ovs_dpdk.OvsDpdkContext()

    @mock.patch('yardstick.benchmark.contexts.standalone.model.StandaloneContextHelper')
    @mock.patch('yardstick.benchmark.contexts.standalone.model.Server')
    def test___init__(self, mock_helper, mock_server):
        self.ovs_dpdk.helper = mock_helper
        self.ovs_dpdk.vnf_node = mock_server
        self.assertIsNone(self.ovs_dpdk.file_path)
        self.assertTrue(self.ovs_dpdk.first_run)

    def test_init(self):
        self.ovs_dpdk.helper.parse_pod_file = mock.Mock(return_value=[{}, {}, {}])
        self.assertIsNone(self.ovs_dpdk.init(self.ATTRS))

    def test_setup_ovs(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
            self.ovs_dpdk.connection = ssh_mock
            self.ovs_dpdk.networks = self.NETWORKS
            self.ovs_dpdk.ovs_properties = {}
            self.assertIsNone(self.ovs_dpdk.setup_ovs())

    def test_start_ovs_serverswitch(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
            self.ovs_dpdk.connection = ssh_mock
            self.ovs_dpdk.networks = self.NETWORKS
            self.ovs_dpdk.ovs_properties = {}
            self.ovs_dpdk.wait_for_vswitchd = 0
            self.assertIsNone(self.ovs_dpdk.start_ovs_serverswitch())

    def test_setup_ovs_bridge_add_flows(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
            self.ovs_dpdk.connection = ssh_mock
            self.ovs_dpdk.networks = self.NETWORKS
            self.ovs_dpdk.ovs_properties = {
                'version': {'ovs': '2.7.0'}
            }
            self.ovs_dpdk.wait_for_vswitchd = 0
            self.assertIsNone(self.ovs_dpdk.setup_ovs_bridge_add_flows())

    def test_cleanup_ovs_dpdk_env(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
            self.ovs_dpdk.connection = ssh_mock
            self.ovs_dpdk.networks = self.NETWORKS
            self.ovs_dpdk.ovs_properties = {
                'version': {'ovs': '2.7.0'}
            }
            self.ovs_dpdk.wait_for_vswitchd = 0
            self.assertIsNone(self.ovs_dpdk.cleanup_ovs_dpdk_env())

    @mock.patch('yardstick.benchmark.contexts.standalone.model.OvsDeploy')
    def test_check_ovs_dpdk_env(self, mock_ovs):
        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
            self.ovs_dpdk.connection = ssh_mock
            self.ovs_dpdk.networks = self.NETWORKS
            self.ovs_dpdk.ovs_properties = {
                    'version': {'ovs': '2.7.0', 'dpdk': '16.11.1'}
            }
            self.ovs_dpdk.wait_for_vswitchd = 0
            self.ovs_dpdk.cleanup_ovs_dpdk_env = mock.Mock()
            self.assertIsNone(self.ovs_dpdk.check_ovs_dpdk_env())
            self.ovs_dpdk.ovs_properties = {
                'version': {'ovs': '2.0.0'}
            }
            self.ovs_dpdk.wait_for_vswitchd = 0
            self.cleanup_ovs_dpdk_env = mock.Mock()
            mock_ovs.deploy = mock.Mock()
            self.assertRaises(Exception, self.ovs_dpdk.check_ovs_dpdk_env)

    @mock.patch('yardstick.ssh.SSH')
    def test_deploy(self, ssh_mock):
        ssh_mock.execute.return_value = (0, "a", "")

        self.ovs_dpdk.vm_deploy = False
        self.assertIsNone(self.ovs_dpdk.deploy())

        self.ovs_dpdk.vm_deploy = True
        self.ovs_dpdk.host_mgmt = {}
        self.ovs_dpdk.install_req_libs = mock.Mock()
        self.ovs_dpdk.helper.get_nic_details = mock.Mock(return_value={})
        self.ovs_dpdk.check_ovs_dpdk_env = mock.Mock(return_value={})
        self.ovs_dpdk.setup_ovs = mock.Mock(return_value={})
        self.ovs_dpdk.start_ovs_serverswitch = mock.Mock(return_value={})
        self.ovs_dpdk.setup_ovs_bridge_add_flows = mock.Mock(return_value={})
        self.ovs_dpdk.setup_ovs_dpdk_context = mock.Mock(return_value={})
        self.ovs_dpdk.wait_for_vnfs_to_start = mock.Mock(return_value={})
        # TODO(elfoley): This test should check states/sideeffects instead of
        # output.
        self.assertIsNone(self.ovs_dpdk.deploy())

    @mock.patch('yardstick.benchmark.contexts.standalone.model.Libvirt')
    @mock.patch('yardstick.ssh.SSH')
    def test_undeploy(self, ssh_mock, _):
        ssh_mock.execute.return_value = (0, "a", "")

        self.ovs_dpdk.vm_deploy = False
        self.assertIsNone(self.ovs_dpdk.undeploy())

        self.ovs_dpdk.vm_deploy = True
        self.ovs_dpdk.vm_names = ['vm_0', 'vm_1']
        self.ovs_dpdk.connection = ssh_mock
        self.ovs_dpdk.drivers = ['vm_0', 'vm_1']
        self.ovs_dpdk.cleanup_ovs_dpdk_env = mock.Mock()
        self.ovs_dpdk.networks = self.NETWORKS
        self.assertIsNone(self.ovs_dpdk.undeploy())

    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__get_server_with_dic_attr_name(self):

        attrs = {
            'name': 'foo',
            'file': self._get_file_abspath(self.NODES_ovs_dpdk_SAMPLE)
        }

        self.ovs_dpdk.init(attrs)

        attr_name = {'name': 'foo.bar'}
        result = self.ovs_dpdk._get_server(attr_name)

        self.assertEqual(result, None)

    def test__get_server_not_found(self):

        attrs = {
            'name': 'foo',
            'file': self._get_file_abspath(self.NODES_ovs_dpdk_SAMPLE)
        }

        self.ovs_dpdk.helper.parse_pod_file = mock.Mock(return_value=[{}, {}, {}])
        self.ovs_dpdk.init(attrs)

        attr_name = 'bar.foo'
        result = self.ovs_dpdk._get_server(attr_name)

        self.assertEqual(result, None)

    def test__get_server_mismatch(self):

        attrs = {
            'name': 'foo',
            'file': self._get_file_abspath(self.NODES_ovs_dpdk_SAMPLE)
        }

        self.ovs_dpdk.init(attrs)

        attr_name = 'bar.foo1'
        result = self.ovs_dpdk._get_server(attr_name)

        self.assertEqual(result, None)

    def test__get_server_duplicate(self):

        attrs = {
            'name': 'foo',
            'file': self._get_file_abspath(self.NODES_DUPLICATE_SAMPLE)
        }

        self.ovs_dpdk.init(attrs)

        attr_name = 'node1.foo'
        with self.assertRaises(ValueError):
            self.ovs_dpdk._get_server(attr_name)

    def test__get_server_found(self):

        attrs = {
            'name': 'foo',
            'file': self._get_file_abspath(self.NODES_ovs_dpdk_SAMPLE)
        }

        self.ovs_dpdk.init(attrs)

        attr_name = 'node1.foo'
        result = self.ovs_dpdk._get_server(attr_name)

        self.assertEqual(result['ip'], '10.229.47.137')
        self.assertEqual(result['name'], 'node1.foo')
        self.assertEqual(result['user'], 'root')
        self.assertEqual(result['key_filename'], '/root/.yardstick_key')

    def test__get_network(self):
        network1 = {
            'name': 'net_1',
            'vld_id': 'vld111',
            'segmentation_id': 'seg54',
            'network_type': 'type_a',
            'physical_network': 'phys',
        }
        network2 = {
            'name': 'net_2',
            'vld_id': 'vld999',
        }
        self.ovs_dpdk.networks = {
            'a': network1,
            'b': network2,
        }

        attr_name = {}
        self.assertIsNone(self.ovs_dpdk._get_network(attr_name))

        attr_name = {'vld_id': 'vld777'}
        self.assertIsNone(self.ovs_dpdk._get_network(attr_name))

        self.assertIsNone(self.ovs_dpdk._get_network(None))

        attr_name = 'vld777'
        self.assertIsNone(self.ovs_dpdk._get_network(attr_name))

        attr_name = {'vld_id': 'vld999'}
        expected = {
            "name": 'net_2',
            "vld_id": 'vld999',
            "segmentation_id": None,
            "network_type": None,
            "physical_network": None,
        }
        result = self.ovs_dpdk._get_network(attr_name)
        self.assertDictEqual(result, expected)

        attr_name = 'a'
        expected = network1
        result = self.ovs_dpdk._get_network(attr_name)
        self.assertDictEqual(result, expected)

    def test_configure_nics_for_ovs_dpdk(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
        self.ovs_dpdk.vm_deploy = True
        self.ovs_dpdk.connection = ssh_mock
        self.ovs_dpdk.vm_names = ['vm_0', 'vm_1']
        self.ovs_dpdk.drivers = []
        self.ovs_dpdk.networks = self.NETWORKS
        self.ovs_dpdk.helper.get_mac_address = mock.Mock(return_value="")
        self.ovs_dpdk.get_vf_datas = mock.Mock(return_value="")
        self.assertIsNone(self.ovs_dpdk.configure_nics_for_ovs_dpdk())

    @mock.patch('yardstick.benchmark.contexts.standalone.model.Libvirt.add_ovs_interface')
    def test__enable_interfaces(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
        self.ovs_dpdk.vm_deploy = True
        self.ovs_dpdk.connection = ssh_mock
        self.ovs_dpdk.vm_names = ['vm_0', 'vm_1']
        self.ovs_dpdk.drivers = []
        self.ovs_dpdk.networks = self.NETWORKS
        self.ovs_dpdk.get_vf_datas = mock.Mock(return_value="")
        self.assertIsNone(self.ovs_dpdk._enable_interfaces(0, ["private_0"], 'test'))

    @mock.patch('yardstick.benchmark.contexts.standalone.ovs_dpdk.Libvirt')
    @mock.patch('yardstick.benchmark.contexts.standalone.model.Server')
    def test_setup_ovs_dpdk_context(self, _, mock_libvirt):
        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_mock.put = \
                mock.Mock(return_value=(0, "a", ""))
            ssh.return_value = ssh_mock
        self.ovs_dpdk.vm_deploy = True
        self.ovs_dpdk.connection = ssh_mock
        self.ovs_dpdk.vm_names = ['vm_0', 'vm_1']
        self.ovs_dpdk.drivers = []
        self.ovs_dpdk.servers = {
            'vnf_0': {
                'network_ports': {
                    'mgmt': {'cidr': '152.16.100.10/24'},
                    'xe0': ['private_0'],
                    'xe1': ['public_0']
                }
            }
        }
        self.ovs_dpdk.networks = self.NETWORKS
        self.ovs_dpdk.host_mgmt = {}
        self.ovs_dpdk.flavor = {}
        self.ovs_dpdk.configure_nics_for_ovs_dpdk = mock.Mock(return_value="")
        mock_libvirt.check_if_vm_exists_and_delete = mock.Mock(return_value="")
        mock_libvirt.build_vm_xml = mock.Mock(return_value=[6, "00:00:00:00:00:01"])
        self.ovs_dpdk._enable_interfaces = mock.Mock(return_value="")
        mock_libvirt.virsh_create_vm = mock.Mock(return_value="")
        mock_libvirt.pin_vcpu_for_perf = mock.Mock(return_value="")
        self.ovs_dpdk.vnf_node.generate_vnf_instance = mock.Mock(return_value={})
        self.assertIsNotNone(self.ovs_dpdk.setup_ovs_dpdk_context())