Handle ModuleSoftError in purge.

purge_alias on a referenced alias crashes the module

Author: jiuka

plugins/module_utils/helper/purge.py

@@ -1,4 +1,6 @@
 from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.ansibleguy.opnsense.plugins.module_utils.base.handler import \
+    ModuleSoftError
 
 
 def purge(
@@ -12,17 +14,20 @@ def purge(
         result['diff']['after'][item_to_purge[diff_param]] = None
 
     if not module.check_mode:
-        _obj = obj_func(item_to_purge)
-        _obj.exists = True
+        try:
+            _obj = obj_func(item_to_purge)
+            _obj.exists = True
 
-        if module.params['action'] == 'delete':
-            _obj.delete()
+            if module.params['action'] == 'delete':
+                _obj.delete()
 
-        else:
-            if _obj.b.is_enabled():
-                result['diff']['before'][item_to_purge[diff_param]] = {'enabled': True}
-                result['diff']['after'][item_to_purge[diff_param]] = {'enabled': False}
-                _obj.b.disable()
+            else:
+                if _obj.b.is_enabled():
+                    result['diff']['before'][item_to_purge[diff_param]] = {'enabled': True}
+                    result['diff']['after'][item_to_purge[diff_param]] = {'enabled': False}
+                    _obj.b.disable()
+        except ModuleSoftError:
+            pass
 
 
 def check_purge_filter(module: AnsibleModule, item: dict) -> bool:

tests/alias_purge.yml

@@ -126,6 +126,31 @@
         opn7.data | length != 1
       when: not ansible_check_mode
 
+    - name: Adding 4
+      ansibleguy.opnsense.alias_multi:
+        aliases:
+          ANSIBLE_TEST_4_1:
+            content: ['192.168.1.1', '192.168.1.2']
+          ANSIBLE_TEST_4_2:
+            content: 'ANSIBLE_TEST_4_1'
+      when: not ansible_check_mode
+
+    - name: Purge used alias
+      ansibleguy.opnsense.alias_purge:
+        aliases:
+          ANSIBLE_TEST_4_2:
+      when: not ansible_check_mode
+      register: opn11
+      failed_when: >
+        opn11.failed or
+        'warnings' not in opn11
+
+    - name: Purge using alias first
+      ansibleguy.opnsense.alias_purge:
+        aliases:
+          ANSIBLE_TEST_4_1:
+      when: not ansible_check_mode
+
     - name: Purge ALL - not forced
       ansibleguy.opnsense.alias_purge:
       when: not ansible_check_mode