[docs] Fix outdated API references in management tests documentation - #48418
Open
Ali Satwat Khan (alisatwat3) wants to merge 7 commits into
Open
[docs] Fix outdated API references in management tests documentation#48418Ali Satwat Khan (alisatwat3) wants to merge 7 commits into
Ali Satwat Khan (alisatwat3) wants to merge 7 commits into
Conversation
Contributor
|
Thank you for your contribution Ali Satwat Khan (@alisatwat3)! We will review the pull request and get back to you soon. |
|
Azure Pipelines: Successfully started running 1 pipeline(s). 8 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Ali Satwat Khan (alisatwat3)
marked this pull request as ready for review
August 4, 2026 09:06
Ali Satwat Khan (alisatwat3)
requested a review
from Daniel Jurek (danieljurek)
as a code owner
August 4, 2026 09:06
|
Azure Pipelines: Successfully started running 1 pipeline(s). 8 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Copilot started reviewing on behalf of
Ali Satwat Khan (alisatwat3)
August 4, 2026 09:07
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates management testing documentation to use current credential parameter, helper, and base-class names.
Changes:
- Corrects
ClientSecretCredentialkeyword arguments. - Updates credential helper and test base-class references.
Copilot started reviewing on behalf of
Ali Satwat Khan (alisatwat3)
August 4, 2026 09:48
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
doc/dev/mgmt/tests.md:172
create_mgmt_client()does not perform checks that verify the client was created successfully; it only constructs the client, applies playback configuration, and returns it (azure_recorded_testcase.py:100-122). This wording can incorrectly imply failures will be detected before the first service operation, so remove the validation claim.
3. The `create_mgmt_client()` helper method of `AzureMgmtRecordedTestCase` creates a client object using fake credentials during playback or credentials from environment variables in live mode, with some checks to make sure it's created successfully and cause the unit test to fail if not. You should use it for any clients you create.
Copilot started reviewing on behalf of
Ali Satwat Khan (alisatwat3)
August 4, 2026 11:39
View session
Copilot started reviewing on behalf of
Ali Satwat Khan (alisatwat3)
August 4, 2026 18:35
View session
Copilot started reviewing on behalf of
Ali Satwat Khan (alisatwat3)
August 4, 2026 20:47
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
doc/dev/mgmt/tests.md:102
- These two commands are not copyable as written: both CMD and POSIX shells interpret the unquoted
</>placeholder characters as redirection operators rather than part of the value. Quote the assignment so readers can run the documented commands and then replace the placeholder safely.
set AZURE_SUBSCRIPTION_ID=<value> # Windows CMD
export AZURE_SUBSCRIPTION_ID=<value> # Linux shell only
This file contains hidden or 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
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.
Description
Fixes #48400.
Updates
doc/dev/mgmt/tests.mdto match the current credential and management-test implementation:client_secretandtenant_idwithClientSecretCredential.mgmt_settings_real.pyworkflow with the environment-variable-based live-test setup, includingAZURE_SUBSCRIPTION_ID.AzureMgmtRecordedTestCaseuses fake credentials during playback and environment-based credentials in live mode.All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines
git diff --checkand cross-checked against the current test framework implementation.