updated implementation

Author: Ammar Husain Mian Fazulul

nisystemlink/clients/test_plan/test_plan_templates/_test_plan_templates_client.py

@@ -3,12 +3,9 @@
 from typing import List, Optional
 
 from nisystemlink.clients import core
-
-from uplink import Field, retry
-
 from nisystemlink.clients.core._uplink._base_client import BaseClient
-
 from nisystemlink.clients.core._uplink._methods import post
+from uplink import Field, retry
 
 from . import models
 
@@ -53,6 +50,18 @@ def create_test_plan_templates(
         ...
 
     @post("query-testplan-templates")
+    def __query_test_plan_templates(
+        self, query_test_plan_templates: models._QueryTestPlanTemplatesRequest
+    ) -> models.QueryTestPlanTemplatesResponse:
+        """Queries one or more test plan templates and return errors for failed queries.
+
+        Returns: A list of test plan templates, based on the query and errors for the wrong query.
+
+        Raises: ApiException: if unable to communicate with the `/niworkorder` service of provided invalid
+                arguments.
+        """
+        ...
+
     def query_test_plan_templates(
         self, query_test_plan_templates: models.QueryTestPlanTemplatesRequest
     ) -> models.QueryTestPlanTemplatesResponse:
@@ -63,7 +72,27 @@ def query_test_plan_templates(
         Raises: ApiException: if unable to communicate with the `/niworkorder` service of provided invalid
                 arguments.
         """
-        ...
+        projection_str = (
+            [projection.name for projection in query_test_plan_templates.projection]
+            if query_test_plan_templates.projection
+            else None
+        )
+        query_params = {
+            "filter": query_test_plan_templates.filter,
+            "take": query_test_plan_templates.take,
+            "substitutions": query_test_plan_templates.substitutions,
+            "continuationToken": query_test_plan_templates.continuation_token,
+            "orderBy": query_test_plan_templates.order_by,
+            "descending": query_test_plan_templates.descending,
+            "projection": projection_str,
+        }
+
+        query_params = {k: v for k, v in query_params.items() if v is not None}
+
+        query_request = models._QueryTestPlanTemplatesRequest(**query_params)
+
+        print(query_request)
+        return self.__query_test_plan_templates(query_test_plan_templates=query_request)
 
     @post("delete-testplan-templates", args=[Field("ids")])
     def delete_test_plan_templates(

nisystemlink/clients/test_plan/test_plan_templates/models/__init__.py

@@ -3,6 +3,7 @@
 )
 from nisystemlink.clients.test_plan.test_plan_templates.models._query_test_plan_templates_request import (
     QueryTestPlanTemplatesRequest,
+    _QueryTestPlanTemplatesRequest,
     TestPlanTemplateField,
 )
 from nisystemlink.clients.test_plan.test_plan_templates.models._query_test_plan_templates_response import (

nisystemlink/clients/test_plan/test_plan_templates/models/_query_test_plan_templates_request.py

@@ -16,21 +16,25 @@ class TestPlanTemplateOrderBy(str, Enum):
 
 
 class TestPlanTemplateField(str, Enum):
-    ID = "id"
-    NAME = "name"
-    TEMPLATE_GROUP = "templateGroup"
-    PRODUCT_FAMILIES = "productFamilies"
-    PART_NUMBERS = "partNumbers"
-    SUMMARY = "summary"
-    DESCRIPTION = "description"
-    TEST_PROGRAM = "testProgram"
-    ESTIMATED_DURATION_IN_SECONDS = "estimatedDurationInSeconds"
-    SYSTEM_FILTER = "systemFilter"
-    EXECUTION_ACTIONS = "executionActions"
-    FILE_IDS = "fileIds"
-    WORKSPACE = "workspace"
-    PROPERTIES = "properties"
-    DASHBOARD = "dashboard"
+    ID = enum.auto()
+    NAME = enum.auto()
+    TEMPLATE_GROUP = enum.auto()
+    PRODUCT_FAMILIES = enum.auto()
+    PART_NUMBERS = enum.auto()
+    SUMMARY = enum.auto()
+    DESCRIPTION = enum.auto()
+    TEST_PROGRAM = enum.auto()
+    ESTIMATED_DURATION_IN_SECONDS = enum.auto()
+    SYSTEM_FILTER = enum.auto()
+    EXECUTION_ACTIONS = enum.auto()
+    FILE_IDS = enum.auto()
+    WORKSPACE = enum.auto()
+    PROPERTIES = enum.auto()
+    DASHBOARD = enum.auto()
+    CREATED_BY = enum.auto()
+    UPDATED_BY = enum.auto()
+    CREATED_AT = enum.auto()
+    UPDATED_AT = enum.auto()
 
 
 class QueryTestPlanTemplatesRequest(JsonModel):
@@ -75,6 +79,14 @@ class QueryTestPlanTemplatesRequest(JsonModel):
     order_by: Optional[TestPlanTemplateOrderBy] = None
     """Field by which test plan templates can be ordered/sorted."""
 
+    substitutions: Optional[List[str]] = None
+    """Makes substitutions in the query filter expression
+    using non-negative integers. These integers
+    use the @ symbol as a prefix. The filter
+    expression replaces each substitution
+    with the element at the corresponding
+    index in this list. The index is zero-based."""
+
     descending: Optional[bool] = None
     """Whether to return the test plan templates in the descending order. By default, test plan
     templates are sorted in the ascending order."""
@@ -141,6 +153,14 @@ class _QueryTestPlanTemplatesRequest(JsonModel):
     order_by: Optional[TestPlanTemplateOrderBy] = None
     """Field by which test plan templates can be ordered/sorted."""
 
+    substitutions: Optional[List[str]] = None
+    """Makes substitutions in the query filter expression
+    using non-negative integers. These integers
+    use the @ symbol as a prefix. The filter
+    expression replaces each substitution
+    with the element at the corresponding
+    index in this list. The index is zero-based."""
+
     descending: Optional[bool] = None
     """Whether to return the test plan templates in the descending order. By default, test plan
     templates are sorted in the ascending order."""
@@ -149,7 +169,7 @@ class _QueryTestPlanTemplatesRequest(JsonModel):
     """Allows users to continue the query at the next test plan templates that matches the given
     criteria."""
 
-    projection: List[str] = []
+    projection: Optional[List[str]] = None
     """
     Gets or sets the projection to be used when retrieving the assets. If not specified,
     all properties will be returned.

nisystemlink/clients/test_plan/test_plan_templates/models/_test_plan_templates.py

@@ -22,10 +22,10 @@ class Dashboard(JsonModel):
 class TestPlanTemplateBase(JsonModel):
     """Contains information about a test plan template."""
 
-    name: str
+    name: str | None
     """Name of the test plan template."""
 
-    template_group: str = None
+    template_group: str | None = None
     """The template group defined by the user."""
 
     product_families: Optional[List[str]] = None
@@ -47,7 +47,7 @@ class TestPlanTemplateBase(JsonModel):
     """The estimated time in seconds for executing the test plan created from this template."""
 
     system_filter: Optional[str] = None
-    """The LINQ filter string is used to filter the potential list of 
+    """The LINQ filter string is used to filter the potential list of
     systems capable of executing test plans created from this template.
     """
 

tests/integration/test_plan/test_plan_templates/test_test_plan_template.py

@@ -1,9 +1,7 @@
 from typing import List
 
 import pytest
-
 from nisystemlink.clients.core._http_configuration import HttpConfiguration
-
 from nisystemlink.clients.test_plan.models._execution_definition import ManualExecution
 from nisystemlink.clients.test_plan.test_plan_templates import TestPlanTemplateClient
 from nisystemlink.clients.test_plan.test_plan_templates.models import (
@@ -44,12 +42,13 @@ def _create_test_plan_templates(
             created_test_plan_templates = (
                 created_test_plan_templates + response.created_test_plan_templates
             )
-        client.delete_test_plan_templates(
-            ids=[
-                test_plan_template.id
-                for test_plan_template in created_test_plan_templates
-            ]
-        )
+    client.delete_test_plan_templates(
+        ids=[
+            test_plan_template.id
+            for test_plan_template in created_test_plan_templates
+            if test_plan_template.id is not None
+        ]
+    )
 
 
 @pytest.mark.integration
@@ -110,15 +109,13 @@ def test__query_test_plan_template__returns_queried_test_plan_template(
 
         assert template_id is not None
 
+        query = QueryTestPlanTemplatesRequest(filter=f'id="{template_id}"', take=1)
+
         query_test_plan_template_response: QueryTestPlanTemplatesResponse = (
-            client.query_test_plan_templates(
-                query_test_plan_templates=QueryTestPlanTemplatesRequest(
-                    filter=f'id="{template_id}"', take=1
-                )
-            )
+            client.query_test_plan_templates(query_test_plan_templates=query)
         )
 
-        assert len(query_test_plan_template_response.test_plan_templates) == 1
+        assert len(query_test_plan_template_response.test_plan_templates) == 1, query
         assert (
             query_test_plan_template_response.test_plan_templates[0].id == template_id
         )
@@ -166,6 +163,7 @@ def test_query_test_plan_templates_with_projections__returns_test_plan_templates
         query = QueryTestPlanTemplatesRequest(
             projection=[TestPlanTemplateField.ID, TestPlanTemplateField.NAME],
         )
+        print(query)
         response = client.query_test_plan_templates(query_test_plan_templates=query)
 
         assert response is not None