aws-deadline / deadline-cloud-test-fixtures

This package contains pytest fixtures that are used to test AWS Deadline Cloud Python packages
Apache License 2.0
9 stars 13 forks source link

fix: Add default max_retries to Job.wait_until_complete to avoid infinite waiting #134

Closed YutongLi291 closed 2 months ago

YutongLi291 commented 2 months ago

What was the problem/requirement? (What/Why)

Job.wait_until_complete() has a default max_retries of infinite retries, which is problematic if something unforeseen happens and the tests that use the function will just retry forever.

We should add a default for the function so that will not happen.

What was the solution? (How)

Add a default to the wait_until_complete() function for its max_retries parameter, so that the default behaviour would be to retry up to the default number of times, waiting for the job to complete.

What is the impact of this change?

More robust tests, and less possibility of an infinite loop happening in the off chance,.

How was this change tested?

hatch build hatch run fmt hatch run test

Was this change documented?

No

Is this a breaking change?

No

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

sonarcloud[bot] commented 2 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud