Merge pull request #552 from netscaler/cleanup

Code cleanup

Author: shivashankar-vaddepally

Makefile

@@ -1,20 +1,20 @@
 fmt:
-	autoflake plugins/modules/*.py
-	autoflake plugins/module_utils/*.py
-	autoflake --recursive tests/
-	autoflake migrationtool/*py
+    autoflake plugins/modules/*.py
+    autoflake plugins/module_utils/*.py
+    autoflake --recursive tests/
+    autoflake tools/migrationtool/*py
 
-	black plugins/modules/*.py
-	black plugins/module_utils/*.py
-	black tests/
-	black migrationtool/*.py
+    black plugins/modules/*.py
+    black plugins/module_utils/*.py
+    black tests/
+    black tools/migrationtool/*.py
 
-	isort plugins/modules/*.py
-	isort plugins/module_utils/*.py
-	isort tests/
-	isort migrationtool/*.py
+    isort plugins/modules/*.py
+    isort plugins/module_utils/*.py
+    isort tests/
+    isort tools/migrationtool/*.py
 
-	yamlfmt .
+    yamlfmt $(shell find . -name '*.yml' -o -name '*.yaml')
 
 install:
 	ansible-galaxy collection install . --force

plugins/module_utils/client.py

@@ -62,25 +62,25 @@ def __init__(self, module, resource_name):
         )
         if netscaler_console_as_proxy:
             if self._module.params.get("managed_netscaler_instance_name"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_NAME"
-                ] = self._module.params.get("managed_netscaler_instance_name")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_NAME"] = (
+                    self._module.params.get("managed_netscaler_instance_name")
+                )
             if self._module.params.get("managed_netscaler_instance_ip"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_IP"
-                ] = self._module.params.get("managed_netscaler_instance_ip")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_IP"] = (
+                    self._module.params.get("managed_netscaler_instance_ip")
+                )
             if self._module.params.get("managed_netscaler_instance_id"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_ID"
-                ] = self._module.params.get("managed_netscaler_instance_id")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_ID"] = (
+                    self._module.params.get("managed_netscaler_instance_id")
+                )
             if self._module.params.get("managed_netscaler_instance_username"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_USERNAME"
-                ] = self._module.params.get("managed_netscaler_instance_username")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_USERNAME"] = (
+                    self._module.params.get("managed_netscaler_instance_username")
+                )
             if self._module.params.get("managed_netscaler_instance_password"):
-                self._headers[
-                    "_MPS_API_PROXY_MANAGED_INSTANCE_PASSWORD"
-                ] = self._module.params.get("managed_netscaler_instance_password")
+                self._headers["_MPS_API_PROXY_MANAGED_INSTANCE_PASSWORD"] = (
+                    self._module.params.get("managed_netscaler_instance_password")
+                )
 
     @trace
     def url_builder(

plugins/module_utils/common.py

@@ -10,10 +10,10 @@
 import re
 
 from .constants import (
+    GLOBAL_BINDING_ARG_LIST,
     HTTP_RESOURCE_ALREADY_EXISTS,
     HTTP_RESOURCE_NOT_FOUND,
     HTTP_SUCCESS_CODES,
-    GLOBAL_BINDING_ARG_LIST
 )
 from .decorators import trace
 from .logger import log

plugins/module_utils/constants.py

@@ -117,37 +117,37 @@
 
 # this list contains globalbindings whose GET call must have query params args=type and filter=get_arg_keys (check in nitro_resource_map)
 GLOBAL_BINDING_ARG_LIST = [
-    'dnsglobal_dnspolicy_binding',
-    'responderglobal_responderpolicy_binding',
-    'contentinspectionglobal_contentinspectionpolicy_binding',
-    'appflowglobal_appflowpolicy_binding',
-    'appfwglobal_auditnslogpolicy_binding',
-    'appfwglobal_auditsyslogpolicy_binding',
-    'appfwglobal_appfwpolicy_binding',
-    'rewriteglobal_rewritepolicy_binding',
-    'transformglobal_transformpolicy_binding',
-    'sslglobal_sslpolicy_binding',
-    'tunnelglobal_tunneltrafficpolicy_binding',
-    'cmpglobal_cmppolicy_binding',
-    'feoglobal_feopolicy_binding',
-    'icaglobal_icapolicy_binding',
-    'lbglobal_lbpolicy_binding',
-    'cacheglobal_cachepolicy_binding',
-    'botglobal_botpolicy_binding',
+    "dnsglobal_dnspolicy_binding",
+    "responderglobal_responderpolicy_binding",
+    "contentinspectionglobal_contentinspectionpolicy_binding",
+    "appflowglobal_appflowpolicy_binding",
+    "appfwglobal_auditnslogpolicy_binding",
+    "appfwglobal_auditsyslogpolicy_binding",
+    "appfwglobal_appfwpolicy_binding",
+    "rewriteglobal_rewritepolicy_binding",
+    "transformglobal_transformpolicy_binding",
+    "sslglobal_sslpolicy_binding",
+    "tunnelglobal_tunneltrafficpolicy_binding",
+    "cmpglobal_cmppolicy_binding",
+    "feoglobal_feopolicy_binding",
+    "icaglobal_icapolicy_binding",
+    "lbglobal_lbpolicy_binding",
+    "cacheglobal_cachepolicy_binding",
+    "botglobal_botpolicy_binding",
 ]
 
 GETALL_ONLY_RESOURCES = [
-    'appfwlearningdata',
-    'application',
-    'bridgetable',
-    'gslbldnsentry',
-    'locationfile',
-    'locationfile6',
-    'routerdynamicrouting',
-    'sslcertbundle',
-    'sslcertfile',
-    'sslcrlfile',
-    'ssldhfile',
-    'sslkeyfile',
-    'systementitydata'
+    "appfwlearningdata",
+    "application",
+    "bridgetable",
+    "gslbldnsentry",
+    "locationfile",
+    "locationfile6",
+    "routerdynamicrouting",
+    "sslcertbundle",
+    "sslcertfile",
+    "sslcrlfile",
+    "ssldhfile",
+    "sslkeyfile",
+    "systementitydata",
 ]

plugins/module_utils/module_executor.py

@@ -35,10 +35,10 @@
 )
 from .constants import (
     ATTRIBUTES_NOT_PRESENT_IN_GET_RESPONSE,
+    GETALL_ONLY_RESOURCES,
     HTTP_RESOURCE_ALREADY_EXISTS,
     NETSCALER_COMMON_ARGUMENTS,
     NITRO_ATTRIBUTES_ALIASES,
-    GETALL_ONLY_RESOURCES,
 )
 from .decorators import trace
 from .logger import log, loglines
@@ -91,9 +91,7 @@ def __init__(self, resource_name, supports_check_mode=True):
             argument_spec=argument_spec,
             supports_check_mode=supports_check_mode,
             mutually_exclusive=[
-                (
-                    "nitro_pass", "nitro_auth_token"
-                ),
+                ("nitro_pass", "nitro_auth_token"),
                 (
                     "managed_netscaler_instance_name",
                     "managed_netscaler_instance_ip",
@@ -148,10 +146,9 @@ def __init__(self, resource_name, supports_check_mode=True):
             self.module.params["api_path"] = "nitro/v2/config"
         self.have_token = self.module.params.get("nitro_auth_token", None)
         self.client = NitroAPIClient(self.module, self.resource_name)
-        have_userpass = all([
-            self.module.params.get("nitro_user"),
-            self.module.params.get("nitro_pass")
-        ])
+        have_userpass = all(
+            [self.module.params.get("nitro_user"), self.module.params.get("nitro_pass")]
+        )
         if have_userpass and not self.module.check_mode:
             self.client._headers.pop("X-NITRO-USER", None)
             self.client._headers.pop("X-NITRO-PASS", None)
@@ -167,13 +164,22 @@ def __init__(self, resource_name, supports_check_mode=True):
 
             else:
                 if self.netscaler_console_as_proxy_server:
-                    self.module.params["nitro_auth_token"] = response["login"][0].get("sessionid", None)
+                    self.module.params["nitro_auth_token"] = response["login"][0].get(
+                        "sessionid", None
+                    )
                 else:
-                    self.module.params["nitro_auth_token"] = response.get("sessionid", None)
+                    self.module.params["nitro_auth_token"] = response.get(
+                        "sessionid", None
+                    )
 
                 if not self.module.params["nitro_auth_token"]:
-                    self.return_failure("ERROR: Login failed. No sessionid returned from the NetScaler ADC")
-                log("INFO: Login successful. Session ID: %s" % self.module.params["nitro_auth_token"])
+                    self.return_failure(
+                        "ERROR: Login failed. No sessionid returned from the NetScaler ADC"
+                    )
+                log(
+                    "INFO: Login successful. Session ID: %s"
+                    % self.module.params["nitro_auth_token"]
+                )
 
                 self.client._headers["Cookie"] = (
                     "NITRO_AUTH_TOKEN=%s" % self.module.params["nitro_auth_token"]
@@ -222,7 +228,11 @@ def return_success(self):
             # }
         if self.resource_name == "login":
             self.module_result["sessionid"] = self.sessionid
-        if self.client._headers.get("Cookie", None) not in (None, "") and not self.module.check_mode and not self.have_token:
+        if (
+            self.client._headers.get("Cookie", None) not in (None, "")
+            and not self.module.check_mode
+            and not self.have_token
+        ):
             ok, response = adc_logout(self.client)
             if not ok:
                 log("ERROR: Logout failed: %s" % response)
@@ -252,7 +262,11 @@ def update_diff_list(self, existing=None, desired=None, delete=False, **kwargs):
 
     @trace
     def return_failure(self, msg):
-        if self.client._headers.get("Cookie", None) not in (None, "") and not self.module.check_mode and not self.have_token:
+        if (
+            self.client._headers.get("Cookie", None) not in (None, "")
+            and not self.module.check_mode
+            and not self.have_token
+        ):
             ok, response = adc_logout(self.client)
             if not ok:
                 log("ERROR: Logout failed: %s" % response)
@@ -445,21 +459,23 @@ def install(self):
     @trace
     def create_or_update(self):
         desired_state = self.module.params["state"]
-        remove_non_updatable_params = self.module.params.get("remove_non_updatable_params", "no")
+        remove_non_updatable_params = self.module.params.get(
+            "remove_non_updatable_params", "no"
+        )
         if (
-            desired_state == "present" and
-            self.resource_name.endswith("_binding") and
-            "state" in self.resource_module_params
+            desired_state == "present"
+            and self.resource_name.endswith("_binding")
+            and "state" in self.resource_module_params
         ):
             self.resource_module_params.pop("state")
         self.update_diff_list(
             existing=self.existing_resource, desired=self.resource_module_params
         )
         if not self.existing_resource and "add" in self.supported_operations:
-            if (
-                self.resource_name.endswith("_binding") and
-                desired_state in {"enabled", "disabled"}
-            ):
+            if self.resource_name.endswith("_binding") and desired_state in {
+                "enabled",
+                "disabled",
+            }:
                 self.resource_module_params["state"] = desired_state.upper()
 
             self.module_result["changed"] = True
@@ -556,9 +572,8 @@ def create_or_update(self):
                         % (self.resource_name, self.resource_id)
                     )
                     self.delete()
-                    if (
-                        self.module.params["state"] == "present" and
-                        any(x in self.supported_operations for x in ("enabled", "disabled"))
+                    if self.module.params["state"] == "present" and any(
+                        x in self.supported_operations for x in ("enabled", "disabled")
                     ):
                         # We want to keep the previous state of the binding
                         self.resource_module_params["state"] = (
@@ -569,7 +584,9 @@ def create_or_update(self):
                     )
                 # Here we are checking if resource has immutable keys
                 # if yes, we will check if the user wants to keep the non-updatable params (which in turn will return error)
-                elif immutable_keys_list is None or (immutable_keys_list and remove_non_updatable_params == "no"):
+                elif immutable_keys_list is None or (
+                    immutable_keys_list and remove_non_updatable_params == "no"
+                ):
                     self.module_result["changed"] = True
                     log(
                         "INFO: Resource %s:%s exists and is different. Will be UPDATED."
@@ -597,18 +614,21 @@ def create_or_update(self):
                         self.module_result["changed"] = False
                         self.module.exit_json(**self.module_result)
                     else:
-                        if (
-                            self.resource_name.endswith("_binding") and
-                            self.module.params["state"] in {"enabled", "disabled"}
-                        ):
-                            existing_state = self.existing_resource.get("state", "").upper()
+                        if self.resource_name.endswith(
+                            "_binding"
+                        ) and self.module.params["state"] in {"enabled", "disabled"}:
+                            existing_state = self.existing_resource.get(
+                                "state", ""
+                            ).upper()
                             if existing_state != desired_state:
                                 # Create the resource in desired state
                                 self.module_result["changed"] = True
                                 self.delete()
                                 self.resource_module_params["state"] = desired_state
                                 ok, err = create_resource(
-                                    self.client, self.resource_name, self.resource_module_params
+                                    self.client,
+                                    self.resource_name,
+                                    self.resource_module_params,
                                 )
                                 if not ok:
                                     self.return_failure(err)
@@ -847,8 +867,10 @@ def sync_single_binding(self, binding_name):
                 self.add_bindings(
                     binding_name=binding_name,
                     desired_bindings=[
-                        x for x in desired_binding_members
-                        if x[get_bindprimary_key(binding_name, x)] in to_be_added_bindprimary_keys
+                        x
+                        for x in desired_binding_members
+                        if x[get_bindprimary_key(binding_name, x)]
+                        in to_be_added_bindprimary_keys
                     ],
                 )
 
@@ -967,9 +989,9 @@ def change_password(self):
                     )
                 else:
                     # set system user USERNAME -password NEW_PASSWORD
-                    self.resource_module_params[
-                        "password"
-                    ] = self.resource_module_params["new_password"]
+                    self.resource_module_params["password"] = (
+                        self.resource_module_params["new_password"]
+                    )
                     ok, err = update_resource(
                         self.client, "systemuser", self.resource_module_params
                     )
@@ -1096,7 +1118,10 @@ def main(self):
                 if "bindings" in NITRO_RESOURCE_MAP[self.resource_name].keys():
                     self.sync_all_bindings()
 
-            elif self.resource_name == "install" and self.module.params["state"] == "installed":
+            elif (
+                self.resource_name == "install"
+                and self.module.params["state"] == "installed"
+            ):
                 self.install()
 
             elif self.module.params["state"] in {

tools/migrationtool/convert_yaml.py

@@ -4,6 +4,7 @@
 # MIT License (see LICENSE or https://opensource.org/licenses/MIT)
 
 import argparse
+
 import yaml
 from utils import (
     netscaler_login_specifics,