Skip to content

Commit aa44f0a

Browse files
[Recorder] Update readmes and changelog - prep 2.0 release (Azure#21257)
* update readmes and changelog * Update sdk/test-utils/recorder/CHANGELOG.md * Update sdk/test-utils/recorder/CHANGELOG.md * Update sdk/test-utils/recorder/CHANGELOG.md
1 parent 9b40829 commit aa44f0a

File tree

3 files changed

+25
-21
lines changed

3 files changed

+25
-21
lines changed

sdk/test-utils/recorder/CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Release History
22

3-
## 2.0.0 (Unreleased)
3+
## 2.0.0 (2022-04-07)
4+
5+
Marks the first release of recorder v2. This project is a test utility that assits with testing the packages maintained at the Azure SDK for JavaScript repository by leveraging the unified out-of-process test proxy server. This is not intended for the public utilization.
46

57
## 2022-03-02
68

sdk/test-utils/recorder/README.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11
## Azure @azure-tools/test-recorder-new library for JavaScript
22

3-
This is an experimental tool to record and playback the tests in the JS repo by leveraging the unified out-of-process test proxy server. This library is still under construction.
4-
Feature work is being tracked at [#15829](https://github.com/Azure/azure-sdk-for-js/issues/15829)
3+
**Note: This project is a test utility that assits with testing the packages maintained at the Azure SDK for JavaScript repository. This is not intended for the public utilization.**
4+
5+
This tool helps to record and playback the tests in the JS repo by leveraging the unified out-of-process test proxy server.
56

67
## Resources
78

9+
- [Migration guide to recorder v2 from v1](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/MIGRATION.md)
810
- [Azure SDK Tools Test Proxy](https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy/Azure.Sdk.Tools.TestProxy)
911
- [Using Test Proxy with docker container](https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy/docker#build-and-run)
1012

11-
## Running the test-proxy tool
13+
## Running the tests along with the test-proxy tool
14+
15+
### With the `dev-tool` commands
16+
17+
- The following commands run the tests with the default configs, and concurrently runs the proxy tool in record/playback modes if it is not already active. Additionally, more options can be passeed to override the default configs.
18+
- `dev-tool run test:node-js-input -- --timeout 5000000 'dist-esm/test/**/*.spec.js'`
19+
- `dev-tool run test:node-ts-input -- --timeout 1200000 --exclude 'test/**/browser/*.spec.ts' 'test/**/*.spec.ts'`
20+
- `dev-tool run test:browser`
21+
Read more at [dev-tool commands #usage](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/dev-tool/README.md#usage)
22+
23+
Follow the below two methods if you wish to run the proxy tool yourself without relying on the `dev-tool` commands.
1224

1325
### With the `docker run` command
1426

@@ -18,8 +30,6 @@ Feature work is being tracked at [#15829](https://github.com/Azure/azure-sdk-for
1830
1931
Map the root directory of the azure-sdk-for-js repo to `/srv/testproxy` inside the container for an accurate location while generating recordings.
2032

21-
(Eventually, recorder will trigger this for you!)
22-
2333
Add `--add-host host.docker.internal:host-gateway` for linux to access host's network(to access `localhost`) through `host.docker.internal`.
2434
Docker for Windows and Mac support `host.docker.internal` as a functioning alias for localhost.
2535

@@ -37,18 +47,3 @@ Feature work is being tracked at [#15829](https://github.com/Azure/azure-sdk-for
3747
> `test-proxy --storage-location <root-of-the-repo>`
3848
3949
[ `root-of-the-repo example` - `/workspaces/azure-sdk-for-js` if you're on codespaces]
40-
41-
## Run the tests using recorder-new at `test-utils/testing-recorder-new`
42-
43-
- Navigate to the test-utils\testing-recorder-new folder
44-
- Run `rush update && rush build -t .`
45-
- Run `rushx test:node`
46-
- Run `rushx test:browser`
47-
48-
## Copying the recordings saved in the container
49-
50-
For some reason, the volume mapping did not work for you, copy the recordings manually.
51-
52-
- `docker cp <container_id>:/srv/testproxy/ temp-location`
53-
54-
[This will be fixed eventually [#Issue-17138](https://github.com/Azure/azure-sdk-for-js/issues/17138)]

sdk/test-utils/testing-recorder-new/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,10 @@ You will need to create a local `.env` file under the same directory as this rea
1313
"STORAGE_SAS_URL",
1414
"TABLES_SAS_CONNECTION_STRING"
1515
```
16+
17+
## Run the tests at `test-utils/testing-recorder-new`
18+
19+
- Navigate to the test-utils\testing-recorder-new folder
20+
- Run `rush update && rush build -t .`
21+
- Run `rushx test:node`
22+
- Run `rushx test:browser`

0 commit comments

Comments
 (0)