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

[Communication] Migrated recordings to the assets repo #37803

Merged
merged 1 commit into from
Aug 10, 2023

Conversation

kinelski
Copy link
Member

To reduce the quickly growing size of our repository, the Engineering System team asked us to move our test recordings to the Azure SDK Assets repo. This PR migrates recordings from Communication libraries.

Note: Azure.Communication.CallAutomation is not included in this PR because migration is causing ci test failures. This issue is currently under investigation.

What’s changing

  • Test recordings won’t live in a SessionRecords folder anymore. Instead, they’ll be stored in a folder named .assets, located at the root of the repo. This folder lives only locally and will never be committed to the SDK repository since recordings won’t live there anymore. The .assets folder will be created and handled automatically by the Test Framework.
  • To push new recordings to the Azure SDK Assets repo, you must have the test-proxy command line tool installed. The Test Framework will install it for you if you run tests in Record mode on Windows but, if needed, you can check manual installation instructions here: Azure SDK Tools Test Proxy
  • Every project will now have an assets.json file next to it. This file is used by the Test Framework behind the scenes to retrieve recordings from the assets repo and populate the local .assets folder. Here’s an example of how this file looks like:
{
  "AssetsRepo": "Azure/azure-sdk-assets",
  "AssetsRepoPrefixPath": "net",
  "TagPrefix": "net/textanalytics/Azure.AI.TextAnalytics",
  "Tag": "net/textanalytics/Azure.AI.TextAnalytics_d876a50505"
}

If you have new recordings, you’ll need to push them to the assets repo with the test-proxy tool. This is the only change in your workflow. This can be achieved by invoking the following command:

test-proxy push -a <path-to-assets.json>

After running this command, the assets.json file will be updated with a new tag. Please remember to include this tag update in your PR to the .NET SDK repo along with any other changes in your library. You can check here for an example of how a PR with updates in recordings looks like.

Keep in mind that pushing to the assets repo is done via the test-proxy tool. You will never need to clone the assets repo manually, and you won’t need to open a PR there. This is all handled by the test-proxy tool and the Test Framework behind the scenes.

Additional documentation

@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

@kinelski kinelski requested a review from minwoolee-msft as a code owner July 24, 2023 15:28
@kinelski kinelski requested a review from pallavit July 24, 2023 15:28
@kinelski
Copy link
Member Author

Rebased to main and included new/updated recordings. Merging this PR.

@kinelski kinelski enabled auto-merge (squash) August 10, 2023 04:45
@kinelski kinelski merged commit 0dd488b into Azure:main Aug 10, 2023
@kinelski kinelski deleted the com-migration branch August 10, 2023 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants