@azure-tools/typespec-ts 0.54.0 → 0.55.0-dev.6

package/src/modular/emitTests.ts

@@ -1,22 +1,22 @@
+import { existsSync, rmSync } from "fs";
+import { join } from "path";
 import { SourceFile } from "ts-morph";
-import { SdkContext } from "../utils/interfaces.js";
+import { resolveReference } from "../framework/reference.js";
 import { NameType, normalizeName } from "../rlc-common/index.js";
-import { join } from "path";
-import { existsSync, rmSync } from "fs";
-import { getClassicalClientName } from "./helpers/namingHelpers.js";
+import { SdkContext } from "../utils/interfaces.js";
 import { ServiceOperation } from "../utils/operationUtil.js";
+import { AzureTestDependencies } from "./external-dependencies.js";
 import {
   buildParameterValueMap,
-  prepareCommonParameters,
-  getDescriptiveName,
   ClientEmitOptions,
-  iterateClientsAndMethods,
-  generateMethodCall,
   createSourceFile,
-  generateResponseAssertions
+  generateMethodCall,
+  generateResponseAssertions,
+  getDescriptiveName,
+  iterateClientsAndMethods,
+  prepareCommonParameters,
 } from "./helpers/exampleValueHelpers.js";
-import { AzureTestDependencies } from "./external-dependencies.js";
-import { resolveReference } from "../framework/reference.js";
+import { getClassicalClientName } from "./helpers/namingHelpers.js";
 import { CreateRecorderHelpers } from "./static-helpers-metadata.js";
 
 /**
@@ -24,19 +24,12 @@ import { CreateRecorderHelpers } from "./static-helpers-metadata.js";
  */
 async function cleanupTestFolder(dpgContext: SdkContext) {
   const clients = dpgContext.sdkPackage.clients;
-  const baseTestFolder = join(
-    dpgContext.generationPathDetail?.rootDir ?? "",
-    "test",
-    "generated"
-  );
+  const baseTestFolder = join(dpgContext.generationPathDetail?.rootDir ?? "", "test", "generated");
 
   // If there are multiple clients, clean up subfolders
   if (clients.length > 1) {
     for (const client of clients) {
-      const subFolder = normalizeName(
-        getClassicalClientName(client),
-        NameType.File
-      );
+      const subFolder = normalizeName(getClassicalClientName(client), NameType.File);
       const clientTestFolder = join(baseTestFolder, subFolder);
       if (existsSync(clientTestFolder)) {
         rmSync(clientTestFolder, { recursive: true, force: true });
@@ -63,24 +56,16 @@ export async function emitTests(dpgContext: SdkContext): Promise<SourceFile[]> {
 function emitMethodTests(
   dpgContext: SdkContext,
   method: ServiceOperation,
-  options: ClientEmitOptions
+  options: ClientEmitOptions,
 ): SourceFile | undefined {
   const examples = method.operation.examples ?? [];
   if (examples.length === 0) {
     return;
   }
 
-  const methodPrefix = `${options.classicalMethodPrefix ?? ""} ${
-    method.oriName ?? method.name
-  }`;
+  const methodPrefix = `${options.classicalMethodPrefix ?? ""} ${method.oriName ?? method.name}`;
   const fileName = normalizeName(`${methodPrefix} Test`, NameType.File);
-  const sourceFile = createSourceFile(
-    dpgContext,
-    method,
-    options,
-    "test",
-    fileName
-  );
+  const sourceFile = createSourceFile(dpgContext, method, options, "test", fileName);
   const clientName = getClassicalClientName(options.client);
 
   // Use resolveReference for test dependencies to let the binder handle imports automatically
@@ -90,21 +75,17 @@ function emitMethodTests(
   const afterEachType = resolveReference(AzureTestDependencies.afterEach);
   const itType = resolveReference(AzureTestDependencies.it);
   const describeType = resolveReference(AzureTestDependencies.describe);
-  const createRecorderHelper = resolveReference(
-    CreateRecorderHelpers.createRecorder
-  );
+  const createRecorderHelper = resolveReference(CreateRecorderHelpers.createRecorder);
 
   // Compute the relative path from the generated test file to src/index.js.
   // Single-client files land at test/generated/<file>.spec.ts (2 levels up),
   // while multi-client files land at test/generated/<subFolder>/<file>.spec.ts (3 levels up).
-  const srcIndexRelativePath = options.subFolder
-    ? "../../../src/index.js"
-    : "../../src/index.js";
+  const srcIndexRelativePath = options.subFolder ? "../../../src/index.js" : "../../src/index.js";
 
   // Import the client
   sourceFile.addImportDeclaration({
     moduleSpecifier: srcIndexRelativePath,
-    namedImports: [clientName]
+    namedImports: [clientName],
   });
 
   const testFunctions = [];
@@ -112,8 +93,7 @@ function emitMethodTests(
   let clientParameterDefs: string[] = [];
 
   // Create test describe block
-  const methodDescription =
-    method.doc ?? `test ${method.oriName ?? method.name}`;
+  const methodDescription = method.doc ?? `test ${method.oriName ?? method.name}`;
   let normalizedDescription =
     methodDescription.charAt(0).toLowerCase() + methodDescription.slice(1);
 
@@ -126,27 +106,16 @@ function emitMethodTests(
     // Create a more descriptive test name based on the operation (same as samples)
     const testName = getDescriptiveName(method, example.name, "test");
     const parameterMap = buildParameterValueMap(example);
-    const parameters = prepareCommonParameters(
-      dpgContext,
-      method,
-      parameterMap,
-      options.client
-    );
+    const parameters = prepareCommonParameters(dpgContext, method, parameterMap, options.client);
 
     // Prepare client-level parameters
-    const requiredClientParams = parameters.filter(
-      (p) => p.onClient && !p.isOptional
-    );
-    clientParameterDefs = requiredClientParams.map(
-      (p) => `const ${p.name} = ${p.value};`
-    );
+    const requiredClientParams = parameters.filter((p) => p.onClient && !p.isOptional);
+    clientParameterDefs = requiredClientParams.map((p) => `const ${p.name} = ${p.value};`);
     clientParamNames = requiredClientParams.map((p) => p.name);
     // add client options to parameters
     // const clientOptions = recorder.configureClientOptions({});
     clientParamNames.push("clientOptions");
-    clientParameterDefs.push(
-      `const clientOptions = recorder.configureClientOptions({});`
-    );
+    clientParameterDefs.push(`const clientOptions = recorder.configureClientOptions({});`);
 
     const { methodCall } = generateMethodCall(method, parameters, options);
 
@@ -160,15 +129,13 @@ function emitMethodTests(
       testFunctionBody.push(`/* Test passes if no exception is thrown */`);
     } else if (isPaging) {
       testFunctionBody.push(`const resArray = new Array();`);
-      testFunctionBody.push(
-        `for await (const item of ${methodCall}) { resArray.push(item); }`
-      );
+      testFunctionBody.push(`for await (const item of ${methodCall}) { resArray.push(item); }`);
       testFunctionBody.push(`${assertType}.ok(resArray);`);
       // Add response assertions for paging results
       const pagingAssertions = generateResponseAssertions(
         example,
         "resArray",
-        true // isPaging = true
+        true, // isPaging = true
       );
       testFunctionBody.push(...pagingAssertions);
     } else if (isLRO) {
@@ -188,7 +155,7 @@ function emitMethodTests(
     // Create a test function
     const testFunction = {
       name: testName,
-      body: testFunctionBody
+      body: testFunctionBody,
     };
 
     testFunctions.push(testFunction);
@@ -216,7 +183,7 @@ ${testFunctions
   ${itType}("should ${fn.name}", async function() {
     ${fn.body.join("\n    ")}
   });
-`
+`,
   )
   .join("")}
 });`;

package/src/modular/external-dependencies.ts

@@ -4,258 +4,258 @@ export const DefaultCoreDependencies: CoreDependencies = {
   Client: {
     kind: "externalDependency",
     name: "Client",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   ClientOptions: {
     kind: "externalDependency",
     name: "ClientOptions",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   Pipeline: {
     kind: "externalDependency",
     name: "Pipeline",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   getClient: {
     kind: "externalDependency",
     name: "getClient",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   RestError: {
     kind: "externalDependency",
     name: "RestError",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   OperationOptions: {
     kind: "externalDependency",
     name: "OperationOptions",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   StreamableMethod: {
     kind: "externalDependency",
     name: "StreamableMethod",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   PathUncheckedResponse: {
     kind: "externalDependency",
     name: "PathUncheckedResponse",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   AbortSignalLike: {
     kind: "externalDependency",
     name: "AbortSignalLike",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   createRestError: {
     kind: "externalDependency",
     name: "createRestError",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   operationOptionsToRequestParameters: {
     kind: "externalDependency",
     name: "operationOptionsToRequestParameters",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   uint8ArrayToString: {
     kind: "externalDependency",
     name: "uint8ArrayToString",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   stringToUint8Array: {
     kind: "externalDependency",
     name: "stringToUint8Array",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   KeyCredential: {
     kind: "externalDependency",
     name: "KeyCredential",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   isKeyCredential: {
     kind: "externalDependency",
     name: "isKeyCredential",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   TokenCredential: {
     kind: "externalDependency",
     name: "TokenCredential",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   ErrorModel: {
     kind: "externalDependency",
     name: "ErrorModel",
-    module: "@typespec/ts-http-runtime"
+    module: "@typespec/ts-http-runtime",
   },
   AzureCoreErrorResponse: {
     kind: "externalDependency",
     name: "ErrorResponse",
-    module: "@azure-rest/core-client"
-  }
+    module: "@azure-rest/core-client",
+  },
 } as const;
 
 export const AzurePollingDependencies = {
   PollerLike: {
     kind: "externalDependency",
     module: "@azure/core-lro",
-    name: "PollerLike"
+    name: "PollerLike",
   },
   OperationState: {
     kind: "externalDependency",
     module: "@azure/core-lro",
-    name: "OperationState"
+    name: "OperationState",
   },
   DeserializeState: {
     kind: "externalDependency",
     module: "@azure/core-lro",
-    name: "deserializeState"
+    name: "deserializeState",
   },
   ResourceLocationConfig: {
     kind: "externalDependency",
     module: "@azure/core-lro",
-    name: "ResourceLocationConfig"
-  }
+    name: "ResourceLocationConfig",
+  },
 };
 
 export const AzureCoreDependencies: CoreDependencies = {
   Client: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "Client"
+    name: "Client",
   },
   ClientOptions: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "ClientOptions"
+    name: "ClientOptions",
   },
   Pipeline: {
     kind: "externalDependency",
     module: "@azure/core-rest-pipeline",
-    name: "Pipeline"
+    name: "Pipeline",
   },
   getClient: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "getClient"
+    name: "getClient",
   },
   RestError: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "RestError"
+    name: "RestError",
   },
   OperationOptions: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "OperationOptions"
+    name: "OperationOptions",
   },
   StreamableMethod: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "StreamableMethod"
+    name: "StreamableMethod",
   },
   PathUncheckedResponse: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "PathUncheckedResponse"
+    name: "PathUncheckedResponse",
   },
   AbortSignalLike: {
     kind: "externalDependency",
     module: "@azure/abort-controller",
-    name: "AbortSignalLike"
+    name: "AbortSignalLike",
   },
   createRestError: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "createRestError"
+    name: "createRestError",
   },
   operationOptionsToRequestParameters: {
     kind: "externalDependency",
     module: "@azure-rest/core-client",
-    name: "operationOptionsToRequestParameters"
+    name: "operationOptionsToRequestParameters",
   },
   uint8ArrayToString: {
     kind: "externalDependency",
     module: "@azure/core-util",
-    name: "uint8ArrayToString"
+    name: "uint8ArrayToString",
   },
   stringToUint8Array: {
     kind: "externalDependency",
     module: "@azure/core-util",
-    name: "stringToUint8Array"
+    name: "stringToUint8Array",
   },
   KeyCredential: {
     kind: "externalDependency",
     name: "KeyCredential",
-    module: "@azure/core-auth"
+    module: "@azure/core-auth",
   },
   isKeyCredential: {
     kind: "externalDependency",
     name: "isKeyCredential",
-    module: "@azure/core-auth"
+    module: "@azure/core-auth",
   },
   TokenCredential: {
     kind: "externalDependency",
     name: "TokenCredential",
-    module: "@azure/core-auth"
+    module: "@azure/core-auth",
   },
   ErrorModel: {
     kind: "externalDependency",
     name: "ErrorModel",
-    module: "@azure-rest/core-client"
+    module: "@azure-rest/core-client",
   },
   AzureCoreErrorResponse: {
     kind: "externalDependency",
     name: "ErrorResponse",
-    module: "@azure-rest/core-client"
-  }
+    module: "@azure-rest/core-client",
+  },
 };
 
 export const AzureIdentityDependencies = {
   DefaultAzureCredential: {
     kind: "externalDependency",
     module: "@azure/identity",
-    name: "DefaultAzureCredential"
-  }
+    name: "DefaultAzureCredential",
+  },
 };
 
 export const AzureTestDependencies = {
   Recorder: {
     kind: "externalDependency",
     module: "@azure-tools/test-recorder",
-    name: "Recorder"
+    name: "Recorder",
   },
   env: {
     kind: "externalDependency",
     module: "@azure-tools/test-recorder",
-    name: "env"
+    name: "env",
   },
   createTestCredential: {
     kind: "externalDependency",
     module: "@azure-tools/test-credential",
-    name: "createTestCredential"
+    name: "createTestCredential",
   },
   assert: {
     kind: "externalDependency",
     module: "vitest",
-    name: "assert"
+    name: "assert",
   },
   beforeEach: {
     kind: "externalDependency",
     module: "vitest",
-    name: "beforeEach"
+    name: "beforeEach",
   },
   afterEach: {
     kind: "externalDependency",
     module: "vitest",
-    name: "afterEach"
+    name: "afterEach",
   },
   it: {
     kind: "externalDependency",
     module: "vitest",
-    name: "it"
+    name: "it",
   },
   describe: {
     kind: "externalDependency",
     module: "vitest",
-    name: "describe"
-  }
+    name: "describe",
+  },
 } as const;