feat: Add client for SystemLink jobs API by ganesh-nithin · Pull Request #85 · ni/nisystemlink-clients-python

ganesh-nithin · 2024-11-29T06:46:29Z

This contribution adheres to CONTRIBUTING.md.

What does this Pull Request accomplish?

This PR adds client methods for job group of Systems endpoints with integration tests for these endpoints

Why should this Pull Request be merged?

This System client (job) for System Management endpoints will improve user interactivity with those endpoints

What testing has been done?

Automated integration tests are included.

API Link: Swagger-link

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin · 2024-12-03T04:37:03Z

tests/integration/system/test_system_client.py

+        assert len(response) == 1
+
+    def test__list_jobs__Invalid_system_id__fails(self, client: SystemClient):
+        with pytest.raises(Exception):


Suggested change

with pytest.raises(Exception):

with pytest.raises(ApiException):

reflect this in other places.

Modified & reflected in other places.

Madhan-Reddy-ni · 2024-12-03T04:21:50Z

nisystemlink/clients/system/_system_client.py

+            Query("take"),
+        ],
+    )
+    def list_jobs(


Suggested change

def list_jobs(

def list_jobs_paged(

Skipping the suggestion as list jobs are not paged as it don't have continuation token property.

Madhan-Reddy-ni · 2024-12-03T04:25:23Z

nisystemlink/clients/system/_system_client.py

+        ...
+
+    @post("query-jobs")
+    def query_jobs(self, query: models.QueryJobsRequest) -> models.QueryJobsResponse:


Suggested change

def query_jobs(self, query: models.QueryJobsRequest) -> models.QueryJobsResponse:

def query_jobs_paged(self, query: models.QueryJobsRequest) -> models.QueryJobsResponse:

Skipping the suggestion as query jobs are not paged as it don't have continuation token property.

Madhan-Reddy-ni · 2024-12-03T04:27:32Z

nisystemlink/clients/system/_system_client.py

+            The list of jobs that matched the criteria.
+
+        Raises:
+            ApiException: if unable to communicate with the System Service


Suggested change

ApiException: if unable to communicate with the System Service

ApiException: if unable to communicate with the ``/nisysmgmt`` Service

Update in all other places

I have updated it, & reflected the same in other places.

Madhan-Reddy-ni · 2024-12-03T04:35:49Z

nisystemlink/clients/system/models/_create_job_request.py

+class CreateJobRequest(JobConfig):
+    """Model for create job request."""
+
+    metadata: Optional[Dict[str, Any]] = None


Please update it with actual properties..

I have updated it. As CreateJobResponse is extended from CreateJobRequest, properties will be updated in it.

Madhan-Reddy-ni · 2024-12-03T05:46:12Z

nisystemlink/clients/system/models/_http_error.py

+from nisystemlink.clients.core._uplink._json_model import JsonModel
+
+
+class HttpError(JsonModel):


Use ApiError class from uplink core module instead of creating new one.

I have updated it, & reflected the same in other places.

Madhan-Reddy-ni · 2024-12-03T05:51:00Z

nisystemlink/clients/system/models/_query_jobs_response.py

+    error: Optional[HttpError] = None
+    """Represents the standard error structure."""
+
+    data: Optional[List[str]] = None


Please change the datatype of the data property.

Updated the property.

Madhan-Reddy-ni · 2024-12-03T06:03:14Z

tests/integration/system/test_system_client.py

+@pytest.mark.integration
+@pytest.mark.enterprise
+class TestSystemClient:
+    def test__create_job__succeeds(


can we update test names with proper details?

I have updated the tests.

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

Madhan-Reddy-ni · 2024-12-03T13:07:18Z

nisystemlink/clients/system/models/__init__.py

@@ -0,0 +1,10 @@
+from ._job import Job, JobState


Suggested change

from ._job import Job, JobState

from ._job import Job, JobState, JobConfig, JobResult

Madhan-Reddy-ni · 2024-12-03T13:20:09Z

tests/integration/system/test_system_client.py

+
+    def test__list_jobs__invalid_system_id(self, client: SystemClient):
+        response = client.list_jobs(system_id="Invalid_system_id")
+        assert response == []


Suggested change

assert response == []

assert len(response) == 0

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

santhoshramaraj · 2024-12-05T22:42:00Z

@ganesh-nithin , please update field/arg names to be Pythonic, for example id or job_id based on context instead of jid

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin added 9 commits November 27, 2024 12:40

feat: add systems client code for get jobs API.

c2278f1

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

feat: add systems client code for create job API.

cbba5c7

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

feat: add systems client code for get jobs summary API.

258f373

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

feat: add systems client code for query jobs API.

4e22c28

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

feat: add systems client code for cancel jobs API.

6070c71

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

refactor: modify docs strings for systems client.

55684d8

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

feat: add unit tests for jobs in systems client/

412c8ef

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

refactor: change name systems into system.

2f91a6c

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

feat: add example documentation for system client.

63083f5

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin requested review from cameronwaterman, mure and spanglerco as code owners November 29, 2024 06:46

ganesh-nithin marked this pull request as draft November 29, 2024 06:54

feat: add api references for system client API.

5a4f0ae

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin marked this pull request as ready for review November 29, 2024 07:34

refactor: format code using black & flake8.

1e17b89

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin commented Dec 3, 2024

View reviewed changes

Madhan-Reddy-ni suggested changes Dec 3, 2024

View reviewed changes

ganesh-nithin added 2 commits December 3, 2024 13:19

refactor: address system client PR comments.

13accda

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

refactor: modify system client tests.

5dd2381

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin requested a review from Madhan-Reddy-ni December 3, 2024 10:47

refactor: fix lint issues in CI.

4a4b977

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

Madhan-Reddy-ni reviewed Dec 3, 2024

View reviewed changes

Madhan-Reddy-ni added the enhancement New feature or request label Dec 3, 2024

ganesh-nithin added 2 commits December 4, 2024 16:04

refactor: modify model names.

814f1fb

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

refactor: modify test cases for system client.

85cc103

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin marked this pull request as draft December 6, 2024 09:28

refactor: modify field names to be pythonic.

3ef21ec

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin added 4 commits December 9, 2024 09:03

refactor: modify tests.

6167da2

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

refactor: add wrapping for job client.

0e33a87

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

refactor: modify clients & tests.

5575f20

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

refactor: format system client code.

ee1d908

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

ganesh-nithin marked this pull request as ready for review December 11, 2024 17:20

ganesh-nithin requested a review from Madhan-Reddy-ni December 11, 2024 17:20

ganesh-nithin added 2 commits December 11, 2024 22:52

refactor: modify union operator.

3e727c8

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

refactor: format system client code.

6ebb8f1

Signed-off-by: Ganesh Nithin <sarvabhotla.g@solitontech.com>

	with pytest.raises(Exception):
	with pytest.raises(ApiException):

	def query_jobs(self, query: models.QueryJobsRequest) -> models.QueryJobsResponse:
	def query_jobs_paged(self, query: models.QueryJobsRequest) -> models.QueryJobsResponse:

	ApiException: if unable to communicate with the System Service
	ApiException: if unable to communicate with the ``/nisysmgmt`` Service

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


		class HttpError(JsonModel):

	from ._job import Job, JobState
	from ._job import Job, JobState, JobConfig, JobResult

Conversation

ganesh-nithin commented Nov 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this Pull Request accomplish?

Why should this Pull Request be merged?

What testing has been done?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

santhoshramaraj commented Dec 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ganesh-nithin commented Nov 29, 2024 •

edited

Loading

santhoshramaraj commented Dec 5, 2024 •

edited

Loading