# 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 eventlet
import mock
from ironic.common import exception
from ironic.drivers import base as driver_base
from ironic.tests import base
[docs]class FakeVendorInterface(driver_base.VendorInterface):
[docs] def get_properties(self):
pass
@driver_base.passthru(['POST'])
[docs] def noexception(self):
return "Fake"
@driver_base.driver_passthru(['POST'])
[docs] def driver_noexception(self):
return "Fake"
@driver_base.passthru(['POST'])
[docs] def ironicexception(self):
raise exception.IronicException("Fake!")
@driver_base.passthru(['POST'])
[docs] def normalexception(self):
raise Exception("Fake!")
[docs] def validate(self, task, **kwargs):
pass
[docs] def driver_validate(self, **kwargs):
pass
[docs]class PassthruDecoratorTestCase(base.TestCase):
[docs] def setUp(self):
super(PassthruDecoratorTestCase, self).setUp()
self.fvi = FakeVendorInterface()
driver_base.LOG = mock.Mock()
[docs] def test_passthru_noexception(self):
result = self.fvi.noexception()
self.assertEqual("Fake", result)
[docs] def test_passthru_ironicexception(self):
self.assertRaises(exception.IronicException,
self.fvi.ironicexception, mock.ANY)
driver_base.LOG.exception.assert_called_with(
mock.ANY, 'ironicexception')
[docs] def test_passthru_nonironicexception(self):
self.assertRaises(exception.VendorPassthruException,
self.fvi.normalexception, mock.ANY)
driver_base.LOG.exception.assert_called_with(
mock.ANY, 'normalexception')
[docs] 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'])
@mock.patch.object(eventlet.greenthread, 'spawn_n',
side_effect=lambda func, *args, **kw: func(*args, **kw))
[docs]class DriverPeriodicTaskTestCase(base.TestCase):
[docs] def test(self, spawn_mock):
method_mock = mock.Mock()
function_mock = mock.Mock()
class TestClass(object):
@driver_base.driver_periodic_task(spacing=42)
def method(self, foo, bar=None):
method_mock(foo, bar=bar)
@driver_base.driver_periodic_task(spacing=100, parallel=False)
def function():
function_mock()
obj = TestClass()
self.assertEqual(42, obj.method._periodic_spacing)
self.assertTrue(obj.method._periodic_task)
self.assertEqual('ironic.tests.drivers.test_base.method',
obj.method._periodic_name)
self.assertEqual('ironic.tests.drivers.test_base.function',
function._periodic_name)
obj.method(1, bar=2)
method_mock.assert_called_once_with(1, bar=2)
self.assertEqual(1, spawn_mock.call_count)
function()
function_mock.assert_called_once_with()
self.assertEqual(1, spawn_mock.call_count)
[docs]class CleanStepTestCase(base.TestCase):
[docs] 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.Mock()
task_mock = mock.Mock()
class TestClass(driver_base.BaseInterface):
interface_type = 'test'
@driver_base.clean_step(priority=0)
def zap_method(self, task):
pass
@driver_base.clean_step(priority=10)
def clean_method(self, task):
method_mock(task)
def not_clean_method(self, task):
pass
class TestClass2(driver_base.BaseInterface):
interface_type = 'test2'
@driver_base.clean_step(priority=0)
def zap_method2(self, task):
pass
@driver_base.clean_step(priority=20)
def clean_method2(self, task):
method_mock(task)
def not_clean_method2(self, task):
pass
obj = TestClass()
obj2 = TestClass2()
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.assertEqual('test', obj.get_clean_steps(
task_mock)[0]['interface'])
self.assertEqual('clean_method', obj.get_clean_steps(
task_mock)[0]['step'])
self.assertEqual(0, obj.get_clean_steps(task_mock)[1]['priority'])
self.assertEqual('test', obj.get_clean_steps(
task_mock)[1]['interface'])
self.assertEqual('zap_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.assertEqual('test2', obj2.get_clean_steps(
task_mock)[0]['interface'])
self.assertEqual('clean_method2', obj2.get_clean_steps(
task_mock)[0]['step'])
self.assertEqual(0, obj2.get_clean_steps(task_mock)[1]['priority'])
self.assertEqual('test2', obj2.get_clean_steps(
task_mock)[1]['interface'])
self.assertEqual('zap_method2', obj2.get_clean_steps(
task_mock)[1]['step'])
# 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)