[Unified Recorder] TestProxyClient takes test context to generate recordings at desired location

sdk/test-utils/recorder-new/package.json

@@ -59,7 +59,8 @@
   "dependencies": {
     "@azure-tools/test-recorder": "^1.0.0",
     "@azure/core-http": "^2.0.0",
-    "@azure/core-rest-pipeline": "^1.1.0"
+    "@azure/core-rest-pipeline": "^1.1.0",
+    "@azure/test-utils": "^1.0.0"
   },
   "devDependencies": {
     "@azure/dev-tool": "^1.0.0",

sdk/test-utils/recorder-new/src/core-v1-recorder.ts

@@ -5,6 +5,7 @@ import { HttpClient, HttpOperationResponse } from "@azure/core-http";
 import { DefaultHttpClient, WebResourceLike } from "@azure/core-http";
 import { isPlaybackMode, isRecordMode } from "@azure-tools/test-recorder";
 import { TestProxyHttpClient } from "./core-v2-recorder";
+import { Suite } from "mocha";
 
 /**
  * This client manages the recorder life cycle and interacts with the proxy-tool to do the recording,
@@ -15,8 +16,8 @@ import { TestProxyHttpClient } from "./core-v2-recorder";
  */
 export class TestProxyHttpClientCoreV1 extends TestProxyHttpClient {
   public httpClientCoreV1: HttpClient;
-  constructor(sessionFile: string) {
-    super(sessionFile);
+  constructor(testContext?: { parent?: Suite | undefined; title: string }) {
+    super(testContext);
     this.httpClientCoreV1 = new DefaultHttpClient();
   }
 

sdk/test-utils/recorder-new/src/core-v2-recorder.ts

@@ -11,8 +11,15 @@ import {
   PipelineResponse,
   SendRequest
 } from "@azure/core-rest-pipeline";
-import { env, isPlaybackMode, isRecordMode } from "@azure-tools/test-recorder";
+import {
+  env,
+  generateTestRecordingFilePath,
+  isPlaybackMode,
+  isRecordMode
+} from "@azure-tools/test-recorder";
 import { RecorderError, RecordingStateManager } from "./utils";
+import { isNode } from "@azure/test-utils";
+import { Suite } from "mocha";
 
 const paths = {
   playback: "/playback",
@@ -35,12 +42,30 @@ export class TestProxyHttpClient {
   public httpClient: HttpClient;
   private stateManager = new RecordingStateManager();
   private playback: boolean;
+  private sessionFile: string;
 
-  constructor(private sessionFile: string) {
-    this.sessionFile = sessionFile;
-    this.mode = env.TEST_MODE;
-    this.playback = isPlaybackMode();
-    this.httpClient = createDefaultHttpClient();
+  constructor(
+    private testContext?: {
+      parent?: Suite | undefined;
+      title?: string;
+    }
+  ) {
+    if (!this.testContext) {
+      // throw error in record and playback modes saying that file path is undetermined
+      throw new Error("");
+    } else {
+      this.sessionFile =
+        "sdk/test-utils/testing-recorder-new/recordings/" +
+        `${generateTestRecordingFilePath(
+          isNode ? "node" : "browsers",
+          this.testContext.parent!.fullTitle(),
+          this.testContext.title!,
+          "json"
+        )}`;
+      this.mode = env.TEST_MODE;
+      this.playback = isPlaybackMode();
+      this.httpClient = createDefaultHttpClient();
+    }
   }
 
   /**

sdk/test-utils/recorder-new/test/testProxyClient.spec.ts

@@ -6,6 +6,7 @@ import { env } from "@azure-tools/test-recorder";
 import { expect } from "chai";
 import { TestProxyHttpClient } from "../src";
 import { RecorderError, RecordingStateManager } from "../src/utils";
+import { Suite } from "mocha";
 
 describe("TestProxyClient functions", () => {
   afterEach(() => {
@@ -21,11 +22,14 @@ describe("TestProxyClient functions", () => {
     timeout: 0,
     allowInsecureConnection: false
   };
-
+  const fakeTestContext = {
+    parent: { fullTitle: () => "" },
+    title: "dummy_file_name"
+  } as Suite;
   describe("redirectRequest method", () => {
     it("request unchanged if not playback or record modes", function() {
       env.TEST_MODE = "live";
-      const client = new TestProxyHttpClient("dummy_file_name");
+      const client = new TestProxyHttpClient(fakeTestContext);
       expect(client.redirectRequest(initialRequest)).to.deep.equal(initialRequest);
     });
 
@@ -36,7 +40,7 @@ describe("TestProxyClient functions", () => {
           ...initialRequest,
           headers: createHttpHeaders({ "x-recording-id": "dummy-recording-id" })
         };
-        const client = new TestProxyHttpClient("dummy_file_name");
+        const client = new TestProxyHttpClient(fakeTestContext);
         expect(client.redirectRequest(request)).to.deep.equal(request);
       });
 
@@ -46,7 +50,7 @@ describe("TestProxyClient functions", () => {
           ...initialRequest,
           headers: createHttpHeaders({})
         };
-        const client = new TestProxyHttpClient("dummy_file_name");
+        const client = new TestProxyHttpClient(fakeTestContext);
         client.recordingId = "dummy-recording-id";
         expect(client.redirectRequest(request)).to.deep.equal({
           ...request,
@@ -64,7 +68,7 @@ describe("TestProxyClient functions", () => {
   describe("start method", () => {
     it("nothing happens if not playback or record modes", async function() {
       env.TEST_MODE = "live";
-      const client = new TestProxyHttpClient("dummy_file_name");
+      const client = new TestProxyHttpClient(fakeTestContext);
       client.httpClient.sendRequest = (): Promise<PipelineResponse> => {
         throw new Error("should not have reached here");
       };
@@ -76,7 +80,7 @@ describe("TestProxyClient functions", () => {
         `${testMode} mode: ` + "succeeds in playback or record modes and gets a recordingId",
         async function() {
           env.TEST_MODE = testMode;
-          const client = new TestProxyHttpClient("dummy_file_name");
+          const client = new TestProxyHttpClient(fakeTestContext);
           const recordingId = "dummy-recording-id";
           client.httpClient.sendRequest = (): Promise<PipelineResponse> => {
             return Promise.resolve({
@@ -92,7 +96,7 @@ describe("TestProxyClient functions", () => {
 
       it("throws if not received a 200 status code", async function() {
         env.TEST_MODE = testMode;
-        const client = new TestProxyHttpClient("dummy_file_name");
+        const client = new TestProxyHttpClient(fakeTestContext);
         const recordingId = "dummy-recording-id";
         client.httpClient.sendRequest = (): Promise<PipelineResponse> => {
           return Promise.resolve({
@@ -112,7 +116,7 @@ describe("TestProxyClient functions", () => {
 
       it("throws if not received a recording id upon 200 status code", async function() {
         env.TEST_MODE = testMode;
-        const client = new TestProxyHttpClient("dummy_file_name");
+        const client = new TestProxyHttpClient(fakeTestContext);
         client.httpClient.sendRequest = (): Promise<PipelineResponse> => {
           return Promise.resolve({
             status: 200,
@@ -136,7 +140,7 @@ describe("TestProxyClient functions", () => {
   describe("stop method", () => {
     it("nothing happens if not playback or record modes", async function() {
       env.TEST_MODE = "live";
-      const client = new TestProxyHttpClient("dummy_file_name");
+      const client = new TestProxyHttpClient(fakeTestContext);
       client.httpClient.sendRequest = (): Promise<PipelineResponse> => {
         throw new Error("should not have reached here");
       };
@@ -148,7 +152,7 @@ describe("TestProxyClient functions", () => {
         `${testMode} mode: ` + "fails in playback or record modes if no recordingId",
         async function() {
           env.TEST_MODE = testMode;
-          const client = new TestProxyHttpClient("dummy_file_name");
+          const client = new TestProxyHttpClient(fakeTestContext);
           client.httpClient.sendRequest = (): Promise<PipelineResponse> => {
             return Promise.resolve({
               status: 200,
@@ -171,7 +175,7 @@ describe("TestProxyClient functions", () => {
 
       it("throws if status code is not 200", async function() {
         env.TEST_MODE = testMode;
-        const client = new TestProxyHttpClient("dummy_file_name");
+        const client = new TestProxyHttpClient(fakeTestContext);
         client.httpClient.sendRequest = (): Promise<PipelineResponse> => {
           return Promise.resolve({
             status: 401,
@@ -192,7 +196,7 @@ describe("TestProxyClient functions", () => {
 
       it("succeeds in playback or record modes", async function() {
         env.TEST_MODE = testMode;
-        const client = new TestProxyHttpClient("dummy_file_name");
+        const client = new TestProxyHttpClient(fakeTestContext);
         client.httpClient.sendRequest = (): Promise<PipelineResponse> => {
           return Promise.resolve({
             status: 200,
@@ -210,7 +214,7 @@ describe("TestProxyClient functions", () => {
   describe("modifyRequest method", () => {
     it("request unchanged if not playback or record modes", async function() {
       env.TEST_MODE = "live";
-      const client = new TestProxyHttpClient("dummy_file_name");
+      const client = new TestProxyHttpClient(fakeTestContext);
       expect(await client.modifyRequest(initialRequest)).to.deep.equal(initialRequest);
     });
 
@@ -223,7 +227,7 @@ describe("TestProxyClient functions", () => {
             ...initialRequest,
             headers: createHttpHeaders({ "x-recording-id": "dummy-recording-id" })
           };
-          const client = new TestProxyHttpClient("dummy_file_name");
+          const client = new TestProxyHttpClient(fakeTestContext);
           expect(await client.modifyRequest(request)).to.deep.equal(request);
         }
       );
@@ -234,7 +238,7 @@ describe("TestProxyClient functions", () => {
           ...initialRequest,
           headers: createHttpHeaders({})
         };
-        const client = new TestProxyHttpClient("dummy_file_name");
+        const client = new TestProxyHttpClient(fakeTestContext);
         client.recordingId = "dummy-recording-id";
         expect(await client.modifyRequest(request)).to.deep.equal({
           ...request,
@@ -251,7 +255,7 @@ describe("TestProxyClient functions", () => {
 
   describe("_createRecordingRequest", () => {
     it("_createRecordingRequest adds the recording-file and recording-id headers", () => {
-      const dummyFileName = "dummy_file_name";
+      const dummyFileName = fakeTestContext;
       const client = new TestProxyHttpClient(dummyFileName);
       client.recordingId = "dummy-recording-id";
       const returnedRequest = client["_createRecordingRequest"](initialRequest.url);

sdk/test-utils/recorder/src/index.ts

@@ -13,3 +13,4 @@ export {
 } from "./utils";
 export { pluginForIdentitySDK, pluginForClientSecretCredentialTests } from "./utils/msalAuth.node";
 export { jsonRecordingFilterFunction } from "./basekarma.conf";
+export { generateTestRecordingFilePath } from "./utils/recordingPath";

sdk/test-utils/recorder/src/utils/recordingPath.ts

@@ -25,11 +25,12 @@ export function formatPath(path: string): string {
 export function generateTestRecordingFilePath(
   platform: "node" | "browsers",
   testSuiteTitle: string,
-  testTitle: string
+  testTitle: string,
+  extension?: "js" | "json"
 ): string {
   // File Extension
   // nock recordings for node tests - .js extension
   // recordings are saved in json format for browser tests - .json extension
-  const ext = platform === "node" ? "js" : "json";
+  const ext = !extension ? (platform === "node" ? "js" : "json") : extension;
   return `${platform}/${formatPath(testSuiteTitle)}/recording_${formatPath(testTitle)}.${ext}`;
 }

sdk/test-utils/testing-recorder-new/test/core-v1-test.spec.ts

@@ -8,10 +8,9 @@ import { config } from "dotenv";
 import { isNode } from "@azure/core-util";
 config();
 
-describe("Tests", () => {
-  it("storage test", async function() {
-    const file = (isNode ? "node_" : "browser_") + `core_v1_file_path.json`;
-    const recorder = new TestProxyHttpClientCoreV1(file);
+describe("Core V1 tests", () => {
+  it("storage-queue create queue", async function() {
+    const recorder = new TestProxyHttpClientCoreV1(this.test);
     const options: StoragePipelineOptions = {};
     options.httpClient = recorder;
     const client = new QueueServiceClient(env.STORAGE_SAS_URL, undefined, options);

sdk/test-utils/testing-recorder-new/test/core-v2-test.spec.ts

@@ -5,14 +5,12 @@ import { env } from "@azure-tools/test-recorder";
 import { TableEntity, TableClient } from "@azure/data-tables";
 import { TestProxyHttpClient, recorderHttpPolicy } from "@azure-tools/test-recorder-new";
 import { config } from "dotenv";
-import { isNode } from "@azure/core-util";
 import { createSimpleEntity } from "./utils/utils";
 config();
 
-describe("Tests", () => {
-  it("tables test", async function() {
-    const file = (isNode ? "node_" : "browser_") + `core_v2_file_path.json`;
-    const recorder = new TestProxyHttpClient(file);
+describe("Core V2 tests", () => {
+  it("data-tables create entity", async function() {
+    const recorder = new TestProxyHttpClient(this.test);
     const client = TableClient.fromConnectionString(env.TABLES_SAS_CONNECTION_STRING, "newtable");
     client.pipeline.addPolicy(recorderHttpPolicy(recorder));
     await recorder.start();