Removes the f5-sdk from bigip_command (#48455)

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

@@ -1,7 +1,7 @@
 #!/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
@@ -101,26 +101,27 @@ options:
 extends_documentation_fragment: f5
 author:
   - Tim Rupp (@caphrim007)
+  - Wojciech Wypior (@wojtek0806)
 '''
 
 EXAMPLES = r'''
 - name: run show version on remote devices
   bigip_command:
     commands: show sys version
-    server: lb.mydomain.com
+    provider:
-    password: secret
+      server: lb.mydomain.com
-    user: admin
+      password: secret
-    validate_certs: no
+      user: admin
   delegate_to: localhost
 
 - name: run show version and check to see if output contains BIG-IP
   bigip_command:
     commands: show sys version
     wait_for: result[0] contains BIG-IP
-    server: lb.mydomain.com
+    provider:
-    password: secret
+      server: lb.mydomain.com
-    user: admin
+      password: secret
-    validate_certs: no
+      user: admin
   register: result
   delegate_to: localhost
 
@@ -129,10 +130,10 @@ EXAMPLES = r'''
     commands:
       - show sys version
       - list ltm virtual
-    server: lb.mydomain.com
+    provider:
-    password: secret
+      server: lb.mydomain.com
-    user: admin
+      password: secret
-    validate_certs: no
+      user: admin
   delegate_to: localhost
 
 - name: run multiple commands and evaluate the output
@@ -143,10 +144,10 @@ EXAMPLES = r'''
     wait_for:
       - result[0] contains BIG-IP
       - result[1] contains my-vs
-    server: lb.mydomain.com
+    provider:
-    password: secret
+      server: lb.mydomain.com
-    user: admin
+      password: secret
-    validate_certs: no
+      user: admin
   register: result
   delegate_to: localhost
 
@@ -155,10 +156,10 @@ EXAMPLES = r'''
     commands:
       - show sys version
       - tmsh list ltm virtual
-    server: lb.mydomain.com
+    provider:
-    password: secret
+      server: lb.mydomain.com
-    user: admin
+      password: secret
-    validate_certs: no
+      user: admin
   delegate_to: localhost
 
 - name: Delete all LTM nodes in Partition1, assuming no dependencies exist
@@ -166,10 +167,10 @@ EXAMPLES = r'''
     commands:
       - delete ltm node all
     chdir: Partition1
-    server: lb.mydomain.com
+    provider:
-    password: secret
+      server: lb.mydomain.com
-    user: admin
+      password: secret
-    validate_certs: no
+      user: admin
   delegate_to: localhost
 '''
 
@@ -209,29 +210,28 @@ from collections import deque
 
 
 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 is_cli
+    from library.module_utils.network.f5.common import fq_name
     from library.module_utils.network.f5.common import f5_argument_spec
-    try:
+    from library.module_utils.network.f5.common import transform_name
-        from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    from library.module_utils.network.f5.common import exit_json
-    except ImportError:
+    from library.module_utils.network.f5.common import fail_json
-        HAS_F5SDK = False
+    from library.module_utils.network.f5.common import is_cli
 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 is_cli
+    from ansible.module_utils.network.f5.common import fq_name
     from ansible.module_utils.network.f5.common import f5_argument_spec
-    try:
+    from ansible.module_utils.network.f5.common import transform_name
-        from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    from ansible.module_utils.network.f5.common import compare_dictionary
-    except ImportError:
+    from ansible.module_utils.network.f5.common import exit_json
-        HAS_F5SDK = False
+    from ansible.module_utils.network.f5.common import fail_json
+    from ansible.module_utils.network.f5.common import is_cli
 
 try:
     from ansible.module_utils.network.f5.common import run_commands
@@ -240,10 +240,6 @@ except ImportError:
     HAS_CLI_TRANSPORT = False
 
 
-if HAS_F5SDK:
-    from f5.sdk_exception import LazyAttributesRequired
-
-
 class NoChangeReporter(object):
     stdout_re = [
         # A general error when a resource already exists
@@ -439,10 +435,7 @@ class BaseManager(object):
     def exec_module(self):
         result = dict()
 
-        try:
+        changed = self.execute()
-            changed = self.execute()
-        except iControlUnexpectedHTTPError as e:
-            raise F5ModuleError(str(e))
 
         result.update(**self.changes.to_return())
         result.update(dict(changed=changed))
@@ -628,22 +621,29 @@ class V2Manager(BaseManager):
 
     def execute_on_device(self, commands):
         responses = []
+        uri = "https://{0}:{1}/mgmt/tm/util/bash".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+        )
         for item in to_list(commands):
             try:
-                command = '-c "{0}"'.format(item['command'])
+                args = dict(
-                output = self.client.api.tm.util.bash.exec_cmd(
+                    command='run',
-                    'run',
+                    utilCmdArgs='-c "{0}"'.format(item['command'])
-                    utilCmdArgs=command
                 )
-                if hasattr(output, 'commandResult'):
+                resp = self.client.api.post(uri, json=args)
-                    output = u'{0}'.format(output.commandResult)
+                response = resp.json()
+                if 'commandResult' in response:
+                    output = u'{0}'.format(response['commandResult'])
                     responses.append(output.strip())
-            except F5ModuleError:
+            except ValueError as ex:
-                raise
+                raise F5ModuleError(str(ex))
-            except LazyAttributesRequired:
+
-                # This can happen if there is no "commandResult" attribute in
+            if 'code' in response and response['code'] == 400:
-                # the output variable above.
+                if 'message' in response:
-                pass
+                    raise F5ModuleError(response['message'])
+                else:
+                    raise F5ModuleError(resp.content)
         return responses
 
 
@@ -714,9 +714,8 @@ def main():
         argument_spec=spec.argument_spec,
         supports_check_mode=spec.supports_check_mode
     )
-    if is_cli(module) and not HAS_F5SDK:
+
-        module.fail_json(msg="The python f5-sdk module is required to use the REST api")
+    client = F5RestClient(**module.params)
-    client = F5Client(**module.params)
 
     try:
         mm = ModuleManager(module=module, client=client)

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

@@ -14,9 +14,6 @@ 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 patch
-from units.compat.mock import Mock
 from ansible.module_utils.basic import AnsibleModule
 
 try:
@@ -25,9 +22,13 @@ try:
     from library.modules.bigip_command import V1Manager
     from library.modules.bigip_command import V2Manager
     from library.modules.bigip_command 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_command import Parameters
@@ -35,8 +36,12 @@ except ImportError:
         from ansible.modules.network.f5.bigip_command import V1Manager
         from ansible.modules.network.f5.bigip_command import V2Manager
         from ansible.modules.network.f5.bigip_command 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")