Skip to content

Commit 82de1be

Browse files
author
Aravindhan Palanisamy
committed
update comment
1 parent 2231a4a commit 82de1be

20 files changed

+236
-489
lines changed

‎examples/test_plan/test_plan_templates.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
CreateTestPlanTemplateRequest(
1919
name="Python integration test plan template",
2020
template_group="sample template group",
21-
workspace="33eba2fe-fe42-48a1-a47f-a6669479a8aa",
21+
workspace="YourWorksapceId",
2222
)
2323
]
2424

‎examples/test_plan/test_plans.py‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
from nisystemlink.clients.test_plan import TestPlanClient
33
from nisystemlink.clients.test_plan.models import (
44
CreateTestPlanRequest,
5-
CreateTestPlansRequest,
6-
DeleteTestPlansRequest,
75
QueryTestPlansRequest,
86
ScheduleTestPlanRequest,
97
ScheduleTestPlansRequest,
@@ -18,17 +16,15 @@
1816
)
1917
client = TestPlanClient(configuration=server_configuration)
2018

21-
create_test_plans_request = CreateTestPlansRequest(
22-
test_plans=[
23-
CreateTestPlanRequest(
24-
name="Python integration test plan", state="NEW", partNumber="px40482"
25-
)
26-
]
27-
)
19+
create_test_plans_request = [
20+
CreateTestPlanRequest(
21+
name="Python integration test plan", state="NEW", partNumber="px40482"
22+
)
23+
]
2824

2925
# create a test plan
3026
created_test_plans_response = client.create_test_plans(
31-
create_request=create_test_plans_request
27+
test_plans=create_test_plans_request
3228
)
3329

3430
if created_test_plans_response.created_test_plans:
@@ -73,4 +69,4 @@
7369
)
7470

7571
# Delete test plan
76-
client.delete_test_plans(ids=DeleteTestPlansRequest(ids=[created_test_plan_id]))
72+
client.delete_test_plans(ids=[created_test_plan_id])

‎nisystemlink/clients/test_plan/_test_plan_client.py‎

Lines changed: 7 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ def get_test_plan(self, test_plan_id: str) -> models.TestPlan:
4343
"""
4444
...
4545

46-
@post("testplans")
46+
@post("testplans", args=[Field("testPlans")])
4747
def create_test_plans(
48-
self, create_request: models.CreateTestPlansRequest
49-
) -> models.CreateTestPlansResponse:
48+
self, test_plans: List[models.CreateTestPlanRequest]
49+
) -> models.CreateTestPlansPartialSuccessResponse:
5050
"""Create a new test plan.
5151
5252
Args:
@@ -57,8 +57,8 @@ def create_test_plans(
5757
"""
5858
...
5959

60-
@post("delete-testplans")
61-
def delete_test_plans(self, ids: models.DeleteTestPlansRequest) -> None:
60+
@post("delete-testplans", args=[Field("ids")])
61+
def delete_test_plans(self, ids: List[str]) -> None:
6262
"""Delete test plans by IDs.
6363
6464
Args:
@@ -70,19 +70,6 @@ def delete_test_plans(self, ids: models.DeleteTestPlansRequest) -> None:
7070
...
7171

7272
@post("query-testplans")
73-
def __query_test_plans(
74-
self, query_request: models._QueryTestPlansRequest
75-
) -> models.PagedTestPlans:
76-
"""Query test plans.
77-
78-
Args:
79-
query: The query to execute.
80-
81-
Returns:
82-
A PagedTestPlans object containing test plans that match the query.
83-
"""
84-
...
85-
8673
def query_test_plans(
8774
self, query_request: models.QueryTestPlansRequest
8875
) -> models.PagedTestPlans:
@@ -94,26 +81,7 @@ def query_test_plans(
9481
Returns:
9582
A PagedTestPlans object containing test plans that match the query.
9683
"""
97-
projection_str = (
98-
[projection.name for projection in query_request.projection]
99-
if query_request.projection
100-
else None
101-
)
102-
query_params = {
103-
"filter": query_request.filter,
104-
"take": query_request.take,
105-
"continuation_token": query_request.continuation_token,
106-
"order_by": query_request.order_by,
107-
"descending": query_request.descending,
108-
"return_count": query_request.return_count,
109-
"projection": projection_str,
110-
}
111-
112-
query_params = {k: v for k, v in query_params.items() if v is not None}
113-
114-
query_test_plans_request = models._QueryTestPlansRequest(**query_params)
115-
116-
return self.__query_test_plans(query_request=query_test_plans_request)
84+
...
11785

11886
@post("schedule-testplans")
11987
def schedule_test_plans(
@@ -161,18 +129,6 @@ def create_test_plan_templates(
161129
...
162130

163131
@post("query-testplan-templates")
164-
def __query_test_plan_templates(
165-
self, query_test_plan_templates: models._QueryTestPlanTemplatesRequest
166-
) -> models.PagedTestPlanTemplates:
167-
"""Queries one or more test plan templates and return errors for failed queries.
168-
169-
Returns: A list of test plan templates, based on the query and errors for the wrong query.
170-
171-
Raises: ApiException: if unable to communicate with the `/niworkorder` service of provided invalid
172-
arguments.
173-
"""
174-
...
175-
176132
def query_test_plan_templates(
177133
self, query_test_plan_templates: models.QueryTestPlanTemplatesRequest
178134
) -> models.PagedTestPlanTemplates:
@@ -183,26 +139,7 @@ def query_test_plan_templates(
183139
Raises: ApiException: if unable to communicate with the `/niworkorder` service of provided invalid
184140
arguments.
185141
"""
186-
projection_str = (
187-
[projection.name for projection in query_test_plan_templates.projection]
188-
if query_test_plan_templates.projection
189-
else None
190-
)
191-
query_params = {
192-
"filter": query_test_plan_templates.filter,
193-
"take": query_test_plan_templates.take,
194-
"substitutions": query_test_plan_templates.substitutions,
195-
"continuationToken": query_test_plan_templates.continuation_token,
196-
"orderBy": query_test_plan_templates.order_by,
197-
"descending": query_test_plan_templates.descending,
198-
"projection": projection_str,
199-
}
200-
201-
query_params = {k: v for k, v in query_params.items() if v is not None}
202-
203-
query_request = models._QueryTestPlanTemplatesRequest(**query_params)
204-
205-
return self.__query_test_plan_templates(query_test_plan_templates=query_request)
142+
...
206143

207144
@post("delete-testplan-templates", args=[Field("ids")])
208145
def delete_test_plan_templates(

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

Lines changed: 19 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,24 @@
1-
from ._create_test_plan_request import (
2-
CreateTestPlanRequest,
3-
)
4-
from ._create_test_plans_request import (
5-
CreateTestPlansRequest,
6-
)
7-
from ._create_test_plans_response import (
8-
CreateTestPlansResponse,
9-
)
10-
from ._delete_test_plans_request import (
11-
DeleteTestPlansRequest,
12-
)
13-
from ._update_test_plan_request import (
14-
UpdateTestPlanRequest,
15-
)
16-
from ._update_test_plans_request import (
17-
UpdateTestPlansRequest,
18-
)
19-
from ._update_test_plans_response import (
20-
UpdateTestPlansResponse,
21-
)
22-
from ._query_test_plans_request import (
23-
QueryTestPlansRequest,
24-
_QueryTestPlansRequest,
25-
)
1+
from ._create_test_plan_request import CreateTestPlanRequest
2+
from ._create_test_plans_partial_success_response import (
3+
CreateTestPlansPartialSuccessResponse,
4+
)
5+
from ._dashboard import Dashboard, DashboardUrl
6+
from ._update_test_plan_request import UpdateTestPlanRequest
7+
from ._update_test_plans_request import UpdateTestPlansRequest
8+
from ._update_test_plans_response import UpdateTestPlansResponse
9+
from ._query_test_plans_request import QueryTestPlansRequest, TestPlanField
2610
from ._paged_test_plans import PagedTestPlans
2711
from ._execution_event import ExecutionEvent
2812
from ._order_by import OrderBy
2913
from ._test_plan import TestPlan
3014
from ._state import State
31-
from ._execution_definition import (
32-
ExecutionDefinition,
33-
)
34-
from ._schedule_test_plans_request import (
35-
ScheduleTestPlansRequest,
36-
)
37-
from ._schedule_test_plan_request import (
38-
ScheduleTestPlanRequest,
39-
)
40-
from ._schedule_test_plans_response import (
41-
ScheduleTestPlansResponse,
42-
)
43-
from ._workflow_definition import (
44-
WorkflowDefinition,
45-
)
46-
from ._test_plan_templates import (
47-
TestPlanTemplateBase,
48-
TestPlanTemplate,
49-
)
15+
from ._execution_definition import ExecutionDefinition
16+
from ._schedule_test_plans_request import ScheduleTestPlansRequest
17+
from ._schedule_test_plan_request import ScheduleTestPlanRequest
18+
from ._schedule_test_plans_response import ScheduleTestPlansResponse
19+
from ._workflow_definition import WorkflowDefinition
20+
21+
from ._test_plan_templates import TestPlanTemplateBase, TestPlanTemplate
5022
from ._create_test_plan_templates_partial_success_response import (
5123
CreateTestPlanTemplatePartialSuccessResponse,
5224
)
@@ -55,13 +27,9 @@
5527
)
5628
from ._query_test_plan_templates_request import (
5729
QueryTestPlanTemplatesRequest,
58-
_QueryTestPlanTemplatesRequest,
59-
)
60-
from ._paged_test_plan_templates import (
61-
PagedTestPlanTemplates,
62-
)
63-
from ._create_test_plan_template_request import (
64-
CreateTestPlanTemplateRequest,
30+
TestPlanTemplateField,
6531
)
32+
from ._paged_test_plan_templates import PagedTestPlanTemplates
33+
from ._create_test_plan_template_request import CreateTestPlanTemplateRequest
6634

6735
# flake8: noqa

‎nisystemlink/clients/test_plan/models/_create_test_plan_request.py‎

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,10 @@
22

33
from nisystemlink.clients.core._uplink._json_model import JsonModel
44

5+
from ._dashboard import Dashboard
56
from ._execution_definition import ExecutionDefinition
67

78

8-
class Dashboard(JsonModel):
9-
"""Represents a dashboard reference."""
10-
11-
id: Optional[str] = None
12-
"""ID of the dashboard"""
13-
14-
variables: Optional[Dict[str, str]] = None
15-
"""Variables for the dashboard"""
16-
17-
189
class CreateTestPlanRequest(JsonModel):
1910
"""Represents the request body content for creating a test plan."""
2011

@@ -51,7 +42,7 @@ class CreateTestPlanRequest(JsonModel):
5142
test_program: Optional[str] = None
5243
"""The test program associated with the test plan."""
5344

54-
systemtest_programfilter: Optional[str] = None
45+
system_filter: Optional[str] = None
5546
"""The system filter to apply."""
5647

5748
workspace: Optional[str] = None

‎nisystemlink/clients/test_plan/models/_create_test_plan_template_request.py‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
from nisystemlink.clients.test_plan.models._test_plan_templates import (
2-
TestPlanTemplateBase,
3-
)
1+
from ._test_plan_templates import TestPlanTemplateBase
42

53

64
class CreateTestPlanTemplateRequest(TestPlanTemplateBase):

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
from nisystemlink.clients.core._api_error import ApiError
44
from nisystemlink.clients.core._uplink._json_model import JsonModel
55

6-
from ._test_plan_templates import TestPlanTemplate, TestPlanTemplateBase
6+
from ._create_test_plan_template_request import CreateTestPlanTemplateRequest
7+
from ._test_plan_templates import TestPlanTemplate
78

89

910
class CreateTestPlanTemplatePartialSuccessResponse(JsonModel):
1011

1112
created_test_plan_templates: Optional[List[TestPlanTemplate]] = None
1213
"""The list of test plan templates that were successfully created."""
1314

14-
failed_test_plan_templates: Optional[List[TestPlanTemplateBase]] = None
15+
failed_test_plan_templates: Optional[List[CreateTestPlanTemplateRequest]] = None
1516
"""The list of test plan templates that were not created.
1617
1718
If this is `None`, then all test plan templates were successfully created.

nisystemlink/clients/test_plan/models/_create_test_plans_response.py renamed to nisystemlink/clients/test_plan/models/_create_test_plans_partial_success_response.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,11 @@
77
from ._test_plan import TestPlan
88

99

10-
class CreateTestPlansResponse(JsonModel):
10+
class CreateTestPlansPartialSuccessResponse(JsonModel):
1111
"""Represents the response from creating test plans, including successfully created,
1212
failed test plans, and any associated errors.
1313
"""
1414

15-
test_plans: Optional[List[TestPlan]] = None
16-
"""List of all test plans involved in the operation."""
17-
1815
created_test_plans: Optional[List[TestPlan]] = None
1916
"""List of test plans that were successfully created."""
2017

‎nisystemlink/clients/test_plan/models/_create_test_plans_request.py‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎nisystemlink/clients/test_plan/models/_dashboard.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
from typing import Dict, Optional
2+
3+
from nisystemlink.clients.core._uplink._json_model import JsonModel
4+
5+
6+
class Dashboard(JsonModel):
7+
"""Represents a dashboard reference."""
8+
9+
id: Optional[str] = None
10+
"""ID of the dashboard"""
11+
12+
variables: Optional[Dict[str, str]] = None
13+
"""Variables for the dashboard"""
14+
15+
16+
class DashboardUrl(Dashboard):
17+
"""Definition and URL of the dashboard reference associated with this test plan."""
18+
19+
url: Optional[str] = None
20+
"""URL of the dashboard reference associated with this test plan."""

0 commit comments

Comments
 (0)