feat: Test generation for modular SDK clients

packages/typespec-ts/src/framework/hooks/binder.ts

@@ -42,7 +42,7 @@ export interface Binder {
     sourceFile: SourceFile
   ): string;
   resolveReference(refkey: unknown): string;
-  resolveAllReferences(sourceRoot: string): void;
+  resolveAllReferences(sourceRoot: string, testRoot?: string): void;
 }
 
 const PLACEHOLDER_PREFIX = "__PLACEHOLDER_";
@@ -216,7 +216,7 @@ class BinderImp implements Binder {
   /**
    * Applies all tracked imports to their respective source files.
    */
-  resolveAllReferences(sourceRoot: string): void {
+  resolveAllReferences(sourceRoot: string, testRoot?: string): void {
     this.project.getSourceFiles().map((file) => {
       this.resolveDeclarationReferences(file);
       this.resolveDependencyReferences(file);
@@ -232,7 +232,7 @@ class BinderImp implements Binder {
       }
     });
 
-    this.cleanUnreferencedHelpers(sourceRoot);
+    this.cleanUnreferencedHelpers(sourceRoot, testRoot);
   }
 
   private resolveDependencyReferences(file: SourceFile) {
@@ -292,7 +292,7 @@ class BinderImp implements Binder {
     this.references.get(refkey)!.add(sourceFile);
   }
 
-  private cleanUnreferencedHelpers(sourceRoot: string) {
+  private cleanUnreferencedHelpers(sourceRoot: string, testRoot?: string) {
     const usedHelperNames: string[] = [];
     for (const helper of this.staticHelpers.values()) {
       const sourceFile = helper[SourceFileSymbol];
@@ -311,7 +311,6 @@ class BinderImp implements Binder {
 
     function isFileUnused(file: SourceFile) {
       const name = file.getBaseNameWithoutExtension();
-
       // If one of the used helpers' name is a prefix of this file, the file likely represents a platform-specific implementation of the helper
       // so it should be marked as used even if the file has no direct references.
       return !usedHelperNames.some((s) => name.startsWith(s));
@@ -324,6 +323,17 @@ class BinderImp implements Binder {
       )
       .filter(isFileUnused)
       .forEach((helperFile) => helperFile.delete());
+
+    if (!testRoot) {
+      return;
+    }
+    this.project
+      //normalizae the final path to adapt to different systems
+      .getSourceFiles(
+        normalizePath(path.join(testRoot, "test/generated/util/**/*.*ts"))
+      )
+      .filter(isFileUnused)
+      .forEach((helperFile) => helperFile.delete());
   }
 }
 

packages/typespec-ts/src/framework/load-static-helpers.ts

@@ -37,77 +37,107 @@ export function isStaticHelperMetadata(
 
 export type StaticHelpers = Record<string, StaticHelperMetadata>;
 
-const DEFAULT_STATIC_HELPERS_PATH = "static/static-helpers";
+const DEFAULT_SOURCES_STATIC_HELPERS_PATH = "static/static-helpers";
+const DEFAULT_SOURCES_TESTING_HELPERS_PATH = "static/test-helpers";
 
 export interface LoadStaticHelpersOptions extends Partial<ModularEmitterOptions> {
   helpersAssetDirectory?: string;
   sourcesDir?: string;
+  rootDir?: string;
   program?: Program;
+  /** When true, also load test helpers from static/test-helpers/ into test/generated/util/ */
+  loadTestHelpers?: boolean;
+}
+
+interface FileMetadata {
+  source: string;
+  target: string;
 }
 
 export async function loadStaticHelpers(
   project: Project,
   helpers: StaticHelpers,
   options: LoadStaticHelpersOptions = {}
 ): Promise<Map<string, StaticHelperMetadata>> {
-  const sourcesDir = options.sourcesDir ?? "";
   const helpersMap = new Map<string, StaticHelperMetadata>();
+  // Load static helpers used in sources code
   const defaultStaticHelpersPath = path.join(
     resolveProjectRoot(),
-    DEFAULT_STATIC_HELPERS_PATH
+    DEFAULT_SOURCES_STATIC_HELPERS_PATH
   );
-  const files = await traverseDirectory(
+  const filesInSources = await traverseDirectory(
     options.helpersAssetDirectory ?? defaultStaticHelpersPath,
     options.program
   );
+  await loadFiles(filesInSources, options.sourcesDir ?? "");
+  // Load static helpers used in testing code (only when loadTestHelpers is enabled)
+  if (
+    options.loadTestHelpers ??
+    (options.options?.generateTest &&
+      isAzurePackage({ options: options.options }))
+  ) {
+    const defaultTestingHelpersPath = path.join(
+      resolveProjectRoot(),
+      DEFAULT_SOURCES_TESTING_HELPERS_PATH
+    );
+    const filesInTestings = await traverseDirectory(
+      defaultTestingHelpersPath,
+      options.program,
+      [],
+      "",
+      "test/generated/util"
+    );
+    await loadFiles(filesInTestings, options.rootDir ?? "");
+  }
+  return assertAllHelpersLoadedPresent(helpersMap);
 
-  for (const file of files) {
-    const targetPath = path.join(sourcesDir, file.target);
-    const contents = await readFile(file.source, "utf-8");
-    const addedFile = project.createSourceFile(targetPath, contents, {
-      overwrite: true
-    });
-    addedFile.getImportDeclarations().map((i) => {
-      if (!isAzurePackage({ options: options.options })) {
-        if (
-          i
-            .getModuleSpecifier()
-            .getFullText()
-            .includes("@azure/core-rest-pipeline")
-        ) {
-          i.setModuleSpecifier("@typespec/ts-http-runtime");
+  async function loadFiles(files: FileMetadata[], generateDir: string) {
+    for (const file of files) {
+      const targetPath = path.join(generateDir, file.target);
+      const contents = await readFile(file.source, "utf-8");
+      const addedFile = project.createSourceFile(targetPath, contents, {
+        overwrite: true
+      });
+      addedFile.getImportDeclarations().map((i) => {
+        if (!isAzurePackage({ options: options.options })) {
+          if (
+            i
+              .getModuleSpecifier()
+              .getFullText()
+              .includes("@azure/core-rest-pipeline")
+          ) {
+            i.setModuleSpecifier("@typespec/ts-http-runtime");
+          }
+          if (
+            i
+              .getModuleSpecifier()
+              .getFullText()
+              .includes("@azure-rest/core-client")
+          ) {
+            i.setModuleSpecifier("@typespec/ts-http-runtime");
+          }
         }
-        if (
-          i
-            .getModuleSpecifier()
-            .getFullText()
-            .includes("@azure-rest/core-client")
-        ) {
-          i.setModuleSpecifier("@typespec/ts-http-runtime");
+      });
+
+      for (const entry of Object.values(helpers)) {
+        if (!addedFile.getFilePath().endsWith(entry.location)) {
+          continue;
         }
-      }
-    });
 
-    for (const entry of Object.values(helpers)) {
-      if (!addedFile.getFilePath().endsWith(entry.location)) {
-        continue;
-      }
+        const declaration = getDeclarationByMetadata(addedFile, entry);
+        if (!declaration) {
+          throw new Error(
+            `Declaration ${
+              entry.name
+            } not found in file ${addedFile.getFilePath()}\n This is an Emitter bug, make sure that the map of static helpers passed to loadStaticHelpers matches what is in the file.`
+          );
+        }
 
-      const declaration = getDeclarationByMetadata(addedFile, entry);
-      if (!declaration) {
-        throw new Error(
-          `Declaration ${
-            entry.name
-          } not found in file ${addedFile.getFilePath()}\n This is an Emitter bug, make sure that the map of static helpers passed to loadStaticHelpers matches what is in the file.`
-        );
+        entry[SourceFileSymbol] = addedFile;
+        helpersMap.set(refkey(entry), entry);
       }
-
-      entry[SourceFileSymbol] = addedFile;
-      helpersMap.set(refkey(entry), entry);
     }
   }
-
-  return assertAllHelpersLoadedPresent(helpersMap);
 }
 
 function assertAllHelpersLoadedPresent(
@@ -166,7 +196,8 @@ async function traverseDirectory(
   directory: string,
   program?: Program,
   result: { source: string; target: string }[] = [],
-  relativePath: string = ""
+  relativePath: string = "",
+  targetBaseDir: string = _targetStaticHelpersBaseDir
 ): Promise<{ source: string; target: string }[]> {
   try {
     const files = await readdir(directory);
@@ -181,18 +212,15 @@ async function traverseDirectory(
             filePath,
             program,
             result,
-            path.join(relativePath, file)
+            path.join(relativePath, file),
+            targetBaseDir
           );
         } else if (
           fileStat.isFile() &&
           !file.endsWith(".d.ts") &&
           /.*\..?ts$/.test(file)
         ) {
-          const target = path.join(
-            _targetStaticHelpersBaseDir,
-            relativePath,
-            file
-          );
+          const target = path.join(targetBaseDir, relativePath, file);
           result.push({ source: filePath, target });
         }
       })

packages/typespec-ts/src/index.ts

@@ -6,13 +6,15 @@ import {
   AzureCoreDependencies,
   AzureIdentityDependencies,
   AzurePollingDependencies,
-  DefaultCoreDependencies
+  DefaultCoreDependencies,
+  AzureTestDependencies
 } from "./modular/external-dependencies.js";
 import { clearDirectory } from "./utils/fileSystemUtils.js";
 import { EmitContext, Program } from "@typespec/compiler";
 import { GenerationDirDetail, SdkContext } from "./utils/interfaces.js";
 import {
   CloudSettingHelpers,
+  CreateRecorderHelpers,
   MultipartHelpers,
   PagingHelpers,
   PollingHelpers,
@@ -107,6 +109,7 @@ import { provideSdkTypes } from "./framework/hooks/sdkTypes.js";
 import { transformRLCModel } from "./transform/transform.js";
 import { transformRLCOptions } from "./transform/transfromRLCOptions.js";
 import { emitSamples } from "./modular/emitSamples.js";
+import { emitTests } from "./modular/emitTests.js";
 import { generateCrossLanguageDefinitionFile } from "./utils/crossLanguageDef.js";
 import { getClassicalClientName } from "./modular/helpers/namingHelpers.js";
 
@@ -148,10 +151,12 @@ export async function $onEmit(context: EmitContext) {
       ...MultipartHelpers,
       ...CloudSettingHelpers,
       ...XmlHelpers,
+      ...(rlcOptions.generateTest ? CreateRecorderHelpers : {}),
       ...(rlcOptions.enableStorageCompat ? StorageCompatHelpers : {})
     },
     {
       sourcesDir: dpgContext.generationPathDetail?.modularSourcesDir,
+      rootDir: dpgContext.generationPathDetail?.rootDir,
       options: rlcOptions,
       program
     }
@@ -160,7 +165,8 @@ export async function $onEmit(context: EmitContext) {
     ? {
         ...AzurePollingDependencies,
         ...AzureCoreDependencies,
-        ...AzureIdentityDependencies
+        ...AzureIdentityDependencies,
+        ...AzureTestDependencies
       }
     : { ...DefaultCoreDependencies };
   const binder = provideBinder(outputProject, {
@@ -382,7 +388,15 @@ export async function $onEmit(context: EmitContext) {
       }
     }
 
-    binder.resolveAllReferences(modularSourcesRoot);
+    // Enable modular test generation when generateTest is true
+    if (dpgContext.rlcOptions?.generateTest === true) {
+      await emitTests(dpgContext);
+    }
+
+    binder.resolveAllReferences(
+      modularSourcesRoot,
+      dpgContext.generationPathDetail?.rootDir
+    );
     if (program.compilerOptions.noEmit || program.hasError()) {
       return;
     }
@@ -454,7 +468,7 @@ export async function $onEmit(context: EmitContext) {
       "test"
     );
     const hasTestFolder = await existsSync(existingTestFolderPath);
-    if (option.azureSdkForJs && option.generateTest === undefined) {
+    if (option.generateTest === undefined) {
       if (hasTestFolder) {
         option.generateTest = false;
       } else {
@@ -536,7 +550,7 @@ export async function $onEmit(context: EmitContext) {
       }
 
       // TODO: need support snippets generation for multi-client cases. https://github.com/Azure/autorest.typescript/issues/3048
-      if (option.generateTest && isAzureFlavor) {
+      if (option.generateTest) {
         for (const subClient of dpgContext.sdkPackage.clients) {
           commonBuilders.push((model) =>
             buildSnippets(model, subClient.name, option.azureSdkForJs)
@@ -633,7 +647,7 @@ export async function $onEmit(context: EmitContext) {
     }
 
     // Generate test relevant files
-    if (option.generateTest && isAzureFlavor && !hasTestFolder) {
+    if (option.generateTest && !hasTestFolder) {
       await emitContentByBuilder(
         program,
         [buildRecordedClientFile, buildSampleTest],