HCL file generation for spk infra scaffold (#83)

* generates `input` block for variables in Terragrunt HCL file.

Author: yradsmikham

docs/cloud-infra-management.md

@@ -76,6 +76,7 @@ spk infra scaffold|s [options]
 > `spk infra scaffold --name discovery-service --source https://github.com/microsoft/bedrock --version "0.0.1" --template /microsoft/bedrock/cluster/environments/azure-simple`
 
 Options:
+  --hcl                                          Generate HCL definition file (terragrunt.hcl)
   -n, --name <name>                              Cluster name for scaffolding
   -s, --source <cluster definition github repo>  Source URL for the repository containing the terraform deployment
   -v, --version <repository version>             Version or tag for the repository so a fixed version is referenced
@@ -91,11 +92,13 @@ spk infra scaffold --name discovery-service --source https://github.com/microsof
 
 Output:
 
-```
+definition.json
+
+```json
 {
   "name": "discovery-service",
   "source": "https://github.com/microsoft/bedrock",
-    "template": "bedrock/cluster/environments/azure-simple",
+  "template": "bedrock/cluster/environments/azure-simple",
   "version": "0.0.1",
   "variables": {
     "agent_vm_count": "3",
@@ -127,3 +130,36 @@ Output:
   }
 }
 ```
+
+terrgrunt.hcl
+
+```
+inputs = {
+  agent_vm_count = "3"
+  agent_vm_size = "Standard_D2s_v3"
+  acr_enabled = "true"
+  gc_enabled = "true"
+  cluster_name = ""
+  dns_prefix = ""
+  flux_recreate = ""
+  kubeconfig_recreate = ""
+  gitops_ssh_url = ""
+  gitops_ssh_key = ""
+  gitops_path = ""
+  gitops_url_branch = "master"
+  resource_group_name = ""
+  ssh_public_key = ""
+  service_principal_id = ""
+  service_principal_secret = ""
+  gitops_poll_interval = "5m"
+  vnet_name = ""
+  service_cidr = "10.0.0.0/16"
+  dns_ip = "10.0.0.10"
+  docker_cidr = "172.17.0.1/16"
+  address_space = "10.10.0.0/16"
+  subnet_prefix = "10.10.1.0/24"
+  network_plugin = "azure"
+  network_policy = "azure"
+  oms_agent_enabled = "false"
+}
+```

src/commands/infra/scaffold.test.ts

@@ -3,7 +3,11 @@ import {
   enableVerboseLogging,
   logger
 } from "../../logger";
-import { generateClusterDefinition, parseVariablesTf } from "./scaffold";
+import {
+  generateClusterDefinition,
+  parseVariablesTf,
+  scaffoldHcl
+} from "./scaffold";
 
 beforeAll(() => {
   enableVerboseLogging();
@@ -32,7 +36,7 @@ describe("Validate parsing of sample variables.tf file", () => {
       sampleVarTf
     );
     expect(Object.keys(fields).length).toBe(3);
-    expect(fields.resource_group_name).toBe(null);
+    expect(fields.resource_group_name).toBe("");
     expect(fields.gitops_poll_interval).toBe("5m");
   });
 });
@@ -63,3 +67,21 @@ describe("Validate generation of sample scaffold definition", () => {
     expect(def.variables.resource_group_name).toBe("<insert value>");
   });
 });
+
+describe("Validate generation of a valid cluster HCL file", () => {
+  test("Validate that a variables.tf sample can be parsed and translated to an HCL file", async () => {
+    const mockFileName = "src/commands/mocks/azure-simple";
+    const sampleVarTf = "src/commands/mocks/azure-simple/variables.tf";
+    const value = await scaffoldHcl(mockFileName, sampleVarTf);
+    expect(value).toBe(true);
+  });
+});
+
+describe("Failure testing for generation of a valid cluster HCL file", () => {
+  test("Mocked a failed scenario of HCL generation", async () => {
+    const mockFileName = "src/commands/mocks/azure-simple";
+    const sampleVarTf = "src/commands/mocks/azure-simple";
+    const value = await scaffoldHcl(mockFileName, sampleVarTf);
+    expect(value).toBe(false);
+  });
+});

src/commands/infra/scaffold.ts

@@ -27,6 +27,7 @@ export const scaffoldCommandDecorator = (command: commander.Command): void => {
       "-t, --template <path to variables.tf> ",
       "Location of the variables.tf for the terraform deployment"
     )
+    .option("--hcl", "Generates cluster definition HCL file")
     .action(async opts => {
       try {
         if (opts.name && opts.source && opts.version && opts.template) {
@@ -36,11 +37,23 @@ export const scaffoldCommandDecorator = (command: commander.Command): void => {
             "You must specify each of the variables 'name', 'source', 'version', 'template' in order to scaffold out a deployment."
           );
         }
-
         await copyTfTemplate(opts.template, opts.name);
         await validateVariablesTf(path.join(opts.template, "variables.tf"));
         await renameTfvars(opts.name);
-        await scaffoldInit(opts.name, opts.source, opts.version, opts.template);
+        if (opts.hcl) {
+          logger.info("Generating HCL cluster definition file.");
+          await scaffoldHcl(
+            opts.name,
+            path.join(opts.template, "variables.tf")
+          );
+        } else {
+          await scaffoldJson(
+            opts.name,
+            opts.source,
+            opts.version,
+            opts.template
+          );
+        }
       } catch (err) {
         logger.error("Error occurred while generating scaffold");
         logger.error(err);
@@ -141,7 +154,7 @@ export const parseVariablesTf = (data: string) => {
   const blocks = data.split(splitRegex);
   // iterate through each 'block' and extract the variable name and any possible
   // default value.  if no default value found, null is used in it's place
-  const fields: { [name: string]: string | null } = {};
+  const fields: { [name: string]: string | "" } = {};
   const fieldSplitRegex = /\"\s{0,}\{/;
   const defaultRegex = /default\s{0,}=\s{0,}(.*)/;
   blocks.forEach((b, idx) => {
@@ -160,7 +173,7 @@ export const parseVariablesTf = (data: string) => {
         }
         fields[elt[0]] = value;
       } else {
-        fields[elt[0]] = null;
+        fields[elt[0]] = "";
       }
     }
   });
@@ -200,7 +213,7 @@ export const generateClusterDefinition = (
  * @param bedrockVersion The version of the repo used
  * @param tfVariableFile Path to the variable file to parse
  */
-export const scaffoldInit = async (
+export const scaffoldJson = async (
   name: string,
   bedrockSource: string,
   bedrockVersion: string,
@@ -244,3 +257,46 @@ export const scaffoldInit = async (
   }
   return false;
 };
+
+export const generateHclClusterDefinition = (vartfData: string) => {
+  const data: string = fs.readFileSync(vartfData, "utf8");
+  const fields: { [name: string]: string | "" | any } = parseVariablesTf(data);
+  const def: { [name: string]: string | "" | any } = {};
+  def.inputs = fields;
+  return def;
+};
+
+/**
+ * This function creates a primary base Terragrunt HCL definition for
+ * generating cluster definitions from.
+ *
+ * @param name Name of the cluster definition
+ * @param vartfData Path to the variable.tf file to parse
+ */
+export const scaffoldHcl = async (
+  dirName: string,
+  vartfData: string
+): Promise<boolean> => {
+  try {
+    const def = generateHclClusterDefinition(vartfData);
+    const confPath: string = path.format({
+      base: "terragrunt.hcl",
+      dir: dirName,
+      root: "/ignored"
+    });
+    const hcl = JSON.stringify(def, null, 2)
+      .replace(/\"([^(\")"]+)\":/g, "$1:")
+      .replace(new RegExp(":", "g"), " =")
+      .replace(new RegExp(",", "g"), " ")
+      .replace("{", "")
+      .replace(/\}([^}]*)$/, "$1")
+      .replace(/(^[ \t]*\n)/gm, "")
+      .trim();
+    fs.writeFileSync(confPath, hcl);
+  } catch (err) {
+    logger.error("Failed to create HCL file.");
+    logger.error(err);
+    return false;
+  }
+  return true;
+};

src/commands/mocks/azure-simple/main.tf

@@ -0,0 +1,50 @@
+module "provider" {
+  source = "github.com/microsoft/bedrock?ref=master//cluster/azure/provider"
+}
+
+data "azurerm_resource_group" "cluster_rg" {
+  name = "${var.resource_group_name}"
+}
+
+module "vnet" {
+  source = "github.com/microsoft/bedrock?ref=master//cluster/azure/vnet"
+
+  vnet_name           = "${var.vnet_name}"
+  address_space       = "${var.address_space}"
+  resource_group_name = "${data.azurerm_resource_group.cluster_rg.name}"
+  subnet_names        = ["${var.cluster_name}-aks-subnet"]
+  subnet_prefixes     = ["${var.subnet_prefix}"]
+
+  tags = {
+    environment = "azure-simple"
+  }
+}
+
+module "aks-gitops" {
+  source = "github.com/microsoft/bedrock?ref=master//cluster/azure/aks-gitops"
+
+  acr_enabled              = "${var.acr_enabled}"
+  agent_vm_count           = "${var.agent_vm_count}"
+  agent_vm_size            = "${var.agent_vm_size}"
+  cluster_name             = "${var.cluster_name}"
+  dns_prefix               = "${var.dns_prefix}"
+  flux_recreate            = "${var.flux_recreate}"
+  kubeconfig_recreate      = "${var.kubeconfig_recreate}"
+  gc_enabled               = "${var.gc_enabled}"
+  gitops_ssh_url           = "${var.gitops_ssh_url}"
+  gitops_ssh_key           = "${var.gitops_ssh_key}"
+  gitops_path              = "${var.gitops_path}"
+  gitops_poll_interval     = "${var.gitops_poll_interval}"
+  gitops_url_branch        = "${var.gitops_url_branch}"
+  ssh_public_key           = "${var.ssh_public_key}"
+  resource_group_name      = "${data.azurerm_resource_group.cluster_rg.name}"
+  service_principal_id     = "${var.service_principal_id}"
+  service_principal_secret = "${var.service_principal_secret}"
+  vnet_subnet_id           = "${tostring(element(module.vnet.vnet_subnet_ids, 0))}"
+  service_cidr             = "${var.service_cidr}"
+  dns_ip                   = "${var.dns_ip}"
+  docker_cidr              = "${var.docker_cidr}"
+  network_plugin           = "${var.network_plugin}"
+  network_policy           = "${var.network_policy}"
+  oms_agent_enabled        = "${var.oms_agent_enabled}"
+}

src/commands/mocks/azure-simple/terraform.tfvars

@@ -0,0 +1,19 @@
+resource_group_name      = "resource-group-name"
+cluster_name             = "cluster-name"
+agent_vm_count           = "3"
+dns_prefix               = "dns-prefix"
+service_principal_id     = "client-id"
+service_principal_secret = "client-secret"
+ssh_public_key           = "public-key"
+gitops_ssh_url           = "git@github.com:timfpark/fabrikate-cloud-native-manifests.git"
+gitops_ssh_key           = "<path to private gitops repo key>"
+vnet_name                = "<vnet name>"
+
+#--------------------------------------------------------------
+# Optional variables - Uncomment to use
+#--------------------------------------------------------------
+# gitops_url_branch = "release-123"
+# gitops_poll_interval = "30s"
+# gitops_path = "prod"
+# network_policy = "calico"
+# oms_agent_enabled = "false"