new module nvme namespace

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

@@ -0,0 +1,195 @@
+#!/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': 'certified'}
+
+
+DOCUMENTATION = '''
+author: NetApp Ansible Team (ng-ansibleteam@netapp.com)
+description:
+  - Create/Delete NVME namespace
+extends_documentation_fragment:
+  - netapp.na_ontap
+module: na_ontap_nvme_namespace
+options:
+  state:
+    choices: ['present', 'absent']
+    description:
+      - Whether the specified namespace should exist or not.
+    default: present
+  vserver:
+    description:
+      - Name of the vserver to use.
+    required: true
+  ostype:
+    description:
+      - Specifies the ostype for initiators
+    choices: ['windows', 'linux', 'vmware', 'xen', 'hyper_v']
+  size:
+    description:
+      - Size in bytes.
+        Range is [0..2^63-1].
+    type: int
+  path:
+    description:
+      - Namespace path.
+    type: str
+short_description: "NetApp ONTAP Manage NVME Namespace"
+version_added: "2.8"
+'''
+
+EXAMPLES = """
+
+    - name: Create NVME Namespace
+      na_ontap_nvme_namespace:
+        state: present
+        ostype: linux
+        path: /vol/ansible/test
+        size: 20
+        vserver: "{{ vserver }}"
+        hostname: "{{ hostname }}"
+        username: "{{ username }}"
+        password: "{{ password }}"
+
+    - name: Create NVME Namespace (Idempotency)
+      na_ontap_nvme_namespace:
+        state: present
+        ostype: linux
+        path: /vol/ansible/test
+        size: 20
+        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 NetAppONTAPNVMENamespace(object):
+    """
+    Class with NVME namespace 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'),
+            ostype=dict(required=False, type='str', choices=['windows', 'linux', 'vmware', 'xen', 'hyper_v']),
+            path=dict(required=True, type='str'),
+            size=dict(required=False, type='int')
+        ))
+
+        self.module = AnsibleModule(
+            argument_spec=self.argument_spec,
+            required_if=[('state', 'present', ['ostype', 'size'])],
+            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_namespace(self):
+        """
+        Get current namespace details
+        :return: dict if namespace exists, None otherwise
+        """
+        namespace_get = netapp_utils.zapi.NaElement('nvme-namespace-get-iter')
+        query = {
+            'query': {
+                'nvme-namespace-info': {
+                    'path': self.parameters['path'],
+                    'vserver': self.parameters['vserver']
+                }
+            }
+        }
+        namespace_get.translate_struct(query)
+        try:
+            result = self.server.invoke_successfully(namespace_get, enable_tunneling=False)
+        except netapp_utils.zapi.NaApiError as error:
+            self.module.fail_json(msg='Error fetching namespace 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 result
+        return None
+
+    def create_namespace(self):
+        """
+        Create a NVME Namespace
+        """
+        options = {'path': self.parameters['path'],
+                   'ostype': self.parameters['ostype'],
+                   'size': self.parameters['size']
+                   }
+        namespace_create = netapp_utils.zapi.NaElement('nvme-namespace-create')
+        namespace_create.translate_struct(options)
+        try:
+            self.server.invoke_successfully(namespace_create, enable_tunneling=True)
+        except netapp_utils.zapi.NaApiError as error:
+            self.module.fail_json(msg='Error creating namespace for path %s: %s'
+                                  % (self.parameters.get('path'), to_native(error)),
+                                  exception=traceback.format_exc())
+
+    def delete_namespace(self):
+        """
+        Delete a NVME Namespace
+        """
+        options = {'path': self.parameters['path']
+                   }
+        namespace_delete = netapp_utils.zapi.NaElement.create_node_with_children('nvme-namespace-delete', **options)
+        try:
+            self.server.invoke_successfully(namespace_delete, enable_tunneling=True)
+        except netapp_utils.zapi.NaApiError as error:
+            self.module.fail_json(msg='Error deleting namespace for path %s: %s'
+                                      % (self.parameters.get('path'), to_native(error)),
+                                  exception=traceback.format_exc())
+
+    def apply(self):
+        """
+        Apply action to NVME Namespace
+        """
+        netapp_utils.ems_log_event("na_ontap_nvme_namespace", self.server)
+        current = self.get_namespace()
+        cd_action = self.na_helper.get_cd_action(current, self.parameters)
+        if self.na_helper.changed:
+            if self.module.check_mode:
+                pass
+            else:
+                if cd_action == 'create':
+                    self.create_namespace()
+                elif cd_action == 'delete':
+                    self.delete_namespace()
+
+        self.module.exit_json(changed=self.na_helper.changed)
+
+
+def main():
+    """Execute action"""
+    community_obj = NetAppONTAPNVMENamespace()
+    community_obj.apply()
+
+
+if __name__ == '__main__':
+    main()

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

@@ -0,0 +1,197 @@
+# (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_namespace'''
+
+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_namespace \
+    import NetAppONTAPNVMENamespace as my_module
+
+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):
+        ''' save arguments '''
+        self.type = kind
+        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 == 'namespace':
+            xml = self.build_namespace_info()
+        elif self.type == 'quota_fail':
+            raise netapp_utils.zapi.NaApiError(code='TEST', message="This exception is from the unit test")
+        self.xml_out = xml
+        return xml
+
+    @staticmethod
+    def build_namespace_info():
+        ''' build xml data for namespace-info '''
+        xml = netapp_utils.zapi.NaElement('xml')
+        data = {'num-records': 2,
+                'attributes-list': [{'nvme-namespace-info': {'path': 'abcd/vol'}},
+                                    {'nvme-namespace-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!'
+            vserver = 'ansible'
+            ostype = 'linux'
+            path = 'abcd/vol'
+            size = 20
+        else:
+            hostname = 'hostname'
+            username = 'username'
+            password = 'password'
+            vserver = 'vserver'
+            ostype = 'linux'
+            path = 'abcd/vol'
+            size = 20
+        return dict({
+            'hostname': hostname,
+            'username': username,
+            'password': password,
+            'ostype': ostype,
+            'vserver': vserver,
+            'path': path,
+            'size': size
+        })
+
+    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_namespace()  for non-existent namespace'''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        my_obj.server = self.server
+        assert my_obj.get_namespace() is None
+
+    def test_ensure_get_called_existing(self):
+        ''' test get_namespace()  for existing namespace'''
+        set_module_args(self.set_default_args())
+        my_obj = my_module()
+        my_obj.server = MockONTAPConnection(kind='namespace')
+        assert my_obj.get_namespace()
+
+    @patch('ansible.modules.storage.netapp.na_ontap_nvme_namespace.NetAppONTAPNVMENamespace.create_namespace')
+    def test_successful_create(self, create_namespace):
+        ''' creating namespace 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_namespace.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('namespace')
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert not exc.value.args[0]['changed']
+
+    @patch('ansible.modules.storage.netapp.na_ontap_nvme_namespace.NetAppONTAPNVMENamespace.delete_namespace')
+    def test_successful_delete(self, delete_namespace):
+        ''' deleting namespace 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('namespace')
+        with pytest.raises(AnsibleExitJson) as exc:
+            my_obj.apply()
+        assert exc.value.args[0]['changed']
+        delete_namespace.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_if_all_methods_catch_exception(self):
+        module_args = {}
+        module_args.update(self.set_default_args())
+        set_module_args(module_args)
+        my_obj = my_module()
+        if not self.onbox:
+            my_obj.server = MockONTAPConnection('quota_fail')
+        with pytest.raises(AnsibleFailJson) as exc:
+            my_obj.get_namespace()
+        assert 'Error fetching namespace info:' in exc.value.args[0]['msg']
+        with pytest.raises(AnsibleFailJson) as exc:
+            my_obj.create_namespace()
+        assert 'Error creating namespace for path' in exc.value.args[0]['msg']
+        with pytest.raises(AnsibleFailJson) as exc:
+            my_obj.delete_namespace()
+        assert 'Error deleting namespace for path' in exc.value.args[0]['msg']