fix: hcl rendering nested maps (#3536)

Closes #3529
hashicorp · Mar 4, 2024 · 639b61a · 639b61a
1 parent dc9bcd2
commit 639b61a
Show file tree

Hide file tree

Showing 3 changed files with 109 additions and 1 deletion.
diff --git a/packages/cdktf/lib/hcl/render.ts b/packages/cdktf/lib/hcl/render.ts
@@ -193,6 +193,16 @@ export function renderMapValue(value: any): string {
     return `${value}`;
   }
 
+  if (typeof value === "object") {
+    if (Array.isArray(value)) {
+      return renderListValue(value, "unknownStorageClass");
+    }
+    if (value === null) {
+      return "null";
+    }
+    return renderMap(value);
+  }
+
   return `${value}`;
 }
 

diff --git a/packages/cdktf/test/helper/resource.ts b/packages/cdktf/test/helper/resource.ts
@@ -16,6 +16,7 @@ export interface TestResourceConfig extends TerraformMetaArguments {
   names?: string[];
   tags?: { [key: string]: string };
   nestedType?: { [key: string]: string };
+  anyMap?: { [key: string]: any };
   listBlock?: IResolvable;
   listAttribute?: IResolvable;
 }
@@ -26,6 +27,7 @@ export class TestResource extends TerraformResource {
   public names?: string[];
   public tags?: { [key: string]: string };
   public nestedType?: { [key: string]: string };
+  public anyMap?: { [key: string]: any };
   public listBlock?: IResolvable; // real life bindings also allow an interface here, but we don't use that in our tests using this
   public listAttribute?: IResolvable;
 
@@ -47,6 +49,7 @@ export class TestResource extends TerraformResource {
     this.name = config.name;
     this.names = config.names;
     this.tags = config.tags;
+    this.anyMap = config.anyMap;
     this.nestedType = config.nestedType;
     this.listBlock = config.listBlock;
     this.listAttribute = config.listAttribute;
@@ -58,6 +61,7 @@ export class TestResource extends TerraformResource {
       names: this.names,
       tags: this.tags,
       nested_type: this.nestedType,
+      any_map: this.anyMap,
       list_block: listMapper((a) => a, true)(this.listBlock), // identity function to skip writing a toTerraform function
       list_attribute: listMapper((a) => a, false)(this.listAttribute), // identity function to skip writing a toTerraform function
     };
@@ -88,9 +92,16 @@ export class TestResource extends TerraformResource {
           storageClassType: "stringMap",
         },
 
+        any_map: {
+          value: this.anyMap,
+          type: "map",
+          storageClassType: "anyMap",
+        },
         list_block: listMapper((a) => a, true)(this.listBlock), // identity function to skip writing a toTerraform function
         list_attribute: listMapper((a) => a, false)(this.listAttribute), // identity function to skip writing a toTerraform function
-      }).filter(([_, v]) => !!v?.value)
+      }).filter(
+        ([_, value]) => value !== undefined && value.value !== undefined
+      )
     );
   }
 

diff --git a/packages/cdktf/test/json-to-hcl.test.ts b/packages/cdktf/test/json-to-hcl.test.ts
@@ -373,6 +373,93 @@ describe("output", () => {
     `);
   });
 
+  test("deeply nested map ", async () => {
+    const app = Testing.app();
+    const stack = new TerraformStack(app, "test");
+
+    new TestProvider(stack, "provider", {});
+
+    new TestResource(stack, "probably-kubernetes", {
+      name: "foo",
+      anyMap: {
+        spec: {
+          metadata: {
+            name: "foo",
+            labels: {
+              "foo:bar": "baz",
+              simple: "true",
+            },
+          },
+        },
+      },
+    });
+
+    expect(Testing.synthHcl(stack)).toMatchInlineSnapshot(`
+      "terraform {
+      required_providers {
+        test = {
+      version = "~> 2.0"
+      }
+      }
+
+
+      }
+
+      provider "test" {
+      }
+      resource "test_resource" "probably-kubernetes" {
+      name = "foo"
+      any_map = {
+      spec = {
+      metadata = {
+      name = "foo"
+      labels = {
+      "foo:bar" = "baz"
+      simple = "true"
+      }
+      }
+      }
+      }
+      }"
+    `);
+  });
+
+  test("map with undefined / null value", async () => {
+    const app = Testing.app();
+    const stack = new TerraformStack(app, "test");
+
+    new TestProvider(stack, "provider", {});
+
+    new TestResource(stack, "sth-fishy", {
+      name: "foo",
+      anyMap: {
+        notDefined: undefined,
+        billionDollarMistake: null,
+      },
+    });
+
+    expect(Testing.synthHcl(stack)).toMatchInlineSnapshot(`
+      "terraform {
+      required_providers {
+        test = {
+      version = "~> 2.0"
+      }
+      }
+
+
+      }
+
+      provider "test" {
+      }
+      resource "test_resource" "sth-fishy" {
+      name = "foo"
+      any_map = {
+      billionDollarMistake = null
+      }
+      }"
+    `);
+  });
+
   test("dependent output", async () => {
     const app = Testing.app();
     const stack = new TerraformStack(app, "test");