Removes f5-sdk from bigip_device_group_member (#48464)

lib/ansible/modules/network/f5/bigip_device_group_member.py

@@ -1,8 +1,9 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2017 F5 Networks Inc.
+# Copyright: (c) 2017, F5 Networks 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
 
@@ -45,6 +46,7 @@ options:
 extends_documentation_fragment: f5
 author:
   - Tim Rupp (@caphrim007)
+  - Wojciech Wypior (@wojtek0806)
 '''
 
 EXAMPLES = r'''
@@ -52,9 +54,9 @@ EXAMPLES = r'''
   bigip_device_group_member:
     name: "{{ inventory_hostname }}"
     device_group: device_trust_group
+    provider:
       password: secret
       server: lb.mydomain.com
-    state: present
       user: admin
   delegate_to: localhost
 
@@ -62,9 +64,9 @@ EXAMPLES = r'''
   bigip_device_group_member:
     name: "{{ item }}"
     device_group: device_trust_group
+    provider:
       password: secret
       server: lb.mydomain.com
-    state: present
       user: admin
   loop: "{{ hostvars.keys() }}"
   run_once: true
@@ -78,27 +80,21 @@ RETURN = r'''
 from ansible.module_utils.basic import AnsibleModule
 
 try:
-    from library.module_utils.network.f5.bigip import HAS_F5SDK
+    from library.module_utils.network.f5.bigip import F5RestClient
-    from library.module_utils.network.f5.bigip import F5Client
     from library.module_utils.network.f5.common import F5ModuleError
     from library.module_utils.network.f5.common import AnsibleF5Parameters
     from library.module_utils.network.f5.common import cleanup_tokens
     from library.module_utils.network.f5.common import f5_argument_spec
-    try:
+    from library.module_utils.network.f5.common import exit_json
-        from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    from library.module_utils.network.f5.common import fail_json
-    except ImportError:
-        HAS_F5SDK = False
 except ImportError:
-    from ansible.module_utils.network.f5.bigip import HAS_F5SDK
+    from ansible.module_utils.network.f5.bigip import F5RestClient
-    from ansible.module_utils.network.f5.bigip import F5Client
     from ansible.module_utils.network.f5.common import F5ModuleError
     from ansible.module_utils.network.f5.common import AnsibleF5Parameters
     from ansible.module_utils.network.f5.common import cleanup_tokens
     from ansible.module_utils.network.f5.common import f5_argument_spec
-    try:
+    from ansible.module_utils.network.f5.common import exit_json
-        from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    from ansible.module_utils.network.f5.common import fail_json
-    except ImportError:
-        HAS_F5SDK = False
 
 
 class Parameters(AnsibleF5Parameters):
@@ -110,18 +106,40 @@ class Parameters(AnsibleF5Parameters):
 
     updatables = []
 
+
+class ApiParameters(Parameters):
+    pass
+
+
+class ModuleParameters(Parameters):
+    pass
+
+
+class Changes(Parameters):
     def to_return(self):
         result = {}
         try:
             for returnable in self.returnables:
-                result[returnable] = getattr(self, returnable)
+                change = getattr(self, returnable)
+                if isinstance(change, dict):
+                    result.update(change)
+                else:
+                    result[returnable] = change
             result = self._filter_params(result)
         except Exception:
             pass
         return result
 
 
-class Changes(Parameters):
+class UsableChanges(Changes):
+    pass
+
+
+class ReportableChanges(Changes):
+    pass
+
+
+class Difference(object):
     pass
 
 
@@ -141,22 +159,29 @@ class ModuleManager(object):
         if changed:
             self.changes = Changes(params=changed)
 
+    def _announce_deprecations(self, result):
+        warnings = result.pop('__warnings', [])
+        for warning in warnings:
+            self.module.deprecate(
+                msg=warning['msg'],
+                version=warning['version']
+            )
+
     def exec_module(self):
         changed = False
         result = dict()
         state = self.want.state
 
-        try:
         if state == "present":
             changed = self.present()
         elif state == "absent":
             changed = self.absent()
-        except iControlUnexpectedHTTPError as e:
-            raise F5ModuleError(str(e))
 
-        changes = self.changes.to_return()
+        reportable = ReportableChanges(params=self.changes.to_return())
+        changes = reportable.to_return()
         result.update(**changes)
         result.update(dict(changed=changed))
+        self._announce_deprecations(result)
         return result
 
     def present(self):
@@ -165,15 +190,18 @@ class ModuleManager(object):
         else:
             return self.create()
 
-    def exists(self):
+    def absent(self):
-        parent = self.client.api.tm.cm.device_groups.device_group.load(
+        if self.exists():
-            name=self.want.device_group
+            return self.remove()
-        )
-        exists = parent.devices_s.devices.exists(name=self.want.name)
-        if exists:
-            return True
         return False
 
+    def create(self):
+        self._set_changed_options()
+        if self.module.check_mode:
+            return True
+        self.create_on_device()
+        return True
+
     def remove(self):
         if self.module.check_mode:
             return True
@@ -182,31 +210,54 @@ class ModuleManager(object):
             raise F5ModuleError("Failed to remove the member from the device group.")
         return True
 
-    def create(self):
+    def exists(self):
-        self._set_changed_options()
+        uri = "https://{0}:{1}/mgmt/tm/cm/device-group/{2}/devices/{3}".format(
-        if self.module.check_mode:
+            self.client.provider['server'],
-            return True
+            self.client.provider['server_port'],
-        self.create_on_device()
+            self.want.device_group,
+            self.want.name
+        )
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError:
+            return False
+        if resp.status == 404 or 'code' in response and response['code'] == 404:
+            return False
         return True
 
     def create_on_device(self):
-        parent = self.client.api.tm.cm.device_groups.device_group.load(
+        params = self.changes.api_params()
-            name=self.want.device_group
+        params['name'] = self.want.name
+        params['partition'] = self.want.partition
+        uri = "https://{0}:{1}/mgmt/tm/cm/device-group/{2}/devices/".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            self.want.device_group
         )
-        parent.devices_s.devices.create(name=self.want.name)
+        resp = self.client.api.post(uri, json=params)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
 
-    def absent(self):
+        if 'code' in response and response['code'] in [400, 403]:
-        if self.exists():
+            if 'message' in response:
-            return self.remove()
+                raise F5ModuleError(response['message'])
-        return False
+            else:
+                raise F5ModuleError(resp.content)
 
     def remove_from_device(self):
-        parent = self.client.api.tm.cm.device_groups.device_group.load(
+        uri = "https://{0}:{1}/mgmt/tm/cm/device-group/{2}/devices/{3}".format(
-            name=self.want.device_group
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            self.want.device_group,
+            self.want.name
         )
-        resource = parent.devices_s.devices.load(name=self.want.name)
+        response = self.client.api.delete(uri)
-        if resource:
+        if response.status == 200:
-            resource.delete()
+            return True
+        raise F5ModuleError(response.content)
 
 
 class ArgumentSpec(object):
@@ -218,7 +269,7 @@ class ArgumentSpec(object):
             state=dict(
                 default='present',
                 choices=['absent', 'present']
-            )
+            ),
         )
         self.argument_spec = {}
         self.argument_spec.update(f5_argument_spec)
@@ -232,18 +283,17 @@ def main():
         argument_spec=spec.argument_spec,
         supports_check_mode=spec.supports_check_mode
     )
-    if not HAS_F5SDK:
+
-        module.fail_json(msg="The python f5-sdk module is required")
+    client = F5RestClient(**module.params)
 
     try:
-        client = F5Client(**module.params)
         mm = ModuleManager(module=module, client=client)
         results = mm.exec_module()
         cleanup_tokens(client)
-        module.exit_json(**results)
+        exit_json(module, results, client)
     except F5ModuleError as ex:
         cleanup_tokens(client)
-        module.fail_json(msg=str(ex))
+        fail_json(module, ex, client)
 
 
 if __name__ == '__main__':

test/units/modules/network/f5/test_bigip_device_group_member.py

@@ -8,32 +8,36 @@ __metaclass__ = type
 
 import os
 import json
-import pytest
 import sys
 
 from nose.plugins.skip import SkipTest
 if sys.version_info < (2, 7):
     raise SkipTest("F5 Ansible modules require Python >= 2.7")
 
-from units.compat import unittest
-from units.compat.mock import Mock
-from units.compat.mock import patch
 from ansible.module_utils.basic import AnsibleModule
 
 try:
     from library.modules.bigip_device_group_member import Parameters
     from library.modules.bigip_device_group_member import ModuleManager
     from library.modules.bigip_device_group_member import ArgumentSpec
-    from library.module_utils.network.f5.common import F5ModuleError
+
-    from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    # In Ansible 2.8, Ansible changed import paths.
-    from test.unit.modules.utils import set_module_args
+    from test.units.compat import unittest
+    from test.units.compat.mock import Mock
+    from test.units.compat.mock import patch
+
+    from test.units.modules.utils import set_module_args
 except ImportError:
     try:
         from ansible.modules.network.f5.bigip_device_group_member import Parameters
         from ansible.modules.network.f5.bigip_device_group_member import ModuleManager
         from ansible.modules.network.f5.bigip_device_group_member import ArgumentSpec
-        from ansible.module_utils.network.f5.common import F5ModuleError
+
-        from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
+        # Ansible 2.8 imports
+        from units.compat import unittest
+        from units.compat.mock import Mock
+        from units.compat.mock import patch
+
         from units.modules.utils import set_module_args
     except ImportError:
         raise SkipTest("F5 Ansible modules require the f5-sdk Python library")