@cdktn/hcl2cdk 0.24.0-pre.45 → 0.24.0-pre.47

package/test/__snapshots__/typeCoercion.test.ts.snap

@@ -0,0 +1,253 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`type coercion coerces string literal to number snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import { Op, Token, TerraformStack } from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { AwsProvider } from "./.gen/providers/aws/provider";
+import { SecurityGroupRule } from "./.gen/providers/aws/security-group-rule";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    new AwsProvider(this, "aws", {
+      region: "us-east-1",
+    });
+    new SecurityGroupRule(this, "client_alb_allow_outbound", {
+      cidrBlocks: ["0.0.0.0/0"],
+      description: "Allow any outbound traffic.",
+      fromPort: 0,
+      ipv6CidrBlocks: ["::/0"],
+      protocol: Token.asString(Op.negate(1)),
+      securityGroupId: "sg-1234567890",
+      toPort: 0,
+      type: "egress",
+    });
+  }
+}
+"
+`;
+
+exports[`type coercion expressions need to be coerced to required type snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import {
+  VariableType,
+  TerraformVariable,
+  Fn,
+  Token,
+  TerraformStack,
+} from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { EksCluster } from "./.gen/providers/aws/eks-cluster";
+import { AwsProvider } from "./.gen/providers/aws/provider";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
+    You can read more about this at https://cdktn.io/docs/concepts/variables-and-outputs#input-variables*/
+    new AwsProvider(this, "aws", {
+      region: "us-east-1",
+    });
+    const exampleSpotAndFargateName = new TerraformVariable(
+      this,
+      "example_spot_and_fargate_name",
+      {
+        type: VariableType.STRING,
+      }
+    );
+    const privateSubnets = new TerraformVariable(this, "private_subnets", {
+      type: VariableType.list(
+        VariableType.object({
+          id: VariableType.STRING,
+        })
+      ),
+    });
+    const publicSubnets = new TerraformVariable(this, "public_subnets", {
+      type: VariableType.list(
+        VariableType.object({
+          id: VariableType.STRING,
+        })
+      ),
+    });
+    const roleArn = new TerraformVariable(this, "role_arn", {
+      type: VariableType.STRING,
+    });
+    new EksCluster(this, "example_spot_and_fargate_eks_cluster", {
+      name: exampleSpotAndFargateName.stringValue,
+      roleArn: roleArn.stringValue,
+      vpcConfig: {
+        subnetIds: Token.asList(
+          Fn.concat([
+            Fn.lookupNested(privateSubnets.value, ["*", "id"]),
+            Fn.lookupNested(publicSubnets.value, ["*", "id"]),
+          ])
+        ),
+      },
+    });
+  }
+}
+"
+`;
+
+exports[`type coercion function arguments get coerced to the correct type snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import {
+  VariableType,
+  TerraformVariable,
+  Token,
+  Fn,
+  TerraformStack,
+} from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { AwsProvider } from "./.gen/providers/aws/provider";
+import { Route53Record } from "./.gen/providers/aws/route53-record";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
+    You can read more about this at https://cdktn.io/docs/concepts/variables-and-outputs#input-variables*/
+    new AwsProvider(this, "aws", {
+      region: "us-east-1",
+    });
+    const zoneId = new TerraformVariable(this, "zone_id", {
+      type: VariableType.STRING,
+    });
+    new Route53Record(this, "example_aws_route53_simple_record", {
+      name: "example.com",
+      records: ["example"],
+      ttl: Token.asNumber("300"),
+      type: "TXT",
+      zoneId: Token.asString(
+        Fn.textencodebase64(zoneId.stringValue, "UTF-16LE")
+      ),
+    });
+  }
+}
+"
+`;
+
+exports[`type coercion references used in resource for_eachs need to understand how the value is used snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import {
+  VariableType,
+  TerraformVariable,
+  Token,
+  TerraformIterator,
+  Fn,
+  TerraformStack,
+} from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { IamUserGroupMembership } from "./.gen/providers/aws/iam-user-group-membership";
+import { AwsProvider } from "./.gen/providers/aws/provider";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
+    You can read more about this at https://cdktn.io/docs/concepts/variables-and-outputs#input-variables*/
+    new AwsProvider(this, "aws", {
+      region: "us-east-1",
+    });
+    const iamGroupsUsers = new TerraformVariable(this, "iam_groups_users", {
+      type: VariableType.map(
+        VariableType.object({
+          groups: VariableType.ANY,
+        })
+      ),
+    });
+    /*In most cases loops should be handled in the programming language context and
+    not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input
+    you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source
+    you need to keep this like it is.*/
+    const iamUserGroupMembershipUserGroupsForEachIterator =
+      TerraformIterator.fromList(Token.asAny(iamGroupsUsers.value));
+    new IamUserGroupMembership(this, "iam_user_group_membership_user_groups", {
+      groups: Token.asList(
+        Fn.lookupNested(iamUserGroupMembershipUserGroupsForEachIterator.value, [
+          '["groups"]',
+        ])
+      ),
+      user: Token.asString(iamUserGroupMembershipUserGroupsForEachIterator.key),
+      forEach: iamUserGroupMembershipUserGroupsForEachIterator,
+    });
+  }
+}
+"
+`;
+
+exports[`type coercion references used in resources need to use Token.asString snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import { Token, TerraformStack } from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { AwsProvider } from "./.gen/providers/aws/provider";
+import { Route53Record } from "./.gen/providers/aws/route53-record";
+import { Route53Zone } from "./.gen/providers/aws/route53-zone";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    new AwsProvider(this, "aws", {
+      region: "us-east-1",
+    });
+    const exampleAwsRoute53SimpleZone = new Route53Zone(
+      this,
+      "example_aws_route53_simple_zone",
+      {
+        name: "example.com",
+      }
+    );
+    new Route53Record(this, "example_aws_route53_simple_record", {
+      name: "example.com",
+      records: ["example"],
+      ttl: Token.asNumber("300"),
+      type: "TXT",
+      zoneId: exampleAwsRoute53SimpleZone.zoneId,
+    });
+  }
+}
+"
+`;
+
+exports[`type coercion variables used in resources need to use stringValue snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import { VariableType, TerraformVariable, Token, TerraformStack } from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { AwsProvider } from "./.gen/providers/aws/provider";
+import { Route53Record } from "./.gen/providers/aws/route53-record";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
+    You can read more about this at https://cdktn.io/docs/concepts/variables-and-outputs#input-variables*/
+    new AwsProvider(this, "aws", {
+      region: "us-east-1",
+    });
+    const zoneId = new TerraformVariable(this, "zone_id", {
+      type: VariableType.STRING,
+    });
+    new Route53Record(this, "example_aws_route53_simple_record", {
+      name: "example.com",
+      records: ["example"],
+      ttl: Token.asNumber("300"),
+      type: "TXT",
+      zoneId: zoneId.stringValue,
+    });
+  }
+}
+"
+`;

package/test/__snapshots__/variables.test.ts.snap

@@ -0,0 +1,150 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`variables basic snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import { VariableType, TerraformVariable, TerraformStack } from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { DataLocalFile } from "./.gen/providers/local/data-local-file";
+import { LocalProvider } from "./.gen/providers/local/provider";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
+    You can read more about this at https://cdktn.io/docs/concepts/variables-and-outputs#input-variables*/
+    new LocalProvider(this, "local", {});
+    const imageId = new TerraformVariable(this, "image_id", {
+      type: VariableType.STRING,
+    });
+    new DataLocalFile(this, "foo", {
+      filename: "./\${" + imageId.value + "}.img",
+    });
+  }
+}
+"
+`;
+
+exports[`variables complex type and default snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import {
+  VariableType,
+  TerraformVariable,
+  Fn,
+  Token,
+  TerraformStack,
+} from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { DataLocalFile } from "./.gen/providers/local/data-local-file";
+import { LocalProvider } from "./.gen/providers/local/provider";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
+    You can read more about this at https://cdktn.io/docs/concepts/variables-and-outputs#input-variables*/
+    new LocalProvider(this, "local", {});
+    const dockerPorts = new TerraformVariable(this, "docker_ports", {
+      default: [
+        {
+          external: 8300,
+          internal: 8300,
+          protocol: "tcp",
+        },
+      ],
+      type: VariableType.list(
+        VariableType.object({
+          external: VariableType.NUMBER,
+          internal: VariableType.NUMBER,
+          protocol: VariableType.STRING,
+        })
+      ),
+    });
+    new DataLocalFile(this, "foo", {
+      filename:
+        "./" +
+        Token.asString(Fn.lookupNested(dockerPorts.value, ["0", "protocol"])) +
+        ".img",
+    });
+  }
+}
+"
+`;
+
+exports[`variables sensitive and required snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import {
+  VariableType,
+  TerraformVariable,
+  Fn,
+  Token,
+  TerraformStack,
+} from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { DataLocalFile } from "./.gen/providers/local/data-local-file";
+import { LocalProvider } from "./.gen/providers/local/provider";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
+    You can read more about this at https://cdktn.io/docs/concepts/variables-and-outputs#input-variables*/
+    new LocalProvider(this, "local", {});
+    const userInformation = new TerraformVariable(this, "user_information", {
+      sensitive: true,
+      nullable: false,
+      type: VariableType.object({
+        address: VariableType.STRING,
+        name: VariableType.STRING,
+      }),
+    });
+    new DataLocalFile(this, "foo", {
+      filename:
+        "./" +
+        Token.asString(Fn.lookupNested(userInformation.value, ["name"])) +
+        ".img",
+    });
+  }
+}
+"
+`;
+
+exports[`variables validations snapshot typescript 1`] = `
+"import { Construct } from "constructs";
+import { VariableType, TerraformVariable, TerraformStack } from "cdktn";
+/*
+ * Provider bindings are generated by running \`cdktn get\`.
+ * See https://cdktn.io/docs/concepts/providers#import-providers for more details.
+ */
+import { DataLocalFile } from "./.gen/providers/local/data-local-file";
+import { LocalProvider } from "./.gen/providers/local/provider";
+class MyConvertedCode extends TerraformStack {
+  constructor(scope: Construct, name: string) {
+    super(scope, name);
+    /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
+    You can read more about this at https://cdktn.io/docs/concepts/variables-and-outputs#input-variables*/
+    new LocalProvider(this, "local", {});
+    const imageId = new TerraformVariable(this, "image_id", {
+      description: "The id of the machine image (AMI) to use for the server.",
+      validation: [
+        {
+          errorMessage:
+            "The image_id value must be a valid AMI id, starting with ami-.",
+          condition:
+            '\${length(var.image_id) > 4 && substr(var.image_id, 0, 4) == "ami-"}',
+        },
+      ],
+      type: VariableType.STRING,
+    });
+    new DataLocalFile(this, "foo", {
+      filename: "./\${" + imageId.value + "}.img",
+    });
+  }
+}
+"
+`;

package/test/backends.test.ts

@@ -0,0 +1,75 @@
+// Copyright (c) HashiCorp, Inc
+// SPDX-License-Identifier: MPL-2.0
+import { testCase, Synth, Snapshot } from "./helpers/convert";
+
+describe("backends", () => {
+  testCase.test(
+    "local backend",
+    `
+          terraform {
+            backend "local" {
+              path = "relative/path/to/terraform.tfstate"
+            }
+          }     
+          `,
+    [],
+    Snapshot.yes,
+    Synth.yes,
+  );
+
+  testCase.test(
+    "remote backend",
+    `
+          terraform {
+            backend "remote" {
+              hostname = "app.terraform.io"
+              organization = "company"
+          
+              workspaces {
+                name = "my-app-prod"
+              }
+            }
+          }
+          `,
+    [],
+    Snapshot.yes,
+    Synth.yes,
+  );
+
+  testCase.test(
+    "remote state",
+    `
+          data "terraform_remote_state" "vpc" {
+            backend = "remote"
+    
+            config = {
+              organization = "hashicorp"
+              workspaces = {
+                name = "vpc-prod"
+              }
+            }
+          }
+          `,
+    [],
+    Snapshot.yes,
+    Synth.yes,
+  );
+
+  testCase.test(
+    "remote state types",
+    `
+      data "terraform_remote_state" "s3" {
+        backend = "s3"
+
+        config = {
+          bucket = "mybucket"
+          key    = "path/to/my/key"
+          region = "us-east-1"
+        }
+      }
+      `,
+    [],
+    Snapshot.yes,
+    Synth.yes,
+  );
+});