Test Generation in Modular

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

@@ -41,7 +41,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_";
@@ -226,7 +226,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);
@@ -242,7 +242,7 @@ class BinderImp implements Binder {
       }
     });
 
-    this.cleanUnreferencedHelpers(sourceRoot);
+    this.cleanUnreferencedHelpers(sourceRoot, testRoot);
   }
 
   private resolveDependencyReferences(file: SourceFile) {
@@ -302,7 +302,7 @@ class BinderImp implements Binder {
     this.references.get(refkey)!.add(sourceFile);
   }
 
-  private cleanUnreferencedHelpers(sourceRoot: string) {
+  private cleanUnreferencedHelpers(sourceRoot: string, testRoot?: string) {
     const usedHelperFiles = new Set<SourceFile>();
     for (const helper of this.staticHelpers.values()) {
       const sourceFile = helper[SourceFileSymbol];
@@ -319,13 +319,24 @@ class BinderImp implements Binder {
       }
     }
 
+    // delete unused helper files
     this.project
       //normalizae the final path to adapt to different systems
       .getSourceFiles(
         normalizePath(path.join(sourceRoot, "static-helpers/**/*.ts"))
       )
       .filter((helperFile) => !usedHelperFiles.has(helperFile))
       .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((helperFile) => !usedHelperFiles.has(helperFile))
+      .forEach((helperFile) => helperFile.delete());
   }
 }
 

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

@@ -35,76 +35,97 @@ 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;
+}
+
+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
   );
+  await loadFiles(filesInSources, options.sourcesDir ?? "");
+  // Load static helpers used in testing code
+  const defaultTestingHelpersPath = path.join(
+    resolveProjectRoot(),
+    DEFAULT_SOURCES_TESTING_HELPERS_PATH
+  );
+  const filesInTestings = await traverseDirectory(
+    defaultTestingHelpersPath,
+    [],
+    "",
+    "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(
@@ -158,11 +179,11 @@ function getDeclarationByMetadata(
   }
 }
 
-const _targetStaticHelpersBaseDir = "static-helpers";
 async function traverseDirectory(
   directory: string,
   result: { source: string; target: string }[] = [],
-  relativePath: string = ""
+  relativePath: string = "",
+  targetBaseDir: string = "static-helpers"
 ): Promise<{ source: string; target: string }[]> {
   try {
     const files = await readdir(directory);
@@ -176,18 +197,15 @@ async function traverseDirectory(
           await traverseDirectory(
             filePath,
             result,
-            path.join(relativePath, file)
+            path.join(relativePath, file),
+            targetBaseDir
           );
         } else if (
           fileStat.isFile() &&
           !file.endsWith(".d.ts") &&
           file.endsWith(".ts")
         ) {
-          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,12 +6,14 @@ import {
   AzureCoreDependencies,
   AzureIdentityDependencies,
   AzurePollingDependencies,
-  DefaultCoreDependencies
+  DefaultCoreDependencies,
+  AzureTestDependencies
 } from "./modular/external-dependencies.js";
 import { EmitContext, Program } from "@typespec/compiler";
 import { GenerationDirDetail, SdkContext } from "./utils/interfaces.js";
 import {
   CloudSettingHelpers,
+  CreateRecorderHelpers,
   MultipartHelpers,
   PagingHelpers,
   PollingHelpers,
@@ -93,6 +95,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";
 
 export * from "./lib.js";
 
@@ -133,10 +136,12 @@ export async function $onEmit(context: EmitContext) {
       ...PollingHelpers,
       ...UrlTemplateHelpers,
       ...MultipartHelpers,
-      ...CloudSettingHelpers
+      ...CloudSettingHelpers,
+      ...CreateRecorderHelpers
     },
     {
       sourcesDir: dpgContext.generationPathDetail?.modularSourcesDir,
+      rootDir: dpgContext.generationPathDetail?.rootDir,
       options: rlcOptions
     }
   );
@@ -145,7 +150,8 @@ export async function $onEmit(context: EmitContext) {
     ? {
         ...AzurePollingDependencies,
         ...AzureCoreDependencies,
-        ...AzureIdentityDependencies
+        ...AzureIdentityDependencies,
+        ...AzureTestDependencies
       }
     : { ...DefaultCoreDependencies };
   console.time("onEmit: provide binder");
@@ -355,8 +361,18 @@ export async function $onEmit(context: EmitContext) {
       }
     }
 
+    // Enable modular test generation when explicitly set to true
+    if (emitterOptions["experimental-generate-test-files"] === true) {
+      console.time("onEmit: emit tests");
+      await emitTests(dpgContext);
+      console.timeEnd("onEmit: emit tests");
+    }
+
     console.time("onEmit: resolve references");
-    binder.resolveAllReferences(modularSourcesRoot);
+    binder.resolveAllReferences(
+      modularSourcesRoot,
+      dpgContext.generationPathDetail?.rootDir ?? ""
+    );
     if (program.compilerOptions.noEmit || program.hasError()) {
       return;
     }

packages/typespec-ts/src/lib.ts

@@ -70,6 +70,7 @@ export interface EmitterOptions {
   "default-value-object"?: boolean;
   //TODO should remove this after finish the release tool test
   "should-use-pnpm-dep"?: boolean;
+  "experimental-generate-test-files"?: boolean;
 }
 
 export const RLCOptionsSchema: JSONSchemaType<EmitterOptions> = {
@@ -335,6 +336,11 @@ export const RLCOptionsSchema: JSONSchemaType<EmitterOptions> = {
       type: "boolean",
       nullable: true,
       description: "Internal option for test."
+    },
+    "experimental-generate-test-files": {
+      type: "boolean",
+      nullable: true,
+      description: "Whether to generate test files for the client."
     }
   },
   required: []