New Module: na_ontap_vscan_scanner_pool (#49786)
* changes to clusteR * Revert "changes to clusteR" This reverts commit 33ee1b71e4bc8435fb315762a871f8c4cb6c5f80. * na ontap vscan scanner pool * Update author
This commit is contained in:
Chris Archibald
John R Barker
parent
8707f1793e
commit
7b5897d266
2 changed files with 417 additions and 0 deletions
|
|
@ -0,0 +1,238 @@
|
|||
#!/usr/bin/python
|
||||
|
||||
# (c) 2018, 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 = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: na_ontap_vscan_scanner_pool
|
||||
short_description: NetApp ONTAP Vscan Scanner Pools Configuration.
|
||||
extends_documentation_fragment:
|
||||
- netapp.na_ontap
|
||||
version_added: '2.8'
|
||||
author: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
|
||||
description:
|
||||
- Configure a Vscan Scanner Pool
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Whether a Vscan Scanner pool is present or not
|
||||
choices: ['present', 'absent']
|
||||
default: present
|
||||
|
||||
vserver:
|
||||
description:
|
||||
- the name of the data vserver to use.
|
||||
required: true
|
||||
|
||||
hostnames:
|
||||
description:
|
||||
- List of hostnames of Vscan servers which are allowed to connect to Data ONTAP
|
||||
|
||||
privileged_users:
|
||||
description:
|
||||
- List of privileged usernames. Username must be in the form "domain-name\\user-name"
|
||||
|
||||
scanner_pool:
|
||||
description:
|
||||
- the name of the virus scanner pool
|
||||
required: true
|
||||
|
||||
scanner_policy:
|
||||
description:
|
||||
- The name of the Virus scanner Policy
|
||||
choices: ['primary', 'secondary', 'idle']
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Create and enable Scanner pool
|
||||
na_ontap_vscan_scanner_pool:
|
||||
state: present
|
||||
username: '{{ netapp_username }}'
|
||||
password: '{{ netapp_password }}'
|
||||
hostname: '{{ netapp_hostname }}'
|
||||
vserver: carchi-vsim2
|
||||
hostnames: ['name', 'name2']
|
||||
privileged_users: ['sim.rtp.openeng.netapp.com\\admin', 'sim.rtp.openeng.netapp.com\\carchi']
|
||||
scanner_pool: Scanner1
|
||||
scanner_policy: primary
|
||||
|
||||
- name: Delete a scanner pool
|
||||
na_ontap_vscan_scanner_pool:
|
||||
state: absent
|
||||
username: '{{ netapp_username }}'
|
||||
password: '{{ netapp_password }}'
|
||||
hostname: '{{ netapp_hostname }}'
|
||||
vserver: carchi-vsim2
|
||||
scanner_pool: Scanner1
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
|
||||
"""
|
||||
|
||||
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
|
||||
|
||||
HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
|
||||
|
||||
|
||||
class NetAppOntapVscanScannerPool(object):
|
||||
|
||||
def __init__(self):
|
||||
self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
|
||||
self.argument_spec.update(dict(
|
||||
state=dict(choices=['present', 'absent'], default='present'),
|
||||
vserver=dict(required=True, type='str'),
|
||||
hostnames=dict(requried=False, type='list'),
|
||||
privileged_users=dict(required=False, type='list'),
|
||||
scanner_pool=dict(required=True, type='str'),
|
||||
scanner_policy=dict(required=False, choices=['primary', 'secondary', 'idle'])
|
||||
))
|
||||
self.module = AnsibleModule(
|
||||
argument_spec=self.argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
parameters = self.module.params
|
||||
self.hostnames = parameters['hostnames']
|
||||
self.vserver = parameters['vserver']
|
||||
self.privileged_users = parameters['privileged_users']
|
||||
self.scanner_pool = parameters['scanner_pool']
|
||||
self.state = parameters['state']
|
||||
self.scanner_policy = parameters['scanner_policy']
|
||||
|
||||
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)
|
||||
|
||||
def create_scanner_pool(self):
|
||||
"""
|
||||
Create a Vscan Scanner Pool
|
||||
:return: nothing
|
||||
"""
|
||||
scanner_pool_obj = netapp_utils.zapi.NaElement('vscan-scanner-pool-create')
|
||||
if self.hostnames:
|
||||
string_obj = netapp_utils.zapi.NaElement('hostnames')
|
||||
scanner_pool_obj.add_child_elem(string_obj)
|
||||
for hostname in self.hostnames:
|
||||
string_obj.add_new_child('string', hostname)
|
||||
if self.privileged_users:
|
||||
users_obj = netapp_utils.zapi.NaElement('privileged-users')
|
||||
scanner_pool_obj.add_child_elem(users_obj)
|
||||
for user in self.privileged_users:
|
||||
users_obj.add_new_child('privileged-user', user)
|
||||
scanner_pool_obj.add_new_child('scanner-pool', self.scanner_pool)
|
||||
try:
|
||||
self.server.invoke_successfully(scanner_pool_obj, True)
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
self.module.fail_json(msg='Error creating Vscan Scanner Pool %s: %s' %
|
||||
(self.scanner_pool, to_native(error)),
|
||||
exception=traceback.format_exc())
|
||||
|
||||
def apply_policy(self):
|
||||
"""
|
||||
Apply a Scanner policy to a Scanner pool
|
||||
:return: nothing
|
||||
"""
|
||||
apply_policy_obj = netapp_utils.zapi.NaElement('vscan-scanner-pool-apply-policy')
|
||||
apply_policy_obj.add_new_child('scanner-policy', self.scanner_policy)
|
||||
apply_policy_obj.add_new_child('scanner-pool', self.scanner_pool)
|
||||
try:
|
||||
self.server.invoke_successfully(apply_policy_obj, True)
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
self.module.fail_json(msg='Error appling policy %s to pool %s: %s' %
|
||||
(self.scanner_policy, self.scanner_pool, to_native(error)),
|
||||
exception=traceback.format_exc())
|
||||
|
||||
def get_scanner_pool(self):
|
||||
"""
|
||||
Check to see if a scanner pool exist or not
|
||||
:return: True if it exist, False if it does not
|
||||
"""
|
||||
scanner_pool_obj = netapp_utils.zapi.NaElement('vscan-scanner-pool-get-iter')
|
||||
scanner_pool_info = netapp_utils.zapi.NaElement('scan-scanner-pool-info')
|
||||
scanner_pool_info.add_new_child('scanner-pool', self.scanner_pool)
|
||||
query = netapp_utils.zapi.NaElement('query')
|
||||
query.add_child_elem(scanner_pool_info)
|
||||
scanner_pool_obj.add_child_elem(query)
|
||||
try:
|
||||
result = self.server.invoke_successfully(scanner_pool_obj, True)
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
self.module.fail_json(msg='Error searching for Vscan Scanner Pool %s: %s' %
|
||||
(self.scanner_pool, to_native(error)),
|
||||
exception=traceback.format_exc())
|
||||
if result.get_child_by_name('num-records'):
|
||||
if result.get_child_by_name('attributes-list').get_child_by_name('vscan-scanner-pool-info').get_child_content(
|
||||
'scanner-pool') == self.scanner_pool:
|
||||
return result.get_child_by_name('attributes-list').get_child_by_name('vscan-scanner-pool-info')
|
||||
return False
|
||||
return False
|
||||
|
||||
def delete_scanner_pool(self):
|
||||
"""
|
||||
Delete a Scanner pool
|
||||
:return: nothing
|
||||
"""
|
||||
scanner_pool_obj = netapp_utils.zapi.NaElement('vscan-scanner-pool-delete')
|
||||
scanner_pool_obj.add_new_child('scanner-pool', self.scanner_pool)
|
||||
try:
|
||||
self.server.invoke_successfully(scanner_pool_obj, True)
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
self.module.fail_json(msg='Error deleting Vscan Scanner Pool %s: %s' %
|
||||
(self.scanner_pool, to_native(error)),
|
||||
exception=traceback.format_exc())
|
||||
|
||||
def asup_log_for_cserver(self, event_name):
|
||||
"""
|
||||
Fetch admin vserver for the given cluster
|
||||
Create and Autosupport log event with the given module name
|
||||
:param event_name: Name of the event log
|
||||
:return: None
|
||||
"""
|
||||
results = netapp_utils.get_cserver(self.server)
|
||||
cserver = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=results)
|
||||
netapp_utils.ems_log_event(event_name, cserver)
|
||||
|
||||
def apply(self):
|
||||
self.asup_log_for_cserver("na_ontap_vscan_scanner_pool")
|
||||
changed = False
|
||||
scanner_pool_obj = self.get_scanner_pool()
|
||||
if self.state == 'present':
|
||||
if not scanner_pool_obj:
|
||||
self.create_scanner_pool()
|
||||
if self.scanner_policy:
|
||||
self.apply_policy()
|
||||
changed = True
|
||||
# apply Scanner policy
|
||||
if scanner_pool_obj:
|
||||
if scanner_pool_obj.get_child_content('scanner-policy') != self.scanner_policy:
|
||||
self.apply_policy()
|
||||
changed = True
|
||||
if self.state == 'absent':
|
||||
if scanner_pool_obj:
|
||||
self.delete_scanner_pool()
|
||||
changed = True
|
||||
self.module.exit_json(changed=changed)
|
||||
|
||||
|
||||
def main():
|
||||
"""
|
||||
Execute action from playbook
|
||||
"""
|
||||
command = NetAppOntapVscanScannerPool()
|
||||
command.apply()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
@ -0,0 +1,179 @@
|
|||
# (c) 2018, NetApp, Inc
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
''' unit tests for Ansible module: na_ontap_vscan_scanner_pool '''
|
||||
|
||||
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_vscan_scanner_pool \
|
||||
import NetAppOntapVscanScannerPool as scanner_module # module under test
|
||||
|
||||
if not netapp_utils.has_netapp_lib():
|
||||
pytestmark = pytest.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.params = 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 == 'scanner':
|
||||
xml = self.build_scanner_pool_info(self.params)
|
||||
self.xml_out = xml
|
||||
return xml
|
||||
|
||||
@staticmethod
|
||||
def build_scanner_pool_info(sanner_details):
|
||||
xml = netapp_utils.zapi.NaElement('xml')
|
||||
attributes = {
|
||||
'num-records': 1,
|
||||
'attributes-list': {
|
||||
'vscan-scanner-pool-info': {
|
||||
'scanner-pool': sanner_details['scanner_pool'],
|
||||
'scanner-policy': sanner_details['scanner_policy']
|
||||
}
|
||||
}
|
||||
}
|
||||
xml.translate_struct(attributes)
|
||||
return xml
|
||||
|
||||
|
||||
class TestMyModule(unittest.TestCase):
|
||||
''' Unit tests for na_ontap_job_schedule '''
|
||||
|
||||
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.mock_scanner = {
|
||||
'state': 'present',
|
||||
'scanner_pool': 'test_pool',
|
||||
'vserver': 'test_vserver',
|
||||
'hostnames': ['host1', 'host2'],
|
||||
'privileged_users': ['domain\\admin', 'domain\\carchi8py'],
|
||||
'scanner_policy': 'primary'
|
||||
}
|
||||
|
||||
def mock_args(self):
|
||||
return {
|
||||
'state': self.mock_scanner['state'],
|
||||
'scanner_pool': self.mock_scanner['scanner_pool'],
|
||||
'vserver': self.mock_scanner['vserver'],
|
||||
'hostnames': self.mock_scanner['hostnames'],
|
||||
'privileged_users': self.mock_scanner['privileged_users'],
|
||||
'hostname': 'test',
|
||||
'username': 'test_user',
|
||||
'password': 'test_pass!',
|
||||
'scanner_policy': self.mock_scanner['scanner_policy']
|
||||
}
|
||||
|
||||
def get_scanner_mock_object(self, kind=None):
|
||||
scanner_obj = scanner_module()
|
||||
scanner_obj.asup_log_for_cserver = Mock(return_value=None)
|
||||
if kind is None:
|
||||
scanner_obj.server = MockONTAPConnection()
|
||||
else:
|
||||
scanner_obj.server = MockONTAPConnection(kind='scanner', data=self.mock_scanner)
|
||||
return scanner_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({})
|
||||
scanner_module()
|
||||
print('Info: %s' % exc.value.args[0]['msg'])
|
||||
|
||||
def test_get_nonexistent_scanner(self):
|
||||
''' Test if get_scanner_pool returns None for non-existent job '''
|
||||
set_module_args(self.mock_args())
|
||||
result = self.get_scanner_mock_object().get_scanner_pool()
|
||||
assert not result
|
||||
|
||||
def test_get_existing_scanner(self):
|
||||
''' Test if get_scanner_pool returns None for non-existent job '''
|
||||
set_module_args(self.mock_args())
|
||||
result = self.get_scanner_mock_object('scanner').get_scanner_pool()
|
||||
assert result
|
||||
|
||||
def test_successfully_create(self):
|
||||
set_module_args(self.mock_args())
|
||||
with pytest.raises(AnsibleExitJson) as exc:
|
||||
self.get_scanner_mock_object().apply()
|
||||
assert exc.value.args[0]['changed']
|
||||
|
||||
def test_create_idempotency(self):
|
||||
set_module_args(self.mock_args())
|
||||
with pytest.raises(AnsibleExitJson) as exc:
|
||||
self.get_scanner_mock_object('scanner').apply()
|
||||
assert not exc.value.args[0]['changed']
|
||||
|
||||
def test_apply_policy(self):
|
||||
data = self.mock_args()
|
||||
data['scanner_policy'] = 'secondary'
|
||||
set_module_args(data)
|
||||
with pytest.raises(AnsibleExitJson) as exc:
|
||||
self.get_scanner_mock_object('scanner').apply()
|
||||
assert exc.value.args[0]['changed']
|
||||
|
||||
def test_successfully_delete(self):
|
||||
data = self.mock_args()
|
||||
data['state'] = 'absent'
|
||||
set_module_args(data)
|
||||
with pytest.raises(AnsibleExitJson) as exc:
|
||||
self.get_scanner_mock_object('scanner').apply()
|
||||
assert exc.value.args[0]['changed']
|
||||
|
||||
def test_delete_idempotency(self):
|
||||
data = self.mock_args()
|
||||
data['state'] = 'absent'
|
||||
set_module_args(data)
|
||||
with pytest.raises(AnsibleExitJson) as exc:
|
||||
self.get_scanner_mock_object().apply()
|
||||
assert not exc.value.args[0]['changed']
|
||||
Loading…
Reference in a new issue