feat: add DUT filter and DUT serial number fields in test plans models (#151)

Co-authored-by: Aravindhan Palanisamy <[email protected]>

Author: aravindhan-ni

examples/test_plan/test_plan_templates.py

@@ -29,6 +29,7 @@
         test_program="TP-INT-002",
         estimated_duration_in_seconds=86400,
         system_filter="os:linux AND arch:x64",
+        dut_Filter="modelName = 'cRIO-9045' AND serialNumber = '01E82ED0'",
         execution_actions=[
             ManualExecution(action="boot", type="MANUAL"),
             JobExecution(

examples/test_plan/test_plans.py

@@ -32,8 +32,10 @@
         properties={"env": "staging", "priority": "high"},
         part_number="px40482",
         dut_id="Sample-Dut_Id",
+        dut_serial_number="serial_number_123",
         test_program="TP-Integration-001",
         system_filter="os:linux AND arch:x64",
+        dut_Filter="modelName = 'cRIO-9045' AND serialNumber = '01E82ED0'",
         workspace="your_workspace_id",
         file_ids_from_template=["file1", "file2"],
         dashboard=Dashboard(

nisystemlink/clients/test_plan/models/_create_test_plan_request.py

@@ -12,47 +12,53 @@ class CreateTestPlanRequest(JsonModel):
     name: Optional[str] = None
     """The name of the test plan."""
 
-    template_id: Optional[str] = None
-    """The ID of the template to use for the test plan."""
-
     state: Optional[str] = None
     """The state of the test plan."""
 
+    template_id: Optional[str] = None
+    """The ID of the template to use for the test plan."""
+
     description: Optional[str] = None
     """A description of the test plan."""
 
     assigned_to: Optional[str] = None
     """The user or group assigned to the test plan."""
 
-    work_order_id: Optional[str] = None
-    """The work order ID associated with the test plan."""
-
-    estimated_duration_in_seconds: Optional[int] = None
-    """The estimated duration of the test plan in seconds."""
-
-    properties: Optional[Dict[str, str]] = None
-    """Additional properties for the test plan."""
-
     part_number: Optional[str] = None
     """The part number associated with the test plan."""
 
     dut_id: Optional[str] = None
     """The Device Under Test (DUT) ID."""
 
+    dut_serial_number: Optional[str] = None
+    """The Device Under Test (DUT) serial number."""
+
     test_program: Optional[str] = None
     """The test program associated with the test plan."""
 
+    work_order_id: Optional[str] = None
+    """The work order ID associated with the test plan."""
+
+    estimated_duration_in_seconds: Optional[int] = None
+    """The estimated duration of the test plan in seconds."""
+
     system_filter: Optional[str] = None
     """The system filter to apply."""
 
-    workspace: Optional[str] = None
-    """The workspace associated with the test plan."""
+    dut_filter: Optional[str] = None
+    """The DUT filter to apply."""
+
+    execution_actions: Optional[List[ExecutionDefinition]] = None
+    """List of execution actions for the test plan."""
 
     file_ids_from_template: Optional[List[str]] = None
     """List of file IDs from the template."""
 
+    workspace: Optional[str] = None
+    """The workspace associated with the test plan."""
+
+    properties: Optional[Dict[str, str]] = None
+    """Additional properties for the test plan."""
+
     dashboard: Optional[Dashboard] = None
     """The dashboard associated with the test plan."""
-
-    execution_actions: Optional[List[ExecutionDefinition]] = None
-    """List of execution actions for the test plan."""

nisystemlink/clients/test_plan/models/_query_test_plan_templates_request.py

@@ -29,6 +29,7 @@ class TestPlanTemplateField(str, Enum):
     TEST_PROGRAM = "TEST_PROGRAM"
     ESTIMATED_DURATION_IN_SECONDS = "ESTIMATED_DURATION_IN_SECONDS"
     SYSTEM_FILTER = "SYSTEM_FILTER"
+    DUT_FILTER = "DUT_FILTER"
     EXECUTION_ACTIONS = "EXECUTION_ACTIONS"
     FILE_IDS = "FILE_IDS"
     WORKSPACE = "WORKSPACE"
@@ -60,6 +61,7 @@ class QueryTestPlanTemplatesRequest(WithPaging):
     `testProgram`: String representing the test program name of the test plan created from this
     template.
     `systemFilter`: String representing the LINQ filter used to filter the potential list of systems
+    `dutFilter`: String representing the LINQ filter used to filter the potential list of DUTs
     capable of executing test plans created from this template.
     `workspace`: String representing the workspace where the test plan template belongs.
     `createdBy`: String representing the user who created the test plan template.

nisystemlink/clients/test_plan/models/_query_test_plans_request.py

@@ -20,26 +20,28 @@ class TestPlanField(enum.Enum):
     ASSIGNED_TO = "ASSIGNED_TO"
     WORK_ORDER_ID = "WORK_ORDER_ID"
     WORK_ORDER_NAME = "WORK_ORDER_NAME"
-    WORKSPACE = "WORKSPACE"
-    CREATED_BY = "CREATED_BY"
-    UPDATED_BY = "UPDATED_BY"
-    CREATED_AT = "CREATED_AT"
-    UPDATED_AT = "UPDATED_AT"
-    PROPERTIES = "PROPERTIES"
     PART_NUMBER = "PART_NUMBER"
     DUT_ID = "DUT_ID"
+    DUT_SERIAL_NUMBER = "DUT_SERIAL_NUMBER"
     TEST_PROGRAM = "TEST_PROGRAM"
+    WORKSPACE = "WORKSPACE"
+    CREATED_BY = "CREATED_BY"
+    UPDATED_BY = "UPDATED_BY"
     SYSTEM_ID = "SYSTEM_ID"
     FIXTURE_IDS = "FIXTURE_IDS"
-    SYSTEM_FILTER = "SYSTEM_FILTER"
     PLANNED_START_DATE_TIME = "PLANNED_START_DATE_TIME"
     ESTIMATED_END_DATE_TIME = "ESTIMATED_END_DATE_TIME"
     ESTIMATED_DURATION_IN_SECONDS = "ESTIMATED_DURATION_IN_SECONDS"
+    SYSTEM_FILTER = "SYSTEM_FILTER"
+    DUT_FILTER = "DUT_FILTER"
+    CREATED_AT = "CREATED_AT"
+    UPDATED_AT = "UPDATED_AT"
+    PROPERTIES = "PROPERTIES"
     FILE_IDS_FROM_TEMPLATE = "FILE_IDS_FROM_TEMPLATE"
+    DASHBOARD = "DASHBOARD"
     EXECUTION_ACTIONS = "EXECUTION_ACTIONS"
     EXECUTION_HISTORY = "EXECUTION_HISTORY"
     DASHBOARD_URL = "DASHBOARD_URL"
-    DASHBOARD = "DASHBOARD"
     WORKFLOW = "WORKFLOW"
 
 

nisystemlink/clients/test_plan/models/_test_plan.py

@@ -41,42 +41,33 @@ class TestPlan(JsonModel):
     work_order_name: Optional[str] = None
     """The name of the associated work order."""
 
-    workspace: Optional[str] = None
-    """The workspace to which the test plan belongs."""
-
-    created_by: Optional[str] = None
-    """The user who created the test plan."""
-
-    updated_by: Optional[str] = None
-    """The user who last updated the test plan."""
-
-    created_At: Optional[datetime] = None
-    """The date and time when the test plan was created."""
-
-    updated_at: Optional[datetime] = None
-    """The date and time when the test plan was last updated."""
-
-    properties: Optional[Dict[str, str]] = None
-    """Additional properties associated with the test plan."""
-
     part_number: Optional[str] = None
     """The part number associated with the test plan."""
 
     dut_id: Optional[str] = None
     """The identifier of the device under test (DUT)."""
 
+    dut_serial_number: Optional[str] = None
+    """The serial number of the device under test (DUT)."""
+
     test_program: Optional[str] = None
     """The test program associated with the test plan."""
 
+    workspace: Optional[str] = None
+    """The workspace to which the test plan belongs."""
+
+    created_by: Optional[str] = None
+    """The user who created the test plan."""
+
+    updated_by: Optional[str] = None
+    """The user who last updated the test plan."""
+
     system_id: Optional[str] = None
     """The identifier of the system used for the test plan."""
 
     fixture_ids: Optional[List[str]] = None
     """The list of fixture identifiers associated with the test plan."""
 
-    system_filter: Optional[str] = None
-    """The filter used to select systems for the test plan."""
-
     planned_start_date_time: Optional[datetime] = None
     """The planned start date and time for the test plan."""
 
@@ -86,9 +77,27 @@ class TestPlan(JsonModel):
     estimated_duration_in_seconds: Optional[float] = None
     """The estimated duration of the test plan in seconds."""
 
+    system_filter: Optional[str] = None
+    """The filter used to select systems for the test plan."""
+
+    dut_filter: Optional[str] = None
+    """The filter used to select DUTs for the test plan."""
+
+    created_at: Optional[datetime] = None
+    """The date and time when the test plan was created."""
+
+    updated_at: Optional[datetime] = None
+    """The date and time when the test plan was last updated."""
+
+    properties: Optional[Dict[str, str]] = None
+    """Additional properties associated with the test plan."""
+
     file_ids_from_template: Optional[List[str]] = None
     """The list of file identifiers inherited from the template."""
 
+    dashboard: Optional[DashboardUrl] = None
+    """The dashboard data related to the test plan."""
+
     execution_actions: Optional[List[ExecutionDefinition]] = None
     """The execution actions defined for the test plan."""
 
@@ -97,6 +106,3 @@ class TestPlan(JsonModel):
 
     dashboard_url: Optional[Dict[str, str]] = None
     """The URLs for dashboards related to the test plan."""
-
-    dashboard: Optional[DashboardUrl] = None
-    """The dashboard data related to the test plan."""

nisystemlink/clients/test_plan/models/_test_plan_templates.py

@@ -39,6 +39,11 @@ class TestPlanTemplateBase(JsonModel):
     systems capable of executing test plans created from this template.
     """
 
+    dut_filter: Optional[str] = None
+    """The LINQ filter string is used to filter the potential list of
+    DUTs capable of executing test plans created from this template.
+    """
+
     execution_actions: Optional[List[ExecutionDefinition]] = None
     """Defines the executions that will be used for test plan actions
     created from this template.

tests/integration/test_plan/test_test_plan_client.py

@@ -131,8 +131,10 @@ class TestTestPlanClient:
             properties={"env": "staging", "priority": "high"},
             part_number="px40482",
             dut_id="Sample-Dut_Id",
+            dut_serial_number="Sample-Dut_serial_number",
             test_program="TP-Integration-001",
             system_filter="os:linux AND arch:x64",
+            dut_Filter="modelName = 'cRIO-9045' AND serialNumber = '01E82ED0'",
             workspace=_workspace,
             file_ids_from_template=["file1", "file2"],
             dashboard=_dashboard,
@@ -152,6 +154,7 @@ class TestTestPlanClient:
             test_program="TP-INT-002",
             estimated_duration_in_seconds=86400,
             system_filter="os:linux AND arch:x64",
+            dut_Filter="modelName = 'cRIO-9045' AND serialNumber = '01E82ED0'",
             execution_actions=_execution_actions,
             file_ids=["file1", "file2"],
             workspace=_workspace,
@@ -330,13 +333,15 @@ def test__query_test_plans_with_projections__returns_the_test_plans_with_project
             and test_plan.workspace is None
             and test_plan.created_by is None
             and test_plan.updated_at is None
-            and test_plan.created_At is None
+            and test_plan.created_at is None
             and test_plan.updated_by is None
             and test_plan.properties is None
             and test_plan.part_number is None
             and test_plan.dut_id is None
+            and test_plan.dut_serial_number is None
             and test_plan.test_program is None
             and test_plan.system_filter is None
+            and test_plan.dut_filter is None
             and test_plan.fixture_ids is None
             and test_plan.system_id is None
             and test_plan.planned_start_date_time is None
@@ -459,6 +464,7 @@ def test__query_test_plan_templates_with_projections__returns_test_plan_template
             and test_plan_template.test_program is None
             and test_plan_template.estimated_duration_in_seconds is None
             and test_plan_template.system_filter is None
+            and test_plan_template.dut_filter is None
             and test_plan_template.execution_actions is None
             and test_plan_template.file_ids is None
             and test_plan_template.workspace is None