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

[Common Recorder] Updated README #5288

Merged
merged 7 commits into from
Oct 4, 2019
Merged

Conversation

sadasant
Copy link
Contributor

This is just a proposal! Let's review it and make it better together <3

Fixes #4961

@sadasant sadasant self-assigned this Sep 27, 2019
`@azure/keyvault/keyvault-keys` repository). It must be used inside of Mocha's
tests, since it uses [nise](https://www.npmjs.com/package/nise) under the hood.
It also returns an object with a method `stop()`, which will allow you to control when
you want the recorder to stop re-routing your http requests.
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

getUniqueName and newDate are not part of src/index.ts though! Should we make an issue?

Copy link
Member

Choose a reason for hiding this comment

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

They are part of the Recorder interface that is being exported in the src/index.ts file.

getUniqueName: (prefix: string, label?: string) => string;

record(this) is invoked in the beforeEach section.

record(this) returns the Recorder interface which has a bunch of functions attached to it.
stop, skip, getUniqueName, newDate

export function record(testContext: Mocha.Context): Recorder {

Copy link
Member

@HarshaNalluru HarshaNalluru left a comment

Choose a reason for hiding this comment

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

Great job, @sadasant !!! 🤩
I could only review half of the document, I'll take some time to review it completely. 🥱

sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Outdated Show resolved Hide resolved
sdk/test-utils/recorder/README.md Show resolved Hide resolved
sdk/test-utils/recorder/README.md Show resolved Hide resolved
sdk/test-utils/recorder/README.md Show resolved Hide resolved
sdk/test-utils/recorder/README.md Show resolved Hide resolved
sdk/test-utils/recorder/README.md Show resolved Hide resolved
Copy link
Member

@HarshaNalluru HarshaNalluru left a comment

Choose a reason for hiding this comment

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

🎉

@sadasant sadasant merged commit f269b12 into Azure:master Oct 4, 2019
@sadasant sadasant deleted the feature/fix4961 branch October 4, 2019 14:34
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.

[Record and Playback] Filling out README with instructions
3 participants