mirror of https://github.com/ansible/ansible.git
Felipe Garcia Bulsoni
7 years ago
committed by
Dag Wieers
parent
5ccbe61258
commit
fd304d9b5b
@ -0,0 +1,219 @@
|
||||
#!/usr/bin/python
|
||||
# Copyright (c) 2016-2017 Hewlett Packard Enterprise Development LP
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneview_san_manager
|
||||
short_description: Manage OneView SAN Manager resources
|
||||
description:
|
||||
- Provides an interface to manage SAN Manager resources. Can create, update, or delete.
|
||||
version_added: "2.4"
|
||||
requirements:
|
||||
- hpOneView >= 3.1.1
|
||||
author:
|
||||
- Felipe Bulsoni (@fgbulsoni)
|
||||
- Thiago Miotto (@tmiotto)
|
||||
- Adriane Cardozo (@adriane-cardozo)
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Indicates the desired state for the Uplink Set resource.
|
||||
- C(present) ensures data properties are compliant with OneView.
|
||||
- C(absent) removes the resource from OneView, if it exists.
|
||||
- C(connection_information_set) updates the connection information for the SAN Manager. This operation is non-idempotent.
|
||||
default: present
|
||||
choices: [present, absent, connection_information_set]
|
||||
data:
|
||||
description:
|
||||
- List with SAN Manager properties.
|
||||
required: true
|
||||
|
||||
extends_documentation_fragment:
|
||||
- oneview
|
||||
- oneview.validateetag
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Creates a Device Manager for the Brocade SAN provider with the given hostname and credentials
|
||||
oneview_san_manager:
|
||||
config: /etc/oneview/oneview_config.json
|
||||
state: present
|
||||
data:
|
||||
providerDisplayName: Brocade Network Advisor
|
||||
connectionInfo:
|
||||
- name: Host
|
||||
value: 172.18.15.1
|
||||
- name: Port
|
||||
value: 5989
|
||||
- name: Username
|
||||
value: username
|
||||
- name: Password
|
||||
value: password
|
||||
- name: UseSsl
|
||||
value: true
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Ensure a Device Manager for the Cisco SAN Provider is present
|
||||
oneview_san_manager:
|
||||
config: /etc/oneview/oneview_config.json
|
||||
state: present
|
||||
data:
|
||||
name: 172.18.20.1
|
||||
providerDisplayName: Cisco
|
||||
connectionInfo:
|
||||
- name: Host
|
||||
value: 172.18.20.1
|
||||
- name: SnmpPort
|
||||
value: 161
|
||||
- name: SnmpUserName
|
||||
value: admin
|
||||
- name: SnmpAuthLevel
|
||||
value: authnopriv
|
||||
- name: SnmpAuthProtocol
|
||||
value: sha
|
||||
- name: SnmpAuthString
|
||||
value: password
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Sets the SAN Manager connection information
|
||||
oneview_san_manager:
|
||||
config: /etc/oneview/oneview_config.json
|
||||
state: connection_information_set
|
||||
data:
|
||||
connectionInfo:
|
||||
- name: Host
|
||||
value: '172.18.15.1'
|
||||
- name: Port
|
||||
value: '5989'
|
||||
- name: Username
|
||||
value: 'username'
|
||||
- name: Password
|
||||
value: 'password'
|
||||
- name: UseSsl
|
||||
value: true
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Refreshes the SAN Manager
|
||||
oneview_san_manager:
|
||||
config: /etc/oneview/oneview_config.json
|
||||
state: present
|
||||
data:
|
||||
name: 172.18.15.1
|
||||
refreshState: RefreshPending
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Delete the SAN Manager recently created
|
||||
oneview_san_manager:
|
||||
config: /etc/oneview/oneview_config.json
|
||||
state: absent
|
||||
data:
|
||||
name: '172.18.15.1'
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
san_manager:
|
||||
description: Has the OneView facts about the SAN Manager.
|
||||
returned: On state 'present'. Can be null.
|
||||
type: dict
|
||||
'''
|
||||
|
||||
from ansible.module_utils.oneview import OneViewModuleBase, OneViewModuleValueError
|
||||
|
||||
|
||||
class SanManagerModule(OneViewModuleBase):
|
||||
MSG_CREATED = 'SAN Manager created successfully.'
|
||||
MSG_UPDATED = 'SAN Manager updated successfully.'
|
||||
MSG_DELETED = 'SAN Manager deleted successfully.'
|
||||
MSG_ALREADY_PRESENT = 'SAN Manager is already present.'
|
||||
MSG_ALREADY_ABSENT = 'SAN Manager is already absent.'
|
||||
MSG_SAN_MANAGER_PROVIDER_DISPLAY_NAME_NOT_FOUND = "The provider '{0}' was not found."
|
||||
|
||||
argument_spec = dict(
|
||||
state=dict(type='str', default='present', choices=['absent', 'present', 'connection_information_set']),
|
||||
data=dict(type='dict', required=True)
|
||||
)
|
||||
|
||||
def __init__(self):
|
||||
super(SanManagerModule, self).__init__(additional_arg_spec=self.argument_spec, validate_etag_support=True)
|
||||
self.resource_client = self.oneview_client.san_managers
|
||||
|
||||
def execute_module(self):
|
||||
if self.data.get('connectionInfo'):
|
||||
for connection_hash in self.data.get('connectionInfo'):
|
||||
if connection_hash.get('name') == 'Host':
|
||||
resource_name = connection_hash.get('value')
|
||||
elif self.data.get('name'):
|
||||
resource_name = self.data.get('name')
|
||||
else:
|
||||
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.'
|
||||
raise OneViewModuleValueError(msg.format())
|
||||
|
||||
resource = self.resource_client.get_by_name(resource_name)
|
||||
|
||||
if self.state == 'present':
|
||||
changed, msg, san_manager = self._present(resource)
|
||||
return dict(changed=changed, msg=msg, ansible_facts=dict(san_manager=san_manager))
|
||||
|
||||
elif self.state == 'absent':
|
||||
return self.resource_absent(resource, method='remove')
|
||||
|
||||
elif self.state == 'connection_information_set':
|
||||
changed, msg, san_manager = self._connection_information_set(resource)
|
||||
return dict(changed=changed, msg=msg, ansible_facts=dict(san_manager=san_manager))
|
||||
|
||||
def _present(self, resource):
|
||||
if not resource:
|
||||
provider_uri = self.data.get('providerUri', self._get_provider_uri_by_display_name(self.data))
|
||||
return True, self.MSG_CREATED, self.resource_client.add(self.data, provider_uri)
|
||||
else:
|
||||
merged_data = resource.copy()
|
||||
merged_data.update(self.data)
|
||||
|
||||
# Remove 'connectionInfo' from comparison, since it is not possible to validate it.
|
||||
resource.pop('connectionInfo', None)
|
||||
merged_data.pop('connectionInfo', None)
|
||||
|
||||
if self.compare(resource, merged_data):
|
||||
return False, self.MSG_ALREADY_PRESENT, resource
|
||||
else:
|
||||
updated_san_manager = self.resource_client.update(resource=merged_data, id_or_uri=resource['uri'])
|
||||
return True, self.MSG_UPDATED, updated_san_manager
|
||||
|
||||
def _connection_information_set(self, resource):
|
||||
if not resource:
|
||||
return self._present(resource)
|
||||
else:
|
||||
merged_data = resource.copy()
|
||||
merged_data.update(self.data)
|
||||
merged_data.pop('refreshState', None)
|
||||
if not self.data.get('connectionInfo', None):
|
||||
raise OneViewModuleValueError('A connectionInfo field is required for this operation.')
|
||||
updated_san_manager = self.resource_client.update(resource=merged_data, id_or_uri=resource['uri'])
|
||||
return True, self.MSG_UPDATED, updated_san_manager
|
||||
|
||||
def _get_provider_uri_by_display_name(self, data):
|
||||
display_name = data.get('providerDisplayName')
|
||||
provider_uri = self.resource_client.get_provider_uri(display_name)
|
||||
|
||||
if not provider_uri:
|
||||
raise OneViewModuleValueError(self.MSG_SAN_MANAGER_PROVIDER_DISPLAY_NAME_NOT_FOUND.format(display_name))
|
||||
|
||||
return provider_uri
|
||||
|
||||
|
||||
def main():
|
||||
SanManagerModule().run()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -0,0 +1,239 @@
|
||||
# Copyright (c) 2016-2017 Hewlett Packard Enterprise Development LP
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from ansible.compat.tests import unittest, mock
|
||||
from oneview_module_loader import SanManagerModule
|
||||
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()
|
||||
Loading…
Reference in New Issue