Updates to the f5 module utils (#48428)

Updating module utils to align with functionality in modules

lib/ansible/module_utils/network/f5/bigip.py

@@ -7,7 +7,7 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-import time
+import re
 
 try:
     from f5.bigip import ManagementRoot
@@ -33,72 +33,123 @@ class F5Client(F5BaseClient):
 
     @property
     def api(self):
-        exc = None
         if self._client:
             return self._client
 
-        for x in range(0, 10):
-            try:
-                result = ManagementRoot(
-                    self.provider['server'],
-                    self.provider['user'],
-                    self.provider['password'],
-                    port=self.provider['server_port'],
-                    verify=self.provider['validate_certs'],
-                    token='tmos'
-                )
-                self._client = result
-                return self._client
-            except Exception as ex:
-                exc = ex
-                time.sleep(1)
-        error = 'Unable to connect to {0} on port {1}.'.format(
-            self.provider['server'], self.provider['server_port']
-        )
-
-        if exc is not None:
-            error += ' The reported error was "{0}".'.format(str(exc))
-        raise F5ModuleError(error)
+        try:
+            result = ManagementRoot(
+                self.provider['server'],
+                self.provider['user'],
+                self.provider['password'],
+                port=self.provider['server_port'],
+                verify=self.provider['validate_certs'],
+                token='tmos'
+            )
+            self._client = result
+            return self._client
+        except Exception as ex:
+            error = 'Unable to connect to {0} on port {1}. The reported error was "{2}".'.format(
+                self.provider['server'], self.provider['server_port'], str(ex)
+            )
+            raise F5ModuleError(error)
 
 
 class F5RestClient(F5BaseClient):
     def __init__(self, *args, **kwargs):
         super(F5RestClient, self).__init__(*args, **kwargs)
         self.provider = self.merge_provider_params()
+        self.headers = {
+            'Content-Type': 'application/json'
+        }
 
     @property
     def api(self):
-        exc = None
         if self._client:
             return self._client
-        for x in range(0, 10):
-            try:
-                url = "https://{0}:{1}/mgmt/shared/authn/login".format(
-                    self.provider['server'], self.provider['server_port']
-                )
-                payload = {
-                    'username': self.provider['user'],
-                    'password': self.provider['password'],
-                    'loginProviderName': self.provider['auth_provider'] or 'tmos'
-                }
-                session = iControlRestSession()
-                session.verify = self.provider['validate_certs']
-                response = session.post(url, json=payload)
+        session, err = self.connect_via_token_auth()
+        if err or session is None:
+            session, err = self.connect_via_basic_auth()
+            if err or session is None:
+                raise F5ModuleError(err)
+        self._client = session
+        return session
 
-                if response.status not in [200]:
-                    raise F5ModuleError('Status code: {0}. Unexpected Error: {1} for uri: {2}\nText: {3}'.format(
-                        response.status, response.reason, response.url, response.content
-                    ))
-
-                session.headers['X-F5-Auth-Token'] = response.json()['token']['token']
-                self._client = session
-                return self._client
-            except Exception as ex:
-                exc = ex
-                time.sleep(1)
-        error = 'Unable to connect to {0} on port {1}.'.format(
+    def connect_via_token_auth(self):
+        url = "https://{0}:{1}/mgmt/shared/authn/login".format(
             self.provider['server'], self.provider['server_port']
         )
-        if exc is not None:
-            error += ' The reported error was "{0}".'.format(str(exc))
-        raise F5ModuleError(error)
+        payload = {
+            'username': self.provider['user'],
+            'password': self.provider['password'],
+            'loginProviderName': self.provider['auth_provider'] or 'tmos'
+        }
+        session = iControlRestSession(
+            validate_certs=self.provider['validate_certs']
+        )
+
+        response = session.post(
+            url,
+            json=payload,
+            headers=self.headers
+        )
+
+        if response.status not in [200]:
+            return None, response.content
+
+        session.request.headers['X-F5-Auth-Token'] = response.json()['token']['token']
+        return session, None
+
+    def connect_via_basic_auth(self):
+        url = "https://{0}:{1}/mgmt/tm/sys".format(
+            self.provider['server'], self.provider['server_port']
+        )
+        session = iControlRestSession(
+            url_username=self.provider['user'],
+            url_password=self.provider['password'],
+            validate_certs=self.provider['validate_certs'],
+        )
+
+        response = session.get(
+            url,
+            headers=self.headers
+        )
+
+        if response.status not in [200]:
+            return None, response.content
+        return session, None
+
+    # TODO(This section of code should be developed to support proxy_to)
+    #
+    # def get_identifier(self, proxy_to):
+    #     if re.search(r'([0-9-a-z]+\-){4}[0-9-a-z]+', proxy_to, re.I):
+    #         return proxy_to
+    #     return self.get_device_uuid(proxy_to)
+    #
+    # def get_device_uuid(self, proxy_to):
+    #     uri = "https://{0}:{1}/mgmt/shared/resolver/device-groups/cm-cloud-managed-devices/devices/?$filter=hostname+eq+'{2}'&$select=uuid".format(
+    #         self.provider['server'], self.provider['server_port'], proxy_to
+    #     )
+    #     resp = self.client.api.get(uri)
+    #     try:
+    #         response = resp.json()
+    #     except ValueError as ex:
+    #         raise F5ModuleError(str(ex))
+    #
+    #     if 'code' in response and response['code'] == 400:
+    #         if 'message' in response:
+    #             raise F5ModuleError(response['message'])
+    #         else:
+    #             raise F5ModuleError(resp.content)
+    #
+    #     if len(collection) > 1:
+    #         raise F5ModuleError(
+    #             "More that one managed device was found with this hostname. "
+    #             "'proxy_to' devices must be unique. Consider specifying the UUID of the device."
+    #         )
+    #     elif len(collection) == 0:
+    #         raise F5ModuleError(
+    #             "No device was found with that hostname"
+    #         )
+    #     else:
+    #         resource = collection.pop()
+    #         return resource.pop('uuid', None)