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] Point users to language repository test documentation #6368

Merged
merged 3 commits into from
Jun 27, 2023

Conversation

mccoyp
Copy link
Member

@mccoyp mccoyp commented Jun 19, 2023

We recently had an instance where a partner team intended to set up the test proxy tool for testing their already-migrated Python library. Instead of referring to our language-specific test docs, though, they found this azure-sdk-tools documentation; this made them think that they had to set up the test proxy tool manually with .NET/Docker, but Python's tooling actually handles tool installation and startup for them.

To avoid this issue, I think it would be good to have a disclaimer at the start of this document to let people know that this isn't meant for test writers' reference. I added links to what seem to be the test-writing guides for each language, but it would be great if each language's test proxy owner could double-check them 🙂

@mccoyp mccoyp added Docs Test-Proxy Anything relating to test-proxy requests or issues. labels Jun 19, 2023
@mccoyp mccoyp requested a review from mikeharder as a code owner June 19, 2023 23:27
**To users writing SDK tests:** This document is not intended to be a test preperation reference. You should instead refer
to documentation in your specific language repository in order to configure recorded tests.

#### Test documentation by language:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add this to the asset-sync / test-proxy readme in sdk tools repo shouldn't we.

@mccoyp mccoyp merged commit 54ad039 into main Jun 27, 2023
@mccoyp mccoyp deleted the proxy-test-ref branch June 27, 2023 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Test-Proxy Anything relating to test-proxy requests or issues.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants