wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Change na_ontap_igroup to NetAppModule module format (#52280)

Browse source 
* Revert "changes to clusteR"

This reverts commit 33ee1b71e4bc8435fb315762a871f8c4cb6c5f80.

* update to igroup

* fix author

* Revert "Revert "changes to clusteR""

This reverts commit 2c517792115179665d43d74780dc356ca41b9abe.
This commit is contained in:
Chris Archibald 2019-02-21 11:01:36 -08:00 committed by John R Barker
parent ffd8f8d844
commit 740d53011e
2 changed files with 382 additions and 136 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

253
lib/ansible/modules/storage/netapp/na_ontap_igroup.py
View file

@ -1,11 +1,12 @@
#!/usr/bin/python
''' this is igroup module
(c) 2018, NetApp, Inc
(c) 2018-2019, NetApp, Inc
# 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 = {
@ -17,14 +18,14 @@ ANSIBLE_METADATA = {
DOCUMENTATION = '''
module: na_ontap_igroup
short_description: NetApp ONTAP iSCSI igroup configuration
short_description: NetApp ONTAP iSCSI or FC igroup configuration
extends_documentation_fragment:
- netapp.na_ontap
version_added: '2.6'
author: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
description:
- create, destroy or rename Igroups and add or remove initiator in igroups.
- Create/Delete/Rename Igroups and Modify initiators belonging to an igroup
options:
state:
@ -53,9 +54,14 @@ options:
description:
- OS type of the initiators within the group.
initiator:
initiators:
description:
- List of initiators to be mapped to the igroup.
- WWPN, WWPN Alias, or iSCSI name of Initiator to add or remove.
- For a modify operation, this list replaces the exisiting initiators
- This module does not add or remove specific initiator(s) in an igroup
aliases:
- initiator
bind_portset:
description:
@ -74,13 +80,25 @@ options:
'''
EXAMPLES = '''
- name: Create Igroup
- name: Create iSCSI Igroup
na_ontap_igroup:
state: present
name: ansibleIgroup3
initiator_group_type: iscsi
ostype: linux
initiator: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com
initiators: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com,abc.com:redhat.com
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create FC Igroup
na_ontap_igroup:
state: present
name: ansibleIgroup4
initiator_group_type: fcp
ostype: linux
initiators: 20:00:00:50:56:9f:19:82
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
@ -93,15 +111,15 @@ EXAMPLES = '''
name: testexamplenewname
initiator_group_type: iscsi
ostype: linux
initiator: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com
initiators: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: remove Igroup
- name: Modify Igroup Initiators (replaces exisiting initiators)
na_ontap_igroup:
state: absent
state: present
name: ansibleIgroup3
initiator_group_type: iscsi
ostype: linux
@ -111,6 +129,14 @@ EXAMPLES = '''
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete Igroup
na_ontap_igroup:
state: absent
name: ansibleIgroup3
vserver: ansibleVServer
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
'''
RETURN = '''
@ -121,6 +147,7 @@ import traceback
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_native
import ansible.module_utils.netapp as netapp_utils
from ansible.module_utils.netapp_module import NetAppModule
HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
@ -138,7 +165,7 @@ class NetAppOntapIgroup(object):
ostype=dict(required=False, type='str'),
initiator_group_type=dict(required=False, type='str',
choices=['fcp', 'iscsi', 'mixed']),
initiator=dict(required=False, type='str'),
initiators=dict(required=False, type='list', aliases=['initiator']),
vserver=dict(required=True, type='str'),
force_remove_initiator=dict(required=False, type='bool', default=False),
bind_portset=dict(required=False, type='str')
@ -149,25 +176,14 @@ class NetAppOntapIgroup(object):
supports_check_mode=True
)
params = self.module.params
# set up state variables
self.state = params['state']
self.name = params['name']
self.ostype = params['ostype']
self.initiator_group_type = params['initiator_group_type']
self.initiator = params['initiator']
self.vserver = params['vserver']
self.from_name = params['from_name']
self.force_remove_initiator = params['force_remove_initiator']
self.bind_portset = params['bind_portset']
self.na_helper = NetAppModule()
self.parameters = self.na_helper.set_parameters(self.module.params)
if HAS_NETAPP_LIB is False:
self.module.fail_json(
msg="the python NetApp-Lib module is required")
else:
self.server = netapp_utils.setup_na_ontap_zapi(
module=self.module, vserver=self.vserver)
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.parameters['vserver'])
def get_igroup(self, name):
"""
@ -179,84 +195,75 @@ class NetAppOntapIgroup(object):
:rtype: dict
"""
igroup_info = netapp_utils.zapi.NaElement('igroup-get-iter')
igroup_attributes = netapp_utils.zapi.NaElement('initiator-group-info')
igroup_attributes.add_new_child('initiator-group-name', name)
query = netapp_utils.zapi.NaElement('query')
query.add_child_elem(igroup_attributes)
igroup_info.add_child_elem(query)
attributes = dict(query={'initiator-group-info': {'initiator-group-name': name}})
igroup_info.translate_struct(attributes)
result, current = None, None
try:
result = self.server.invoke_successfully(igroup_info, True)
return_value = None
if result.get_child_by_name('num-records') and \
int(result.get_child_content('num-records')) >= 1:
igroup_attributes = result.get_child_by_name(
'attributes-list').get_child_by_name(
'igroup-attributes')
return_value = {
'name': name,
except netapp_utils.zapi.NaApiError as error:
self.module.fail_json(msg='Error fetching igroup info %s: %s' % (self.parameters['name'], to_native(error)),
exception=traceback.format_exc())
if result.get_child_by_name('num-records') and int(result.get_child_content('num-records')) >= 1:
igroup = result.get_child_by_name('attributes-list').get_child_by_name('initiator-group-info')
initiators = []
if igroup.get_child_by_name('initiators'):
current_initiators = igroup['initiators'].get_children()
for initiator in current_initiators:
initiators.append(initiator['initiator-name'])
current = {
'initiators': initiators
}
return return_value
return current
def add_initiator(self):
def add_initiators(self):
"""
Add the initiator.
Add the list of initiators to igroup
:return: None
"""
options = {'initiator-group-name': self.name}
# don't add if initiators is empty string
if self.parameters.get('initiators') == [''] or self.parameters.get('initiators') is None:
return
for initiator in self.parameters['initiators']:
self.modify_initiator(initiator, 'igroup-add')
if self.initiator is not None:
options['initiator'] = self.initiator
def remove_initiators(self, initiators):
"""
Removes all existing initiators from igroup
:return: None
"""
for initiator in initiators:
self.modify_initiator(initiator, 'igroup-remove')
igroup_add = netapp_utils.zapi.NaElement.create_node_with_children(
'igroup-add', **options)
def modify_initiator(self, initiator, zapi):
"""
Add or remove an initiator to/from an igroup
"""
initiator.strip() # remove leading spaces if any (eg: if user types a space after comma in initiators list)
options = {'initiator-group-name': self.parameters['name'],
'initiator': initiator}
igroup_modify = netapp_utils.zapi.NaElement.create_node_with_children(zapi, **options)
try:
self.server.invoke_successfully(igroup_add,
enable_tunneling=True)
return True
self.server.invoke_successfully(igroup_modify, enable_tunneling=True)
except netapp_utils.zapi.NaApiError as error:
if to_native(error.code) == "9008":
# Error 9008 denotes Initiator group already contains initiator
return False
else:
self.module.fail_json(msg='Error adding igroup initiator %s: %s' % (self.name, to_native(error)),
exception=traceback.format_exc())
def remove_initiator(self):
"""
Remove the initiator.
"""
options = {'initiator': self.initiator}
options['initiator-group-name'] = self.name
igroup_remove = netapp_utils.zapi.NaElement.create_node_with_children(
'igroup-remove', **options)
try:
self.server.invoke_successfully(igroup_remove,
enable_tunneling=True)
return True
except netapp_utils.zapi.NaApiError as error:
if to_native(error.code) == "9007":
# Error 9007 denotes Initiator group does not contain initiator
return False
else:
self.module.fail_json(msg='Error removing igroup initiator %s: %s' % (self.name, to_native(error)),
self.module.fail_json(msg='Error modifying igroup initiator %s: %s' % (self.parameters['name'],
to_native(error)),
exception=traceback.format_exc())
def create_igroup(self):
"""
Create the igroup.
"""
options = {'initiator-group-name': self.name}
if self.ostype is not None:
options['os-type'] = self.ostype
if self.initiator_group_type is not None:
options['initiator-group-type'] = self.initiator_group_type
if self.bind_portset is not None:
options['bind-portset'] = self.bind_portset
options = {'initiator-group-name': self.parameters['name']}
if self.parameters.get('ostype') is not None:
options['os-type'] = self.parameters['ostype']
if self.parameters.get('initiator_group_type') is not None:
options['initiator-group-type'] = self.parameters['initiator_group_type']
if self.parameters.get('bind_portset') is not None:
options['bind-portset'] = self.parameters['bind_portset']
igroup_create = netapp_utils.zapi.NaElement.create_node_with_children(
'igroup-create', **options)
@ -264,23 +271,24 @@ class NetAppOntapIgroup(object):
try:
self.server.invoke_successfully(igroup_create,
enable_tunneling=True)
self.add_initiator()
except netapp_utils.zapi.NaApiError as error:
self.module.fail_json(msg='Error provisioning igroup %s: %s' % (self.name, to_native(error)),
self.module.fail_json(msg='Error provisioning igroup %s: %s' % (self.parameters['name'], to_native(error)),
exception=traceback.format_exc())
self.add_initiators()
def delete_igroup(self):
"""
Delete the igroup.
"""
igroup_delete = netapp_utils.zapi.NaElement.create_node_with_children(
'igroup-destroy', **{'initiator-group-name': self.name, 'force': 'true' if self.force_remove_initiator else 'false'})
'igroup-destroy', **{'initiator-group-name': self.parameters['name'],
'force': 'true' if self.parameters['force_remove_initiator'] else 'false'})
try:
self.server.invoke_successfully(igroup_delete,
enable_tunneling=True)
except netapp_utils.zapi.NaApiError as error:
self.module.fail_json(msg='Error deleting igroup %s: %s' % (self.name, to_native(error)),
self.module.fail_json(msg='Error deleting igroup %s: %s' % (self.parameters['name'], to_native(error)),
exception=traceback.format_exc())
def rename_igroup(self):
@ -288,65 +296,44 @@ class NetAppOntapIgroup(object):
Rename the igroup.
"""
igroup_rename = netapp_utils.zapi.NaElement.create_node_with_children(
'igroup-rename', **{'initiator-group-name': self.from_name, 'initiator-group-new-name': str(
self.name)})
'igroup-rename', **{'initiator-group-name': self.parameters['from_name'],
'initiator-group-new-name': str(self.parameters['name'])})
try:
self.server.invoke_successfully(igroup_rename,
enable_tunneling=True)
except netapp_utils.zapi.NaApiError as error:
self.module.fail_json(msg='Error renaming igroup %s: %s' % (self.name, to_native(error)),
self.module.fail_json(msg='Error renaming igroup %s: %s' % (self.parameters['name'], to_native(error)),
exception=traceback.format_exc())
def apply(self):
changed = False
igroup_exists = False
rename_igroup = False
initiator_changed = False
def autosupport_log(self):
netapp_utils.ems_log_event("na_ontap_igroup", self.server)
igroup_details = self.get_igroup(self.name)
if igroup_details is not None:
igroup_exists = True
if self.state == 'absent':
changed = True
elif self.state == 'present':
if self.initiator:
changed = True
def apply(self):
self.autosupport_log()
current = self.get_igroup(self.parameters['name'])
# rename and create are mutually exclusive
rename, cd_action, modify = None, None, None
if self.parameters.get('from_name'):
rename = self.na_helper.is_rename_action(self.get_igroup(self.parameters['from_name']), current)
else:
if self.state == 'present':
# create by default, or rename if from_name exists
changed = True
if self.from_name:
igroup_details = self.get_igroup(self.from_name)
if igroup_details is not None:
rename_igroup = True
igroup_exists = True
else:
self.module.fail_json(msg='Error renaming igroup %s does not exist' % (self.from_name))
cd_action = self.na_helper.get_cd_action(current, self.parameters)
if cd_action is None and self.parameters['state'] == 'present':
modify = self.na_helper.get_modified_attributes(current, self.parameters)
if changed:
changed = False
if self.na_helper.changed:
if self.module.check_mode:
pass
else:
if self.state == 'present':
if not igroup_exists:
self.create_igroup()
changed = True
else:
if self.initiator:
changed = self.add_initiator()
if rename_igroup:
if rename:
self.rename_igroup()
changed = True
elif self.state == 'absent':
if self.initiator:
self.remove_initiator()
elif cd_action == 'create':
self.create_igroup()
elif cd_action == 'delete':
self.delete_igroup()
changed = True
self.module.exit_json(changed=changed)
if modify:
self.remove_initiators(current['initiators'])
self.add_initiators()
self.module.exit_json(changed=self.na_helper.changed)
def main():

259
test/units/modules/storage/netapp/test_na_ontap_igroup.py Normal file
View file

@ -0,0 +1,259 @@
# (c) 2018, NetApp, Inc
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
''' unit test template for ONTAP Ansible module '''
from __future__ import print_function
import json
import pytest
from units.compat import unittest
from units.compat.mock import patch, Mock
from ansible.module_utils import basic
from ansible.module_utils._text import to_bytes
import ansible.module_utils.netapp as netapp_utils
from ansible.modules.storage.netapp.na_ontap_igroup \
import NetAppOntapIgroup as igroup # module under test
if not netapp_utils.has_netapp_lib():
pytestmark = pytest.mark.skip('skipping as missing required netapp_lib')
def set_module_args(args):
"""prepare arguments so that they will be picked up during module creation"""
args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
basic._ANSIBLE_ARGS = to_bytes(args) # pylint: disable=protected-access
class AnsibleExitJson(Exception):
"""Exception class to be raised by module.exit_json and caught by the test case"""
pass
class AnsibleFailJson(Exception):
"""Exception class to be raised by module.fail_json and caught by the test case"""
pass
def exit_json(*args, **kwargs): # pylint: disable=unused-argument
"""function to patch over exit_json; package return data into an exception"""
if 'changed' not in kwargs:
kwargs['changed'] = False
raise AnsibleExitJson(kwargs)
def fail_json(*args, **kwargs): # pylint: disable=unused-argument
"""function to patch over fail_json; package return data into an exception"""
kwargs['failed'] = True
raise AnsibleFailJson(kwargs)
class MockONTAPConnection(object):
''' mock server connection to ONTAP host '''
def __init__(self, kind=None, data=None):
''' save arguments '''
self.kind = kind
self.data = data
self.xml_in = None
self.xml_out = None
def invoke_successfully(self, xml, enable_tunneling): # pylint: disable=unused-argument
''' mock invoke_successfully returning xml data '''
self.xml_in = xml
if self.kind == 'igroup':
xml = self.build_igroup()
if self.kind == 'igroup_no_initiators':
xml = self.build_igroup_no_initiators()
self.xml_out = xml
return xml
@staticmethod
def build_igroup():
''' build xml data for initiator '''
xml = netapp_utils.zapi.NaElement('xml')
attributes = {
'num-records': 1,
'attributes-list': {
'initiator-group-info': {
'initiators': [
{
'initiator-info': {
'initiator-name': 'init1'
}},
{
'initiator-info': {
'initiator-name': 'init2'
}}
]
}
}
}
xml.translate_struct(attributes)
return xml
@staticmethod
def build_igroup_no_initiators():
''' build xml data for igroup with no initiators '''
xml = netapp_utils.zapi.NaElement('xml')
attributes = {
'num-records': 1,
'attributes-list': {
'initiator-group-info': {
'vserver': 'test'
}
}
}
xml.translate_struct(attributes)
return xml
class TestMyModule(unittest.TestCase):
''' a group of related Unit Tests '''
def setUp(self):
self.mock_module_helper = patch.multiple(basic.AnsibleModule,
exit_json=exit_json,
fail_json=fail_json)
self.mock_module_helper.start()
self.addCleanup(self.mock_module_helper.stop)
self.server = MockONTAPConnection()
def mock_args(self):
return {
'vserver': 'vserver',
'name': 'test',
'initiators': 'init1',
'ostype': 'linux',
'initiator_group_type': 'fcp',
'bind_portset': 'true',
'hostname': 'hostname',
'username': 'username',
'password': 'password'
}
def get_igroup_mock_object(self, kind=None):
"""
Helper method to return an na_ontap_igroup object
:param kind: passes this param to MockONTAPConnection()
:return: na_ontap_igroup object
"""
obj = igroup()
obj.autosupport_log = Mock(return_value=None)
if kind is None:
obj.server = MockONTAPConnection()
else:
obj.server = MockONTAPConnection(kind=kind)
return obj
def test_module_fail_when_required_args_missing(self):
''' required arguments are reported as errors '''
with pytest.raises(AnsibleFailJson) as exc:
set_module_args({})
igroup()
def test_get_nonexistent_igroup(self):
''' Test if get_igroup returns None for non-existent igroup '''
data = self.mock_args()
set_module_args(data)
result = self.get_igroup_mock_object().get_igroup('dummy')
assert result is None
def test_get_existing_igroup_with_initiators(self):
''' Test if get_igroup returns list of existing initiators '''
data = self.mock_args()
set_module_args(data)
result = self.get_igroup_mock_object('igroup').get_igroup(data['name'])
assert data['initiators'] in result['initiators']
assert result['initiators'] == ['init1', 'init2']
def test_get_existing_igroup_without_initiators(self):
''' Test if get_igroup returns empty list() '''
data = self.mock_args()
set_module_args(data)
result = self.get_igroup_mock_object('igroup_no_initiators').get_igroup(data['name'])
assert result['initiators'] == []
@patch('ansible.modules.storage.netapp.na_ontap_igroup.NetAppOntapIgroup.add_initiators')
@patch('ansible.modules.storage.netapp.na_ontap_igroup.NetAppOntapIgroup.remove_initiators')
def test_modify_initiator_calls_add_and_remove(self, remove, add):
'''Test remove_initiator() is called followed by add_initiator() on modify operation'''
data = self.mock_args()
data['initiators'] = 'replacewithme'
set_module_args(data)
obj = self.get_igroup_mock_object('igroup')
with pytest.raises(AnsibleExitJson) as exc:
current = obj.get_igroup(data['name'])
obj.apply()
remove.assert_called_with(current['initiators'])
add.assert_called_with()
@patch('ansible.modules.storage.netapp.na_ontap_igroup.NetAppOntapIgroup.modify_initiator')
def test_modify_called_from_add(self, modify):
'''Test remove_initiator() and add_initiator() calls modify'''
data = self.mock_args()
data['initiators'] = 'replacewithme'
add, remove = 'igroup-add', 'igroup-remove'
set_module_args(data)
with pytest.raises(AnsibleExitJson) as exc:
self.get_igroup_mock_object('igroup_no_initiators').apply()
modify.assert_called_with('replacewithme', add)
assert modify.call_count == 1 # remove nothing, add 1 new
@patch('ansible.modules.storage.netapp.na_ontap_igroup.NetAppOntapIgroup.modify_initiator')
def test_modify_called_from_remove(self, modify):
'''Test remove_initiator() and add_initiator() calls modify'''
data = self.mock_args()
data['initiators'] = ''
remove = 'igroup-remove'
set_module_args(data)
with pytest.raises(AnsibleExitJson) as exc:
self.get_igroup_mock_object('igroup').apply()
modify.assert_called_with('init2', remove)
assert modify.call_count == 2 # remove existing 2, add nothing
@patch('ansible.modules.storage.netapp.na_ontap_igroup.NetAppOntapIgroup.add_initiators')
def test_successful_create(self, add):
''' Test successful create '''
set_module_args(self.mock_args())
with pytest.raises(AnsibleExitJson) as exc:
self.get_igroup_mock_object().apply()
assert exc.value.args[0]['changed']
add.assert_called_with()
def test_successful_delete(self):
''' Test successful delete '''
data = self.mock_args()
data['state'] = 'absent'
set_module_args(self.mock_args())
with pytest.raises(AnsibleExitJson) as exc:
self.get_igroup_mock_object('igroup').apply()
assert exc.value.args[0]['changed']
def test_successful_modify(self):
''' Test successful modify '''
data = self.mock_args()
data['initiators'] = 'new'
set_module_args(self.mock_args())
with pytest.raises(AnsibleExitJson) as exc:
self.get_igroup_mock_object('igroup').apply()
assert exc.value.args[0]['changed']
@patch('ansible.modules.storage.netapp.na_ontap_igroup.NetAppOntapIgroup.get_igroup')
def test_successful_rename(self, get_vserver):
'''Test successful rename'''
data = self.mock_args()
data['from_name'] = 'test'
data['name'] = 'test_new'
set_module_args(data)
current = {
'initiators': ['init1', 'init2']
}
get_vserver.side_effect = [
None,
current
]
with pytest.raises(AnsibleExitJson) as exc:
self.get_igroup_mock_object().apply()
assert exc.value.args[0]['changed']