Merge pull request #29 from ITV/CPSTREAM-2338-tests-and-type

refactor: adding tests and defaults

Author: uyggnodoow

README.md

@@ -33,6 +33,15 @@ A Terraform module that creates Web Application Firewall (WAFV2).
 
 - See [Example Codes](https://github.com/aws-ss/terraform-aws-wafv2/tree/main/examples) for full details.
 
+## Tests
+
+This module has unit tests.
+To run them, do:
+
+```shell
+terraform test
+```
+
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
 

examples/RegexMatchStatement/README.md

@@ -0,0 +1,9 @@
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```

examples/RegexMatchStatement/main.tf

@@ -0,0 +1,123 @@
+provider "aws" {
+  region = "ap-northeast-2"
+}
+
+module "wafv2" {
+  source = "../..//"
+
+  enabled_web_acl_association = true
+  resource_arn                = []
+
+  enabled_logging_configuration = false
+
+  name           = "WebACL01"
+  scope          = "REGIONAL"
+  default_action = "allow"
+  rule = [
+    {
+      name     = "APIVersionRegexRule"
+      priority = 10
+      action   = "block"
+      regex_match_statement = {
+        field_to_match = {
+          uri_path = {}
+        }
+        regex_string = "^/api/v[0-9]+/.*"
+        text_transformation = [
+          {
+            priority = 0
+            type     = "LOWERCASE"
+          }
+        ]
+      }
+      visibility_config = {
+        cloudwatch_metrics_enabled = true
+        metric_name                = "APIVersionRegexRule"
+        sampled_requests_enabled   = true
+      }
+    },
+    {
+      name     = "JWTTokenRegexRule"
+      priority = 20
+      action   = "allow"
+      regex_match_statement = {
+        field_to_match = {
+          single_header = {
+            name = "authorization"
+          }
+        }
+        regex_string = "^Bearer [A-Za-z0-9\\-_]+\\.[A-Za-z0-9\\-_]+\\.[A-Za-z0-9\\-_]+$"
+        text_transformation = [
+          {
+            priority = 0
+            type     = "NONE"
+          }
+        ]
+      }
+      visibility_config = {
+        cloudwatch_metrics_enabled = true
+        metric_name                = "JWTTokenRegexRule"
+        sampled_requests_enabled   = true
+      }
+    },
+    {
+      name     = "SQLInjectionRegexRule"
+      priority = 30
+      action   = "block"
+      regex_match_statement = {
+        field_to_match = {
+          query_string = {}
+        }
+        regex_string = ".*(select|union|insert|delete|drop).*"
+        text_transformation = [
+          {
+            priority = 0
+            type     = "LOWERCASE"
+          },
+          {
+            priority = 1
+            type     = "URL_DECODE"
+          }
+        ]
+      }
+      visibility_config = {
+        cloudwatch_metrics_enabled = true
+        metric_name                = "SQLInjectionRegexRule"
+        sampled_requests_enabled   = true
+      }
+    },
+    {
+      name     = "EmailValidationRegexRule"
+      priority = 40
+      action   = "allow"
+      regex_match_statement = {
+        field_to_match = {
+          single_query_argument = {
+            name = "email"
+          }
+        }
+        regex_string = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
+        text_transformation = [
+          {
+            priority = 0
+            type     = "LOWERCASE"
+          }
+        ]
+      }
+      visibility_config = {
+        cloudwatch_metrics_enabled = true
+        metric_name                = "EmailValidationRegexRule"
+        sampled_requests_enabled   = true
+      }
+    }
+  ]
+  visibility_config = {
+    cloudwatch_metrics_enabled = false
+    metric_name                = "cloudwatch_metric_name"
+    sampled_requests_enabled   = false
+  }
+  tags = {
+    Team  = "Security"
+    Owner = "Security"
+  }
+}

examples/RegexMatchStatement/outputs.tf

@@ -0,0 +1,19 @@
+output "web_acl_arn" {
+  description = "The ARN of the WAFv2 Web ACL"
+  value       = module.wafv2.aws_wafv2_arn
+}
+
+output "web_acl_id" {
+  description = "The ID of the WAFv2 Web ACL"
+  value       = module.wafv2.aws_wafv2_id
+}
+
+output "web_acl_capacity" {
+  description = "The capacity of the WAFv2 Web ACL"
+  value       = module.wafv2.aws_wafv2_capacity
+}
+
+output "web_acl_rules" {
+  description = "The rules configured in the WAFv2 Web ACL"
+  value       = module.wafv2.aws_wafv2_rule
+}

examples/RegexMatchStatement/variables.tf

@@ -0,0 +1 @@
+# No variables needed for this example

examples/RegexMatchStatement/versions.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = ">= 1.0"
+
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 5.32"
+    }
+  }
+}