1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/tests/unit/plugins/modules/test_oneview_san_manager.py
Felix Fontein b531ecdc9b
Unflatmap community.general (#5461)
* Move files.

* Update imports and references.

* Move wrongly placed files.

* Reverse redirects, deprecate long → short name redirects.

* Simplify contribution guidelines for new modules.

* Rewrite BOTMETA.

* Add changelog fragment.

* Fix ignore.txt files.
2022-11-02 20:42:29 +00:00

244 lines
9.2 KiB
Python

# Copyright (c) 2016-2017 Hewlett Packard Enterprise Development LP
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
from ansible_collections.community.general.tests.unit.compat import unittest, mock
from .oneview_module_loader import SanManagerModule
from .oneview_conftest import mock_ov_client, mock_ansible_module
from .hpe_test_utils import OneViewBaseTestCase
from copy import deepcopy
FAKE_MSG_ERROR = 'Fake message error'
DEFAULT_SAN_MANAGER_TEMPLATE = dict(
name='172.18.15.1',
providerDisplayName='Brocade Network Advisor',
uri='/rest/fc-sans/device-managers/UUU-AAA-BBB',
refreshState='OK',
connectionInfo=[
{
'valueFormat': 'IPAddressOrHostname',
'displayName': 'Host',
'name': 'Host',
'valueType': 'String',
'required': False,
'value': '172.18.15.1'
}]
)
class SanManagerModuleSpec(unittest.TestCase,
OneViewBaseTestCase):
PARAMS_FOR_PRESENT = dict(
config='config.json',
state='present',
data=DEFAULT_SAN_MANAGER_TEMPLATE
)
PARAMS_FOR_CONNECTION_INFORMATION_SET = dict(
config='config.json',
state='connection_information_set',
data=DEFAULT_SAN_MANAGER_TEMPLATE.copy()
)
PARAMS_WITH_CHANGES = dict(
config='config.json',
state='present',
data=dict(name=DEFAULT_SAN_MANAGER_TEMPLATE['name'],
refreshState='RefreshPending')
)
PARAMS_FOR_ABSENT = dict(
config='config.json',
state='absent',
data=dict(name=DEFAULT_SAN_MANAGER_TEMPLATE['name'])
)
def setUp(self):
self.configure_mocks(self, SanManagerModule)
self.resource = self.mock_ov_client.san_managers
def test_should_add_new_san_manager(self):
self.resource.get_by_name.return_value = []
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.resource.add.return_value = DEFAULT_SAN_MANAGER_TEMPLATE
self.mock_ansible_module.params = self.PARAMS_FOR_PRESENT
SanManagerModule().run()
self.mock_ansible_module.exit_json.assert_called_once_with(
changed=True,
msg=SanManagerModule.MSG_CREATED,
ansible_facts=dict(san_manager=DEFAULT_SAN_MANAGER_TEMPLATE)
)
def test_should_find_provider_uri_to_add(self):
self.resource.get_by_name.return_value = []
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.resource.add.return_value = DEFAULT_SAN_MANAGER_TEMPLATE
self.mock_ansible_module.params = self.PARAMS_FOR_PRESENT
SanManagerModule().run()
provider_display_name = DEFAULT_SAN_MANAGER_TEMPLATE['providerDisplayName']
self.resource.get_provider_uri.assert_called_once_with(provider_display_name)
def test_should_not_update_when_data_is_equals(self):
output_data = deepcopy(DEFAULT_SAN_MANAGER_TEMPLATE)
output_data.pop('connectionInfo')
self.resource.get_by_name.return_value = deepcopy(DEFAULT_SAN_MANAGER_TEMPLATE)
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.mock_ansible_module.params = self.PARAMS_FOR_PRESENT
SanManagerModule().run()
self.mock_ansible_module.exit_json.assert_called_once_with(
changed=False,
msg=SanManagerModule.MSG_ALREADY_PRESENT,
ansible_facts=dict(san_manager=output_data)
)
def test_update_when_data_has_modified_attributes(self):
data_merged = deepcopy(DEFAULT_SAN_MANAGER_TEMPLATE)
data_merged['fabricType'] = 'DirectAttach'
self.resource.get_by_name.return_value = DEFAULT_SAN_MANAGER_TEMPLATE
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.resource.update.return_value = data_merged
self.mock_ansible_module.params = self.PARAMS_WITH_CHANGES
SanManagerModule().run()
self.mock_ansible_module.exit_json.assert_called_once_with(
changed=True,
msg=SanManagerModule.MSG_UPDATED,
ansible_facts=dict(san_manager=data_merged)
)
def test_update_should_not_send_connection_info_when_not_informed_on_data(self):
merged_data = deepcopy(DEFAULT_SAN_MANAGER_TEMPLATE)
merged_data['refreshState'] = 'RefreshPending'
output_data = deepcopy(merged_data)
output_data.pop('connectionInfo')
self.resource.get_by_name.return_value = DEFAULT_SAN_MANAGER_TEMPLATE
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.resource.update.return_value = merged_data
self.mock_ansible_module.params = self.PARAMS_WITH_CHANGES
SanManagerModule().run()
self.resource.update.assert_called_once_with(resource=output_data, id_or_uri=output_data['uri'])
def test_should_remove_san_manager(self):
self.resource.get_by_name.return_value = deepcopy(DEFAULT_SAN_MANAGER_TEMPLATE)
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.mock_ansible_module.params = self.PARAMS_FOR_ABSENT.copy()
SanManagerModule().run()
self.mock_ansible_module.exit_json.assert_called_once_with(
changed=True,
msg=SanManagerModule.MSG_DELETED
)
def test_should_do_nothing_when_san_manager_not_exist(self):
self.resource.get_by_name.return_value = []
self.mock_ansible_module.params = self.PARAMS_FOR_ABSENT.copy()
SanManagerModule().run()
self.mock_ansible_module.exit_json.assert_called_once_with(
changed=False,
msg=SanManagerModule.MSG_ALREADY_ABSENT
)
def test_should_fail_when_name_not_found(self):
self.resource.get_by_name.return_value = []
self.resource.get_provider_uri.return_value = None
self.mock_ansible_module.params = self.PARAMS_FOR_PRESENT
SanManagerModule().run()
self.mock_ansible_module.fail_json.assert_called_once_with(
exception=mock.ANY,
msg="The provider 'Brocade Network Advisor' was not found."
)
def test_should_fail_when_name_and_hosts_in_connectionInfo_missing(self):
bad_params = deepcopy(self.PARAMS_FOR_PRESENT)
bad_params['data'].pop('name')
bad_params['data'].pop('connectionInfo')
self.mock_ansible_module.params = bad_params
SanManagerModule().run()
msg = 'A "name" or "connectionInfo" must be provided inside the "data" field for this operation. '
msg += 'If a "connectionInfo" is provided, the "Host" name is considered as the "name" for the resource.'
self.mock_ansible_module.fail_json.assert_called_once_with(exception=mock.ANY, msg=msg)
def test_connection_information_set_should_set_the_connection_information(self):
data_merged = deepcopy(DEFAULT_SAN_MANAGER_TEMPLATE)
data_merged['fabricType'] = 'DirectAttach'
self.resource.get_by_name.return_value = DEFAULT_SAN_MANAGER_TEMPLATE
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.resource.update.return_value = data_merged
self.mock_ansible_module.params = self.PARAMS_FOR_CONNECTION_INFORMATION_SET
SanManagerModule().run()
self.mock_ansible_module.exit_json.assert_called_once_with(
changed=True,
msg=SanManagerModule.MSG_UPDATED,
ansible_facts=dict(san_manager=data_merged)
)
def test_should_add_new_san_manager_when_connection_information_set_called_without_resource(self):
self.resource.get_by_name.return_value = []
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.resource.add.return_value = DEFAULT_SAN_MANAGER_TEMPLATE
self.mock_ansible_module.params = self.PARAMS_FOR_CONNECTION_INFORMATION_SET
SanManagerModule().run()
self.mock_ansible_module.exit_json.assert_called_once_with(
changed=True,
msg=SanManagerModule.MSG_CREATED,
ansible_facts=dict(san_manager=DEFAULT_SAN_MANAGER_TEMPLATE)
)
def test_should_fail_when_required_attribute_missing(self):
bad_params = deepcopy(self.PARAMS_FOR_CONNECTION_INFORMATION_SET)
bad_params['data'] = self.PARAMS_FOR_CONNECTION_INFORMATION_SET['data'].copy()
bad_params['data'].pop('connectionInfo')
self.resource.get_by_name.return_value = DEFAULT_SAN_MANAGER_TEMPLATE
self.resource.get_provider_uri.return_value = '/rest/fc-sans/providers/123/device-managers'
self.mock_ansible_module.params = bad_params
SanManagerModule().run()
msg = 'A connectionInfo field is required for this operation.'
self.mock_ansible_module.fail_json.assert_called_once_with(exception=mock.ANY, msg=msg)
if __name__ == '__main__':
unittest.main()