feat: Added wrappers automatically generated via hook (terraform-aws-…

…modules#156)

.github/workflows/pre-commit.yml

@@ -71,6 +71,14 @@ jobs:
  id: minMax
  uses: clowdhaus/[email protected]
 
+ - name: Install hcledit (for terraform_wrapper_module_for_each hook)
+ shell: bash
+ run: |
+ curl -L "$(curl -s https://api.github.com/repos/minamijoyo/hcledit/releases/latest | grep -o -E -m 1 "https://.+?_linux_amd64.tar.gz")" > hcledit.tgz
+ sudo tar -xzf hcledit.tgz -C /usr/bin/ hcledit
+ rm -f hcledit.tgz 2> /dev/null
+ hcledit version
+
  - name: Pre-commit Terraform ${{ steps.minMax.outputs.maxVersion }}
  uses: clowdhaus/terraform-composite-actions/[email protected]
  with:

.pre-commit-config.yaml

@@ -1,8 +1,9 @@
 repos:
  - repo: https://github.com/antonbabenko/pre-commit-terraform
- rev: v1.66.0
+ rev: v1.71.0
  hooks:
  - id: terraform_fmt
+ - id: terraform_wrapper_module_for_each
  - id: terraform_validate
  - id: terraform_docs
  args:

README.md

@@ -97,6 +97,14 @@ inputs = {
 }
 ```
 
+
+## Module wrappers
+
+Users of this Terraform module can create multiple similar resources by using [`for_each` meta-argument within `module` block](https://www.terraform.io/language/meta-arguments/for_each) which became available in Terraform 0.13.
+
+Users of Terragrunt can achieve similar results by using modules provided in the [wrappers](https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/tree/master/wrappers) directory, if they prefer to reduce amount of configuration files.
+
+
 ## Examples:
 
 - [Complete](https://github.com/terraform-aws-modules/terraform-aws-s3-bucket/tree/master/examples/complete) - Complete S3 bucket with most of supported features enabled

wrappers/README.md

@@ -12,10 +12,20 @@ This wrapper does not implement any extra functionality.
 
 ```hcl
 terraform {
- source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
+ source = "tfr:https:///terraform-aws-modules/s3-bucket/aws//wrappers"
+ # Alternative source:
+ # source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
 }
 
 inputs = {
+ defaults = { # Default values
+ create = true
+ tags = {
+ Terraform = "true"
+ Environment = "dev"
+ }
+ }
+
  items = {
  my-item = {
  # omitted... can be any argument supported by the module
@@ -34,6 +44,14 @@ inputs = {
 module "wrapper" {
  source = "terraform-aws-modules/s3-bucket/aws//wrappers"
 
+ defaults = { # Default values
+ create = true
+ tags = {
+ Terraform = "true"
+ Environment = "dev"
+ }
+ }
+
  items = {
  my-item = {
  # omitted... can be any argument supported by the module
@@ -52,18 +70,30 @@ module "wrapper" {
 
 ```hcl
 terraform {
- source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
+ source = "tfr:https:///terraform-aws-modules/s3-bucket/aws//wrappers"
+ # Alternative source:
+ # source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
 }
 
 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"
- force_destroy = true
+ bucket = "my-random-bucket-1"
  }
  bucket2 = {
- bucket = "my-random-bucket-2"
- force_destroy = true
+ bucket = "my-random-bucket-2"
+ tags = {
+ Secure = "probably"
+ }
  }
  }
 }

wrappers/main.tf

@@ -3,37 +3,38 @@ module "wrapper" {
 
  for_each = var.items
 
- create_bucket = try(each.value.create_bucket, true)
- attach_elb_log_delivery_policy = try(each.value.attach_elb_log_delivery_policy, false)
- attach_lb_log_delivery_policy = try(each.value.attach_lb_log_delivery_policy, false)
- attach_deny_insecure_transport_policy = try(each.value.attach_deny_insecure_transport_policy, false)
- attach_require_latest_tls_policy = try(each.value.attach_require_latest_tls_policy, false)
- attach_policy = try(each.value.attach_policy, false)
- attach_public_policy = try(each.value.attach_public_policy, true)
- bucket = try(each.value.bucket, null)
- bucket_prefix = try(each.value.bucket_prefix, null)
- acl = try(each.value.acl, null)
- policy = try(each.value.policy, null)
- tags = try(each.value.tags, {})
- force_destroy = try(each.value.force_destroy, false)
- acceleration_status = try(each.value.acceleration_status, null)
- request_payer = try(each.value.request_payer, null)
- website = try(each.value.website, {})
- cors_rule = try(each.value.cors_rule, [])
- versioning = try(each.value.versioning, {})
- logging = try(each.value.logging, {})
- grant = try(each.value.grant, [])
- owner = try(each.value.owner, {})
- expected_bucket_owner = try(each.value.expected_bucket_owner, null)
- lifecycle_rule = try(each.value.lifecycle_rule, [])
- replication_configuration = try(each.value.replication_configuration, {})
- server_side_encryption_configuration = try(each.value.server_side_encryption_configuration, {})
- object_lock_configuration = try(each.value.object_lock_configuration, {})
- block_public_acls = try(each.value.block_public_acls, false)
- block_public_policy = try(each.value.block_public_policy, false)
- ignore_public_acls = try(each.value.ignore_public_acls, false)
- restrict_public_buckets = try(each.value.restrict_public_buckets, false)
- control_object_ownership = try(each.value.control_object_ownership, false)
- object_ownership = try(each.value.object_ownership, "ObjectWriter")
- putin_khuylo = try(each.value.putin_khuylo, true)
+ create_bucket = try(each.value.create_bucket, var.defaults.create_bucket, true)
+ attach_elb_log_delivery_policy = try(each.value.attach_elb_log_delivery_policy, var.defaults.attach_elb_log_delivery_policy, false)
+ attach_lb_log_delivery_policy = try(each.value.attach_lb_log_delivery_policy, var.defaults.attach_lb_log_delivery_policy, false)
+ attach_deny_insecure_transport_policy = try(each.value.attach_deny_insecure_transport_policy, var.defaults.attach_deny_insecure_transport_policy, false)
+ attach_require_latest_tls_policy = try(each.value.attach_require_latest_tls_policy, var.defaults.attach_require_latest_tls_policy, false)
+ attach_policy = try(each.value.attach_policy, var.defaults.attach_policy, false)
+ attach_public_policy = try(each.value.attach_public_policy, var.defaults.attach_public_policy, true)
+ bucket = try(each.value.bucket, var.defaults.bucket, null)
+ bucket_prefix = try(each.value.bucket_prefix, var.defaults.bucket_prefix, null)
+ acl = try(each.value.acl, var.defaults.acl, null)
+ policy = try(each.value.policy, var.defaults.policy, null)
+ tags = try(each.value.tags, var.defaults.tags, {})
+ force_destroy = try(each.value.force_destroy, var.defaults.force_destroy, false)
+ acceleration_status = try(each.value.acceleration_status, var.defaults.acceleration_status, null)
+ request_payer = try(each.value.request_payer, var.defaults.request_payer, null)
+ website = try(each.value.website, var.defaults.website, {})
+ cors_rule = try(each.value.cors_rule, var.defaults.cors_rule, [])
+ versioning = try(each.value.versioning, var.defaults.versioning, {})
+ logging = try(each.value.logging, var.defaults.logging, {})
+ grant = try(each.value.grant, var.defaults.grant, [])
+ owner = try(each.value.owner, var.defaults.owner, {})
+ expected_bucket_owner = try(each.value.expected_bucket_owner, var.defaults.expected_bucket_owner, null)
+ lifecycle_rule = try(each.value.lifecycle_rule, var.defaults.lifecycle_rule, [])
+ replication_configuration = try(each.value.replication_configuration, var.defaults.replication_configuration, {})
+ server_side_encryption_configuration = try(each.value.server_side_encryption_configuration, var.defaults.server_side_encryption_configuration, {})
+ object_lock_configuration = try(each.value.object_lock_configuration, var.defaults.object_lock_configuration, {})
+ object_lock_enabled = try(each.value.object_lock_enabled, var.defaults.object_lock_enabled, false)
+ block_public_acls = try(each.value.block_public_acls, var.defaults.block_public_acls, false)
+ block_public_policy = try(each.value.block_public_policy, var.defaults.block_public_policy, false)
+ ignore_public_acls = try(each.value.ignore_public_acls, var.defaults.ignore_public_acls, false)
+ restrict_public_buckets = try(each.value.restrict_public_buckets, var.defaults.restrict_public_buckets, false)
+ control_object_ownership = try(each.value.control_object_ownership, var.defaults.control_object_ownership, false)
+ object_ownership = try(each.value.object_ownership, var.defaults.object_ownership, "ObjectWriter")
+ putin_khuylo = try(each.value.putin_khuylo, var.defaults.putin_khuylo, true)
 }

wrappers/notification/README.md

@@ -12,10 +12,20 @@ This wrapper does not implement any extra functionality.
 
 ```hcl
 terraform {
- source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers/notification"
+ source = "tfr:https:///terraform-aws-modules/s3-bucket/aws//wrappers/notification"
+ # Alternative source:
+ # source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers/notification"
 }
 
 inputs = {
+ defaults = { # Default values
+ create = true
+ tags = {
+ Terraform = "true"
+ Environment = "dev"
+ }
+ }
+
  items = {
  my-item = {
  # omitted... can be any argument supported by the module
@@ -34,6 +44,14 @@ inputs = {
 module "wrapper" {
  source = "terraform-aws-modules/s3-bucket/aws//wrappers/notification"
 
+ defaults = { # Default values
+ create = true
+ tags = {
+ Terraform = "true"
+ Environment = "dev"
+ }
+ }
+
  items = {
  my-item = {
  # omitted... can be any argument supported by the module
@@ -52,18 +70,30 @@ module "wrapper" {
 
 ```hcl
 terraform {
- source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
+ source = "tfr:https:///terraform-aws-modules/s3-bucket/aws//wrappers"
+ # Alternative source:
+ # source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
 }
 
 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"
- force_destroy = true
+ bucket = "my-random-bucket-1"
  }
  bucket2 = {
- bucket = "my-random-bucket-2"
- force_destroy = true
+ bucket = "my-random-bucket-2"
+ tags = {
+ Secure = "probably"
+ }
  }
  }
 }

wrappers/notification/main.tf

@@ -3,13 +3,13 @@ module "wrapper" {
 
  for_each = var.items
 
- create = try(each.value.create, true)
- create_sns_policy = try(each.value.create_sns_policy, true)
- create_sqs_policy = try(each.value.create_sqs_policy, true)
- bucket = try(each.value.bucket, "")
- bucket_arn = try(each.value.bucket_arn, null)
- eventbridge = try(each.value.eventbridge, null)
- lambda_notifications = try(each.value.lambda_notifications, {})
- sqs_notifications = try(each.value.sqs_notifications, {})
- sns_notifications = try(each.value.sns_notifications, {})
+ create = try(each.value.create, var.defaults.create, true)
+ create_sns_policy = try(each.value.create_sns_policy, var.defaults.create_sns_policy, true)
+ create_sqs_policy = try(each.value.create_sqs_policy, var.defaults.create_sqs_policy, true)
+ bucket = try(each.value.bucket, var.defaults.bucket, "")
+ bucket_arn = try(each.value.bucket_arn, var.defaults.bucket_arn, null)
+ eventbridge = try(each.value.eventbridge, var.defaults.eventbridge, null)
+ lambda_notifications = try(each.value.lambda_notifications, var.defaults.lambda_notifications, {})
+ sqs_notifications = try(each.value.sqs_notifications, var.defaults.sqs_notifications, {})
+ sns_notifications = try(each.value.sns_notifications, var.defaults.sns_notifications, {})
 }

wrappers/notification/outputs.tf

@@ -1,4 +1,5 @@
 output "wrapper" {
  description = "Map of outputs of a wrapper."
  value = module.wrapper
+ # sensitive = false # No sensitive module output found
 }

wrappers/notification/variables.tf

@@ -1,3 +1,9 @@
+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

wrappers/object/README.md

@@ -12,10 +12,20 @@ This wrapper does not implement any extra functionality.
 
 ```hcl
 terraform {
- source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers/object"
+ source = "tfr:https:///terraform-aws-modules/s3-bucket/aws//wrappers/object"
+ # Alternative source:
+ # source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers/object"
 }
 
 inputs = {
+ defaults = { # Default values
+ create = true
+ tags = {
+ Terraform = "true"
+ Environment = "dev"
+ }
+ }
+
  items = {
  my-item = {
  # omitted... can be any argument supported by the module
@@ -34,6 +44,14 @@ inputs = {
 module "wrapper" {
  source = "terraform-aws-modules/s3-bucket/aws//wrappers/object"
 
+ defaults = { # Default values
+ create = true
+ tags = {
+ Terraform = "true"
+ Environment = "dev"
+ }
+ }
+
  items = {
  my-item = {
  # omitted... can be any argument supported by the module
@@ -52,18 +70,30 @@ module "wrapper" {
 
 ```hcl
 terraform {
- source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
+ source = "tfr:https:///terraform-aws-modules/s3-bucket/aws//wrappers"
+ # Alternative source:
+ # source = "git::[email protected]:terraform-aws-modules/terraform-aws-s3-bucket.git?ref=master//wrappers"
 }
 
 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"
- force_destroy = true
+ bucket = "my-random-bucket-1"
  }
  bucket2 = {
- bucket = "my-random-bucket-2"
- force_destroy = true
+ bucket = "my-random-bucket-2"
+ tags = {
+ Secure = "probably"
+ }
  }
  }
 }