Added extract all parameter to test_plan_client method #515
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
a-holm
reviewed
Apr 4, 2025
| @@ -361,6 +361,9 @@ def get_test_suites_for_plan(self, project, plan_id, expand=None, continuation_t | |||
| version='7.0', | |||
| route_values=route_values, | |||
| query_parameters=query_parameters) | |||
| if extract_all and 'x-ms-continuationtoken' in response.headers: | |||
| continuation_token = response.headers['x-ms-continuationtoken'] | |||
| return self._deserialize('[TestPlan]', self._unwrap_collection(response)) + self.get_test_plans(project, plan_id, expand=expand, continuation_token=continuation_token, as_tree_view=as_tree_view, extract_all=True) | |||
There was a problem hiding this comment.
The response is being deserialized using self._deserialize('[TestPlan]', ...). I believe this should be self._deserialize('[TestSuite]', ...) to match the method's return type and the API response structure.
There was a problem hiding this comment.
Also the recursive call is made to self.get_test_plans(...). I believe it should be calling self.get_test_suites_for_plan(...) to fetch the next page of test suites. If i am correct (which i might not be) then due to calling the wrong method (get_test_plans), the arguments are mismatched. plan_id is passed where owner is expected.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As I was using the library I realized that I was not getting all test suites of my project. After a fast search I found that the API only returns stacks of 200 records.
When using the "get_test_suites_for_plan" method I can pass the "continuation_token" but there is not a easy way of obtaining this token unless duplicating the method.
I suggest to add a parameter to automatically call the API multiple times when a continuation token is returned by the API.
This can be applied to other methods like "get_test_plans" and maybe it must be replicated to the other "test_plant_client.py" classes.