Migration guide for Unified Recorder #19210
Merged
Conversation
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
timovv
added
the
test-utils-recorder
timovv
requested review from
deyaaeldeen,
jeremymeng,
joheredi,
maorleger and
witemple-msft
timovv
commented
Dec 15, 2021
timovv
commented
Dec 15, 2021
jeremymeng
reviewed
Dec 16, 2021
sadasant
reviewed
Dec 16, 2021
sadasant
reviewed
Dec 16, 2021
sadasant
reviewed
Dec 16, 2021
sadasant
reviewed
Dec 16, 2021
sadasant
reviewed
Dec 16, 2021
Member
Author
|
We should add a troubleshooting section that describes how to run the recorder manually and get logs. |
4 tasks
Comment on lines
+34
to
+35
| - `node-ts-input` runs the tests using `ts-node`, without code coverage. | ||
| - `node-js-input` runs the tests using the built JavaScript output, and generates coverage reporting using `nyc`. |
Contributor
There was a problem hiding this comment.
Suggested change
| - `node-ts-input` runs the tests using `ts-node`, without code coverage. | |
| - `node-js-input` runs the tests using the built JavaScript output, and generates coverage reporting using `nyc`. | |
| - `node-ts-input` runs the tests using `ts-node`(takes TS files as input), without code coverage. | |
| - `node-js-input` runs the tests using the test (JS) bundle built with rollup, and generates coverage reporting using `nyc`. |
| }); | ||
| ``` | ||
|
|
||
| To enable the recorder, you should then initialize your SDK client as normal and use the recorder's `configureClient` method. This method will attach the necessary policies to the client for recording to be enabled. |
Contributor
There was a problem hiding this comment.
Let's also mention that the client should be exposing the "pipeline" object to get the policy added properly.
Member
Author
There was a problem hiding this comment.
It would be a compile error if pipeline isn't exposed, but I'll add a note
Co-authored-by: Harsha Nalluru <[email protected]>
Co-authored-by: Harsha Nalluru <[email protected]>
Co-authored-by: Harsha Nalluru <[email protected]>
|
|
||
| Once you have made the necessary code changes, it is time to re-record your tests using the Unified Recorder to complete the migration. To do this, first **delete** the directory containing the old recordings (the `recordings` folder). Then, run your tests with the `TEST_MODE` environment variable to `record`. | ||
|
|
||
| If everything succeeds, the new recordings will be made available in the `recordings` directory. Inspect them to make sure everything looks OK (no secrets present, etc.), and then run the tests in playback mode to ensure everything is passing. If you're running into issues, check out the [Troubleshooting section](#troubleshooting). |
Contributor
There was a problem hiding this comment.
troubleshooting is empty?
Member
Author
There was a problem hiding this comment.
uh oh...
why do I remember writing it if it's not there...
| docker run -v <your azure-sdk-for-js repository root>:/srv/testproxy -p 5001:5001 -p 5000:5000 -e Logging__LogLevel__Microsoft=Debug azsdkengsys.azurecr.io/engsys/testproxy-lin:latest | ||
| ``` | ||
|
|
||
| Once you've done this, you can run your tests in a separate terminal. `dev-tool` will detect that a test proxy container is already running and will point requests to the Docker container you started. |
HarshaNalluru
approved these changes
Jan 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Tips and tricks for migrating from the old recorder to the shiny new Unified Recorder.
Needs updates as result of API changes:
TestProxyHttpClients for better clarity and Renaming #19446