update check_suite_id to handle paginated results #338
Conversation
|
Made this a draft while I continue working on it. |
cgeisel
force-pushed
the
get-suites-pagination
branch
from
a734ec2 to
650d42d
Compare
cgeisel
force-pushed
the
get-suites-pagination
branch
from
650d42d to
e74e63f
Compare
|
This is ready for review. I updated the three functions and updated or added unit tests. When running the test suite the e2e tests all failed for me, I am not sure how to run those successfully but am willing to learn. |
|
Hi @cgeisel thank you for your patience, the changes you made looks solid. Can you point this PR to release/1.12.0? Thank you! |
|
Repointed to release/1.12.0. Let me know if there's anything else you need and I'll jump on it. |
|
@acuanico-tr-galt any chance you could have a look? I'm eager to stop thinking about this PR. :) |
|
Hi @cgeisel apologies for the late response. We are just closing on the tests of some other new features but rest assured ,we'll include this fix as part of the next release. Thank you for your patience! |
|
Thanks, much appreciated. |
Issue being resolved: #332
Solution description
How are we solving the problem?
Updating check_suite_id to use __get_all_entities instead of __send_request to get paginated results. This PR creates a new method __get_all_suites following the pattern used by __get_all_projects and others.
Changes
What changes where made?
check_suite_id now uses __get_all_suites, which wraps __get_all_entities to get paginated results. The API for check_suite_id does not change.
Potential impacts
What could potentially be affected by the implemented changes?
Any area of the cli where check_suite_id is called, it could add latency to the call. It should not otherwise impact anything, since it is still returning a boolean if the suite id is returned.
Steps to test
Happy path to test implemented scenario
Create a project with more than a single page of suites (ie >250). Use the add_run trcli command with --suite-id for a suite in the second page of results and observe that before this is merged, the call will fail with the error "Suite with ID (some id) does not exist in TestRail."
PR Tasks