[INFRA] Support for local paths Nate.infra.relative paths

guides/cloud-infra-management.md

@@ -52,3 +52,81 @@ following:
 - **Using arguments** - Pass in your formatted source url for your private AzDO
   repo with the PAT and arbitrary username specified. Example
   `spk infra scaffold --name fabrikam --source https://spk:{$PAT}@dev.azure.com/microsoft/spk/_git/infra_repo --version master --template cluster/environments/azure-single-keyvault`
+
+## Terraform Modules with Local Paths
+
+`spk` now supports Terraform source templates that use a
+[local repository path](https://www.terraform.io/docs/modules/sources.html#local-paths)
+for references to modules. To obtain the modules for further teraform
+deployment, `spk generate` will shape a module source value from the `source`,
+`tempate`, and `version` arguments passed.
+
+**Example:**
+
+Template Main.tf
+
+```tf
+"aks-gitops" {
+  source = "../../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
+  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_label             = var.gitops_label
+  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
+  kubernetes_version       = var.kubernetes_version
+}`;
+
+```
+
+SPK-generated Main.tf
+
+```tf
+"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
+  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_label             = var.gitops_label
+  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
+  kubernetes_version       = var.kubernetes_version
+}`;
+
+```

src/commands/infra/generate.ts

@@ -23,6 +23,7 @@ import { copyTfTemplate } from "./scaffold";
 import { build as buildError, log as logError } from "../../lib/errorBuilder";
 import { errorStatusCode } from "../../lib/errorStatusCode";
 import { exec } from "../../lib/shell";
+import { file } from "mock-fs";
 
 interface CommandOptions {
   project: string | undefined;
@@ -368,7 +369,7 @@ export const generateTfvars = (
  * Checks if an spk.tfvars already exists
  *
  * @param generatedPath Path to the spk.tfvars file
- * @param tfvarsFilename Name of .tfvars file
+ * @param tfvarsFilename Name of .tfvars fileb
  */
 export const checkTfvars = (
   generatedPath: string,
@@ -501,6 +502,60 @@ export const singleDefinitionGeneration = async (
   await copyTfTemplate(templatePath, childDirectory, true);
 };
 
+/**
+ * Checks to see if module sources are local
+ *
+ * @param tfFile path to the terraform file in child directory
+ */
+export const checkModuleSource = (tfData: string): boolean => {
+  // Check if the file string matches an instance of a module source value as a local path
+  const matches = tfData.match(/^\s*source\s+=\s+["'](\.\.?\/[^"']*)["']$/gm);
+  if (matches != null) {
+    return true;
+  }
+  return false;
+};
+
+/**
+ * Checks to see if module sources are local
+ *
+ * @param sourceConfig Array of source configuration
+ */
+export const moduleSourceModify = async (
+  fileSource: SourceInformation,
+  tfData: string
+): Promise<string> => {
+  let result = "";
+  const sourceFolder = getSourceFolderNameFromURL(fileSource.source);
+  const sourcePath = path.join(spkTemplatesPath, sourceFolder);
+  // Split data by line and iterate
+  for (let line of tfData.split(/\r?\n/)) {
+    // Match line to expected module source format
+    if (line.match(/^\s*source\s+=\s+["'](\.\.?\/[^"']*)["']$/gm) != null) {
+      // Split the line into segments, the third element is the source value
+      const splitLine = line.split(/\s+/);
+      // Filter on module source value
+      const moduleSource = new RegExp(splitLine[3].replace(/['"]+/g, ""), "g");
+      // Get relative path of terraform module local to the repo
+      const repoModulePath = await simpleGit(
+        path.join(
+          sourcePath,
+          fileSource.template,
+          splitLine[3].replace(/["']/g, "")
+        )
+      ).revparse(["--show-prefix"]);
+      // Concatendate the Git URL with munged data
+      const gitSource = fileSource.source
+        .replace(/(^\w+:|^)\/\//g, "")
+        .concat("?ref=", fileSource.version, "//", repoModulePath);
+      // Replace the line
+      line = line.replace(moduleSource, gitSource);
+    }
+    result += line + "\n";
+  }
+  return result;
+};
+
 /**
  * Creates "generated" directory if it does not already exists
  *
@@ -543,7 +598,6 @@ export const generateConfig = async (
       createGenerated(parentDirectory);
       createGenerated(childDirectory);
     }
-
     combineVariable(
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       parentInfraConfig.variables!,
@@ -576,6 +630,36 @@ export const generateConfig = async (
       templatePath
     );
   }
+  // TODO: Function to check for relative paths:
+  // CheckLocal: check source value, is value = ./ or ../ (Local syntax)
+  // ModifyLocal: munge url from YAML, apply url to relative source path
+  // Throw exception if failed
+  const files = await fsExtra.readdirSync(childDirectory, "utf-8");
+  // Check to test outsource: terraform registry,
+  // Iterate through 'TF' files / Parse of tf files? (Code Coverage?)
+  for (const file of files) {
+    if (path.extname(file) === ".tf") {
+      const tfData = fsExtra.readFileSync(
+        path.join(childDirectory, file),
+        "utf8"
+      );
+      const containsLocalSource = await checkModuleSource(tfData);
+      if (containsLocalSource) {
+        logger.info(
+          `Local relative paths for module source values detected in terraform file: ${file}`
+        );
+        const mungeData = await moduleSourceModify(sourceConfig, tfData);
+        logger.info(
+          `Terraform File: ${file} local module source values successfully converted to git source paths`
+        );
+        fsExtra.writeFileSync(
+          path.join(childDirectory, file),
+          mungeData,
+          "utf8"
+        );
+      }
+    }
+  }
 };
 
 export const execute = async (