fix: remove unused variables and update linting checks to ensure this is caught in the future

bryantbiggs · bryantbiggs · commit a404a62adb41 · 2021-11-17T09:28:07.000-05:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -3,11 +3,25 @@ repos:
     rev: v1.56.0
     hooks:
       - id: terraform_fmt
+      - id: terraform_validate
       - id: terraform_docs
         args:
           - '--args=--lockfile=false'
-      - id: terraform_validate
       - id: terraform_tflint
+        args:
+          - '--args=--only=terraform_deprecated_interpolation'
+          - '--args=--only=terraform_deprecated_index'
+          - '--args=--only=terraform_unused_declarations'
+          - '--args=--only=terraform_comment_syntax'
+          - '--args=--only=terraform_documented_outputs'
+          - '--args=--only=terraform_documented_variables'
+          - '--args=--only=terraform_typed_variables'
+          - '--args=--only=terraform_module_pinned_source'
+          - '--args=--only=terraform_naming_convention'
+          - '--args=--only=terraform_required_version'
+          - '--args=--only=terraform_required_providers'
+          - '--args=--only=terraform_standard_module_structure'
+          - '--args=--only=terraform_workspace_remote'
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1
     hooks:
diff --git a/examples/complete/README.md b/examples/complete/README.md
@@ -23,15 +23,16 @@ Note that this example may create resources which will incur monetary charges on
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.1 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.0 |
+| <a name="requirement_random"></a> [random](#requirement\_random) | >= 2.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
 | <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.0 |
-| <a name="provider_random"></a> [random](#provider\_random) | n/a |
+| <a name="provider_random"></a> [random](#provider\_random) | >= 2.0 |
 
 ## Modules
 
@@ -56,7 +57,6 @@ Note that this example may create resources which will incur monetary charges on
 | [aws_iam_policy_document.custom](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
 | [aws_iam_policy_document.datadog_cmk](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
 | [aws_secretsmanager_secret.datadog_api_key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_secret) | data source |
-| [aws_secretsmanager_secret_version.datadog_api_key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_secret_version) | data source |
 
 ## Inputs
 
diff --git a/examples/complete/main.tf b/examples/complete/main.tf
@@ -22,10 +22,6 @@ data "aws_secretsmanager_secret" "datadog_api_key" {
   name = "datadog/api_key"
 }
 
-data "aws_secretsmanager_secret_version" "datadog_api_key" {
-  secret_id = data.aws_secretsmanager_secret.datadog_api_key.id
-}
-
 data "aws_caller_identity" "current" {}
 
 ################################################################################
diff --git a/examples/complete/variables.tf b/examples/complete/variables.tf
diff --git a/examples/complete/versions.tf b/examples/complete/versions.tf
@@ -1,7 +1,14 @@
 terraform {
-  required_version = ">= 0.12.26"
+  required_version = ">= 0.13.1"
 
   required_providers {
-    aws = ">= 3.0"
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 3.0"
+    }
+    random = {
+      source  = "hashicorp/random"
+      version = ">= 2.0"
+    }
   }
 }
diff --git a/examples/simple/README.md b/examples/simple/README.md
@@ -19,15 +19,16 @@ Note that this example may create resources which will incur monetary charges on
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.1 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.0 |
+| <a name="requirement_random"></a> [random](#requirement\_random) | >= 2.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
 | <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.0 |
-| <a name="provider_random"></a> [random](#provider\_random) | n/a |
+| <a name="provider_random"></a> [random](#provider\_random) | >= 2.0 |
 
 ## Modules
 
diff --git a/examples/simple/variables.tf b/examples/simple/variables.tf
diff --git a/examples/simple/versions.tf b/examples/simple/versions.tf
@@ -1,7 +1,14 @@
 terraform {
-  required_version = ">= 0.12.26"
+  required_version = ">= 0.13.1"
 
   required_providers {
-    aws = ">= 3.0"
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 3.0"
+    }
+    random = {
+      source  = "hashicorp/random"
+      version = ">= 2.0"
+    }
   }
 }
diff --git a/main.tf b/main.tf
@@ -142,6 +142,8 @@ module "vpc_flow_log_forwarder" {
   policy_name               = var.vpc_fl_forwarder_policy_name
   use_policy_name_prefix    = var.vpc_fl_forwarder_use_policy_name_prefix
   policy_path               = var.vpc_fl_forwarder_policy_path
+  s3_log_bucket_arns        = var.vpc_fl_forwarder_s3_log_bucket_arns
+  read_cloudwatch_logs      = var.vpc_fl_forwarder_read_cloudwatch_logs
 
   tags = merge(var.tags, var.vpc_fl_forwarder_tags)
 }
diff --git a/modules/log_forwarder/README.md b/modules/log_forwarder/README.md
@@ -43,13 +43,14 @@ module "datadog_log_forwarder" {
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.1 |
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.0 |
+| <a name="requirement_null"></a> [null](#requirement\_null) | >= 3.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
 | <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.0 |
-| <a name="provider_null"></a> [null](#provider\_null) | n/a |
+| <a name="provider_null"></a> [null](#provider\_null) | >= 3.0 |
 
 ## Modules
 
@@ -100,7 +101,6 @@ module "datadog_log_forwarder" {
 | <a name="input_policy_name"></a> [policy\_name](#input\_policy\_name) | Forwarder policy name | `string` | `""` | no |
 | <a name="input_policy_path"></a> [policy\_path](#input\_policy\_path) | Forwarder policy path | `string` | `null` | no |
 | <a name="input_publish"></a> [publish](#input\_publish) | Whether to publish creation/change as a new Lambda Function Version | `bool` | `false` | no |
-| <a name="input_read_cloudwatch_logs"></a> [read\_cloudwatch\_logs](#input\_read\_cloudwatch\_logs) | Whether the forwarder will read logs from CloudWatch or not | `bool` | `false` | no |
 | <a name="input_reserved_concurrent_executions"></a> [reserved\_concurrent\_executions](#input\_reserved\_concurrent\_executions) | The amount of reserved concurrent executions for the forwarder lambda function | `number` | `100` | no |
 | <a name="input_role_arn"></a> [role\_arn](#input\_role\_arn) | IAM role arn for forwarder lambda function to utilize | `string` | `null` | no |
 | <a name="input_role_max_session_duration"></a> [role\_max\_session\_duration](#input\_role\_max\_session\_duration) | The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours | `number` | `null` | no |
diff --git a/modules/log_forwarder/variables.tf b/modules/log_forwarder/variables.tf
@@ -170,12 +170,6 @@ variable "s3_log_bucket_arns" {
   default     = []
 }
 
-variable "read_cloudwatch_logs" {
-  description = "Whether the forwarder will read logs from CloudWatch or not"
-  type        = bool
-  default     = false
-}
-
 # Forwarder Lambda Function
 variable "forwarder_version" {
   description = "Forwarder version - see https://github.com/DataDog/datadog-serverless-functions/releases"
diff --git a/modules/log_forwarder/versions.tf b/modules/log_forwarder/versions.tf
@@ -6,5 +6,9 @@ terraform {
       source  = "hashicorp/aws"
       version = ">= 3.0"
     }
+    null = {
+      source  = "hashicorp/null"
+      version = ">= 3.0"
+    }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,6 @@ data "aws_secretsmanager_secret" "datadog_api_key" {`
`22`	`22`	`name = "datadog/api_key"`
`23`	`23`	`}`
`24`	`24`
`25`		`-data "aws_secretsmanager_secret_version" "datadog_api_key" {`
`26`		`- secret_id = data.aws_secretsmanager_secret.datadog_api_key.id`
`27`		`-}`
`28`		`-`
`29`	`25`	`data "aws_caller_identity" "current" {}`
`30`	`26`
`31`	`27`	`################################################################################`
Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,8 @@ module "vpc_flow_log_forwarder" {`
`142`	`142`	`policy_name = var.vpc_fl_forwarder_policy_name`
`143`	`143`	`use_policy_name_prefix = var.vpc_fl_forwarder_use_policy_name_prefix`
`144`	`144`	`policy_path = var.vpc_fl_forwarder_policy_path`
	`145`	`+ s3_log_bucket_arns = var.vpc_fl_forwarder_s3_log_bucket_arns`
	`146`	`+ read_cloudwatch_logs = var.vpc_fl_forwarder_read_cloudwatch_logs`
`145`	`147`
`146`	`148`	`tags = merge(var.tags, var.vpc_fl_forwarder_tags)`
`147`	`149`	`}`