Add Template.filter() API method

Add ``Template.create()`` API method

Author: atodorov

docs/source/modules/tcms.rpc.api.rst

@@ -34,6 +34,7 @@ Submodules
    tcms.rpc.api.priority
    tcms.rpc.api.product
    tcms.rpc.api.tag
+   tcms.rpc.api.template
    tcms.rpc.api.testcase
    tcms.rpc.api.testcasestatus
    tcms.rpc.api.testexecution

docs/source/modules/tcms.rpc.api.template.rst

@@ -0,0 +1,7 @@
+tcms.rpc.api.template module
+============================
+
+.. automodule:: tcms.rpc.api.template
+   :members:
+   :show-inheritance:
+   :undoc-members:

tcms/rpc/api/forms/testcase.py

@@ -2,7 +2,7 @@
 
 from tcms.core.forms.fields import UserField
 from tcms.rpc.api.forms import UpdateModelFormMixin
-from tcms.testcases.models import Category, TestCase, TestCaseStatus
+from tcms.testcases.models import Category, Template, TestCase, TestCaseStatus
 
 
 class NewForm(forms.ModelForm):
@@ -32,6 +32,12 @@ class Meta:
         fields = "__all__"
 
 
+class TemplateForm(forms.ModelForm):
+    class Meta:
+        model = Template
+        fields = "__all__"
+
+
 class TestCaseStatusForm(forms.ModelForm):
     class Meta:
         model = TestCaseStatus

tcms/rpc/api/template.py

@@ -0,0 +1,53 @@
+# Copyright (c) 2025 Alexander Todorov <[email protected]>
+#
+# Licensed under the GPL 2.0: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+
+from django.forms.models import model_to_dict
+from modernrpc.core import rpc_method
+
+from tcms.rpc.api.forms.testcase import TemplateForm
+from tcms.rpc.decorators import permissions_required
+from tcms.testcases.models import Template
+
+
+@permissions_required("testcases.view_template")
+@rpc_method(name="Template.filter")
+def filter(query):  # pylint: disable=redefined-builtin
+    """
+    .. function:: RPC Template.filter(query)
+
+        Perform a search and return the resulting list of templates.
+
+        :param query: Field lookups for :class:`tcms.testcases.models.Template`
+        :type query: dict
+        :return: Serialized list of :class:`tcms.testcases.models.Template` objects
+        :rtype: dict
+        :raises PermissionDenied: if missing *testcases.view_template* permission
+    """
+    return list(
+        Template.objects.filter(**query).values("id", "name", "text").distinct()
+    )
+
+
+@permissions_required("testcases.add_template")
+@rpc_method(name="Template.create")
+def create(values):
+    """
+    .. function:: RPC Template.create(values)
+
+        Create a new Template object and store it in the database.
+
+        :param values: Field values for :class:`tcms.testcases.models.Template`
+        :type values: dict
+        :return: Serialized :class:`tcms.testcases.models.Template` object
+        :rtype: dict
+        :raises ValueError: if input values don't validate
+        :raises PermissionDenied: if missing *testcases.add_template* permission
+    """
+    form = TemplateForm(values)
+
+    if form.is_valid():
+        template = form.save()
+        return model_to_dict(template)
+
+    raise ValueError(list(form.errors.items()))

tcms/rpc/tests/test_template.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=attribute-defined-outside-init, invalid-name, objects-update-used
+#
+# Copyright (c) 2025 Alexander Todorov <[email protected]>
+#
+# Licensed under the GPL 2.0: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+
+
+from tcms.rpc.tests.utils import APIPermissionsTestCase
+from tcms.testcases.models import Template
+from tcms.xmlrpc_wrapper import XmlRPCFault
+
+
+class TemplateCreate(APIPermissionsTestCase):
+    permission_label = "testcases.add_template"
+
+    def verify_api_with_permission(self):
+        result = self.rpc_client.Template.create(
+            {
+                "name": "API test",
+                "text": """
+- Method name:
+- Method URL:
+- Input data:
+- Expected result:""",
+            }
+        )
+
+        # verify the serialized result
+        self.assertIn("id", result)
+        self.assertEqual(result["name"], "API test")
+        self.assertIn("Method URL", result["text"])
+
+        # verify the object from the DB
+        template = Template.objects.get(pk=result["id"])
+        self.assertEqual(template.name, result["name"])
+        self.assertEqual(template.text, result["text"])
+
+    def verify_api_without_permission(self):
+        with self.assertRaisesRegex(
+            XmlRPCFault, 'Authentication failed when calling "Template.create"'
+        ):
+            self.rpc_client.Template.create(
+                {
+                    "name": "1-2-3",
+                    "text": """
+1) Do:
+2) Do:
+3) Result should be:""",
+                }
+            )
+
+
+class TestTemplateFilter(APIPermissionsTestCase):
+    permission_label = "testcases.view_template"
+
+    @classmethod
+    def _fixture_setup(cls):
+        super()._fixture_setup()
+
+    def verify_api_with_permission(self):
+        result = self.rpc_client.Template.filter(
+            {
+                "name": "Gherkin syntax",
+            }
+        )[0]
+
+        self.assertIn("id", result)
+        self.assertEqual(result["name"], "Gherkin syntax")
+        self.assertIn("what behavior will be tested", result["text"])
+
+    def verify_api_without_permission(self):
+        with self.assertRaisesRegex(
+            XmlRPCFault, 'Authentication failed when calling "Template.filter"'
+        ):
+            self.rpc_client.Template.filter({})

tcms/settings/common.py

@@ -498,6 +498,7 @@
     "tcms.rpc.api.priority",
     "tcms.rpc.api.product",
     "tcms.rpc.api.tag",
+    "tcms.rpc.api.template",
     "tcms.rpc.api.testcase",
     "tcms.rpc.api.testexecution",
     "tcms.rpc.api.testexecutionstatus",