github/pre-commit-opentofu
1
0
Fork 1
mirror of https://github.com/tofuutils/pre-commit-opentofu.git synced 2025-10-15 17:38:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
pre-commit-opentofu/hooks/tofu_wrapper_module_for_each.sh
T. Hinrichsmeyer e059c5859b
 feat: spport .tofu files (#6) 
Signed-off-by: T. Hinrichsmeyer <t.hinrichsmeyer@ndr.de>
2024-10-16 12:15:37 +02:00

439 lines
14 KiB
Bash
Executable file
Raw Blame History

#!/usr/bin/env bash
set -eo pipefail
# globals variables
# shellcheck disable=SC2155 # No way to assign to readonly variable in separate lines
readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
# shellcheck source=_common.sh
. "$SCRIPT_DIR/_common.sh"
function main {
common::initialize "$SCRIPT_DIR"
common::parse_cmdline "$@"
common::export_provided_env_vars "${ENV_VARS[@]}"
common::parse_and_export_env_vars
# JFYI: suppress color for `hcledit` is N/A`
check_dependencies
# shellcheck disable=SC2153 # False positive
tofu_module_wrapper_ "${ARGS[*]}"
}
readonly CONTENT_MAIN_TF='module "wrapper" {}'
readonly CONTENT_VARIABLES_TF='variable "defaults" {
description = "Map of default values which will be used for each item."
type = any
default = {}
}
variable "items" {
description = "Maps of items to create a wrapper from. Values are passed through to the module."
type = any
default = {}
}'
readonly CONTENT_OUTPUTS_TF='output "wrapper" {
description = "Map of outputs of a wrapper."
value = module.wrapper
WRAPPER_OUTPUT_SENSITIVE
}'
readonly CONTENT_VERSIONS_TF='terraform {
required_version = ">= 1.6.0"
}'
# shellcheck disable=SC2016 # False positive
readonly CONTENT_README='# WRAPPER_TITLE
The configuration in this directory contains an implementation of a single module wrapper pattern, which allows managing several copies of a module in places where using the native OpenTofu 1.6.0+ `for_each` feature is not feasible (e.g., with Terragrunt).
You may want to use a single Terragrunt configuration file to manage multiple resources without duplicating `terragrunt.hcl` files for each copy of the same module.
This wrapper does not implement any extra functionality.
## Usage with Terragrunt
`terragrunt.hcl`:
```hcl
terraform {
source = "tfr:///MODULE_REPO_ORG/MODULE_REPO_SHORTNAME/MODULE_REPO_PROVIDER//WRAPPER_PATH"
# Alternative source:
# source = "git::git@github.com:MODULE_REPO_ORG/terraform-MODULE_REPO_PROVIDER-MODULE_REPO_SHORTNAME.git//WRAPPER_PATH?ref=master"
}
inputs = {
defaults = { # Default values
create = true
tags = {
OpenTofu = "true"
Environment = "dev"
}
}
items = {
my-item = {
# omitted... can be any argument supported by the module
}
my-second-item = {
# omitted... can be any argument supported by the module
}
# omitted...
}
}
```
## Usage with OpenTofu
```hcl
module "wrapper" {
source = "MODULE_REPO_ORG/MODULE_REPO_SHORTNAME/MODULE_REPO_PROVIDER//WRAPPER_PATH"
defaults = { # Default values
create = true
tags = {
OpenTofu = "true"
Environment = "dev"
}
}
items = {
my-item = {
# omitted... can be any argument supported by the module
}
my-second-item = {
# omitted... can be any argument supported by the module
}
# omitted...
}
}
```
## Example: Manage multiple S3 buckets in one Terragrunt layer
`eu-west-1/s3-buckets/terragrunt.hcl`:
```hcl
terraform {
source = "tfr:///terraform-aws-modules/s3-bucket/aws//wrappers"
# Alternative source:
# source = "git::git@github.com:terraform-aws-modules/terraform-aws-s3-bucket.git//wrappers?ref=master"
}
inputs = {
defaults = {
force_destroy = true
attach_elb_log_delivery_policy = true
attach_lb_log_delivery_policy = true
attach_deny_insecure_transport_policy = true
attach_require_latest_tls_policy = true
}
items = {
bucket1 = {
bucket = "my-random-bucket-1"
}
bucket2 = {
bucket = "my-random-bucket-2"
tags = {
Secure = "probably"
}
}
}
}
```'
function tofu_module_wrapper_ {
local args
read -r -a args <<< "$1"
local root_dir
local module_dir="" # values: empty (default), "." (just root module), or a single module (e.g. "modules/iam-user")
local wrapper_dir="wrappers"
local wrapper_relative_source_path="../" # From "wrappers" to root_dir.
local module_repo_org
local module_repo_name
local module_repo_shortname
local module_repo_provider
local dry_run="false"
local verbose="false"
root_dir=$(git rev-parse --show-toplevel 2> /dev/null || pwd)
module_repo_org="terraform-aws-modules"
module_repo_name=${root_dir##*/}
module_repo_shortname="${module_repo_name#terraform-aws-}"
module_repo_provider="aws"
for argv in "${args[@]}"; do
local key="${argv%%=*}"
local value="${argv#*=}"
case "$key" in
--root-dir)
root_dir="$value"
;;
--module-dir)
module_dir="$value"
;;
--wrapper-dir)
wrapper_dir="$value"
;;
--module-repo-org)
module_repo_org="$value"
;;
--module-repo-shortname)
module_repo_shortname="$value"
;;
--module-repo-provider)
module_repo_provider="$value"
;;
--dry-run)
dry_run="true"
;;
--verbose)
verbose="true"
;;
*)
cat << EOF
ERROR: Unrecognized argument: $key
Hook ID: $HOOK_ID.
Generate OpenTofu module wrapper. Available arguments:
--root-dir=... - Root dir of the repository (Optional)
--module-dir=... - Single module directory. Options: "." (means just root module),
"modules/iam-user" (a single module), or empty (means include all
submodules found in "modules/*"). Default: "${module_dir}". (Optional)
--wrapper-dir=... - Directory where 'wrappers' should be saved. Default: "${wrapper_dir}". (Optional)
--module-repo-org=... - Module repository organization (e.g., 'terraform-aws-modules'). (Optional)
--module-repo-shortname=... - Short name of the repository (e.g., for 'terraform-aws-s3-bucket' it should be 's3-bucket'). (Optional)
--module-repo-provider=... - Name of the repository provider (e.g., for 'terraform-aws-s3-bucket' it should be 'aws'). (Optional)
--dry-run - Whether to run in dry mode. If not specified, wrapper files will be overwritten.
--verbose - Show verbose output.
Example:
--module-dir=modules/object - Generate wrapper for one specific submodule.
--module-dir=. - Generate wrapper for the root module.
--module-repo-org=terraform-google-modules --module-repo-shortname=network --module-repo-provider=google - Generate wrappers for repository available by name "terraform-google-modules/network/google" in the OpenTofu registry and it includes all modules (root and in "modules/*").
EOF
exit 1
;;
esac
done
if [[ ! $root_dir ]]; then
echo "--root-dir can't be empty. Remove it to use default value."
exit 1
fi
if [[ ! $wrapper_dir ]]; then
echo "--wrapper-dir can't be empty. Remove it to use default value."
exit 1
fi
if [[ ! $module_repo_org ]]; then
echo "--module-repo-org can't be empty. Remove it to use default value."
exit 1
fi
if [[ ! $module_repo_shortname ]]; then
echo "--module-repo-shortname can't be empty. It should be part of full repo name (eg, s3-bucket)."
exit 1
fi
if [[ ! $module_repo_provider ]]; then
echo "--module-repo-provider can't be empty. It should be name of the provider used by the module (eg, aws)."
exit 1
fi
if [[ ! -d "$root_dir" ]]; then
echo "Root directory $root_dir does not exist!"
exit 1
fi
OLD_IFS="$IFS"
IFS=$'\n'
all_module_dirs=("./")
# Find all modules directories if nothing was provided via "--module-dir" argument
if [[ ! $module_dir ]]; then
# shellcheck disable=SC2207
all_module_dirs+=($(cd "${root_dir}" && find . -maxdepth 2 -path '**/modules/*' -type d -print))
else
all_module_dirs=("$module_dir")
fi
IFS="$OLD_IFS"
for module_dir in "${all_module_dirs[@]}"; do
# Remove "./" from the "./modules/iam-user" or "./"
module_dir="${module_dir/.\//}"
full_module_dir="${root_dir}/${module_dir}"
# echo "FULL=${full_module_dir}"
if [[ ! -d "$full_module_dir" ]]; then
echo "Module directory \"$full_module_dir\" does not exist!"
exit 1
fi
# Remove "modules/" from "modules/iam-user"
# module_name="${module_dir//modules\//}"
module_name="${module_dir#modules/}"
if [[ ! $module_name ]]; then
wrapper_title="Wrapper for the root module"
wrapper_path="${wrapper_dir}"
else
wrapper_title="Wrapper for module: \`${module_dir}\`"
wrapper_path="${wrapper_dir}/${module_name}"
fi
# Wrappers will be stored in "wrappers/{module_name}"
output_dir="${root_dir}/${wrapper_dir}/${module_name}"
# Calculate relative depth for module source by number of slashes
module_depth="${module_dir//[^\/]/}"
local relative_source_path=$wrapper_relative_source_path
for ((c = 0; c < ${#module_depth}; c++)); do
relative_source_path+="../"
done
create_tmp_file_tf
if [[ "$verbose" == "true" ]]; then
echo "Root directory: $root_dir"
echo "Module directory: $module_dir"
echo "Output directory: $output_dir"
echo "Temp file: $tmp_file_tf"
echo
fi
# Read content of all OpenTofu files
# shellcheck disable=SC2207
all_tf_content=$(find "${full_module_dir}" -regex '.*\.(tf|tofu)' -maxdepth 1 -type f -exec cat {} +)
if [[ ! $all_tf_content ]]; then
common::colorify "yellow" "Skipping ${full_module_dir} because there are no *.(tf|tofu) files."
continue
fi
# Get names of module variables in all OpenTofu files
# shellcheck disable=SC2207
module_vars=($(echo "$all_tf_content" | hcledit block list | { grep "^variable\." | cut -d'.' -f 2 | sort || true; }))
# Get names of module outputs in all OpenTofu files
# shellcheck disable=SC2207
module_outputs=($(echo "$all_tf_content" | hcledit block list | { grep "^output\." | cut -d'.' -f 2 || true; }))
# Get names of module providers in all OpenTofu files
module_providers=$(echo "$all_tf_content" | hcledit block list | { grep "^provider\." || true; })
if [[ $module_providers ]]; then
common::colorify "yellow" "Skipping ${full_module_dir} because it is a legacy module which contains its own local provider configurations and so calls to it may not use the for_each argument."
break
fi
# Looking for sensitive output
local wrapper_output_sensitive="# sensitive = false # No sensitive module output found"
for module_output in "${module_outputs[@]}"; do
module_output_sensitive=$(echo "$all_tf_content" | hcledit attribute get "output.${module_output}.sensitive")
# At least one output is sensitive - the wrapper's output should be sensitive, too
if [[ "$module_output_sensitive" == "true" ]]; then
wrapper_output_sensitive="sensitive = true # At least one sensitive module output (${module_output}) found (requires OpenTofu 1.6.0+)"
break
fi
done
# Create content of temporary main.tf file
hcledit attribute append module.wrapper.source "\"${relative_source_path}${module_dir}\"" --newline -f "$tmp_file_tf" -u
hcledit attribute append module.wrapper.for_each var.items --newline -f "$tmp_file_tf" -u
# Add newline before the first variable in a loop
local newline="--newline"
for module_var in "${module_vars[@]}"; do
# Get default value for the variable
var_default=$(echo "$all_tf_content" | hcledit attribute get "variable.${module_var}.default")
# Empty default means that the variable is required
if [[ ! $var_default ]]; then
var_value="try(each.value.${module_var}, var.defaults.${module_var})"
elif [[ "$var_default" == "{" ]]; then
# BUG in hcledit ( https://github.com/minamijoyo/hcledit/issues/31 ) which breaks on inline comments
# https://github.com/terraform-aws-modules/terraform-aws-security-group/blob/0bd31aa88339194efff470d3b3f58705bd008db0/rules.tf#L8
# As a result, wrappers in terraform-aws-security-group module are missing values of the rules variable and is not useful. :(
var_value="try(each.value.${module_var}, var.defaults.${module_var}, {})"
elif [[ $var_default == \<\<* ]]; then
# Heredoc style default values produce HCL parsing error:
# 'Unterminated template string; No closing marker was found for the string.'
# Because closing marker must be alone on it's own line:
# https://developer.hashicorp.com/terraform/language/expressions/strings#heredoc-strings
var_value="try(each.value.${module_var}, var.defaults.${module_var}, $var_default
)"
else
var_value="try(each.value.${module_var}, var.defaults.${module_var}, $var_default)"
fi
hcledit attribute append "module.wrapper.${module_var}" "${var_value}" $newline -f "$tmp_file_tf" -u
newline=""
done
[[ "$verbose" == "true" ]] && cat "$tmp_file_tf"
if [[ "$dry_run" == "false" ]]; then
common::colorify "green" "Saving files into \"${output_dir}\""
# Create output dir
[[ ! -d "$output_dir" ]] && mkdir -p "$output_dir"
mv "$tmp_file_tf" "${output_dir}/main.tf"
echo "$CONTENT_VARIABLES_TF" > "${output_dir}/variables.tf"
echo "$CONTENT_VERSIONS_TF" > "${output_dir}/versions.tf"
echo "$CONTENT_OUTPUTS_TF" > "${output_dir}/outputs.tf"
sed -i.bak "s|WRAPPER_OUTPUT_SENSITIVE|${wrapper_output_sensitive}|g" "${output_dir}/outputs.tf"
rm -rf "${output_dir}/outputs.tf.bak"
echo "$CONTENT_README" > "${output_dir}/README.md"
sed -i.bak -e "
s#WRAPPER_TITLE#${wrapper_title}#g
s#WRAPPER_PATH#${wrapper_path}#g
s#MODULE_REPO_ORG#${module_repo_org}#g
s#MODULE_REPO_SHORTNAME#${module_repo_shortname}#g
s#MODULE_REPO_PROVIDER#${module_repo_provider}#g
" "${output_dir}/README.md"
rm -rf "${output_dir}/README.md.bak"
else
common::colorify "yellow" "There is nothing to save. Remove --dry-run flag to write files."
fi
done
}
function check_dependencies {
if ! command -v hcledit > /dev/null; then
echo "ERROR: The binary 'hcledit' is required by this hook but is not installed or is not in the system's PATH."
echo "Check documentation: https://github.com/minamijoyo/hcledit"
exit 1
fi
}
function create_tmp_file_tf {
# Can't append extension for mktemp, so renaming instead
tmp_file=$(mktemp "${TMPDIR:-/tmp}/tfwrapper-XXXXXXXXXX")
mv "$tmp_file" "$tmp_file.tf"
tmp_file_tf="$tmp_file.tf"
# mktemp creates with no group/other read permissions
chmod a+r "$tmp_file_tf"
echo "$CONTENT_MAIN_TF" > "$tmp_file_tf"
}
[[ "${BASH_SOURCE[0]}" != "$0" ]] || main "$@"
Reference in a new issue View git blame Copy permalink