yum_versionlock: fix idempotency when using wildcard (asterisk) (#2787) (#2896)

* Check idempotency on yum_versionlock

* Lock packages wildcard

* fix formatting

Co-authored-by: Felix Fontein <felix@fontein.de>

* Fix formatting in asserts

* little closer but not still there

* Import fnmatch

* Change check_mode logic

* Add check_mode for add

* Add changelog

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 0a9cf38118)

Co-authored-by: Amin Vakil <info@aminvakil.com>

changelogs/fragments/2787-yum_versionlock-fix_idempotency_when_using_wildcard.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - yum_versionlock - fix idempotency when using wildcard (asterisk) in ``name`` option (https://github.com/ansible-collections/community.general/issues/2761).

plugins/modules/packaging/os/yum_versionlock.py

@@ -76,6 +76,7 @@ state:
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.text.converters import to_native
+from fnmatch import fnmatch
 
 
 class YumVersionLock:
@@ -125,23 +126,23 @@ def main():
     if state in ('present'):
         command = 'add'
         for single_pkg in packages:
-            if single_pkg not in versionlock_packages:
-                if module.check_mode:
-                    changed = True
-                    continue
+            if not any(fnmatch(pkg.split(":", 1)[-1], single_pkg) for pkg in versionlock_packages.split()):
                 packages_list.append(single_pkg)
         if packages_list:
-            changed = yum_v.ensure_state(packages_list, command)
+            if module.check_mode:
+                changed = True
+            else:
+                changed = yum_v.ensure_state(packages_list, command)
     elif state in ('absent'):
         command = 'delete'
         for single_pkg in packages:
-            if single_pkg in versionlock_packages:
-                if module.check_mode:
-                    changed = True
-                    continue
+            if any(fnmatch(pkg, single_pkg) for pkg in versionlock_packages.split()):
                 packages_list.append(single_pkg)
         if packages_list:
-            changed = yum_v.ensure_state(packages_list, command)
+            if module.check_mode:
+                changed = True
+            else:
+                changed = yum_v.ensure_state(packages_list, command)
 
     module.exit_json(
         changed=changed,

tests/integration/targets/yum_versionlock/tasks/main.yml

@@ -29,6 +29,18 @@
             state: present
           register: lock_all_packages
 
+        - name: Lock all packages again
+          community.general.yum_versionlock:
+            name: "{{ yum_updates.results | map(attribute='name') | list }}"
+            state: present
+          register: lock_all_packages_again
+
+        - name: Lock packages wildcard
+          community.general.yum_versionlock:
+            name: "nss*"
+            state: present
+          register: lock_nss_wildcard
+
           # This should fail when it needs user interaction and missing -y is on purpose.
         - name: Update all packages (not really)
           command: yum update --setopt=obsoletes=0
@@ -54,10 +66,12 @@
         - name: Assert everything is fine
           assert:
             that:
-              - "{{ lock_all_packages.changed }}"
-              - "{{ not update_all_locked_packages.changed }}"
-              - "{{ unlock_all_packages.changed }}"
-              - "{{ update_all_packages.changed }}"
+              - lock_all_packages is changed
+              - lock_all_packages_again is not changed
+              - lock_nss_wildcard is not changed
+              - update_all_locked_packages is not changed
+              - unlock_all_packages is changed
+              - update_all_packages is changed
       when: yum_updates.results | length != 0
 
     - name: Remove installed packages in case it was not installed