Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Test Proxy] Improve variables API documentation #25203

Merged
merged 1 commit into from
Jul 15, 2022
Merged

Conversation

mccoyp
Copy link
Member

@mccoyp mccoyp commented Jul 13, 2022

Description

Prompted by an issue the Storage team ran into, when kwargs.pop("variables") fails in live test pipelines (because the test proxy isn't running, and variables therefore aren't provided).

In addition to recommending a default value for kwargs.pop, this simplifies the use of variables by using the setdefault method to query the dictionary, or update it, in the same line -- without any need to check for emptiness or live-running status of the test!

@scbedd

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.
    • Verified using the Storage test that prompted this change

@mccoyp mccoyp requested review from scbedd and jalauzon-msft July 13, 2022 19:32
@mccoyp mccoyp merged commit 0492dc7 into main Jul 15, 2022
@mccoyp mccoyp deleted the proxy-variables-doc branch July 15, 2022 00:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants