[Communication] Migrated recordings to the assets repo #37803
Merged
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.
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
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.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 Proxyassets.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: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:
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 thetest-proxy
tool and the Test Framework behind the scenes.Additional documentation