Define module for NetApp E-Series iSCSI targets (#40632)

Create a new module for managing E-Series iSCSI targets.

test/integration/targets/netapp_eseries_iscsi_target/aliases

@@ -0,0 +1,10 @@
+# This test is not enabled by default, but can be utilized by defining required variables in integration_config.yml
+# Example integration_config.yml:
+# ---
+#netapp_e_api_host: 10.113.1.111:8443
+#netapp_e_api_username: admin
+#netapp_e_api_password: myPass
+#netapp_e_ssid: 1
+
+unsupported
+netapp/eseries

test/integration/targets/netapp_eseries_iscsi_target/tasks/main.yml

@@ -0,0 +1 @@
+- include_tasks: run.yml

test/integration/targets/netapp_eseries_iscsi_target/tasks/run.yml

@@ -0,0 +1,68 @@
+# Test code for the netapp_e_iscsi_interface module
+# (c) 2018, NetApp, Inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+- name: NetApp Test iSCSI Target module
+  fail:
+    msg: 'Please define netapp_e_api_username, netapp_e_api_password, netapp_e_api_host, and netapp_e_ssid.'
+  when:  netapp_e_api_username is undefined or netapp_e_api_password is undefined
+          or netapp_e_api_host is undefined or netapp_e_ssid is undefined
+  vars: &vars
+    credentials: &creds
+      api_url: "https://{{ netapp_e_api_host }}/devmgr/v2"
+      api_username: "{{ netapp_e_api_username }}"
+      api_password: "{{ netapp_e_api_password }}"
+      ssid: "{{ netapp_e_ssid }}"
+      validate_certs: no
+    secrets: &secrets
+      # 12 characters
+      - 012345678912
+      # 16 characters
+      - 0123456789123456
+
+- name: set credentials
+  set_fact:
+    credentials: *creds
+
+- name: Show some debug information
+  debug:
+    msg: "Using user={{ credentials.api_username }} on server={{ credentials.api_url }}."
+
+- name: Ensure we can set the chap secret
+  netapp_e_iscsi_target:
+    <<: *creds
+    name: myTarget
+    chap_secret: "{{ item }}"
+  loop: *secrets
+
+- name: Turn off all of the options
+  netapp_e_iscsi_target:
+    <<: *creds
+    name: abc
+    ping: no
+    unnamed_discovery: no
+
+- name: Ensure we can set the ping option
+  netapp_e_iscsi_target:
+    <<: *creds
+    name: myTarget
+    ping: yes
+    unnamed_discovery: yes
+  register: result
+
+- name: Ensure we received a change
+  assert:
+    that: result.changed
+
+- name: Run the ping change in check-mode
+  netapp_e_iscsi_target:
+    <<: *creds
+    name: myTarget
+    ping: yes
+    unnamed_discovery: yes
+  check: yes
+  register: result
+
+- name: Ensure no change resulted
+  assert:
+    that: not result.changed

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

@@ -0,0 +1,134 @@
+# coding=utf-8
+# (c) 2018, NetApp Inc.
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from mock import MagicMock
+
+from ansible.modules.storage.netapp.netapp_e_iscsi_target import IscsiTarget
+from units.modules.utils import AnsibleExitJson, AnsibleFailJson, ModuleTestCase, set_module_args
+
+__metaclass__ = type
+
+import mock
+
+from ansible.compat.tests.mock import PropertyMock
+
+
+class IscsiTargetTest(ModuleTestCase):
+    REQUIRED_PARAMS = {
+        'api_username': 'rw',
+        'api_password': 'password',
+        'api_url': 'http://localhost',
+        'ssid': '1',
+        'name': 'abc',
+    }
+
+    CHAP_SAMPLE = 'a' * 14
+
+    REQ_FUNC = 'ansible.modules.storage.netapp.netapp_e_iscsi_target.request'
+
+    def _set_args(self, args=None):
+        module_args = self.REQUIRED_PARAMS.copy()
+        if args is not None:
+            module_args.update(args)
+        set_module_args(module_args)
+
+    def test_validate_params(self):
+        """Ensure we can pass valid parameters to the module"""
+        for i in range(12, 16):
+            secret = 'a' * i
+            self._set_args(dict(chap=secret))
+            tgt = IscsiTarget()
+
+    def test_invalid_chap_secret(self):
+        for secret in [11 * 'a', 17 * 'a', u'©' * 12]:
+            with self.assertRaisesRegexp(AnsibleFailJson, r'.*?CHAP secret is not valid.*') as result:
+                self._set_args(dict(chap=secret))
+                tgt = IscsiTarget()
+
+    def test_apply_iscsi_settings(self):
+        """Ensure that the presence of CHAP always triggers an update."""
+        self._set_args(dict(chap=self.CHAP_SAMPLE))
+        tgt = IscsiTarget()
+
+        # CHAP is enabled
+        fake = dict(alias=self.REQUIRED_PARAMS.get('name'), chap=True)
+
+        # We don't care about the return here
+        with mock.patch(self.REQ_FUNC, return_value=(200, "")) as request:
+            with mock.patch.object(IscsiTarget, 'target', new_callable=PropertyMock) as call:
+                call.return_value = fake
+                self.assertTrue(tgt.apply_iscsi_settings())
+                self.assertTrue(request.called, msg="An update was expected!")
+
+                # Retest with check_mode enabled
+                tgt.check_mode = True
+                request.reset_mock()
+                self.assertTrue(tgt.apply_iscsi_settings())
+                self.assertFalse(request.called, msg="No update was expected in check_mode!")
+
+    def test_apply_iscsi_settings_no_change(self):
+        """Ensure that we don't make unnecessary requests or updates"""
+        name = 'abc'
+        self._set_args(dict(alias=name))
+        fake = dict(alias=name, chap=False)
+        with mock.patch(self.REQ_FUNC, return_value=(200, "")) as request:
+            with mock.patch.object(IscsiTarget, 'target', new_callable=PropertyMock) as call:
+                call.return_value = fake
+                tgt = IscsiTarget()
+                self.assertFalse(tgt.apply_iscsi_settings())
+                self.assertFalse(request.called, msg="No update was expected!")
+
+    def test_apply_iscsi_settings_fail(self):
+        """Ensure we handle request failures cleanly"""
+        self._set_args()
+        fake = dict(alias='', chap=True)
+        with self.assertRaisesRegexp(AnsibleFailJson, r".*?update.*"):
+            with mock.patch(self.REQ_FUNC, side_effect=Exception) as request:
+                with mock.patch.object(IscsiTarget, 'target', new_callable=PropertyMock) as call:
+                    call.return_value = fake
+                    tgt = IscsiTarget()
+                    tgt.apply_iscsi_settings()
+
+    def test_apply_target_changes(self):
+        """Ensure that changes trigger an update."""
+        self._set_args(dict(ping=True, unnamed_discovery=True))
+        tgt = IscsiTarget()
+
+        # CHAP is enabled
+        fake = dict(ping=False, unnamed_discovery=False)
+
+        # We don't care about the return here
+        with mock.patch(self.REQ_FUNC, return_value=(200, "")) as request:
+            with mock.patch.object(IscsiTarget, 'target', new_callable=PropertyMock) as call:
+                call.return_value = fake
+                self.assertTrue(tgt.apply_target_changes())
+                self.assertTrue(request.called, msg="An update was expected!")
+
+                # Retest with check_mode enabled
+                tgt.check_mode = True
+                request.reset_mock()
+                self.assertTrue(tgt.apply_target_changes())
+                self.assertFalse(request.called, msg="No update was expected in check_mode!")
+
+    def test_apply_target_changes_no_change(self):
+        """Ensure that we don't make unnecessary requests or updates"""
+        self._set_args(dict(ping=True, unnamed_discovery=True))
+        fake = dict(ping=True, unnamed_discovery=True)
+        with mock.patch(self.REQ_FUNC, return_value=(200, "")) as request:
+            with mock.patch.object(IscsiTarget, 'target', new_callable=PropertyMock) as call:
+                call.return_value = fake
+                tgt = IscsiTarget()
+                self.assertFalse(tgt.apply_target_changes())
+                self.assertFalse(request.called, msg="No update was expected!")
+
+    def test_apply_target_changes_fail(self):
+        """Ensure we handle request failures cleanly"""
+        self._set_args()
+        fake = dict(ping=False, unnamed_discovery=False)
+        with self.assertRaisesRegexp(AnsibleFailJson, r".*?update.*"):
+            with mock.patch(self.REQ_FUNC, side_effect=Exception) as request:
+                with mock.patch.object(IscsiTarget, 'target', new_callable=PropertyMock) as call:
+                    call.return_value = fake
+                    tgt = IscsiTarget()
+                    tgt.apply_target_changes()