Source code for ironic.tests.drivers.drac.test_client

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

"""
Test class for DRAC client wrapper.
"""

import time
from xml.etree import ElementTree

import mock

from ironic.common import exception
from ironic.drivers.modules.drac import client as drac_client
from ironic.tests import base
from ironic.tests.db import utils as db_utils
from ironic.tests.drivers.drac import utils as test_utils
from ironic.tests.drivers import third_party_driver_mock_specs as mock_specs

INFO_DICT = db_utils.get_test_drac_info()


@mock.patch.object(drac_client, 'pywsman', spec_set=mock_specs.PYWSMAN_SPEC)
[docs]class DracClientTestCase(base.TestCase):
[docs] def setUp(self): super(DracClientTestCase, self).setUp() self.resource_uri = 'http://foo/wsman'
[docs] def test_wsman_enumerate(self, mock_client_pywsman): mock_xml = test_utils.mock_wsman_root('<test></test>') mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.enumerate.return_value = mock_xml client = drac_client.Client(**INFO_DICT) client.wsman_enumerate(self.resource_uri) mock_options = mock_client_pywsman.ClientOptions.return_value mock_options.set_flags.assert_called_once_with( mock_client_pywsman.FLAG_ENUMERATION_OPTIMIZATION) mock_options.set_max_elements.assert_called_once_with(100) mock_pywsman_client.enumerate.assert_called_once_with( mock_options, None, self.resource_uri) mock_xml.context.assert_called_once_with()
@mock.patch.object(time, 'sleep', lambda seconds: None)
[docs] def test_wsman_enumerate_retry(self, mock_client_pywsman): mock_xml = test_utils.mock_wsman_root('<test></test>') mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.enumerate.side_effect = [None, mock_xml] client = drac_client.Client(**INFO_DICT) client.wsman_enumerate(self.resource_uri) mock_options = mock_client_pywsman.ClientOptions.return_value mock_options.set_flags.assert_called_once_with( mock_client_pywsman.FLAG_ENUMERATION_OPTIMIZATION) mock_options.set_max_elements.assert_called_once_with(100) mock_pywsman_client.enumerate.assert_has_calls([ mock.call(mock_options, None, self.resource_uri), mock.call(mock_options, None, self.resource_uri) ]) mock_xml.context.assert_called_once_with()
[docs] def test_wsman_enumerate_with_additional_pull(self, mock_client_pywsman): mock_root = mock.Mock(spec=['string']) mock_root.string.side_effect = [ test_utils.build_soap_xml([{'item1': 'test1'}]), test_utils.build_soap_xml([{'item2': 'test2'}]) ] mock_xml = mock.Mock(spec=['context', 'root']) mock_xml.root.return_value = mock_root mock_xml.context.side_effect = [42, 42, None] mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.enumerate.return_value = mock_xml mock_pywsman_client.pull.return_value = mock_xml client = drac_client.Client(**INFO_DICT) result = client.wsman_enumerate(self.resource_uri) # assert the XML was merged result_string = ElementTree.tostring(result) self.assertIn(b'<item1>test1</item1>', result_string) self.assertIn(b'<item2>test2</item2>', result_string) mock_options = mock_client_pywsman.ClientOptions.return_value mock_options.set_flags.assert_called_once_with( mock_client_pywsman.FLAG_ENUMERATION_OPTIMIZATION) mock_options.set_max_elements.assert_called_once_with(100) mock_pywsman_client.enumerate.assert_called_once_with( mock_options, None, self.resource_uri)
[docs] def test_wsman_enumerate_filter_query(self, mock_client_pywsman): mock_xml = test_utils.mock_wsman_root('<test></test>') mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.enumerate.return_value = mock_xml client = drac_client.Client(**INFO_DICT) filter_query = 'SELECT * FROM foo' client.wsman_enumerate(self.resource_uri, filter_query=filter_query) mock_options = mock_client_pywsman.ClientOptions.return_value mock_filter = mock_client_pywsman.Filter.return_value mock_filter.simple.assert_called_once_with(mock.ANY, filter_query) mock_pywsman_client.enumerate.assert_called_once_with( mock_options, mock_filter, self.resource_uri) mock_xml.context.assert_called_once_with()
[docs] def test_wsman_enumerate_invalid_filter_dialect(self, mock_client_pywsman): client = drac_client.Client(**INFO_DICT) self.assertRaises(exception.DracInvalidFilterDialect, client.wsman_enumerate, self.resource_uri, filter_query='foo', filter_dialect='invalid')
[docs] def test_wsman_invoke(self, mock_client_pywsman): result_xml = test_utils.build_soap_xml( [{'ReturnValue': drac_client.RET_SUCCESS}], self.resource_uri) mock_xml = test_utils.mock_wsman_root(result_xml) mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.invoke.return_value = mock_xml method_name = 'method' client = drac_client.Client(**INFO_DICT) client.wsman_invoke(self.resource_uri, method_name) mock_options = mock_client_pywsman.ClientOptions.return_value mock_pywsman_client.invoke.assert_called_once_with( mock_options, self.resource_uri, method_name, None)
@mock.patch.object(time, 'sleep', lambda seconds: None)
[docs] def test_wsman_invoke_retry(self, mock_client_pywsman): result_xml = test_utils.build_soap_xml( [{'ReturnValue': drac_client.RET_SUCCESS}], self.resource_uri) mock_xml = test_utils.mock_wsman_root(result_xml) mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.invoke.side_effect = [None, mock_xml] method_name = 'method' client = drac_client.Client(**INFO_DICT) client.wsman_invoke(self.resource_uri, method_name) mock_options = mock_client_pywsman.ClientOptions.return_value mock_pywsman_client.invoke.assert_has_calls([ mock.call(mock_options, self.resource_uri, method_name, None), mock.call(mock_options, self.resource_uri, method_name, None) ])
[docs] def test_wsman_invoke_with_selectors(self, mock_client_pywsman): result_xml = test_utils.build_soap_xml( [{'ReturnValue': drac_client.RET_SUCCESS}], self.resource_uri) mock_xml = test_utils.mock_wsman_root(result_xml) mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.invoke.return_value = mock_xml method_name = 'method' selectors = {'foo': 'bar'} client = drac_client.Client(**INFO_DICT) client.wsman_invoke(self.resource_uri, method_name, selectors=selectors) mock_options = mock_client_pywsman.ClientOptions.return_value mock_pywsman_client.invoke.assert_called_once_with( mock_options, self.resource_uri, method_name, None) mock_options.add_selector.assert_called_once_with('foo', 'bar')
[docs] def test_wsman_invoke_with_properties(self, mock_client_pywsman): result_xml = test_utils.build_soap_xml( [{'ReturnValue': drac_client.RET_SUCCESS}], self.resource_uri) mock_xml = test_utils.mock_wsman_root(result_xml) mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.invoke.return_value = mock_xml method_name = 'method' properties = {'foo': 'bar'} client = drac_client.Client(**INFO_DICT) client.wsman_invoke(self.resource_uri, method_name, properties=properties) mock_options = mock_client_pywsman.ClientOptions.return_value mock_pywsman_client.invoke.assert_called_once_with( mock_options, self.resource_uri, method_name, None) mock_options.add_property.assert_called_once_with('foo', 'bar')
[docs] def test_wsman_invoke_with_properties_including_a_list( self, mock_client_pywsman): result_xml = test_utils.build_soap_xml( [{'ReturnValue': drac_client.RET_SUCCESS}], self.resource_uri) mock_xml = test_utils.mock_wsman_root(result_xml) mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.invoke.return_value = mock_xml mock_request_xml = mock_client_pywsman.XmlDoc.return_value method_name = 'method' properties = {'foo': ['bar', 'baz']} client = drac_client.Client(**INFO_DICT) client.wsman_invoke(self.resource_uri, method_name, properties=properties) mock_options = mock_client_pywsman.ClientOptions.return_value mock_pywsman_client.invoke.assert_called_once_with( mock_options, self.resource_uri, method_name, mock_request_xml) mock_request_xml.root().add.assert_has_calls([ mock.call(self.resource_uri, 'foo', 'bar'), mock.call(self.resource_uri, 'foo', 'baz') ]) self.assertEqual(2, mock_request_xml.root().add.call_count)
[docs] def test_wsman_invoke_receives_error_return_value( self, mock_client_pywsman): result_xml = test_utils.build_soap_xml( [{'ReturnValue': drac_client.RET_ERROR, 'Message': 'error message'}], self.resource_uri) mock_xml = test_utils.mock_wsman_root(result_xml) mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.invoke.return_value = mock_xml method_name = 'method' client = drac_client.Client(**INFO_DICT) self.assertRaises(exception.DracOperationFailed, client.wsman_invoke, self.resource_uri, method_name) mock_options = mock_client_pywsman.ClientOptions.return_value mock_pywsman_client.invoke.assert_called_once_with( mock_options, self.resource_uri, method_name, None)
[docs] def test_wsman_invoke_receives_unexpected_return_value( self, mock_client_pywsman): result_xml = test_utils.build_soap_xml( [{'ReturnValue': '42'}], self.resource_uri) mock_xml = test_utils.mock_wsman_root(result_xml) mock_pywsman_client = mock_client_pywsman.Client.return_value mock_pywsman_client.invoke.return_value = mock_xml method_name = 'method' client = drac_client.Client(**INFO_DICT) self.assertRaises(exception.DracUnexpectedReturnValue, client.wsman_invoke, self.resource_uri, method_name, {}, {}, drac_client.RET_SUCCESS) mock_options = mock_client_pywsman.ClientOptions.return_value mock_pywsman_client.invoke.assert_called_once_with( mock_options, self.resource_uri, method_name, None)