ipahost: Fix idempotence issues with update_dns and multiple objects

When using ipahost with the 'hosts' parameters several parameter
conversion routines were not being performed causing the module to try
to execute tasks it was not suposed to.

This issues were fixed by adapting the module to use EntryFactory.

Another issue was happening when 'update_dns: true' is used with some
parameters, like 'description', 'location' or 'mac_address', where, even
if no change was to be performed the plugin would evaluate that the
arguments were different, and tried to modify the object.

The fix for this issue is to ignore 'updatedns' when comparing the
parameters provided with the existing IPA object.

This modification also fix the case where duplicate entries used with
the 'name' parameter in case 'state: absent' would fail without
indicating the use of duplicate entries.

Fixes: #1296
Fixes: https://issues.redhat.com/browse/RHEL-111063

Signed-off-by: Rafael Guterres Jeffman <rjeffman@redhat.com>

Author: rjeffman

plugins/module_utils/ansible_freeipa_module.py

@@ -537,6 +537,14 @@ def convert_param_value_to_lowercase(value):
     return value
 
 
+def convert_param_value_to_uppercase(value):
+    if isinstance(value, list):
+        value = [v.upper() for v in value]
+    if isinstance(value, (str, unicode)):
+        value = value.upper()
+    return value
+
+
 def module_params_get_with_type_cast(
     module, name, datatype, allow_empty=False
 ):
@@ -1656,6 +1664,10 @@ class EntryFactory:
             not valid, 'fail_json' should be called. The function must return
             the entry, modified or not. The funcion signature is
             'def fn(module:IPAAnsibleModule, entry: Entry) -> Entry:'
+        unique_key: A string or list of strings representing parameter names
+            that uniquely identify an object. When set, the objects are checked
+            for duplicates and a EntryFactory.DuplicateKeyError is raised, when
+            instantiating the EntryFactory object if any duplicate is found.
         **user_vars: any other keyword argument is passed to the
             validate_entry callback as user data.
 
@@ -1693,13 +1705,21 @@ def main():
 
     """
 
+    class DuplicateKeyError(Exception):
+        """An exeption for duplicate keys in EntryFactory."""
+
+        def __init__(self, dups):
+            dups = [k if len(k) > 1 else k[0] for k in dups]
+            super().__init__(", ".join(repr(k) for k in dups))
+
     def __init__(
         self,
         ansible_module,
         invalid_params,
         multiname,
         params,
         validate_entry=None,
+        unique_key=None,
         **user_vars
     ):
         """Initialize the Entry Factory."""
@@ -1714,6 +1734,26 @@ def __init__(
         self.validate_entry = validate_entry
         self.user_vars = user_vars
         self.__entries = self._get_entries()
+        _dups = self.get_duplicate_keys(unique_key)
+        if _dups:
+            raise EntryFactory.DuplicateKeyError(_dups)
+
+    def get_duplicate_keys(self, unique_key):
+        """Get a set of duplicate keys based on the given parameter name(s)."""
+        _dups = set()
+        if unique_key is not None:
+            if isinstance(unique_key, (str, unicode)):  # pylint: disable=all
+                unique_key = [unique_key]
+            _keys = set()
+            for _entry in self.__entries:
+                _key_set = tuple(set(_entry[k] for k in unique_key))
+                if _key_set in _keys:
+                    _dups.add(_key_set)
+                _keys.add(_key_set)
+        return _dups
+
+    def __len__(self):
+        return len(self.__entries)
 
     def __iter__(self):
         """Initialize factory iterator."""