511 lines
20 KiB
Python
511 lines
20 KiB
Python
# Copyright 2014 Cisco Systems, Inc.
|
|
# 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 json
|
|
|
|
import mock
|
|
|
|
from ironic.common import exception
|
|
from ironic.common import raid
|
|
from ironic.drivers import base as driver_base
|
|
from ironic.drivers.modules import fake
|
|
from ironic.drivers.modules.network import common as net_common
|
|
from ironic.tests import base
|
|
|
|
|
|
class FakeVendorInterface(driver_base.VendorInterface):
|
|
def get_properties(self):
|
|
pass
|
|
|
|
@driver_base.passthru(['POST'])
|
|
def noexception(self):
|
|
return "Fake"
|
|
|
|
@driver_base.driver_passthru(['POST'])
|
|
def driver_noexception(self):
|
|
return "Fake"
|
|
|
|
@driver_base.passthru(['POST'])
|
|
def ironicexception(self):
|
|
raise exception.IronicException("Fake!")
|
|
|
|
@driver_base.passthru(['POST'])
|
|
def normalexception(self):
|
|
raise Exception("Fake!")
|
|
|
|
@driver_base.passthru(['POST'], require_exclusive_lock=False)
|
|
def shared_task(self):
|
|
return "shared fake"
|
|
|
|
def validate(self, task, **kwargs):
|
|
pass
|
|
|
|
def driver_validate(self, **kwargs):
|
|
pass
|
|
|
|
|
|
class PassthruDecoratorTestCase(base.TestCase):
|
|
|
|
def setUp(self):
|
|
super(PassthruDecoratorTestCase, self).setUp()
|
|
self.fvi = FakeVendorInterface()
|
|
|
|
def test_passthru_noexception(self):
|
|
result = self.fvi.noexception()
|
|
self.assertEqual("Fake", result)
|
|
|
|
@mock.patch.object(driver_base, 'LOG', autospec=True)
|
|
def test_passthru_ironicexception(self, mock_log):
|
|
self.assertRaises(exception.IronicException,
|
|
self.fvi.ironicexception, mock.ANY)
|
|
mock_log.exception.assert_called_with(
|
|
mock.ANY, 'ironicexception')
|
|
|
|
@mock.patch.object(driver_base, 'LOG', autospec=True)
|
|
def test_passthru_nonironicexception(self, mock_log):
|
|
self.assertRaises(exception.VendorPassthruException,
|
|
self.fvi.normalexception, mock.ANY)
|
|
mock_log.exception.assert_called_with(
|
|
mock.ANY, 'normalexception')
|
|
|
|
def test_passthru_shared_task_metadata(self):
|
|
self.assertIn('require_exclusive_lock',
|
|
self.fvi.shared_task._vendor_metadata[1])
|
|
self.assertFalse(
|
|
self.fvi.shared_task._vendor_metadata[1]['require_exclusive_lock'])
|
|
|
|
def test_passthru_exclusive_task_metadata(self):
|
|
self.assertIn('require_exclusive_lock',
|
|
self.fvi.noexception._vendor_metadata[1])
|
|
self.assertTrue(
|
|
self.fvi.noexception._vendor_metadata[1]['require_exclusive_lock'])
|
|
|
|
def test_passthru_check_func_references(self):
|
|
inst1 = FakeVendorInterface()
|
|
inst2 = FakeVendorInterface()
|
|
|
|
self.assertNotEqual(inst1.vendor_routes['noexception']['func'],
|
|
inst2.vendor_routes['noexception']['func'])
|
|
self.assertNotEqual(inst1.driver_routes['driver_noexception']['func'],
|
|
inst2.driver_routes['driver_noexception']['func'])
|
|
|
|
|
|
class CleanStepDecoratorTestCase(base.TestCase):
|
|
|
|
def setUp(self):
|
|
super(CleanStepDecoratorTestCase, self).setUp()
|
|
method_mock = mock.MagicMock()
|
|
del method_mock._is_clean_step
|
|
del method_mock._clean_step_priority
|
|
del method_mock._clean_step_abortable
|
|
del method_mock._clean_step_argsinfo
|
|
self.method = method_mock
|
|
|
|
def test__validate_argsinfo(self):
|
|
# None, empty dict
|
|
driver_base._validate_argsinfo(None)
|
|
driver_base._validate_argsinfo({})
|
|
|
|
# Only description specified
|
|
driver_base._validate_argsinfo({'arg1': {'description': 'desc1'}})
|
|
|
|
# Multiple args
|
|
driver_base._validate_argsinfo({'arg1': {'description': 'desc1',
|
|
'required': True},
|
|
'arg2': {'description': 'desc2'}})
|
|
|
|
def test__validate_argsinfo_not_dict(self):
|
|
self.assertRaisesRegex(exception.InvalidParameterValue,
|
|
'argsinfo.+dictionary',
|
|
driver_base._validate_argsinfo, 'not-a-dict')
|
|
|
|
def test__validate_argsinfo_arg_not_dict(self):
|
|
self.assertRaisesRegex(exception.InvalidParameterValue,
|
|
'Argument.+dictionary',
|
|
driver_base._validate_argsinfo,
|
|
{'arg1': 'not-a-dict'})
|
|
|
|
def test__validate_argsinfo_arg_empty_dict(self):
|
|
self.assertRaisesRegex(exception.InvalidParameterValue,
|
|
'description',
|
|
driver_base._validate_argsinfo,
|
|
{'arg1': {}})
|
|
|
|
def test__validate_argsinfo_arg_missing_description(self):
|
|
self.assertRaisesRegex(exception.InvalidParameterValue,
|
|
'description',
|
|
driver_base._validate_argsinfo,
|
|
{'arg1': {'required': True}})
|
|
|
|
def test__validate_argsinfo_arg_description_invalid(self):
|
|
self.assertRaisesRegex(exception.InvalidParameterValue,
|
|
'string',
|
|
driver_base._validate_argsinfo,
|
|
{'arg1': {'description': True}})
|
|
|
|
def test__validate_argsinfo_arg_required_invalid(self):
|
|
self.assertRaisesRegex(exception.InvalidParameterValue,
|
|
'Boolean',
|
|
driver_base._validate_argsinfo,
|
|
{'arg1': {'description': 'desc1',
|
|
'required': 'maybe'}})
|
|
|
|
def test__validate_argsinfo_arg_unknown_key(self):
|
|
self.assertRaisesRegex(exception.InvalidParameterValue,
|
|
'invalid',
|
|
driver_base._validate_argsinfo,
|
|
{'arg1': {'description': 'desc1',
|
|
'unknown': 'bad'}})
|
|
|
|
def test_clean_step_priority_only(self):
|
|
d = driver_base.clean_step(priority=10)
|
|
d(self.method)
|
|
self.assertTrue(self.method._is_clean_step)
|
|
self.assertEqual(10, self.method._clean_step_priority)
|
|
self.assertFalse(self.method._clean_step_abortable)
|
|
self.assertIsNone(self.method._clean_step_argsinfo)
|
|
|
|
def test_clean_step_all_args(self):
|
|
argsinfo = {'arg1': {'description': 'desc1',
|
|
'required': True}}
|
|
d = driver_base.clean_step(priority=0, abortable=True,
|
|
argsinfo=argsinfo)
|
|
d(self.method)
|
|
self.assertTrue(self.method._is_clean_step)
|
|
self.assertEqual(0, self.method._clean_step_priority)
|
|
self.assertTrue(self.method._clean_step_abortable)
|
|
self.assertEqual(argsinfo, self.method._clean_step_argsinfo)
|
|
|
|
def test_clean_step_bad_priority(self):
|
|
d = driver_base.clean_step(priority='hi')
|
|
self.assertRaisesRegex(exception.InvalidParameterValue, 'priority',
|
|
d, self.method)
|
|
self.assertTrue(self.method._is_clean_step)
|
|
self.assertFalse(hasattr(self.method, '_clean_step_priority'))
|
|
self.assertFalse(hasattr(self.method, '_clean_step_abortable'))
|
|
self.assertFalse(hasattr(self.method, '_clean_step_argsinfo'))
|
|
|
|
def test_clean_step_bad_abortable(self):
|
|
d = driver_base.clean_step(priority=0, abortable='blue')
|
|
self.assertRaisesRegex(exception.InvalidParameterValue, 'abortable',
|
|
d, self.method)
|
|
self.assertTrue(self.method._is_clean_step)
|
|
self.assertEqual(0, self.method._clean_step_priority)
|
|
self.assertFalse(hasattr(self.method, '_clean_step_abortable'))
|
|
self.assertFalse(hasattr(self.method, '_clean_step_argsinfo'))
|
|
|
|
@mock.patch.object(driver_base, '_validate_argsinfo', spec_set=True,
|
|
autospec=True)
|
|
def test_clean_step_bad_argsinfo(self, mock_valid):
|
|
mock_valid.side_effect = exception.InvalidParameterValue('bad')
|
|
d = driver_base.clean_step(priority=0, argsinfo=100)
|
|
self.assertRaises(exception.InvalidParameterValue, d, self.method)
|
|
self.assertTrue(self.method._is_clean_step)
|
|
self.assertEqual(0, self.method._clean_step_priority)
|
|
self.assertFalse(self.method._clean_step_abortable)
|
|
self.assertFalse(hasattr(self.method, '_clean_step_argsinfo'))
|
|
|
|
|
|
class CleanStepTestCase(base.TestCase):
|
|
def test_get_and_execute_clean_steps(self):
|
|
# Create a fake Driver class, create some clean steps, make sure
|
|
# they are listed correctly, and attempt to execute one of them
|
|
|
|
method_mock = mock.MagicMock(spec_set=[])
|
|
method_args_mock = mock.MagicMock(spec_set=[])
|
|
task_mock = mock.MagicMock(spec_set=[])
|
|
|
|
class BaseTestClass(driver_base.BaseInterface):
|
|
def get_properties(self):
|
|
return {}
|
|
|
|
def validate(self, task):
|
|
pass
|
|
|
|
class TestClass(BaseTestClass):
|
|
interface_type = 'test'
|
|
|
|
@driver_base.clean_step(priority=0)
|
|
def manual_method(self, task):
|
|
pass
|
|
|
|
@driver_base.clean_step(priority=10, abortable=True)
|
|
def automated_method(self, task):
|
|
method_mock(task)
|
|
|
|
def not_clean_method(self, task):
|
|
pass
|
|
|
|
class TestClass2(BaseTestClass):
|
|
interface_type = 'test2'
|
|
|
|
@driver_base.clean_step(priority=0)
|
|
def manual_method2(self, task):
|
|
pass
|
|
|
|
@driver_base.clean_step(priority=20, abortable=True)
|
|
def automated_method2(self, task):
|
|
method_mock(task)
|
|
|
|
def not_clean_method2(self, task):
|
|
pass
|
|
|
|
class TestClass3(BaseTestClass):
|
|
interface_type = 'test3'
|
|
|
|
@driver_base.clean_step(priority=0, abortable=True, argsinfo={
|
|
'arg1': {'description': 'desc1',
|
|
'required': True}})
|
|
def manual_method3(self, task, **kwargs):
|
|
method_args_mock(task, **kwargs)
|
|
|
|
@driver_base.clean_step(priority=15, argsinfo={
|
|
'arg10': {'description': 'desc10'}})
|
|
def automated_method3(self, task, **kwargs):
|
|
pass
|
|
|
|
def not_clean_method3(self, task):
|
|
pass
|
|
|
|
obj = TestClass()
|
|
obj2 = TestClass2()
|
|
obj3 = TestClass3()
|
|
|
|
self.assertEqual(2, len(obj.get_clean_steps(task_mock)))
|
|
# Ensure the steps look correct
|
|
self.assertEqual(10, obj.get_clean_steps(task_mock)[0]['priority'])
|
|
self.assertTrue(obj.get_clean_steps(task_mock)[0]['abortable'])
|
|
self.assertEqual('test', obj.get_clean_steps(
|
|
task_mock)[0]['interface'])
|
|
self.assertEqual('automated_method', obj.get_clean_steps(
|
|
task_mock)[0]['step'])
|
|
self.assertEqual(0, obj.get_clean_steps(task_mock)[1]['priority'])
|
|
self.assertFalse(obj.get_clean_steps(task_mock)[1]['abortable'])
|
|
self.assertEqual('test', obj.get_clean_steps(
|
|
task_mock)[1]['interface'])
|
|
self.assertEqual('manual_method', obj.get_clean_steps(
|
|
task_mock)[1]['step'])
|
|
|
|
# Ensure the second obj get different clean steps
|
|
self.assertEqual(2, len(obj2.get_clean_steps(task_mock)))
|
|
# Ensure the steps look correct
|
|
self.assertEqual(20, obj2.get_clean_steps(task_mock)[0]['priority'])
|
|
self.assertTrue(obj2.get_clean_steps(task_mock)[0]['abortable'])
|
|
self.assertEqual('test2', obj2.get_clean_steps(
|
|
task_mock)[0]['interface'])
|
|
self.assertEqual('automated_method2', obj2.get_clean_steps(
|
|
task_mock)[0]['step'])
|
|
self.assertEqual(0, obj2.get_clean_steps(task_mock)[1]['priority'])
|
|
self.assertFalse(obj2.get_clean_steps(task_mock)[1]['abortable'])
|
|
self.assertEqual('test2', obj2.get_clean_steps(
|
|
task_mock)[1]['interface'])
|
|
self.assertEqual('manual_method2', obj2.get_clean_steps(
|
|
task_mock)[1]['step'])
|
|
self.assertIsNone(obj2.get_clean_steps(task_mock)[0]['argsinfo'])
|
|
|
|
# Ensure the third obj has different clean steps
|
|
self.assertEqual(2, len(obj3.get_clean_steps(task_mock)))
|
|
self.assertEqual(15, obj3.get_clean_steps(task_mock)[0]['priority'])
|
|
self.assertFalse(obj3.get_clean_steps(task_mock)[0]['abortable'])
|
|
self.assertEqual('test3', obj3.get_clean_steps(
|
|
task_mock)[0]['interface'])
|
|
self.assertEqual('automated_method3', obj3.get_clean_steps(
|
|
task_mock)[0]['step'])
|
|
self.assertEqual({'arg10': {'description': 'desc10'}},
|
|
obj3.get_clean_steps(task_mock)[0]['argsinfo'])
|
|
self.assertEqual(0, obj3.get_clean_steps(task_mock)[1]['priority'])
|
|
self.assertTrue(obj3.get_clean_steps(task_mock)[1]['abortable'])
|
|
self.assertEqual(obj3.interface_type, obj3.get_clean_steps(
|
|
task_mock)[1]['interface'])
|
|
self.assertEqual('manual_method3', obj3.get_clean_steps(
|
|
task_mock)[1]['step'])
|
|
self.assertEqual({'arg1': {'description': 'desc1', 'required': True}},
|
|
obj3.get_clean_steps(task_mock)[1]['argsinfo'])
|
|
|
|
# Ensure we can execute the function.
|
|
obj.execute_clean_step(task_mock, obj.get_clean_steps(task_mock)[0])
|
|
method_mock.assert_called_once_with(task_mock)
|
|
|
|
args = {'arg1': 'val1'}
|
|
clean_step = {'interface': 'test3', 'step': 'manual_method3',
|
|
'args': args}
|
|
obj3.execute_clean_step(task_mock, clean_step)
|
|
method_args_mock.assert_called_once_with(task_mock, **args)
|
|
|
|
|
|
class MyRAIDInterface(driver_base.RAIDInterface):
|
|
|
|
def create_configuration(self, task):
|
|
pass
|
|
|
|
def delete_configuration(self, task):
|
|
pass
|
|
|
|
|
|
class RAIDInterfaceTestCase(base.TestCase):
|
|
|
|
@mock.patch.object(driver_base.RAIDInterface, 'validate_raid_config',
|
|
autospec=True)
|
|
def test_validate(self, validate_raid_config_mock):
|
|
raid_interface = MyRAIDInterface()
|
|
node_mock = mock.MagicMock(target_raid_config='some_raid_config')
|
|
task_mock = mock.MagicMock(node=node_mock)
|
|
|
|
raid_interface.validate(task_mock)
|
|
|
|
validate_raid_config_mock.assert_called_once_with(
|
|
raid_interface, task_mock, 'some_raid_config')
|
|
|
|
@mock.patch.object(driver_base.RAIDInterface, 'validate_raid_config',
|
|
autospec=True)
|
|
def test_validate_no_target_raid_config(self, validate_raid_config_mock):
|
|
raid_interface = MyRAIDInterface()
|
|
node_mock = mock.MagicMock(target_raid_config={})
|
|
task_mock = mock.MagicMock(node=node_mock)
|
|
|
|
raid_interface.validate(task_mock)
|
|
|
|
self.assertFalse(validate_raid_config_mock.called)
|
|
|
|
@mock.patch.object(raid, 'validate_configuration', autospec=True)
|
|
def test_validate_raid_config(self, common_validate_mock):
|
|
with open(driver_base.RAID_CONFIG_SCHEMA, 'r') as raid_schema_fobj:
|
|
raid_schema = json.load(raid_schema_fobj)
|
|
raid_interface = MyRAIDInterface()
|
|
|
|
raid_interface.validate_raid_config('task', 'some_raid_config')
|
|
|
|
common_validate_mock.assert_called_once_with(
|
|
'some_raid_config', raid_schema)
|
|
|
|
@mock.patch.object(raid, 'get_logical_disk_properties',
|
|
autospec=True)
|
|
def test_get_logical_disk_properties(self, get_properties_mock):
|
|
with open(driver_base.RAID_CONFIG_SCHEMA, 'r') as raid_schema_fobj:
|
|
raid_schema = json.load(raid_schema_fobj)
|
|
raid_interface = MyRAIDInterface()
|
|
raid_interface.get_logical_disk_properties()
|
|
get_properties_mock.assert_called_once_with(raid_schema)
|
|
|
|
|
|
class TestDeployInterface(base.TestCase):
|
|
@mock.patch.object(driver_base.LOG, 'warning', autospec=True)
|
|
def test_warning_on_heartbeat(self, mock_log):
|
|
# NOTE(dtantsur): FakeDeploy does not override heartbeat
|
|
deploy = fake.FakeDeploy()
|
|
deploy.heartbeat(mock.Mock(node=mock.Mock(uuid='uuid',
|
|
driver='driver')),
|
|
'url')
|
|
self.assertTrue(mock_log.called)
|
|
|
|
|
|
class TestNetwork(driver_base.NetworkInterface):
|
|
|
|
def add_provisioning_network(self, task):
|
|
pass
|
|
|
|
def remove_provisioning_network(self, task):
|
|
pass
|
|
|
|
def add_cleaning_network(self, task):
|
|
pass
|
|
|
|
def remove_cleaning_network(self, task):
|
|
pass
|
|
|
|
def configure_tenant_networks(self, task):
|
|
pass
|
|
|
|
def unconfigure_tenant_networks(self, task):
|
|
pass
|
|
|
|
|
|
class NetworkInterfaceTestCase(base.TestCase):
|
|
|
|
@mock.patch.object(driver_base.LOG, 'warning', autospec=True)
|
|
@mock.patch.object(net_common.VIFPortIDMixin, 'vif_list')
|
|
def test_vif_list(self, mock_vif, mock_warn):
|
|
mock_task = mock.MagicMock()
|
|
network = TestNetwork()
|
|
network.vif_list(mock_task)
|
|
mock_vif.assert_called_once_with(mock_task)
|
|
mock_warn.assert_called_once_with(mock.ANY, 'TestNetwork')
|
|
# Test if the log is only called once even if we recreate a new
|
|
# NetworkInterface and call it again.
|
|
# NOTE(sambetts): This must be done inside this test instead of a
|
|
# separate test because otherwise we end up race conditions between the
|
|
# test cases regarding the class variables that are set.
|
|
network = TestNetwork()
|
|
network.vif_list(mock_task)
|
|
mock_warn.assert_called_once_with(mock.ANY, 'TestNetwork')
|
|
|
|
@mock.patch.object(driver_base.LOG, 'warning', autospec=True)
|
|
@mock.patch.object(net_common.VIFPortIDMixin, 'vif_attach')
|
|
def test_vif_attach(self, mock_attach, mock_warn):
|
|
mock_task = mock.MagicMock()
|
|
network = TestNetwork()
|
|
network.vif_attach(mock_task, {'id': 'fake'})
|
|
mock_attach.assert_called_once_with(mock_task, {'id': 'fake'})
|
|
self.assertTrue(mock_warn.called)
|
|
|
|
@mock.patch.object(driver_base.LOG, 'warning', autospec=True)
|
|
@mock.patch.object(net_common.VIFPortIDMixin, 'vif_detach')
|
|
def test_vif_detach(self, mock_detach, mock_warn):
|
|
mock_task = mock.MagicMock()
|
|
network = TestNetwork()
|
|
network.vif_detach(mock_task, 'fake-vif-id')
|
|
mock_detach.assert_called_once_with(mock_task, 'fake-vif-id')
|
|
self.assertTrue(mock_warn.called)
|
|
|
|
@mock.patch.object(driver_base.LOG, 'warning', autospec=True)
|
|
@mock.patch.object(net_common.VIFPortIDMixin, 'port_changed')
|
|
def test_port_changed(self, mock_pc, mock_warn):
|
|
port = mock.MagicMock()
|
|
mock_task = mock.MagicMock()
|
|
network = TestNetwork()
|
|
network.port_changed(mock_task, port)
|
|
mock_pc.assert_called_once_with(mock_task, port)
|
|
self.assertTrue(mock_warn.called)
|
|
|
|
@mock.patch.object(driver_base.LOG, 'warning', autospec=True)
|
|
@mock.patch.object(net_common.VIFPortIDMixin, 'portgroup_changed')
|
|
def test_portgroup_changed(self, mock_pgc, mock_warn):
|
|
port = mock.MagicMock()
|
|
mock_task = mock.MagicMock()
|
|
network = TestNetwork()
|
|
network.portgroup_changed(mock_task, port)
|
|
mock_pgc.assert_called_once_with(mock_task, port)
|
|
self.assertTrue(mock_warn.called)
|
|
|
|
@mock.patch.object(driver_base.LOG, 'warning', autospec=True)
|
|
@mock.patch.object(net_common.VIFPortIDMixin, 'get_current_vif')
|
|
def test_get_current_vif(self, mock_gcv, mock_warn):
|
|
port = mock.MagicMock()
|
|
mock_task = mock.MagicMock()
|
|
network = TestNetwork()
|
|
network.get_current_vif(mock_task, port)
|
|
mock_gcv.assert_called_once_with(mock_task, port)
|
|
self.assertTrue(mock_warn.called)
|
|
|
|
|
|
class TestManagementInterface(base.TestCase):
|
|
|
|
def test_inject_nmi_default_impl(self):
|
|
management = fake.FakeManagement()
|
|
task_mock = mock.MagicMock(spec_set=['node'])
|
|
|
|
self.assertRaises(exception.UnsupportedDriverExtension,
|
|
management.inject_nmi, task_mock)
|