https://github.com/harshanalluru/testing-unpublished-recorder
https://github.com/harshanalluru/testing-unpublished-recorder
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/harshanalluru/testing-unpublished-recorder
- Owner: HarshaNalluru
- Created: 2022-03-04T00:02:50.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-03-04T00:14:04.000Z (over 3 years ago)
- Last Synced: 2025-02-09T22:25:36.976Z (8 months ago)
- Language: TypeScript
- Size: 175 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Leveraging unpublished `@azure-tools/test-recorder`
This repo is a sample that shows how to leverage the unpublished `@azure-tools/test-recorder` with an SDK client from the [Azure/azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js) repo.
## Steps to create this repo
To leverage the recorder artifact from `azure-sdk-for-js` repo, we need the tests in a specific format in terms of code as well as the folder structure.
## Folder structure
```
- .gitignore (ignores `node_modules` and `.env`)
- package.json (dummy)
- rush.json (dummy)
- README.md (this file)
- sdk
|_ service
|_ service-sdk
- package.json
- package-lock.json
- azure-tools-test-recorder-2.0.0.tgz
- azure-test-utils-1.0.0.tgz
- .env (Populate with `TABLES_SAS_CONNECTION_STRING` and `TEST_MODE`)
|_ test
- main.spec.ts (Actual test that uses the recorder with `@azure/data-tables` library)
```
## Setting up this repo & Running tests
- `cd sdk/service/service-sdk`
- Create a fresh `.env` file with `TABLES_SAS_CONNECTION_STRING` and `TEST_MODE`
- `npm install`
- `npm run test`
- Run the proxy tool as well as shown below
## Running the proxy tool
[Docker](https://www.docker.com/get-started) is required, as the [test proxy server](https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy) is run in a container during testing. When running the tests, ensure the Docker daemon is running and you have permission to use it.
- Install [docker](https://www.docker.com/get-started)
- `docker run -v :/srv/testproxy/ -p 5001:5001 -p 5000:5000 azsdkengsys.azurecr.io/engsys/testproxy-lin:1.0.0-dev.20220224.2`
### Note:
`TEST_MODE` can take three values, "record", "playback" or "live"
- "live" - hits the live service, recorder is not involved
- "record" - records the requests and responses, generates recordings
- "playback" - plays the tests back using the recordings
## Refreshing "recorder" and "test-utils" artifacts
- Clone [Azure/azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js)
- `rush update`
- `cd sdk/test-utils/recorder`
- `rush build -t .`
- `rushx pack` (Generates azure-tools-test-recorder-2.0.0.tgz)
- `cd sdk/test-utils/test-utils`
- `rush build -t .`
- `rushx pack` (Generates azure-test-utils-1.0.0.tgz)
- Put them(`azure-tools-test-recorder-2.0.0.tgz` and `azure-test-utils-1.0.0.tgz`) in this repo at `sdk/service/service-sdk/`