New Module: na_ontap_nvme_subsystem (#50887)

* changes to clusteR

* Revert "changes to clusteR"

This reverts commit 33ee1b71e4bc8435fb315762a871f8c4cb6c5f80.

* New module na_ontap_nvme_subsystem

* updates

* update author

* fix author

lib/ansible/modules/storage/netapp/na_ontap_nvme_subsystem.py

@@ -0,0 +1,353 @@
+#!/usr/bin/python
+
+# (c) 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 = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'certified'}
+
+
+DOCUMENTATION = '''
+author: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
+description:
+  - Create/Delete NVME subsystem
+  - Associate(modify) host/map to NVME subsystem
+  - NVMe service should be existing in the data vserver with NVMe protocol as a pre-requisite
+extends_documentation_fragment:
+  - netapp.na_ontap
+module: na_ontap_nvme_subsystem
+options:
+  state:
+    choices: ['present', 'absent']
+    description:
+      - Whether the specified subsystem should exist or not.
+    default: present
+  vserver:
+    description:
+      - Name of the vserver to use.
+    required: true
+  subsystem:
+    description:
+      - Specifies the subsystem
+    required: true
+  ostype:
+    description:
+      - Specifies the ostype for initiators
+    choices: ['windows', 'linux', 'vmware', 'xen', 'hyper_v']
+  skip_host_check:
+    description:
+      - Skip host check
+      - Required to delete an NVMe Subsystem with attached NVMe namespaces
+    default: false
+    type: bool
+  skip_mapped_check:
+    description:
+      - Skip mapped namespace check
+      - Required to delete an NVMe Subsystem with attached NVMe namespaces
+    default: false
+    type: bool
+  hosts:
+    description:
+      - List of host NQNs (NVMe Qualification Name) associated to the controller.
+    type: list
+  paths:
+    description:
+      - List of Namespace paths to be associated with the subsystem.
+    type: list
+short_description: "NetApp ONTAP Manage NVME Subsystem"
+version_added: "2.8"
+'''
+
+EXAMPLES = """
+
+    - name: Create NVME Subsystem
+      na_ontap_nvme_subsystem:
+        state: present
+        subsystem: test_sub
+        vserver: test_dest
+        ostype: linux
+        hostname: "{{ netapp_hostname }}"
+        username: "{{ netapp_username }}"
+        password: "{{ netapp_password }}"
+
+    - name: Delete NVME Subsystem
+      na_ontap_nvme_subsystem:
+        state: absent
+        subsystem: test_sub
+        vserver: test_dest
+        skip_host_check: True
+        skip_mapped_check: True
+        hostname: "{{ netapp_hostname }}"
+        username: "{{ netapp_username }}"
+        password: "{{ netapp_password }}"
+
+    - name: Associate hosts/paths with the subsystem
+      na_ontap_nvme_subsystem:
+        state: absent
+        subsystem: test_sub
+        vserver: test_dest
+        skip_host_check: True
+        skip_mapped_check: True
+        hostname: "{{ netapp_hostname }}"
+        username: "{{ netapp_username }}"
+        password: "{{ netapp_password }}"
+
+    - name: Add NVME Subsystem host/map (Idempotency)
+      na_ontap_nvme_subsystem:
+        state: present
+        subsystem: "{{ subsystem }}"
+        ostype: linux
+        hosts: nqn.1992-08.com.netapp:sn.3017cfc1e2ba11e89c55005056b36338:subsystem.ansible
+        paths: /vol/ansible/test,/vol/ansible/test1
+        vserver: "{{ vserver }}"
+        hostname: "{{ hostname }}"
+        username: "{{ username }}"
+        password: "{{ password }}"
+"""
+
+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
+from ansible.module_utils.netapp_module import NetAppModule
+
+HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
+
+
+class NetAppONTAPNVMESubsystem(object):
+    """
+    Class with NVME subsytem methods
+    """
+
+    def __init__(self):
+
+        self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
+        self.argument_spec.update(dict(
+            state=dict(required=False, type='str', choices=['present', 'absent'], default='present'),
+            vserver=dict(required=True, type='str'),
+            subsystem=dict(required=True, type='str'),
+            ostype=dict(required=False, type='str', choices=['windows', 'linux', 'vmware', 'xen', 'hyper_v']),
+            skip_host_check=dict(required=False, type='bool', default=False),
+            skip_mapped_check=dict(required=False, type='bool', default=False),
+            hosts=dict(required=False, type='list'),
+            paths=dict(required=False, type='list')
+        ))
+
+        self.module = AnsibleModule(
+            argument_spec=self.argument_spec,
+            supports_check_mode=True
+        )
+
+        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.parameters['vserver'])
+
+    def get_subsystem(self):
+        """
+        Get current subsystem details
+        :return: dict if subsystem exists, None otherwise
+        """
+        subsystem_get = netapp_utils.zapi.NaElement('nvme-subsystem-get-iter')
+        query = {
+            'query': {
+                'nvme-subsytem-info': {
+                    'subsystem': self.parameters.get('subsystem')
+                }
+            }
+        }
+        subsystem_get.translate_struct(query)
+        try:
+            result = self.server.invoke_successfully(subsystem_get, enable_tunneling=False)
+        except netapp_utils.zapi.NaApiError as error:
+            self.module.fail_json(msg='Error fetching subsystem info: %s' % to_native(error),
+                                  exception=traceback.format_exc())
+        if result.get_child_by_name('num-records') and int(result.get_child_content('num-records')) >= 1:
+            return True
+        return None
+
+    def create_subsystem(self):
+        """
+        Create a NVME Subsystem
+        """
+        if self.parameters.get('ostype') is None:
+            self.module.fail_json(msg="Error: Missing required parameter 'os_type' for creating subsystem")
+        options = {'subsystem': self.parameters['subsystem'],
+                   'ostype': self.parameters['ostype']
+                   }
+        subsystem_create = netapp_utils.zapi.NaElement('nvme-subsystem-create')
+        subsystem_create.translate_struct(options)
+        try:
+            self.server.invoke_successfully(subsystem_create, enable_tunneling=True)
+        except netapp_utils.zapi.NaApiError as error:
+            self.module.fail_json(msg='Error creating subsystem for %s: %s'
+                                  % (self.parameters.get('subsystem'), to_native(error)),
+                                  exception=traceback.format_exc())
+
+    def delete_subsystem(self):
+        """
+        Delete a NVME subsystem
+        """
+        options = {'subsystem': self.parameters['subsystem'],
+                   'skip-host-check': 'true' if self.parameters.get('skip_host_check') else 'false',
+                   'skip-mapped-check': 'true' if self.parameters.get('skip_mapped_check') else 'false',
+                   }
+        subsystem_delete = netapp_utils.zapi.NaElement.create_node_with_children('nvme-subsystem-delete', **options)
+        try:
+            self.server.invoke_successfully(subsystem_delete, enable_tunneling=True)
+        except netapp_utils.zapi.NaApiError as error:
+            self.module.fail_json(msg='Error deleting subsystem for %s: %s'
+                                      % (self.parameters.get('subsystem'), to_native(error)),
+                                  exception=traceback.format_exc())
+
+    def get_subsystem_host_map(self, type):
+        """
+        Get current subsystem host details
+        :return: list if host exists, None otherwise
+        """
+        if type == 'hosts':
+            zapi_get, zapi_info, zapi_type = 'nvme-subsystem-host-get-iter', 'nvme-target-subsystem-host-info',\
+                                             'host-nqn'
+        elif type == 'paths':
+            zapi_get, zapi_info, zapi_type = 'nvme-subsystem-map-get-iter', 'nvme-target-subsystem-map-info', 'path'
+        subsystem_get = netapp_utils.zapi.NaElement(zapi_get)
+        query = {
+            'query': {
+                zapi_info: {
+                    'subsystem': self.parameters.get('subsystem')
+                }
+            }
+        }
+        subsystem_get.translate_struct(query)
+        try:
+            result = self.server.invoke_successfully(subsystem_get, enable_tunneling=False)
+        except netapp_utils.zapi.NaApiError as error:
+            self.module.fail_json(msg='Error fetching subsystem info: %s' % to_native(error),
+                                  exception=traceback.format_exc())
+        if result.get_child_by_name('num-records') and int(result.get_child_content('num-records')) >= 1:
+            attrs_list = result.get_child_by_name('attributes-list')
+            return_list = []
+            for item in attrs_list.get_children():
+                return_list.append(item[zapi_type])
+            return {type: return_list}
+        return None
+
+    def add_subsystem_host_map(self, data, type):
+        """
+        Add a NVME Subsystem host/map
+        :param: data: list of hosts/paths to be added
+        :param: type: hosts/paths
+        """
+        if type == 'hosts':
+            zapi_add, zapi_type = 'nvme-subsystem-host-add', 'host-nqn'
+        elif type == 'paths':
+            zapi_add, zapi_type = 'nvme-subsystem-map-add', 'path'
+
+        for item in data:
+            options = {'subsystem': self.parameters['subsystem'],
+                       zapi_type: item
+                       }
+            subsystem_add = netapp_utils.zapi.NaElement.create_node_with_children(zapi_add, **options)
+            try:
+                self.server.invoke_successfully(subsystem_add, enable_tunneling=True)
+            except netapp_utils.zapi.NaApiError as error:
+                self.module.fail_json(msg='Error adding %s for subsystem %s: %s'
+                                      % (item, self.parameters.get('subsystem'), to_native(error)),
+                                      exception=traceback.format_exc())
+
+    def remove_subsystem_host_map(self, data, type):
+        """
+        Remove a NVME Subsystem host/map
+        :param: data: list of hosts/paths to be added
+        :param: type: hosts/paths
+        """
+        if type == 'hosts':
+            zapi_remove, zapi_type = 'nvme-subsystem-host-remove', 'host-nqn'
+        elif type == 'paths':
+            zapi_remove, zapi_type = 'nvme-subsystem-map-remove', 'path'
+
+        for item in data:
+            options = {'subsystem': self.parameters['subsystem'],
+                       zapi_type: item
+                       }
+            subsystem_remove = netapp_utils.zapi.NaElement.create_node_with_children(zapi_remove, **options)
+            try:
+                self.server.invoke_successfully(subsystem_remove, enable_tunneling=True)
+            except netapp_utils.zapi.NaApiError as error:
+                self.module.fail_json(msg='Error removing %s for subsystem %s: %s'
+                                          % (item, self.parameters.get('subsystem'), to_native(error)),
+                                      exception=traceback.format_exc())
+
+    def associate_host_map(self, types):
+        """
+        Check if there are hosts or paths to be associated with the subsystem
+        """
+        action_add_dict = {}
+        action_remove_dict = {}
+        for type in types:
+            if self.parameters.get(type):
+                current = self.get_subsystem_host_map(type)
+                if current:
+                    add_items = self.na_helper.\
+                        get_modified_attributes(current, self.parameters, get_list_diff=True).get(type)
+                    remove_items = [item for item in current[type] if item not in self.parameters.get(type)]
+                else:
+                    add_items = self.parameters[type]
+                    remove_items = {}
+                if add_items:
+                    action_add_dict[type] = add_items
+                    self.na_helper.changed = True
+                if remove_items:
+                    action_remove_dict[type] = remove_items
+                    self.na_helper.changed = True
+        return action_add_dict, action_remove_dict
+
+    def modify_host_map(self, add_host_map, remove_host_map):
+        for type, data in add_host_map.items():
+            self.add_subsystem_host_map(data, type)
+        for type, data in remove_host_map.items():
+            self.remove_subsystem_host_map(data, type)
+
+    def apply(self):
+        """
+        Apply action to NVME subsystem
+        """
+        netapp_utils.ems_log_event("na_ontap_nvme_subsystem", self.server)
+        types = ['hosts', 'paths']
+        current = self.get_subsystem()
+        add_host_map, remove_host_map = dict(), dict()
+        cd_action = self.na_helper.get_cd_action(current, self.parameters)
+        if cd_action is not 'delete' and self.parameters['state'] == 'present':
+            add_host_map, remove_host_map = self.associate_host_map(types)
+        if self.na_helper.changed:
+            if self.module.check_mode:
+                pass
+            else:
+                if cd_action == 'create':
+                    self.create_subsystem()
+                    self.modify_host_map(add_host_map, remove_host_map)
+                elif cd_action == 'delete':
+                    self.delete_subsystem()
+                elif cd_action is None:
+                    self.modify_host_map(add_host_map, remove_host_map)
+
+        self.module.exit_json(changed=self.na_helper.changed)
+
+
+def main():
+    """Execute action"""
+    community_obj = NetAppONTAPNVMESubsystem()
+    community_obj.apply()
+
+
+if __name__ == '__main__':
+    main()

test/units/modules/storage/netapp/test_na_ontap_nvme_subsystem.py

@@ -0,0 +1,241 @@
+# (c) 2018, NetApp, Inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+''' unit tests ONTAP Ansible module: na_ontap_nvme_subsystem '''
+
+from __future__ import print_function
+import json
+import pytest
+
+from units.compat import unittest
+from units.compat.mock import patch
+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_nvme_subsystem \
+    import NetAppONTAPNVMESubsystem as my_module
+
+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, parm1=None):
+        ''' save arguments '''
+        self.type = kind
+        self.parm1 = parm1
+        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.type == 'subsystem':
+            xml = self.build_subsystem_info(self.parm1)
+        self.xml_out = xml
+        return xml
+
+    @staticmethod
+    def build_subsystem_info(vserver):
+        ''' build xml data for vserser-info '''
+        xml = netapp_utils.zapi.NaElement('xml')
+        data = {'num-records': 2,
+                'attributes-list': [{'nvme-target-subsystem-map-info': {'path': 'abcd/vol'}},
+                                    {'nvme-target-subsystem-map-info': {'path': 'xyz/vol'}}]}
+        xml.translate_struct(data)
+        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()
+        self.onbox = False
+
+    def set_default_args(self):
+        if self.onbox:
+            hostname = '10.193.75.3'
+            username = 'admin'
+            password = 'netapp1!'
+            subsystem = 'test'
+            vserver = 'ansible'
+            ostype = 'linux'
+            paths = ['abcd/vol', 'xyz/vol']
+        else:
+            hostname = 'hostname'
+            username = 'username'
+            password = 'password'
+            subsystem = 'test'
+            vserver = 'vserver'
+            ostype = 'linux'
+            paths = ['abcd/vol', 'xyz/vol']
+        return dict({
+            'hostname': hostname,
+            'username': username,
+            'password': password,
+            'subsystem': subsystem,
+            'ostype': ostype,
+            'vserver': vserver,
+            'paths': paths
+        })
+
+    def test_module_fail_when_required_args_missing(self):
+        ''' required arguments are reported as errors '''
+        with pytest.raises(AnsibleFailJson) as exc:
+            set_module_args({})
+            my_module()
+        print('Info: %s' % exc.value.args[0]['msg'])
+
+    def test_ensure_get_called(self):
+        ''' test get_subsystem()  for non-existent subsystem'''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        my_obj.server = self.server
+        assert my_obj.get_subsystem() is None
+
+    def test_ensure_get_called_existing(self):
+        ''' test get_subsystem()  for existing subsystem'''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        my_obj.server = MockONTAPConnection(kind='subsystem')
+        assert my_obj.get_subsystem()
+
+    @patch('ansible.modules.storage.netapp.na_ontap_nvme_subsystem.NetAppONTAPNVMESubsystem.create_subsystem')
+    def test_successful_create(self, create_subsystem):
+        ''' creating subsystem and testing idempotency '''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = self.server
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert exc.value.args[0]['changed']
+        create_subsystem.assert_called_with()
+        # to reset na_helper from remembering the previous 'changed' value
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = MockONTAPConnection('subsystem')
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert not exc.value.args[0]['changed']
+
+    @patch('ansible.modules.storage.netapp.na_ontap_nvme_subsystem.NetAppONTAPNVMESubsystem.delete_subsystem')
+    def test_successful_delete(self, delete_subsystem):
+        ''' deleting subsystem and testing idempotency '''
+        data = self.set_default_args()
+        data['state'] = 'absent'
+        set_module_args(data)
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = MockONTAPConnection('subsystem')
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert exc.value.args[0]['changed']
+        delete_subsystem.assert_called_with()
+        # to reset na_helper from remembering the previous 'changed' value
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = self.server
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert not exc.value.args[0]['changed']
+
+    def test_ensure_get_called(self):
+        ''' test get_subsystem_host_map()  for non-existent subsystem'''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        my_obj.server = self.server
+        assert my_obj.get_subsystem_host_map('paths') is None
+
+    def test_ensure_get_called_existing(self):
+        ''' test get_subsystem_host_map()  for existing subsystem'''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        my_obj.server = MockONTAPConnection(kind='subsystem')
+        assert my_obj.get_subsystem_host_map('paths')
+
+    @patch('ansible.modules.storage.netapp.na_ontap_nvme_subsystem.NetAppONTAPNVMESubsystem.add_subsystem_host_map')
+    def test_successful_add_mock(self, add_subsystem_host_map):
+        ''' adding subsystem host/map and testing idempotency '''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = self.server
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert exc.value.args[0]['changed']
+        add_subsystem_host_map.assert_called_with(['abcd/vol', 'xyz/vol'], 'paths')
+
+    @patch('ansible.modules.storage.netapp.na_ontap_nvme_subsystem.NetAppONTAPNVMESubsystem.remove_subsystem_host_map')
+    def test_successful_remove_mock(self, remove_subsystem_host_map):
+        ''' removing subsystem host/map and testing idempotency '''
+        data = self.set_default_args()
+        data['paths'] = ['abcd/vol']
+        set_module_args(data)
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = MockONTAPConnection('subsystem')
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert exc.value.args[0]['changed']
+        remove_subsystem_host_map.assert_called_with(['xyz/vol'], 'paths')
+
+    def test_successful_add(self):
+        ''' adding subsystem host/map and testing idempotency '''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = self.server
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert exc.value.args[0]['changed']
+
+    def test_successful_remove(self):
+        ''' removing subsystem host/map and testing idempotency '''
+        data = self.set_default_args()
+        data['paths'] = ['abcd/vol']
+        set_module_args(data)
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = MockONTAPConnection('subsystem')
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert exc.value.args[0]['changed']