feat: Add Client for Workorders service Test plans and Test plan template APIs

docs/api_reference.rst

@@ -16,6 +16,7 @@ API Reference
    api_reference/file
    api_reference/notebook
    api_reference/feeds
+   api_reference/test_plan_templates
 
 Indices and tables
 ------------------

docs/api_reference/test_plan_templates.rst

@@ -0,0 +1,16 @@
+.. _api_tag_page:
+
+nisystemlink.clients.test_plan.test_plan_templates
+======================
+
+.. autoclass:: nisystemlink.clients.test_plan.test_plan_templates.TestPlanTemplateClient
+   :exclude-members: __init__
+
+   .. automethod:: __init__
+   .. automethod:: create_test_plan_templates
+   .. automethod:: query_test_plan_templates
+   .. automethod:: delete_test_plan_templates
+
+.. automodule:: nisystemlink.clients.test_plan.test_plan_templates.models
+   :members:
+   :imported-members:

docs/getting_started.rst

@@ -318,5 +318,31 @@ Create, query, update, and delete some notebooks.
 Create, query, retry, and cancel notebook executions.
 
 .. literalinclude:: ../examples/notebook/notebook_execution.py
+   :language: python
+   :linenos:
+
+TestPlanTemplate API
+-------
+
+Overview
+~~~~~~~~
+
+The :class:`.TestPlanTemplateClient` class is the primary entry point of the TestPlanTemplate API.
+
+When constructing a :class:`.TestPlanTemplateClient`, you can pass an
+:class:`.HttpConfiguration` (like one retrieved from the
+:class:`.HttpConfigurationManager`), or let :class:`.TestPlanTemplateClient` use the
+default connection. The default connection depends on your environment.
+
+With a :class:`.TestPlanTemplateClient` object, you can:
+
+* Create, query, and delete TestPlanTemplate
+
+Examples
+~~~~~~~~
+
+Create, query and delete test plan templates.
+
+.. literalinclude:: ../examples/test_plan/test_plan_templates/test_plan_templates.py
    :language: python
    :linenos:

examples/test_plan/test_plan_templates/test_plan_templates.py

@@ -0,0 +1,56 @@
+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._test_plan_templates_client import (
+    TestPlanTemplateClient,
+)
+from nisystemlink.clients.test_plan.test_plan_templates.models._query_test_plan_templates_request import (
+    QueryTestPlanTemplatesRequest,
+)
+from nisystemlink.clients.test_plan.test_plan_templates.models._test_plan_templates import (
+    TestPlanTemplateBase,
+)
+
+# Setup the server configuration to point to your instance of SystemLink Enterprise
+server_configuration = HttpConfiguration(
+    server_uri="https://yourserver.yourcompany.com",
+    api_key="YourAPIKeyGeneratedFromSystemLink",
+)
+client = TestPlanTemplateClient(configuration=server_configuration)
+
+# Test plan template request metadata
+create_test_plan_template_request = [
+    TestPlanTemplateBase(
+        name="Python integration test plan template",
+        templateGroup="sample template group",
+        workspace="33eba2fe-fe42-48a1-a47f-a6669479a8aa",
+        executionActions=[ManualExecution(action="TEST", type="MANUAl")],
+    )
+]
+
+# Create a test plan template
+create_test_plan_template_response = client.create_test_plan_templates(
+    test_plan_templates=create_test_plan_template_request
+)
+
+create_test_plan_template_id = None
+
+if (
+    create_test_plan_template_response.created_test_plan_templates
+    and create_test_plan_template_response.created_test_plan_templates[0].id
+):
+    create_test_plan_template_id = str(
+        create_test_plan_template_response.created_test_plan_templates[0].id
+    )
+
+# Query test plan templates using id
+query_test_plan_template_request = QueryTestPlanTemplatesRequest(
+    filter=f'id="{create_test_plan_template_id}"', take=1
+)
+
+client.query_test_plan_templates(
+    query_test_plan_templates=query_test_plan_template_request
+)
+
+# Delete the created test plan template.
+if create_test_plan_template_id is not None:
+    client.delete_test_plan_templates(ids=[create_test_plan_template_id])

nisystemlink/clients/test_plan/__init__.py

@@ -0,0 +1 @@
+# flake8: noqa

nisystemlink/clients/test_plan/models/__init__.py

@@ -0,0 +1,3 @@
+from ._execution_definition import ExecutionDefinition
+
+# flake8: noqa

nisystemlink/clients/test_plan/models/_execution_definition.py

@@ -0,0 +1,95 @@
+from typing import List, Union
+
+from nisystemlink.clients.core._uplink._json_model import JsonModel
+
+
+class Job(JsonModel):
+    """Represents a job to be executed, including its functions, arguments, and metadata."""
+
+    functions: List[str]
+    """List of function names to execute."""
+
+    arguments: List[List[object]]
+    """List of argument lists for each function."""
+
+    metadata: dict[str, object]
+    """Additional metadata for the job."""
+
+
+class NotebookExecution(JsonModel):
+    """Defines the execution of a notebook."""
+
+    action: str
+    """User defined action to perform in workflow (user defined)."""
+
+    type: str = "NOTEBOOK"
+    """Type of execution, default is 'NOTEBOOK'."""
+
+    notebookId: str
+    """ID of the notebook to execute."""
+
+
+class ManualExecution(JsonModel):
+    """Represents a manual execution definition."""
+
+    action: str
+    """User defined action to perform in workflow (user defined)."""
+
+    type: str = "MANUAL"
+    """Type of execution, default is 'MANUAL'."""
+
+
+class JobExecution(JsonModel):
+    """Defines the execution of one or more jobs."""
+
+    action: str
+    """User defined action to perform in workflow (user defined)."""
+
+    type: str = "JOB"
+    """Type of execution, default is 'JOB'."""
+
+    jobs: List[Job]
+    """List of jobs to execute."""
+
+    systemId: str | None = None
+    """Optional system ID where jobs will run."""
+
+
+class ScheduleExecution(JsonModel):
+    """Represents a scheduled execution definition."""
+
+    action: str
+    """User defined action to perform in workflow (user defined)."""
+
+    type: str = "SCHEDULE"
+    """Type of execution, default is 'SCHEDULE'."""
+
+
+class UnscheduleExecution(JsonModel):
+    """Represents an unscheduled execution definition."""
+
+    action: str
+    """User defined action to perform in workflow (user defined)."""
+
+    type: str = "UNSCHEDULE"
+    """Type of execution, default is 'UNSCHEDULE'."""
+
+
+class NoneExecution(JsonModel):
+    """Represents a definition where no execution is specified."""
+
+    action: str
+    """User defined action to perform in workflow (user defined)."""
+
+    type: str = "None"
+    """Type of execution, default is 'None'."""
+
+
+ExecutionDefinition = Union[
+    NotebookExecution,
+    ManualExecution,
+    JobExecution,
+    NoneExecution,
+    ScheduleExecution,
+    UnscheduleExecution,
+]

nisystemlink/clients/test_plan/test_plan_templates/__init__.py

@@ -0,0 +1,5 @@
+from nisystemlink.clients.test_plan.test_plan_templates._test_plan_templates_client import (
+    TestPlanTemplateClient,
+)
+
+# flake8: noqa

nisystemlink/clients/test_plan/test_plan_templates/_test_plan_templates_client.py

@@ -0,0 +1,110 @@
+"""Implementation of Test plan template Client"""
+
+from typing import List, Optional
+
+from nisystemlink.clients import core
+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
+
+
+@retry(
+    when=retry.when.status(408, 429, 502, 503, 504),
+    stop=retry.stop.after_attempt(5),
+    on_exception=retry.CONNECTION_ERROR,
+)
+class TestPlanTemplateClient(BaseClient):
+    def __init__(self, configuration: Optional[core.HttpConfiguration] = None):
+        """Initialize an instance.
+
+        Args:
+            configuration: Defines the web server to connect to and information about
+                how to connect. If not provided, the
+                :class:`HttpConfigurationManager <nisystemlink.clients.core.HttpConfigurationManager>`
+                is used to obtain the configuration.
+
+        Raises:
+            ApiException: if unable to communicate with the `/niworkorder` Service.
+        """
+        if configuration is None:
+            configuration = core.HttpConfigurationManager.get_configuration()
+        super().__init__(configuration, base_path="/niworkorder/v1/")
+
+    @post("testplan-templates", args=[Field("testPlanTemplates")])
+    def create_test_plan_templates(
+        self, test_plan_templates: List[models.TestPlanTemplateBase]
+    ) -> models.CreateTestPlanTemplatePartialSuccessResponse:
+        """Creates one or more test plan template and return errors for failed creations.
+
+        Args:
+            test_plan_templates: A list of test plan templates to attempt to create.
+
+        Returns: A list of created test plan templates, test plan templates that failed to create, and errors for
+                 failures.
+
+        Raises: ApiException: if unable to communicate with the `/niworkorder` service of provided invalid
+                arguments.
+        """
+        ...
+
+    @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:
+        """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.
+        """
+        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(
+        self, ids: List[str]
+    ) -> Optional[models.DeleteTestPlanTemplatesPartialSuccessResponse]:
+        """Deletes one or more test plan templates and return errors for failed deletion.
+
+        Returns:
+            A partial success if any test plan templates failed to delete, or None if all
+            test plan templates were deleted successfully.
+
+        Raises: ApiException: if unable to communicate with the `/niworkorder` service of provided invalid
+            arguments.
+        """
+        ...

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

@@ -0,0 +1,20 @@
+from nisystemlink.clients.test_plan.test_plan_templates.models._create_test_plan_templates_partial_success_response import (
+    CreateTestPlanTemplatePartialSuccessResponse,
+)
+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 (
+    QueryTestPlanTemplatesResponse,
+)
+from nisystemlink.clients.test_plan.test_plan_templates.models._delete_test_plan_templates_partial_success_response import (
+    DeleteTestPlanTemplatesPartialSuccessResponse,
+)
+from nisystemlink.clients.test_plan.test_plan_templates.models._test_plan_templates import (
+    TestPlanTemplateBase,
+    TestPlanTemplateResponse,
+)
+
+# flake8: noqa

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

@@ -0,0 +1,24 @@
+from typing import List, Optional
+
+from nisystemlink.clients.core._api_error import ApiError
+from nisystemlink.clients.core._uplink._json_model import JsonModel
+
+from ._test_plan_templates import TestPlanTemplateBase, TestPlanTemplateResponse
+
+
+class CreateTestPlanTemplatePartialSuccessResponse(JsonModel):
+
+    created_test_plan_templates: Optional[List[TestPlanTemplateResponse]] = None
+    """The list of test plan templates that were successfully created."""
+
+    failed_test_plan_templates: Optional[List[TestPlanTemplateBase]] = None
+    """The list of test plan templates that were not created.
+
+    If this is `None`, then all test plan templates were successfully created.
+    """
+
+    error: Optional[ApiError] = None
+    """Error messages for test plan templates that were not created.
+
+    If this is `None`, then all test plan templates were successfully created.
+    """