@cdktn/provider-generator 0.25.0-pre.41 → 0.25.0-pre.42

package/src/__tests__/provider.test.ts

@@ -70,6 +70,27 @@ function resourceTypesPresentInSnapshot(
   return resources;
 }
 
+/**
+ * Rewrites the registry host in any fully-qualified-name key. The host records
+ * which CLI fetched the schema - terraform's or tofu's - rather than anything
+ * about the generated code, so one snapshot serves both.
+ */
+function stubRegistryHosts(value: any): any {
+  if (Array.isArray(value)) return value.map(stubRegistryHosts);
+  if (value && typeof value === "object") {
+    return Object.fromEntries(
+      Object.entries(value).map(([k, v]) => [
+        k.replace(
+          /^registry\.(?:terraform\.io|opentofu\.org)\//,
+          "STUBBED_REGISTRY/",
+        ),
+        stubRegistryHosts(v),
+      ]),
+    );
+  }
+  return value;
+}
+
 describe("Provider", () => {
   it("generates a provider", async () => {
     const constraint = new TerraformProviderConstraint(
@@ -86,7 +107,7 @@ describe("Provider", () => {
         process.env.CDKTF_EXPERIMENTAL_PROVIDER_SCHEMA_CACHE_PATH,
       );
       await maker.generate([constraint]);
-      const snapshot = directorySnapshot(workdir);
+      const snapshot = stubRegistryHosts(directorySnapshot(workdir));
       expect(snapshot).toMatchSnapshot();
     });
   }, 600_000);
@@ -103,7 +124,7 @@ describe("Provider", () => {
         targetLanguage: Language.TYPESCRIPT,
       });
       await maker.generate([constraint]);
-      const snapshot = directorySnapshot(workdir);
+      const snapshot = stubRegistryHosts(directorySnapshot(workdir));
 
       const terraformResourceTypesPresent: string[] =
         resourceTypesPresentInSnapshot(snapshot, "datadog");
@@ -127,7 +148,7 @@ describe("Provider", () => {
     const constraint = new TerraformProviderConstraint({
       name: "dockerr",
       source: "registry.terraform.io/kreuzwerker/docker",
-      version: "3.0.2",
+      version: "3.9.0",
     });
     return await mkdtemp(async (workdir) => {
       const jsiiPath = path.join(workdir, ".jsii");
@@ -140,7 +161,7 @@ describe("Provider", () => {
         process.env.CDKTF_EXPERIMENTAL_PROVIDER_SCHEMA_CACHE_PATH,
       );
       await maker.generate([constraint]);
-      const snapshot = directorySnapshot(workdir);
+      const snapshot = stubRegistryHosts(directorySnapshot(workdir));
 
       const terraformResourceTypesPresent: string[] =
         resourceTypesPresentInSnapshot(snapshot, "dockerr");
@@ -160,11 +181,13 @@ describe("Provider", () => {
       version: "2.51.0",
       source: "DrFaust92/bitbucket",
     });
+    // andsafe-AG/bitbucket is Terraform-registry only; zahiar/bitbucket is
+    // mirrored on both, so this runs under either CLI.
     const constraint2 = new TerraformProviderConstraint({
       name: "abitbucket",
-      namespace: "andsafe-AG",
-      version: "2.5.0",
-      source: "andsafe-AG/bitbucket",
+      namespace: "zahiar",
+      version: "0.3.0",
+      source: "zahiar/bitbucket",
     });
     return await mkdtemp(async (workdir) => {
       const jsiiPath = path.join(workdir, ".jsii");
@@ -178,7 +201,7 @@ describe("Provider", () => {
       );
       await maker.generate([constraint, constraint2]);
       console.log("workdir", workdir);
-      const snapshot = directorySnapshot(workdir);
+      const snapshot = stubRegistryHosts(directorySnapshot(workdir));
       expect(snapshot).toMatchSnapshot();
     });
   }, 600_000);

package/src/get/__tests__/generator/versions-file.test.ts

@@ -33,7 +33,8 @@ describe("versions.json file generation", () => {
       fqn: "kreuzwerker/docker",
       name: "docker",
       source: "kreuzwerker/docker",
-      version: "2.16.0",
+      // OpenTofu rejects everything below 3.7.0 as unsigned; see #440.
+      version: "3.9.0",
     },
   ];
 
@@ -62,10 +63,14 @@ describe("versions.json file generation", () => {
         path.join(workdir, "versions.json"),
         "utf-8",
       );
-      expect(Object.keys(JSON.parse(output))).toEqual(
-        expect.arrayContaining(
-          constraints.map((c) => `registry.terraform.io/${c.fqn}`),
-        ),
+      // versions.json is keyed by fully qualified name, and the host is
+      // whichever registry the fetching CLI used - terraform's or tofu's - so
+      // assert on the provider part rather than pinning one registry.
+      const keys = Object.keys(JSON.parse(output)).map((k) =>
+        k.split("/").slice(1).join("/"),
+      );
+      expect(keys).toEqual(
+        expect.arrayContaining(constraints.map((c) => c.fqn)),
       );
     },
   );

package/src/get/generator/emitter/struct-emitter.ts

@@ -61,13 +61,13 @@ export class StructEmitter {
         comment.line(att.description);
         comment.line(``);
         comment.line(
-          `Docs at Terraform Registry: {@link ${resource.linkToDocs}#${att.terraformName} ${resource.className}#${att.terraformName}}`,
+          `Docs at ${resource.docsRegistryName}: {@link ${resource.linkToDocs}#${att.terraformName} ${resource.className}#${att.terraformName}}`,
         );
         this.warnAboutIdField(att);
         comment.end();
       } else {
         comment.line(
-          `Docs at Terraform Registry: {@link ${resource.linkToDocs}#${att.terraformName} ${resource.className}#${att.terraformName}}`,
+          `Docs at ${resource.docsRegistryName}: {@link ${resource.linkToDocs}#${att.terraformName} ${resource.className}#${att.terraformName}}`,
         );
         this.warnAboutIdField(att);
         comment.end();

package/src/get/generator/models/resource-model.ts

@@ -115,6 +115,11 @@ export class ResourceModel {
     return this.escapeSchema(JSON.stringify(this.schema, undefined, 2));
   }
 
+  /** Registry that linkToDocs points at, for use in the surrounding prose. */
+  public get docsRegistryName(): string {
+    return registryForTargetVersions(this.targetVersions).displayName;
+  }
+
   public get linkToDocs(): string {
     // Keyed off the project's declared targets, not the FQPN hostname: that
     // hostname reflects whichever CLI fetched the schema, which would make the

package/src/get/generator/provider-generator.ts

@@ -345,7 +345,7 @@ export class TerraformProviderGenerator {
       ? resource.provider
       : resource.terraformType;
     this.code.line(
-      `Refer to the Terraform Registry for docs: [\`${type}\`](${resource.linkToDocs}).`,
+      `Refer to the ${resource.docsRegistryName} for docs: [\`${type}\`](${resource.linkToDocs}).`,
     );
     this.code.closeFile(filePath);
   }