Add extra parameters check when comparing a config to a spec (#464)

* added check for unsupported parameters

* changed check_extra_params to an instance variable

Author: neiljohn-gh

plugins/module_utils/network/dcnm/dcnm.py

@@ -88,7 +88,33 @@ def validate_ip_address_format(type, item, invalid_params):
             )
 
 
-def validate_list_of_dicts(param_list, spec, module=None):
+def find_extra_params(param_list, spec):
+    """
+    Checks for extra parameters in each dictionary of a list
+    when compared against a specification dictionary.
+
+    Args:
+        param_list: A list of dictionaries containing parameters.
+        spec: A dictionary where keys are the valid parameter names.
+
+    Returns:
+        A list of extra parameters found. If a parameter is found in
+        multiple dictionaries in the list, it will appear multiple
+        times in the result.
+    """
+    invalid_params = []
+    spec_keys = set(spec.keys())
+
+    for params in param_list:
+        param_keys = set(params.keys())
+        extra_keys = param_keys - spec_keys
+        if extra_keys:
+            invalid_params.extend(list(extra_keys))
+
+    return invalid_params
+
+
+def validate_list_of_dicts(param_list, spec, module=None, check_extra_params=False):
     """Validate/Normalize playbook params. Will raise when invalid parameters found.
     param_list: a playbook parameter list of dicts
     spec: an argument spec dict
@@ -99,7 +125,8 @@ def validate_list_of_dicts(param_list, spec, module=None):
     v = validation
     normalized = []
     invalid_params = []
-
+    if check_extra_params:
+        invalid_params = find_extra_params(param_list, spec)
     for list_entry in param_list:
         valid_params_dict = {}
         for param in spec:

plugins/modules/dcnm_network.py

@@ -550,6 +550,8 @@ def __init__(self, module):
         else:
             self.paths = self.dcnm_network_paths[self.dcnm_version]
 
+        self.check_extra_params = True
+
         self.result = dict(changed=False, diff=[], response=[], warnings=[])
 
         self.failed_to_rollback = False
@@ -2620,10 +2622,10 @@ def validate_input(self):
             if self.config:
                 msg = None
                 # Validate net params
-                valid_net, invalid_params = validate_list_of_dicts(self.config, net_spec)
+                valid_net, invalid_params = validate_list_of_dicts(self.config, net_spec, check_extra_params=self.check_extra_params)
                 for net in valid_net:
                     if net.get("attach"):
-                        valid_att, invalid_att = validate_list_of_dicts(net["attach"], att_spec)
+                        valid_att, invalid_att = validate_list_of_dicts(net["attach"], att_spec, check_extra_params=self.check_extra_params)
                         net["attach"] = valid_att
                         invalid_params.extend(invalid_att)
 
@@ -2691,10 +2693,10 @@ def validate_input(self):
             if self.config:
                 msg = None
                 # Validate net params
-                valid_net, invalid_params = validate_list_of_dicts(self.config, net_spec)
+                valid_net, invalid_params = validate_list_of_dicts(self.config, net_spec, check_extra_params=self.check_extra_params)
                 for net in valid_net:
                     if net.get("attach"):
-                        valid_att, invalid_att = validate_list_of_dicts(net["attach"], att_spec)
+                        valid_att, invalid_att = validate_list_of_dicts(net["attach"], att_spec, check_extra_params=self.check_extra_params)
                         net["attach"] = valid_att
                         for attach in net["attach"]:
                             attach["deploy"] = net["deploy"]
@@ -2705,7 +2707,8 @@ def validate_input(self):
                                     msg = "Invalid parameters in playbook: tor_ports configurations are supported only on NDFC"
                                     self.module.fail_json(msg=msg)
 
-                                valid_tor_att, invalid_tor_att = validate_list_of_dicts(attach["tor_ports"], tor_att_spec)
+                                valid_tor_att, invalid_tor_att = validate_list_of_dicts(attach["tor_ports"], tor_att_spec,
+                                                                                        check_extra_params=self.check_extra_params)
                                 attach["tor_ports"] = valid_tor_att
                                 for tor in attach["tor_ports"]:
                                     if tor.get("ports"):