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

[Recorder] Adding a note in the readme to release publicly and rename the package(everywhere) #17127

Merged
merged 4 commits into from
Aug 26, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ By default, Rush only displays things written to `STDERR`. If you want to see th

If you want to run the tests of a specific project, go to that project's folder and execute `rushx test`. All of the tests will automatically run both in NodeJS and in the browser. To target these environments individually, you can run `rushx test:node` and `rushx test:browser`.

By default, these npm scripts run previously recorded tests. The recordings have been generated by using a custom recording library called [test-utils-recorder](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/README.md). We will examine how to run recorded tests and live tests in the following sections.
By default, these npm scripts run previously recorded tests. The recordings have been generated by using a custom recording library called [test-recorder](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/README.md). We will examine how to run recorded tests and live tests in the following sections.

#### Recorded tests

Expand All @@ -166,7 +166,7 @@ If you modify the network calls (both the number of calls or their shape) either

Regenerating the recordings has the same requirements as running the live tests. You will be using the same `test` npm script with the environment variables pointing to previously created Azure resources. The only difference is that the `TEST_MODE` environment variable needs to be set to `record`. When this process finishes without errors, the recordings will be updated.

For more information the recorder, please visit the [test-utils-recorder's readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/README.md).
For more information the recorder, please visit the [test-recorder's readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/README.md).

### Other NPM scripts

Expand Down
156 changes: 78 additions & 78 deletions common/config/rush/pnpm-lock.yaml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions rush.json
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,7 @@
"versionPolicyName": "utility"
},
{
"packageName": "@azure/test-utils-recorder",
"packageName": "@azure-tools/test-recorder",
"projectFolder": "sdk/test-utils/recorder",
"versionPolicyName": "utility"
},
Expand Down Expand Up @@ -892,4 +892,4 @@
"versionPolicyName": "management"
}
]
}
}
2 changes: 1 addition & 1 deletion sdk/agrifood/agrifood-farming-rest/karma.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const {
isPlaybackMode,
isSoftRecordMode,
isRecordMode,
} = require("@azure/test-utils-recorder");
} = require("@azure-tools/test-recorder");

module.exports = function (config) {
config.set({
Expand Down
2 changes: 1 addition & 1 deletion sdk/agrifood/agrifood-farming-rest/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
"@azure/dev-tool": "^1.0.0",
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
"@azure/identity": "^1.1.0",
"@azure/test-utils-recorder": "^1.0.0",
"@azure-tools/test-recorder": "^1.0.0",
"@microsoft/api-extractor": "7.13.2",
"@types/chai": "^4.1.6",
"@types/mocha": "^7.0.2",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import { FarmBeatsRestClient, getPoller } from "../../src";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { isNode } from "@azure/core-util";

import { assert } from "chai";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import { FarmBeatsRestClient } from "../../src";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";

import { assert } from "chai";
import { createClient, createRecorder } from "./utils/recordedClient";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import { FarmBeatsRestClient, Farmer, paginate } from "../../src";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";

import { assert } from "chai";
import { createClient, createRecorder } from "./utils/recordedClient";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

import { Context } from "mocha";

import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure/test-utils-recorder";
import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure-tools/test-recorder";
import FarmBeats, { FarmBeatsRestClient } from "../../../src";
import { ClientSecretCredential } from "@azure/identity";

Expand Down
2 changes: 1 addition & 1 deletion sdk/anomalydetector/ai-anomaly-detector/karma.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const {
isPlaybackMode,
isSoftRecordMode,
isRecordMode
} = require("@azure/test-utils-recorder");
} = require("@azure-tools/test-recorder");

module.exports = function(config) {
config.set({
Expand Down
2 changes: 1 addition & 1 deletion sdk/anomalydetector/ai-anomaly-detector/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
"rollup-plugin-visualizer": "^4.0.4",
"typescript": "~4.2.0",
"util": "^0.12.1",
"@azure/test-utils-recorder": "^1.0.0",
"@azure-tools/test-recorder": "^1.0.0",
"typedoc": "0.15.2"
},
"//sampleConfiguration": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import { assert } from "chai";
import { Context } from "mocha";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { AnomalyDetectorClient } from "../src/AnomalyDetectorClient";
import { AzureKeyCredential } from "@azure/core-auth";
import { createRecordedAnomalyDetectorClient, testEnv } from "./utils/recordedClients";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import { Context } from "mocha";

import * as dotenv from "dotenv";
import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure/test-utils-recorder";
import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure-tools/test-recorder";

import { ClientSecretCredential } from "@azure/identity";
import { AnomalyDetectorClient } from "../../src/AnomalyDetectorClient";
Expand Down
2 changes: 1 addition & 1 deletion sdk/appconfiguration/app-configuration/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
"@azure/identity": "2.0.0-beta.6",
"@azure/keyvault-secrets": "^4.2.0",
"@azure/test-utils-recorder": "^1.0.0",
"@azure-tools/test-recorder": "^1.0.0",
"@microsoft/api-extractor": "7.7.11",
"@rollup/plugin-commonjs": "11.0.2",
"@rollup/plugin-inject": "^4.0.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {
} from "../public/utils/testHelpers";

import * as chai from "chai";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { Context } from "mocha";

describe("http request related tests", function() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
CredsAndEndpoint
} from "./utils/testHelpers";
import * as assert from "assert";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { Context } from "mocha";

describe("Authentication", () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
assertThrowsRestError
} from "./utils/testHelpers";
import * as assert from "assert";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { Context } from "mocha";

describe("etags", () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
featureFlagContentType,
featureFlagPrefix
} from "../../src";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { Context } from "mocha";
import { FeatureFlagValue, isFeatureFlag, parseFeatureFlag } from "../../src/featureFlag";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
} from "./utils/testHelpers";
import { AppConfigurationClient } from "../../src";
import * as assert from "assert";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { Context } from "mocha";

describe("AppConfigurationClient (set|clear)ReadOnly", () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
startRecorder
} from "./utils/testHelpers";
import { AppConfigurationClient, ConfigurationSetting, ConfigurationSettingParam } from "../../src";
import { Recorder, delay, isLiveMode } from "@azure/test-utils-recorder";
import { Recorder, delay, isLiveMode } from "@azure-tools/test-recorder";
import { Context } from "mocha";

describe("AppConfigurationClient", () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
secretReferenceContentType,
SecretReferenceValue
} from "../../src";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { Context } from "mocha";

describe("AppConfigurationClient - SecretReference", () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
startRecorder
} from "./utils/testHelpers";
import * as assert from "assert";
import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { Context } from "mocha";

// There's been discussion on other teams about what errors are thrown when. This
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
RecorderEnvironmentSetup,
record,
Recorder
} from "@azure/test-utils-recorder";
} from "@azure-tools/test-recorder";
import * as assert from "assert";

// allow loading from a .env file as an alternative to defining the variable
Expand Down
2 changes: 1 addition & 1 deletion sdk/attestation/attestation/karma.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const {
isPlaybackMode,
isSoftRecordMode,
isRecordMode
} = require("@azure/test-utils-recorder");
} = require("@azure-tools/test-recorder");

module.exports = function(config) {
config.set({
Expand Down
2 changes: 1 addition & 1 deletion sdk/attestation/attestation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
"@azure/dev-tool": "^1.0.0",
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
"@azure/identity": "2.0.0-beta.6",
"@azure/test-utils-recorder": "^1.0.0",
"@azure-tools/test-recorder": "^1.0.0",
"@microsoft/api-extractor": "7.7.11",
"@types/chai": "^4.1.6",
"@types/chai-as-promised": "^7.1.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Context } from "mocha";
import chaiPromises from "chai-as-promised";
chaiUse(chaiPromises);

import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";

import {
createRecordedAdminClient,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Context } from "mocha";
import chaiPromises from "chai-as-promised";
chaiUse(chaiPromises);

import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";

import {
createRecordedAdminClient,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Context } from "mocha";
import chaiPromises from "chai-as-promised";
chaiUse(chaiPromises);

import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";

import { createRecorder } from "../utils/recordedClient";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import chaiAsPromised from "chai-as-promised";

chaiUse(chaiAsPromised);

import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";

import {
createRecordedAdminClient,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Context } from "mocha";
import chaiAsPromised from "chai-as-promised";
chaiUse(chaiAsPromised);

import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";

import {
createRecordedAdminClient,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Context } from "mocha";
import chaiPromises from "chai-as-promised";
chaiUse(chaiPromises);

import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";

import { createRecordedClient, createRecorder, getAttestationUri } from "../utils/recordedClient";
import { AttestationClient } from "../../src";
Expand Down
2 changes: 1 addition & 1 deletion sdk/attestation/attestation/test/utils/recordedClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
record,
RecorderEnvironmentSetup,
isPlaybackMode
} from "@azure/test-utils-recorder";
} from "@azure-tools/test-recorder";

import {
AttestationClient,
Expand Down
2 changes: 1 addition & 1 deletion sdk/batch/batch/karma.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const {
isPlaybackMode,
isSoftRecordMode,
isRecordMode
} = require("@azure/test-utils-recorder");
} = require("@azure-tools/test-recorder");

module.exports = function(config) {
config.set({
Expand Down
2 changes: 1 addition & 1 deletion sdk/batch/batch/test/utils/recordedClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

// import { Context } from "mocha";

// import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure/test-utils-recorder";
// import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure-tools/test-recorder";
// import { TokenCredential, ClientSecretCredential } from "@azure/identity";

import "./env";
Expand Down
2 changes: 1 addition & 1 deletion sdk/communication/communication-chat/karma.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const {
isPlaybackMode,
isSoftRecordMode,
isRecordMode
} = require("@azure/test-utils-recorder");
} = require("@azure-tools/test-recorder");

module.exports = function(config) {
config.set({
Expand Down
2 changes: 1 addition & 1 deletion sdk/communication/communication-chat/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
"@azure/communication-identity": "^1.0.0",
"@azure/dev-tool": "^1.0.0",
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
"@azure/test-utils-recorder": "^1.0.0",
"@azure-tools/test-recorder": "^1.0.0",
"@microsoft/api-extractor": "7.7.11",
"@rollup/plugin-commonjs": "11.0.2",
"@rollup/plugin-json": "^4.0.0",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

import { isLiveMode, Recorder } from "@azure/test-utils-recorder";
import { isLiveMode, Recorder } from "@azure-tools/test-recorder";
import { assert } from "chai";
import { ChatClient, ChatThreadClient } from "../../src";
import { createTestUser, createRecorder, createChatClient } from "./utils/recordedClient";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

import { Recorder } from "@azure/test-utils-recorder";
import { Recorder } from "@azure-tools/test-recorder";
import { assert } from "chai";
import { ChatClient, ChatThreadClient } from "../../src";
import { createTestUser, createRecorder, createChatClient } from "./utils/recordedClient";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import { Context } from "mocha";
import * as dotenv from "dotenv";

import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure/test-utils-recorder";
import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure-tools/test-recorder";
import { isNode } from "@azure/core-util";
import { ChatClient } from "../../../src";
import {
Expand Down
2 changes: 1 addition & 1 deletion sdk/communication/communication-identity/karma.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const {
isPlaybackMode,
isSoftRecordMode,
isRecordMode
} = require("@azure/test-utils-recorder");
} = require("@azure-tools/test-recorder");

module.exports = function(config) {
config.set({
Expand Down
2 changes: 1 addition & 1 deletion sdk/communication/communication-identity/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
"@azure/dev-tool": "^1.0.0",
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
"@azure/test-utils": "^1.0.0",
"@azure/test-utils-recorder": "^1.0.0",
"@azure-tools/test-recorder": "^1.0.0",
"@azure/identity": "2.0.0-beta.6",
"@microsoft/api-extractor": "7.7.11",
"@rollup/plugin-commonjs": "11.0.2",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
} from "@azure/communication-common";
import { assert } from "chai";
import { matrix } from "@azure/test-utils";
import { isPlaybackMode, Recorder } from "@azure/test-utils-recorder";
import { isPlaybackMode, Recorder } from "@azure-tools/test-recorder";
import { CommunicationIdentityClient } from "../../src";
import {
createRecordedCommunicationIdentityClient,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import { assert } from "chai";
import { matrix } from "@azure/test-utils";
import { env, isPlaybackMode, Recorder } from "@azure/test-utils-recorder";
import { env, isPlaybackMode, Recorder } from "@azure-tools/test-recorder";
import { UsernamePasswordCredential } from "@azure/identity";
import { CommunicationAccessToken, CommunicationIdentityClient } from "../../../src";
import {
Expand Down
Loading