From 009cdc05706aa23e72d910a71cf36c7ec3aad1fe Mon Sep 17 00:00:00 2001
From: Simon Kropf <simon.kropf@protonmail.com>
Date: Tue, 7 Jan 2025 15:43:57 +0100
Subject: [PATCH] add filter support for one_template module

---
 plugins/modules/one_template.py | 45 ++++++++++++++++++++-------------
 1 file changed, 28 insertions(+), 17 deletions(-)

diff --git a/plugins/modules/one_template.py b/plugins/modules/one_template.py
index 28f4f14cd3d..ca17ac13322 100644
--- a/plugins/modules/one_template.py
+++ b/plugins/modules/one_template.py
@@ -50,6 +50,15 @@
     choices: ["present", "absent"]
     default: present
     type: str
+  filter:
+    description:
+      - V(-4) - Resources belonging to the user's primary group
+      - V(-3) - Resources belonging to the user
+      - V(-2) - All resources
+      - V(-1) - Resources belonging to the user and any of his groups
+    choices: [-4, -3, -2, -1]
+    default: -3
+    type: int
 
 extends_documentation_fragment:
   - community.general.opennebula
@@ -156,6 +165,7 @@ def __init__(self):
             name=dict(type='str', required=False),
             state=dict(type='str', choices=['present', 'absent'], default='present'),
             template=dict(type='str', required=False),
+            filter=dict(type='int', required=False, default=-3),
         )
 
         mutually_exclusive = [
@@ -181,10 +191,11 @@ def run(self, one, module, result):
         name = params.get('name')
         desired_state = params.get('state')
         template_data = params.get('template')
+        filter = params.get('filter')
 
         self.result = {}
 
-        template = self.get_template_instance(id, name)
+        template = self.get_template_instance(id, name, filter)
         needs_creation = False
         if not template and desired_state != 'absent':
             if id:
@@ -196,16 +207,16 @@ def run(self, one, module, result):
             self.result = self.delete_template(template)
         else:
             if needs_creation:
-                self.result = self.create_template(name, template_data)
+                self.result = self.create_template(name, template_data, filter)
             else:
-                self.result = self.update_template(template, template_data)
+                self.result = self.update_template(template, template_data, filter)
 
         self.exit()
 
-    def get_template(self, predicate):
-        # -3 means "Resources belonging to the user"
+    def get_template(self, predicate, filter):
+        # filter was included, discussion here: https://github.com/ansible-collections/community.general/issues/9278
         # the other two parameters are used for pagination, -1 for both essentially means "return all"
-        pool = self.one.templatepool.info(-3, -1, -1)
+        pool = self.one.templatepool.info(filter, -1, -1)
 
         for template in pool.VMTEMPLATE:
             if predicate(template):
@@ -213,17 +224,17 @@ def get_template(self, predicate):
 
         return None
 
-    def get_template_by_id(self, template_id):
-        return self.get_template(lambda template: (template.ID == template_id))
+    def get_template_by_id(self, template_id, filter):
+        return self.get_template(lambda template: (template.ID == template_id), filter)
 
-    def get_template_by_name(self, name):
-        return self.get_template(lambda template: (template.NAME == name))
+    def get_template_by_name(self, name, filter):
+        return self.get_template(lambda template: (template.NAME == name), filter)
 
-    def get_template_instance(self, requested_id, requested_name):
+    def get_template_instance(self, requested_id, requested_name, filter):
         if requested_id:
-            return self.get_template_by_id(requested_id)
+            return self.get_template_by_id(requested_id, filter)
         else:
-            return self.get_template_by_name(requested_name)
+            return self.get_template_by_name(requested_name, filter)
 
     def get_template_info(self, template):
         info = {
@@ -238,21 +249,21 @@ def get_template_info(self, template):
 
         return info
 
-    def create_template(self, name, template_data):
+    def create_template(self, name, template_data, filter):
         if not self.module.check_mode:
             self.one.template.allocate("NAME = \"" + name + "\"\n" + template_data)
 
-        result = self.get_template_info(self.get_template_by_name(name))
+        result = self.get_template_info(self.get_template_by_name(name, filter))
         result['changed'] = True
 
         return result
 
-    def update_template(self, template, template_data):
+    def update_template(self, template, template_data, filter):
         if not self.module.check_mode:
             # 0 = replace the whole template
             self.one.template.update(template.ID, template_data, 0)
 
-        result = self.get_template_info(self.get_template_by_id(template.ID))
+        result = self.get_template_info(self.get_template_by_id(template.ID, filter))
         if self.module.check_mode:
             # Unfortunately it is not easy to detect if the template would have changed, therefore always report a change here.
             result['changed'] = True