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

docs/api_reference.rst

@@ -18,6 +18,7 @@ API Reference
    api_reference/feeds
    api_reference/assetmanagement
    api_reference/systems
+   api_reference/test_plan
 
 Indices and tables
 ------------------

docs/api_reference/test_plan.rst

@@ -0,0 +1,22 @@
+.. _api_tag_page:
+
+nisystemlink.clients.test_plan
+======================
+
+.. autoclass:: nisystemlink.clients.test_plan.TestPlanClient
+   :exclude-members: __init__
+
+   .. automethod:: __init__
+   .. automethod:: create_test_plans
+   .. automethod:: delete_test_plans
+   .. automethod:: query_test_plans
+   .. automethod:: schedule_test_plans
+   .. automethod:: update_test_plans
+   .. automethod:: get_test_plan
+   .. automethod:: create_test_plan_templates
+   .. automethod:: query_test_plan_templates
+   .. automethod:: delete_test_plan_templates
+
+.. automodule:: nisystemlink.clients.test_plan.models
+   :members:
+   :imported-members:

docs/getting_started.rst

@@ -372,3 +372,36 @@ Create, query, and remove some systems.
 .. literalinclude:: ../examples/systems/systems.py
    :language: python
    :linenos:
+
+TestPlan API
+-------
+
+Overview
+~~~~~~~~
+
+The :class:`.TestPlanClient` class is the primary entry point of the TestPlan API.
+
+When constructing a :class:`.TestPlanClient`, you can pass an
+:class:`.HttpConfiguration` (like one retrieved from the
+:class:`.HttpConfigurationManager`), or let :class:`.TestPlanClient` use the
+default connection. The default connection depends on your environment.
+
+With a :class:`.TestPlanClient` object, you can:
+
+* Create, query, get, update, schedule and delete TestPlans
+* Create, query and delete test plan templates
+
+Examples
+~~~~~~~~
+
+Create, query, get, update, schedule and delete TestPlans
+
+.. literalinclude:: ../examples/test_plan/test_plans.py
+   :language: python
+   :linenos:
+
+Create, query and delete test plan templates.
+
+.. literalinclude:: ../examples/test_plan/test_plan_templates.py
+   :language: python
+   :linenos:

examples/test_plan/test_plan_templates.py

@@ -0,0 +1,82 @@
+from nisystemlink.clients.core._http_configuration import HttpConfiguration
+from nisystemlink.clients.test_plan import TestPlanClient
+from nisystemlink.clients.test_plan.models import (
+    CreateTestPlanTemplateRequest,
+    Dashboard,
+    Job,
+    JobExecution,
+    ManualExecution,
+    QueryTestPlanTemplatesRequest,
+)
+
+
+# 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 = TestPlanClient(configuration=server_configuration)
+
+# Test plan template request metadata
+create_test_plan_template_request = [
+    CreateTestPlanTemplateRequest(
+        name="Python integration test plan template",
+        template_group="sample template group",
+        product_families=["FamilyA", "FamilyB"],
+        part_numbers=["PN-1001", "PN-1002"],
+        summary="Template for running integration test plans",
+        description="This template defines execution steps for integration workflows.",
+        test_program="TP-INT-002",
+        estimated_duration_in_seconds=86400,
+        system_filter="os:linux AND arch:x64",
+        execution_actions=[
+            ManualExecution(action="boot", type="MANUAL"),
+            JobExecution(
+                action="run",
+                type="JOB",
+                jobs=[
+                    Job(
+                        functions=["run_test_suite"],
+                        arguments=[["test_suite.py"]],
+                        metadata={"env": "staging"},
+                    )
+                ],
+                systemId="system-001",
+            ),
+        ],
+        file_ids=["file1", "file2"],
+        workspace="your_workspace_id",
+        properties={"env": "staging", "priority": "high"},
+        dashboard=Dashboard(
+            id="DashBoardId", variables={"product": "PXIe-4080", "location": "Lab1"}
+        ),
+    )
+]
+
+# 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])

examples/test_plan/test_plans.py

@@ -0,0 +1,108 @@
+from datetime import datetime
+
+from nisystemlink.clients.core._http_configuration import HttpConfiguration
+from nisystemlink.clients.test_plan import TestPlanClient
+from nisystemlink.clients.test_plan.models import (
+    CreateTestPlanRequest,
+    Dashboard,
+    Job,
+    JobExecution,
+    ManualExecution,
+    QueryTestPlansRequest,
+    ScheduleTestPlanRequest,
+    ScheduleTestPlansRequest,
+    UpdateTestPlanRequest,
+    UpdateTestPlansRequest,
+)
+
+# 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 = TestPlanClient(configuration=server_configuration)
+
+create_test_plans_request = [
+    CreateTestPlanRequest(
+        name="Python integration test plan",
+        state="NEW",
+        description="Test plan for verifying integration flow",
+        assigned_to="test.user@example.com",
+        estimated_duration_in_seconds=86400,
+        properties={"env": "staging", "priority": "high"},
+        part_number="px40482",
+        dut_id="Sample-Dut_Id",
+        test_program="TP-Integration-001",
+        system_filter="os:linux AND arch:x64",
+        workspace="your_workspace_id",
+        file_ids_from_template=["file1", "file2"],
+        dashboard=Dashboard(
+            id="DashBoardId", variables={"product": "PXIe-4080", "location": "Lab1"}
+        ),
+        execution_actions=[
+            ManualExecution(action="boot", type="MANUAL"),
+            JobExecution(
+                action="run",
+                type="JOB",
+                jobs=[
+                    Job(
+                        functions=["run_test_suite"],
+                        arguments=[["test_suite.py"]],
+                        metadata={"env": "staging"},
+                    )
+                ],
+                systemId="system-001",
+            ),
+        ],
+    )
+]
+
+# create a test plan
+created_test_plans_response = client.create_test_plans(
+    test_plans=create_test_plans_request
+)
+
+if created_test_plans_response.created_test_plans:
+    created_test_plan_id = created_test_plans_response.created_test_plans[0].id
+
+# Query test plan using id.
+query_test_plans_request = QueryTestPlansRequest(
+    skip=0, take=1, descending=False, returnCount=False
+)
+client.query_test_plans(query_request=query_test_plans_request)
+
+# Get test plan
+get_test_plan = client.get_test_plan(test_plan_id=created_test_plan_id)
+
+# Update test plan
+update_test_plans_request = UpdateTestPlansRequest(
+    test_plans=[
+        UpdateTestPlanRequest(
+            id=created_test_plan_id,
+            name="Updated Test Plan",
+        )
+    ]
+)
+updated_test_plan = client.update_test_plans(update_request=update_test_plans_request)
+
+# Schedule the test plan
+schedule_test_plans_request = ScheduleTestPlansRequest(
+    test_plans=[
+        ScheduleTestPlanRequest(
+            id=created_test_plan_id,
+            planned_start_date_time=datetime.strptime(
+                "2025-05-20T15:07:42.527Z", "%Y-%m-%dT%H:%M:%S.%fZ"
+            ),
+            estimated_end_date_time=datetime.strptime(
+                "2025-05-22T15:07:42.527Z", "%Y-%m-%dT%H:%M:%S.%fZ"
+            ),
+            system_id="fake-system",
+        )
+    ]
+)
+schedule_test_plan_response = client.schedule_test_plans(
+    schedule_request=schedule_test_plans_request
+)
+
+# Delete test plan
+client.delete_test_plans(ids=[created_test_plan_id])

nisystemlink/clients/test_plan/__init__.py

@@ -0,0 +1,3 @@
+from ._test_plan_client import TestPlanClient
+
+# flake8: noqa