Support reordering a child template in the Serverless ADR (#377)

This PR is mainly to support reordering a child template in serverless
ADR. It also moves 2 customized exceptions to a common file for both
server and serverless.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Visesh Rajendraprasad <viseshrp@users.noreply.github.com>

Author: 3 people

src/ansys/dynamicreporting/core/exceptions.py

@@ -86,6 +86,14 @@ class MissingReportError(ADRException):
     detail = "Can not find the corresponding report."
 
 
+class TemplateDoesNotExist(ADRException):
+    """Raised when the template is not found"""
+
+
+class TemplateReorderOutOfBounds(ADRException):
+    """Raised when a template is reordered to be out of the size of the children"""
+
+
 """Serverless exceptions."""
 
 

src/ansys/dynamicreporting/core/serverless/template.py

@@ -2,14 +2,13 @@
 from datetime import datetime
 import json
 import os
-from typing import Optional, Tuple
 import uuid
 
 from django.template.loader import render_to_string
 from django.utils import timezone
 
 from ..constants import JSON_ATTR_KEYS
-from ..exceptions import ADRException
+from ..exceptions import ADRException, TemplateDoesNotExist, TemplateReorderOutOfBounds
 from .base import BaseModel, StrEnum
 
 
@@ -408,6 +407,40 @@ def to_json(self, filename: str) -> None:
         # Make the file read-only
         os.chmod(filename, 0o444)
 
+    def reorder_child(self, target_child_template: "Template", new_position: int) -> None:
+        """
+        Reorder the template.guid in parent.children to the specified position.
+
+        Parameters
+        ----------
+        target_child_template : str | TemplateREST
+            The child template to reorder. This can be either the GUID of the template (as a string)
+            or a TemplateREST object.
+        new_position : int
+            The new position in the parent's children list where the template should be placed.
+
+        Raises
+        ------
+        TemplateReorderOutOfBound
+            If the specified position is out of bounds.
+        TemplateDoesNotExist
+            If the target_child_template is not found in the parent's children list.
+        """
+        children_size = len(self.children)
+        if new_position < 0 or new_position >= children_size:
+            raise TemplateReorderOutOfBounds(
+                f"The specified position {new_position} is out of bounds. "
+                f"Valid range: [0, {len(self.children)})"
+            )
+
+        target_guid = target_child_template.guid
+        if target_child_template not in self.children:
+            raise TemplateDoesNotExist(
+                f"Template with GUID '{target_guid}' is not found in the parent's children list."
+            )
+        self.children.remove(target_child_template)
+        self.children.insert(new_position, target_child_template)
+
 
 class Layout(Template):
     def get_column_count(self):

src/ansys/dynamicreporting/core/utils/report_objects.py

@@ -20,7 +20,8 @@
 import dateutil.parser
 import pytz
 
-from . import exceptions, extremely_ugly_hacks, report_utils
+from . import extremely_ugly_hacks, report_utils
+from ..exceptions import TemplateDoesNotExist, TemplateReorderOutOfBounds
 from .encoders import PayloaddataEncoder
 
 try:
@@ -1639,14 +1640,14 @@ def reorder_child(self, target_child_template: str | TemplateREST, new_position:
 
         Raises
         ------
-        TemplateReorderOutOfBoundError
+        TemplateReorderOutOfBound
             If the specified position is out of bounds.
-        ValueError
+        TemplateDoesNotExist
             If the target_child_template is not found in the parent's children list.
         """
         children_size = len(self.children)
         if new_position < 0 or new_position >= children_size:
-            raise exceptions.TemplateReorderOutOfBounds(
+            raise TemplateReorderOutOfBounds(
                 f"The specified position {new_position} is out of bounds. "
                 f"Valid range: [0, {len(self.children)})"
             )
@@ -1658,7 +1659,7 @@ def reorder_child(self, target_child_template: str | TemplateREST, new_position:
         )
 
         if target_guid not in self.children:
-            raise exceptions.TemplateDoesNotExist(
+            raise TemplateDoesNotExist(
                 f"Template with GUID '{target_guid}' is not found in the parent's children list."
             )
         self.children.remove(target_guid)

tests/serverless/test_template.py

@@ -2,7 +2,11 @@
 
 import pytest
 
-from ansys.dynamicreporting.core.exceptions import ADRException
+from ansys.dynamicreporting.core.exceptions import (
+    ADRException,
+    TemplateDoesNotExist,
+    TemplateReorderOutOfBounds,
+)
 
 
 @pytest.mark.ado_test
@@ -1115,3 +1119,40 @@ def test_to_json_non_root_template(adr_serverless):
     # Attempt to call to_json on the child template and expect an ADRException
     with pytest.raises(ADRException, match="Only root templates can be dumped to JSON files."):
         child_template.to_json("dummy_path.json")
+
+
+@pytest.mark.ado_test
+def test_template_reorder_child(adr_serverless):
+    from ansys.dynamicreporting.core.serverless import PanelLayout
+
+    # Create a parent template
+    parent_template = PanelLayout.create(name="ParentTemplate")
+
+    # Create child templates
+    child1 = PanelLayout.create(name="Child1", parent=parent_template)
+    child2 = PanelLayout.create(name="Child2", parent=parent_template)
+    child3 = PanelLayout.create(name="Child3", parent=parent_template)
+
+    # Add children to the parent template
+    parent_template.children = [child1, child2, child3]
+
+    # Reorder child2 to the first position
+    parent_template.reorder_child(child2, 0)
+    assert [child.name for child in parent_template.children] == ["Child2", "Child1", "Child3"]
+
+    # Reorder child3 to the second position
+    parent_template.reorder_child(child3, 1)
+    assert [child.name for child in parent_template.children] == ["Child2", "Child3", "Child1"]
+
+    # Reorder child1 to the last position
+    parent_template.reorder_child(child1, 2)
+    assert [child.name for child in parent_template.children] == ["Child2", "Child3", "Child1"]
+
+    # Test invalid position (out of bounds)
+    with pytest.raises(TemplateReorderOutOfBounds):
+        parent_template.reorder_child(child1, 5)
+
+    # Test invalid child (not in children)
+    invalid_child = PanelLayout.create(name="InvalidChild")
+    with pytest.raises(TemplateDoesNotExist):
+        parent_template.reorder_child(invalid_child, 1)

tests/test_report_objects.py

@@ -4,6 +4,7 @@
 
 import pytest
 
+from ansys.dynamicreporting.core.exceptions import TemplateDoesNotExist, TemplateReorderOutOfBounds
 from ansys.dynamicreporting.core.utils import report_objects as ro
 
 
@@ -393,7 +394,7 @@ def test_templaterest_fields() -> None:
 
 
 @pytest.mark.ado_test
-def test_templaterest_set_order() -> None:
+def test_templaterest_reorder_child() -> None:
     # Create a TemplateREST object
     template = ro.TemplateREST()
     template.children = ["guid1", "guid2", "guid3"]
@@ -415,13 +416,13 @@ def test_templaterest_set_order() -> None:
     # Test invalid position (out of bounds)
     try:
         template.reorder_child("guid1", 5)
-    except ro.exceptions.TemplateReorderOutOfBounds as e:
+    except TemplateReorderOutOfBounds as e:
         assert "out of bounds" in str(e)
 
     # Test invalid GUID (not in children)
     try:
         template.reorder_child("invalid_guid", 1)
-    except ro.exceptions.TemplateDoesNotExist as e:
+    except TemplateDoesNotExist as e:
         assert "not found in the parent's children list" in str(e)