goabonga / terragrunt-generator Goto Github PK

Write a minimal project to explain how to use the generator.

• generate a terraform module
• generate a terragrunt basic project
• write docs (install, usages, ...)

The lookup path specify where is terragrunt search configuration into the config.yaml file for the module.

This path is hard coded

#
# yaml config
# ```yaml
# terraform-google-project-factory:  <----------------------------
#   enabled: true
#   random_project_id: false
#   org_id: 
#   domain: ""
#   name

inputs = merge({
    # billing_account - The ID of the billing account to associate this project with - required
    billing_account = lookup(local.all["terraform-google-project-factory"], "billing_account", "None")
    # name - The name for the project - required
  

We want to make lookup path configurable

terragrunt-gernerator [-h] -u URL -v VERSION [-p PATH] [-l LOOKUP]

| to prevent breaking change the default value is local.all["{{module_name}}"]

• refactoring and writing tests
• refactoring and writing code

The terragrunt include block must be optional.

This block is in use in my personal projects, that's why i can't remove them (radically) now.
It's will be removed in future version but to prevent breaking change it's should to be marked as breaking change first and
we will use a parameter to remove the block into the output.

argparse.BooleanOptionalAction can be used.

terragrunt-gernerator [-h] -u URL -v VERSION [-p PATH] [--include | --no-include]

• refactoring and writing tests
• refactoring and writing code

The terragrunt locals block contains a line used to load the config.yaml configuration.

This path is hard coded, and usable only with file loaded from parent directory.

locals {
  all = merge(
    yamldecode(file(find_in_parent_folders("config.yaml"))),
  )
}

We want to make config parameter more configurable

terragrunt-gernerator [-h] -u URL -v VERSION [-p PATH] [-c CONFIG]

| to prevent breaking change the default value is find_in_parent_folders(\"config.yaml\")

• refactoring and writing tests
• refactoring and writing code

List and test each kind of source URL.

• http(s)
• ssh
• git
• terraform registry scheme

comming