feat: generate providers (experimental)

Signed-off-by: i4k <[email protected]>

Author: i4ki

.github/workflows/ci.yml

@@ -20,4 +20,12 @@ jobs:
         uses: terramate-io/terramate-action@v1
 
       - name: Run generate tests
-        run: terramate generate
+        shell: bash
+        run: |
+          while :
+          do 
+            terramate generate --detailed-exit-code
+            if [ "$?" -neq "2" ];
+              exit $?
+            fi
+          done

generate/terraform/providers/providers.tm

@@ -0,0 +1,93 @@
+# Generate the required_providers and providers block.
+#
+# Example configuration:
+globals "modules" "generate" "terraform" "providers" {
+  entries = [
+    # {
+    #   name    = "aws"
+    #   source  = "hashicorp/aws"
+    #   version = "~> 5.0"
+    #   config = {
+    #     attributes = {
+    #       region = "us-east-1"
+    #     }
+
+    #     blocks = [
+    #       {
+    #         name = "assume_role"
+    #         attributes = {
+    #           role_arn     = "arn:aws:iam::123456789012:role/ROLE_NAME"
+    #           session_name = "SESSION_NAME"
+    #           external_id  = "EXTERNAL_ID"
+    #         }
+    #       },
+    #       {
+    #         name = "assume_role"
+    #         attributes = {
+    #           role_arn = "arn:aws:iam::123456789012:role/FINAL_ROLE_NAME"
+    #         }
+    #       },
+    #       {
+    #         name = "any_other_block_name"
+    #         attributes = {
+    #           whatever = 1
+    #         }
+    #       },
+    #     ]
+    #   }
+    # }
+  ]
+}
+
+generate_hcl "_providers.tm" {
+  lets {
+    entries = tm_try(global.modules.generate.terraform.providers.entries, [])
+  }
+  content {
+    generate_hcl "_providers.tf" {
+      lets {
+        entries            = tm_hcl_expression("global.modules.generate.terraform.providers.entries")
+        required_providers = tm_hcl_expression("{ for v in let.entries : v.name => {source = v.source, version = v.version}}")
+      }
+
+      content {
+        terraform {
+          tm_dynamic "tm_dynamic" {
+            labels = ["required_providers"]
+            attributes = {
+              for_each = tm_hcl_expression("tm_length(let.required_providers) > 0 ? [1] : []")
+              attributes = tm_hcl_expression("let.required_providers")
+            }
+          }
+
+          tm_dynamic "tm_dynamic" {
+            labels = ["provider"]
+            attributes = {
+              for_each   = tm_hcl_expression("let.entries")
+              iterator   = tm_hcl_expression("p")
+              labels     = tm_hcl_expression("[p.value.name]")
+              attributes = tm_hcl_expression("p.value.config.attributes")
+            }
+
+            content {
+              content {
+                # hacks until Terramate supports tm_dynamic.block attribute.
+                tm_dynamic "tm_dynamic" {
+                  for_each = tm_distinct(tm_flatten([for i, p in let.entries : [for b in tm_try(p.config.blocks, []) : b.name]]))
+                  iterator = block
+                  labels   = [block.value]
+                  attributes = {
+                    for_each   = tm_hcl_expression("[for b in tm_try(p.value.config.blocks, []) : b if b.name == \"${block.value}\"]")
+                    iterator   = tm_hcl_expression("b")
+                    attributes = tm_hcl_expression("b.value.attributes")
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+

tests/generate/providers/_providers.tf

@@ -0,0 +1,32 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+terraform {
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 5.0"
+    }
+    google = {
+      source  = "hashicorp/google"
+      version = "~> 6.6.0"
+    }
+  }
+  provider "aws" {
+    region = "us-east-1"
+    assume_role {
+      external_id  = "EXTERNAL_ID"
+      role_arn     = "arn:aws:iam::123456789012:role/ROLE_NAME"
+      session_name = "SESSION_NAME"
+    }
+    assume_role {
+      role_arn = "arn:aws:iam::123456789012:role/FINAL_ROLE_NAME"
+    }
+    any_other_block_name {
+      whatever = 1
+    }
+  }
+  provider "google" {
+    project = "my-project-id"
+    region  = "us-central1"
+  }
+}

tests/generate/providers/_providers.tm

@@ -0,0 +1,44 @@
+// TERRAMATE: GENERATED AUTOMATICALLY DO NOT EDIT
+
+generate_hcl "_providers.tf" {
+  lets {
+    entries = global.modules.generate.terraform.providers.entries
+    required_providers = { for v in let.entries : v.name => {
+      source  = v.source
+      version = v.version
+    } }
+  }
+  content {
+    terraform {
+      tm_dynamic "required_providers" {
+        attributes = let.required_providers
+        for_each = tm_length(let.required_providers) > 0 ? [
+          1,
+          ] : [
+        ]
+      }
+      tm_dynamic "provider" {
+        attributes = p.value.config.attributes
+        for_each   = let.entries
+        iterator   = p
+        labels = [
+          p.value.name,
+        ]
+        content {
+          tm_dynamic "assume_role" {
+            attributes = b.value.attributes
+            for_each = [for b in tm_try(p.value.config.blocks, [
+            ]) : b if b.name == "assume_role"]
+            iterator = b
+          }
+          tm_dynamic "any_other_block_name" {
+            attributes = b.value.attributes
+            for_each = [for b in tm_try(p.value.config.blocks, [
+            ]) : b if b.name == "any_other_block_name"]
+            iterator = b
+          }
+        }
+      }
+    }
+  }
+}

tests/generate/providers/stack.tm.hcl

@@ -0,0 +1,6 @@
+stack {
+  name        = "providers"
+  description = "providers"
+  id          = "91d68d46-42f4-4c78-9446-a099b174bdc4"
+  tags        = ["tests", "terraform"]
+}

tests/generate/providers/tests.tm

@@ -0,0 +1,54 @@
+# Test providers block generation
+
+import {
+  source = "/generate/terraform/providers/providers.tm"
+}
+
+globals "modules" "generate" "terraform" "providers" {
+  entries = [
+    {
+      name    = "aws"
+      source  = "hashicorp/aws"
+      version = "~> 5.0"
+      config = {
+        attributes = {
+          region = "us-east-1"
+        }
+
+        blocks = [
+          {
+            name = "assume_role"
+            attributes = {
+              role_arn     = "arn:aws:iam::123456789012:role/ROLE_NAME"
+              session_name = "SESSION_NAME"
+              external_id  = "EXTERNAL_ID"
+            }
+          },
+          {
+            name = "assume_role"
+            attributes = {
+              role_arn = "arn:aws:iam::123456789012:role/FINAL_ROLE_NAME"
+            }
+          },
+          {
+            name = "any_other_block_name"
+            attributes = {
+              whatever = 1
+            }
+          },
+        ]
+      }
+    },
+    {
+      name    = "google"
+      source  = "hashicorp/google"
+      version = "~> 6.6.0",
+      config = {
+        attributes = {
+          project = "my-project-id"
+          region  = "us-central1"
+        }
+      }
+    }
+  ]
+}

tests/generate/variables/strings/_variables.tf renamed to tests/generate/variables/_variables.tf

@@ -1,5 +1,6 @@
 stack {
-  name        = "strings"
+  name        = "variables"
   description = "strings"
   id          = "40baaeaa-feea-405f-91c0-9424c060fe89"
+  tags        = ["tests", "terraform"]
 }