Fix boolean values in bgprouter example

Author: shivashankar-vaddepally

examples/bgpRouter.yaml renamed to examples/bgprouter.yaml

@@ -5,9 +5,9 @@
   tasks:
     - name: Configure BGP routing
       delegate_to: localhost
-      netscaler.adc.bgpRouter:
+      netscaler.adc.bgprouter:
         state: present
-        localAS: 10
+        localAS: 122
         afParams.addressFamily: "ipv4"
         afParams.redistribute.protocol: "kernel"
         routerId: "10.102.201.219"

meta/runtime.yml

@@ -697,7 +697,7 @@ action_groups:
     - route
     - route6
     - routerdynamicrouting
-    - bgpRouter
+    - bgprouter
     - rsskeytype
     - save_config
     - server

plugins/module_utils/client.py

@@ -18,6 +18,7 @@
 from .constants import (
     HTTP_SUCCESS_CODES,
     NESTED_POST_DATA_RESOURCES,
+    NESTED_POST_DATA_RESOURCES_ALIAS,
 )
 from .decorators import trace
 from .logger import log
@@ -107,7 +108,7 @@ def url_builder(
                 self._module.params["nsip"],
                 self.api_path,
                 "routerDynamicRouting",
-                resource,
+                NESTED_POST_DATA_RESOURCES_ALIAS[resource],
             )
         else:
             url = "%s://%s/%s/%s" % (

plugins/module_utils/common.py

@@ -14,7 +14,8 @@
     HTTP_RESOURCE_NOT_FOUND,
     HTTP_SUCCESS_CODES,
     NESTED_POST_DATA_RESOURCES,
-    GLOBAL_BINDING_ARG_LIST
+    GLOBAL_BINDING_ARG_LIST,
+    NESTED_POST_DATA_RESOURCES_ALIAS,
 )
 from .decorators import trace
 from .logger import log
@@ -96,7 +97,7 @@ def get_resource(client, resource_name, resource_id=None, resource_module_params
     else:
         if resource_name in NESTED_POST_DATA_RESOURCES:
             status_code, response_body = client.get(
-                resource="routerDynamicRouting/%s" % resource_name,
+                resource="routerDynamicRouting/%s" % NESTED_POST_DATA_RESOURCES_ALIAS[resource_name],
                 id=resource_id,
                 args=get_args,
             )
@@ -108,12 +109,15 @@ def get_resource(client, resource_name, resource_id=None, resource_module_params
             )
     if status_code in {HTTP_RESOURCE_NOT_FOUND}:
         return False, []
+    return_response = None
     if status_code in HTTP_SUCCESS_CODES:
         # for zero bindings and some resources, the response_body will be {'errorcode': 0, 'message': 'Done', 'severity': 'NONE'}
         if resource_name in NESTED_POST_DATA_RESOURCES:
             if "routerDynamicRouting" in response_body:
-                 response_body = response_body["routerDynamicRouting"]
-        if resource_name not in response_body:
+                 return_response = response_body["routerDynamicRouting"][NESTED_POST_DATA_RESOURCES_ALIAS[resource_name]]
+            else:
+                return False, []
+        elif resource_name not in response_body:
             if resource_name == "sslcipher":
                 resource_primary_key = NITRO_RESOURCE_MAP[resource_name]["primary_key"]
                 return True, [
@@ -122,32 +126,33 @@ def get_resource(client, resource_name, resource_id=None, resource_module_params
 
             return False, []
 
-        # `update-only` resources return a dict instead of a list.
-        return_response = response_body[resource_name]
+        # `update-only` resources return a dict instead of a list. 
+        if resource_name not in NESTED_POST_DATA_RESOURCES:
+            return_response = response_body[resource_name]
         # FIXME: NITRO-BUG: for some resources like `policypatset_pattern_binding`, NITRO returns keys with uppercase. eg: `String` for `string`.
         # So, we are converting the keys to lowercase.
         # except for `ping` and `traceroute`, all the othe resources returns a keys with lowercase.
         # These `ping` and `traceroute` do not have GET operation. So, we are not handling them here.
-        if isinstance(return_response, dict):
-            return_response = [{k.lower(): v for k, v in return_response.items()}]
-        elif isinstance(return_response, list):
-            return_response = [
-                {k.lower(): v for k, v in resource.items()}
-                for resource in return_response
-            ]
-        else:
-            log(
-                "WARNING: Unexpected response for resource `{}`. Expected a list or a dict, but got: {}".format(
-                    resource_name, return_response
+        if resource_name not in NESTED_POST_DATA_RESOURCES:
+            if isinstance(return_response, dict):
+                return_response = [{k.lower(): v for k, v in return_response.items()}]
+            elif isinstance(return_response, list):
+                return_response = [
+                    {k.lower(): v for k, v in resource.items()}
+                    for resource in return_response
+                ]
+            else:
+                log(
+                    "WARNING: Unexpected response for resource `{}`. Expected a list or a dict, but got: {}".format(
+                        resource_name, return_response
+                    )
                 )
-            )
 
         # Take care of NITRO Anomolies
         return_response = fix_nitro_anomolies(
             resource_name, resource_module_params, return_response
         )
         return (True, return_response)
-    log("pass 3 ")
     return False, []
 
 
@@ -233,26 +238,27 @@ def _check_create_resource_params(resource_name, resource_module_params, action=
     else:
         # TODO: Should we allow non-add keys for the resource? OR should we error out if any non-add key is passed?
         if resource_name in NESTED_POST_DATA_RESOURCES:
-                post_data = {"routerDynamicRouting": {resource_name: {}}}
-                resource_add_keys = NITRO_RESOURCE_MAP[resource_name]["add_payload_keys"]
-                
-                for key in resource_module_params.keys():
-                    if key in resource_add_keys:
-                        keylist = key.split(".")
-                        current_dict = post_data["routerDynamicRouting"][resource_name]
-                        for i, k in enumerate(keylist):
-                            if i == len(keylist) - 1:
-                                current_dict[k] = resource_module_params[key]
-                            else:
-                                if k not in current_dict:
-                                    current_dict[k] = {}
-                                current_dict = current_dict[k]
-                    else:
-                        log(
-                            "WARNING: Key `{}` is not allowed for the resource `{}` for CREATE operation. Skipping the key for the operation".format(
-                                key, resource_name
-                            )
+            resource_add_keys = NITRO_RESOURCE_MAP[resource_name]["add_payload_keys"]
+            resource_name = NESTED_POST_DATA_RESOURCES_ALIAS[resource_name]
+            post_data = {"routerDynamicRouting": {resource_name: {}}}
+            
+            for key in resource_module_params.keys():
+                if key in resource_add_keys:
+                    keylist = key.split(".")
+                    current_dict = post_data["routerDynamicRouting"][resource_name]
+                    for i, k in enumerate(keylist):
+                        if i == len(keylist) - 1:
+                            current_dict[k] = resource_module_params[key]
+                        else:
+                            if k not in current_dict:
+                                current_dict[k] = {}
+                            current_dict = current_dict[k]
+                else:
+                    log(
+                        "WARNING: Key `{}` is not allowed for the resource `{}` for CREATE operation. Skipping the key for the operation".format(
+                            key, resource_name
                         )
+                    )
         else:
             for key in resource_module_params.keys():
                 if not action:

plugins/module_utils/constants.py

@@ -26,7 +26,11 @@
     "sslcertkey": {"password"},
 }
 
-NESTED_POST_DATA_RESOURCES = ["bgpRouter"]
+NESTED_POST_DATA_RESOURCES = ["bgprouter"]
+
+NESTED_POST_DATA_RESOURCES_ALIAS = {
+    "bgprouter": "bgpRouter",
+}
 
 # NITRO accepts some attributes with a name and responsds with a different name in its GET reponse.
 # Eg: For "gslbservice" resource, NITRO expects "ip" in POST request

plugins/module_utils/module_executor.py

@@ -40,6 +40,7 @@
     NITRO_ATTRIBUTES_ALIASES,
     NESTED_POST_DATA_RESOURCES,
     GETALL_ONLY_RESOURCES,
+    NESTED_POST_DATA_RESOURCES_ALIAS,
 )
 from .decorators import trace
 from .logger import log, loglines
@@ -148,7 +149,10 @@ 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)
+        if self.resource_name in NESTED_POST_DATA_RESOURCES:
+            self.client = NitroAPIClient(self.module, NESTED_POST_DATA_RESOURCES_ALIAS[self.resource_name])
+        else:
+            self.client = NitroAPIClient(self.module, self.resource_name)
         have_userpass = all([
             self.module.params.get("nitro_user"),
             self.module.params.get("nitro_pass")
@@ -385,7 +389,45 @@ def is_attribute_equal(
             )
         # By default, compare as string values
         return str(existing_attribute_value) == str(module_params_attribute_value)
+    @trace
+    def is_resource_identical_nested(self):
+        diff_list = []
+
+        def get_nested_value(data, path):
+            cur = data
+            for p in path.split('.'):
+                if isinstance(cur, dict) and p in cur:
+                    cur = cur[p]
+                else:
+                    return None
+            return cur
+
+        for key, desired_value in self.resource_module_params.items():
+            existing_value = get_nested_value(self.existing_resource, key)
 
+            if not self.is_attribute_equal(key, existing_value, desired_value):
+                str_tuple = (
+                    key,
+                    type(existing_value),
+                    existing_value,
+                    type(desired_value),
+                    desired_value,
+                )
+                msg_str = (
+                    "Attribute `%s` differs. Desired: (%s) %s. Existing: (%s) %s"
+                    % str_tuple
+                )
+                diff_list.append(msg_str)
+                log(msg_str)
+
+        if diff_list:
+            self.module_result["diff_list"] = diff_list
+            return False
+        else:
+            self.module_result.pop("diff_list", None)
+            return True
+
+    
     @trace
     def is_resource_identical(self):
         """
@@ -465,7 +507,7 @@ def create_or_update(self):
 
             self.module_result["changed"] = True
             log(
-                "INFO: Resource %s:%s does not exist. Will be CREATED."
+                "INFO: Resource 111 %s:%s does not exist. Will be CREATED."
                 % (
                     self.resource_name,
                     self.resource_id,
@@ -524,8 +566,14 @@ def create_or_update(self):
             # it will remove them from the module_params and update the resource
             # 2. Second iteration will check if the resource is identical. If not, it will update the resource after ignoring the
             # non-updatable resources
-            is_identical, immutable_keys_list = self.is_resource_identical()
+            if self.resource_name in NESTED_POST_DATA_RESOURCES:
+                is_identical = self.is_resource_identical_nested()
+                immutable_keys_list = None
+            else:
+                is_identical, immutable_keys_list = self.is_resource_identical()
+            log(f"is_identical: {is_identical}")
             if is_identical:
+                log("i am here")
                 log(
                     "INFO: Resource `%s:%s` exists and is identical. No change required."
                     % (
@@ -585,8 +633,10 @@ def create_or_update(self):
                     # in case user wants to remove non-updatable params, we will remove them from the module_params
                     for key in immutable_keys_list:
                         self.resource_module_params.pop(key)
-
-                    is_identical, temp_immutable_list = self.is_resource_identical()
+                    if self.resource_name in NESTED_POST_DATA_RESOURCES:
+                        is_identical = self.is_resource_identical_nested()
+                    else:
+                        is_identical, temp_immutable_list = self.is_resource_identical()
                     # temp_immutable_list is a dummy as '_' is not allowed in lint.
                     if is_identical:
                         msg = (
@@ -752,6 +802,7 @@ def update_bindings(
                 )
 
             else:
+                log("i am here 222")
                 log(
                     "INFO: Resource %s:%s's binding %s:%s exists and is identical. No change required."
                     % (

plugins/module_utils/nitro_resource_map.py

@@ -16532,8 +16532,8 @@
         "singleton": False,
         "update_payload_keys": [],
     },
-    "bgpRouter": {
-        "_supported_operations": ["add", "delete", "get"],
+    "bgprouter": {
+        "_supported_operations": ["add", "delete", "get", "unset"],
         "action_payload_keys": {
             "create": [],
             "force": [],