Merge pull request #486 from netscaler/rresources

Handling non-updatable attributes while updating a resource

Author: shivashankar-vaddepally

plugins/module_utils/module_executor.py

@@ -361,13 +361,9 @@ def is_resource_identical(self):
         if not self.module_result["diff_list"]:
             del self.module_result["diff_list"]
         if immutable_resource_module_params != []:
-            msg = (
-                "Cannot change value for the following non-updateable attributes %s"
-                % immutable_resource_module_params
-            )
-            self.return_failure(msg)
+            return (False, immutable_resource_module_params)
 
-        return False if diff_list else True
+        return (False, None) if diff_list else (True, None)
 
     @trace
     def create_or_update(self):
@@ -430,8 +426,13 @@ def create_or_update(self):
                 self.resource_module_params["sitename"] = sitename
 
         else:
-            # Update only if resource is not identical (idempotent)
-            if self.is_resource_identical():
+            # Update process will go through 2 iterations of is_resource_identical
+            # 1. First iteration will check if the resource is identical. If not, it will give the list of non-updatable attributes that exists
+            # in the user playbook. If non-updatable attributes are present, 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 is_identical:
                 log(
                     "INFO: Resource `%s:%s` exists and is identical. No change required."
                     % (
@@ -451,19 +452,46 @@ def create_or_update(self):
                     ok, err = create_resource(
                         self.client, self.resource_name, self.resource_module_params
                     )
-                else:
+
+                elif immutable_keys_list is None:
+                    self.module_result["changed"] = True
                     log(
-                        "INFO: Resource %s:%s exists. Will be UPDATED."
-                        % (
-                            self.resource_name,
-                            self.resource_id,
-                        )
+                        "INFO: Resource %s:%s exists and is different. Will be UPDATED."
+                        % (self.resource_name, self.resource_id)
                     )
                     ok, err = update_resource(
                         self.client, self.resource_name, self.resource_module_params
                     )
-                if not ok:
-                    self.return_failure(err)
+                    if not ok:
+                        self.return_failure(err)
+                else:
+                    for key in immutable_keys_list:
+                        self.resource_module_params.pop(key)
+
+                    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 = (
+                            f"Resource {self.resource_name}/{self.resource_id} not updated because user is trying to "
+                            f"update following non-updatable keys: {immutable_keys_list}"
+                        )
+                        self.module.warn(msg)
+                        log(msg)
+                        self.module_result["changed"] = False
+                        self.module.exit_json(**self.module_result)
+                    else:
+                        self.module_result["changed"] = True
+                        msg = (
+                            f"Resource {self.resource_name}/{self.resource_id} is updated after ignoring following "
+                            f"non-updatable keys: {immutable_keys_list}"
+                        )
+                        self.module.warn(msg)
+                        log(msg)
+                        ok, err = update_resource(
+                            self.client, self.resource_name, self.resource_module_params
+                        )
+                        if not ok:
+                            self.return_failure(err)
 
     @trace
     def enable_or_disable(self, desired_state):