ironic.tests.unit.drivers.modules.redfish.test_utils

Source code for ironic.tests.unit.drivers.modules.redfish.test_utils

# Copyright 2017 Red Hat, 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 collections
import copy
import os

import mock
from oslo_utils import importutils

from ironic.common import exception
from ironic.drivers.modules.redfish import utils as redfish_utils
from ironic.tests.unit.db import base as db_base
from ironic.tests.unit.db import utils as db_utils
from ironic.tests.unit.objects import utils as obj_utils

sushy = importutils.try_import('sushy')

INFO_DICT = db_utils.get_test_redfish_info()


[docs]class MockedConnectionError(Exception): pass
[docs]class MockedResourceNotFoundError(Exception): pass
[docs]class RedfishUtilsTestCase(db_base.DbTestCase):
[docs] def setUp(self): super(RedfishUtilsTestCase, self).setUp() # Default configurations self.config(enabled_hardware_types=['redfish'], enabled_power_interfaces=['redfish'], enabled_management_interfaces=['redfish']) # Redfish specific configurations self.config(connection_attempts=1, group='redfish') self.node = obj_utils.create_test_node( self.context, driver='redfish', driver_info=INFO_DICT) self.parsed_driver_info = { 'address': 'https://example.com', 'system_id': '/redfish/v1/Systems/FAKESYSTEM', 'username': 'username', 'password': 'password', 'verify_ca': True, 'node_uuid': self.node.uuid }
[docs] def test_parse_driver_info(self): response = redfish_utils.parse_driver_info(self.node) self.assertEqual(self.parsed_driver_info, response)
[docs] def test_parse_driver_info_default_scheme(self): self.node.driver_info['redfish_address'] = 'example.com' response = redfish_utils.parse_driver_info(self.node) self.assertEqual(self.parsed_driver_info, response)
[docs] def test_parse_driver_info_default_scheme_with_port(self): self.node.driver_info['redfish_address'] = 'example.com:42' self.parsed_driver_info['address'] = 'https://example.com:42' response = redfish_utils.parse_driver_info(self.node) self.assertEqual(self.parsed_driver_info, response)
[docs] def test_parse_driver_info_missing_info(self): for prop in redfish_utils.REQUIRED_PROPERTIES: self.node.driver_info = INFO_DICT.copy() self.node.driver_info.pop(prop) self.assertRaises(exception.MissingParameterValue, redfish_utils.parse_driver_info, self.node)
[docs] def test_parse_driver_info_invalid_address(self): for value in ['/banana!', 42]: self.node.driver_info['redfish_address'] = value self.assertRaisesRegex(exception.InvalidParameterValue, 'Invalid Redfish address', redfish_utils.parse_driver_info, self.node)
[docs] @mock.patch.object(os.path, 'isdir', autospec=True) def test_parse_driver_info_path_verify_ca(self, mock_isdir): mock_isdir.return_value = True fake_path = '/path/to/a/valid/CA' self.node.driver_info['redfish_verify_ca'] = fake_path self.parsed_driver_info['verify_ca'] = fake_path response = redfish_utils.parse_driver_info(self.node) self.assertEqual(self.parsed_driver_info, response) mock_isdir.assert_called_once_with(fake_path)
[docs] @mock.patch.object(os.path, 'isfile', autospec=True) def test_parse_driver_info_valid_capath(self, mock_isfile): mock_isfile.return_value = True fake_path = '/path/to/a/valid/CA.pem' self.node.driver_info['redfish_verify_ca'] = fake_path self.parsed_driver_info['verify_ca'] = fake_path response = redfish_utils.parse_driver_info(self.node) self.assertEqual(self.parsed_driver_info, response) mock_isfile.assert_called_once_with(fake_path)
[docs] def test_parse_driver_info_invalid_value_verify_ca(self): # Integers are not supported self.node.driver_info['redfish_verify_ca'] = 123456 self.assertRaisesRegex(exception.InvalidParameterValue, 'Invalid value type', redfish_utils.parse_driver_info, self.node)
[docs] def test_parse_driver_info_invalid_system_id(self): # Integers are not supported self.node.driver_info['redfish_system_id'] = 123 self.assertRaisesRegex(exception.InvalidParameterValue, 'The value should be a path', redfish_utils.parse_driver_info, self.node)
[docs] def test_parse_driver_info_valid_string_value_verify_ca(self): for value in ('0', 'f', 'false', 'off', 'n', 'no'): self.node.driver_info['redfish_verify_ca'] = value response = redfish_utils.parse_driver_info(self.node) parsed_driver_info = copy.deepcopy(self.parsed_driver_info) parsed_driver_info['verify_ca'] = False self.assertEqual(parsed_driver_info, response) for value in ('1', 't', 'true', 'on', 'y', 'yes'): self.node.driver_info['redfish_verify_ca'] = value response = redfish_utils.parse_driver_info(self.node) self.assertEqual(self.parsed_driver_info, response)
[docs] def test_parse_driver_info_invalid_string_value_verify_ca(self): for value in ('xyz', '*', '!123', '123'): self.node.driver_info['redfish_verify_ca'] = value self.assertRaisesRegex(exception.InvalidParameterValue, 'The value should be a Boolean', redfish_utils.parse_driver_info, self.node)
[docs] @mock.patch('ironic.drivers.modules.redfish.utils.sushy') @mock.patch('ironic.drivers.modules.redfish.utils.' 'SessionCache.sessions', {}) def test_get_system(self, mock_sushy): mock_sushy.exceptions.ConnectionError = MockedConnectionError fake_conn = mock_sushy.Sushy.return_value fake_system = fake_conn.get_system.return_value response = redfish_utils.get_system(self.node) self.assertEqual(fake_system, response) fake_conn.get_system.assert_called_once_with( '/redfish/v1/Systems/FAKESYSTEM')
[docs] @mock.patch('ironic.drivers.modules.redfish.utils.sushy') @mock.patch('ironic.drivers.modules.redfish.utils.' 'SessionCache.sessions', {}) def test_get_system_resource_not_found(self, mock_sushy): mock_sushy.exceptions.ConnectionError = MockedConnectionError fake_conn = mock_sushy.Sushy.return_value mock_sushy.exceptions.ResourceNotFoundError = ( MockedResourceNotFoundError) fake_conn.get_system.side_effect = MockedResourceNotFoundError() self.assertRaises(exception.RedfishError, redfish_utils.get_system, self.node) fake_conn.get_system.assert_called_once_with( '/redfish/v1/Systems/FAKESYSTEM')
[docs] @mock.patch('time.sleep', autospec=True) @mock.patch('ironic.drivers.modules.redfish.utils.sushy') @mock.patch('ironic.drivers.modules.redfish.utils.' 'SessionCache.sessions', {}) def test_get_system_resource_connection_error_retry(self, mock_sushy, mock_sleep): # Redfish specific configurations self.config(connection_attempts=3, group='redfish') fake_conn = mock_sushy.Sushy.return_value mock_sushy.exceptions.ResourceNotFoundError = ( MockedResourceNotFoundError) mock_sushy.exceptions.ConnectionError = MockedConnectionError fake_conn.get_system.side_effect = MockedConnectionError() self.assertRaises(exception.RedfishConnectionError, redfish_utils.get_system, self.node) expected_get_system_calls = [ mock.call(self.parsed_driver_info['system_id']), mock.call(self.parsed_driver_info['system_id']), mock.call(self.parsed_driver_info['system_id']), ] fake_conn.get_system.assert_has_calls(expected_get_system_calls) mock_sleep.assert_called_with( redfish_utils.CONF.redfish.connection_retry_interval)
[docs] @mock.patch('ironic.drivers.modules.redfish.utils.sushy') @mock.patch('ironic.drivers.modules.redfish.utils.' 'SessionCache.sessions', {}) def test_auth_auto(self, mock_sushy): mock_sushy.exceptions.ConnectionError = MockedConnectionError redfish_utils.get_system(self.node) mock_sushy.Sushy.assert_called_with( self.parsed_driver_info['address'], username=self.parsed_driver_info['username'], password=self.parsed_driver_info['password'], verify=True)
[docs] @mock.patch('ironic.drivers.modules.redfish.utils.sushy') @mock.patch('ironic.drivers.modules.redfish.utils.' 'SessionCache.sessions', {}) def test_ensure_session_reuse(self, mock_sushy): mock_sushy.exceptions.ConnectionError = MockedConnectionError redfish_utils.get_system(self.node) redfish_utils.get_system(self.node) self.assertEqual(1, mock_sushy.Sushy.call_count)
[docs] @mock.patch('ironic.drivers.modules.redfish.utils.sushy') def test_ensure_new_session_address(self, mock_sushy): mock_sushy.exceptions.ConnectionError = MockedConnectionError self.node.driver_info['redfish_address'] = 'http://bmc.foo' redfish_utils.get_system(self.node) self.node.driver_info['redfish_address'] = 'http://bmc.bar' redfish_utils.get_system(self.node) self.assertEqual(2, mock_sushy.Sushy.call_count)
[docs] @mock.patch('ironic.drivers.modules.redfish.utils.sushy') def test_ensure_new_session_username(self, mock_sushy): mock_sushy.exceptions.ConnectionError = MockedConnectionError self.node.driver_info['redfish_username'] = 'foo' redfish_utils.get_system(self.node) self.node.driver_info['redfish_username'] = 'bar' redfish_utils.get_system(self.node) self.assertEqual(2, mock_sushy.Sushy.call_count)
[docs] @mock.patch('ironic.drivers.modules.redfish.utils.sushy') @mock.patch('ironic.drivers.modules.redfish.utils.' 'SessionCache.MAX_SESSIONS', 10) @mock.patch('ironic.drivers.modules.redfish.utils.SessionCache.sessions', collections.OrderedDict()) def test_expire_old_sessions(self, mock_sushy): mock_sushy.exceptions.ConnectionError = MockedConnectionError for num in range(20): self.node.driver_info['redfish_username'] = 'foo-%d' % num redfish_utils.get_system(self.node) self.assertEqual(mock_sushy.Sushy.call_count, 20) self.assertEqual(len(redfish_utils.SessionCache.sessions), 10)
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.