add example with tests (#8)

Author: locus313

.github/workflows/scheduled-test.yml

@@ -0,0 +1,63 @@
+name: Scheduled Terraform Test
+
+on:
+  schedule:
+    - cron: "0 0 * * *" # Runs every day at midnight UTC
+  workflow_dispatch: # Allows manual triggering
+
+jobs:
+  terratest:
+    name: Run Terratest
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: '1.17'
+
+      - name: Install Terraform
+        uses: hashicorp/setup-terraform@v1
+        with:
+          terraform_version: 1.1.5
+
+      - name: Install dependencies
+        run: |
+          go mod tidy
+
+      - name: Run Terratest
+        run: |
+          cd test
+          go test -v
+
+  terraform-compliance:
+    name: Run Terraform Compliance
+    runs-on: ubuntu-latest
+    needs: terratest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Terraform
+        uses: hashicorp/setup-terraform@v3
+        with:
+          terraform_version: 0.13.1
+
+      - name: Terraform Init
+        run: terraform init -backend=false
+        working-directory: ./example
+
+      - name: Terraform Plan
+        run: terraform plan -out=tfplan -input=false
+        working-directory: ./example
+
+      - name: Install terraform-compliance
+        run: |
+          pip install terraform-compliance
+
+      - name: Run terraform-compliance
+        run: terraform-compliance -p ./example/tfplan -f ./compliance/features

README.md

@@ -74,7 +74,7 @@ No modules.
 ```hcl
 module "example-com" {
    source = "locus313/aws-route53/module"
-   version = "1.0.3"
+   version = "1.0.4"
    
    enabled                                                     = true
    primary_domain                                              = "example.com"

compliance/features/example.feature

@@ -0,0 +1,11 @@
+Feature: Route 53 Compliance
+
+  Scenario: Ensure all A records have the correct TTL
+    Given I have AWS Route53 Record defined
+    When its type is "A"
+    Then its ttl must be 3600
+
+  Scenario: Ensure all CNAME records have the correct TTL
+    Given I have AWS Route53 Record defined
+    When its type is "CNAME"
+    Then its ttl must be 3600

example/main.tf

@@ -0,0 +1,46 @@
+module "example-com" {
+   source = "locus313/aws-route53/module"
+   version = "1.0.4"
+   
+   enabled                                                     = true
+   primary_domain                                              = "example.com"
+   
+   records_wr = {
+     "support.example.com"                                     = "https://example.atlassian.net/servicedesk/customer/portals"
+   }
+   
+   records_a = {
+     "example.com"                                             = ["12.23.45.56"]
+   }
+
+   records_aaaa = {
+     "example.com"                                             = ["::ffff:c17:2d38"]
+   }
+
+   records_caa = {
+     "example.com"                                             = ["0 issue \"letsencrypt.org\""]
+   }
+   
+   records_cname = {
+     "calendar.example.com"                                    = ["ghs.googlehosted.com"]
+     "docs.example.com"                                        = ["ghs.googlehosted.com"]
+     "ftp.example.com"                                         = ["example.com"]
+     "mail.example.com"                                        = ["ghs.googlehosted.com"]
+     "sites.example.com"                                       = ["ghs.googlehosted.com"]
+     "www.example.com"                                         = ["example.com"]
+   }
+   
+   records_mx = {
+     "example.com"                                             = ["10 aspmx.l.google.com","20 alt1.aspmx.l.google.com","30 alt2.aspmx.l.google.com","40 aspmx2.googlemail.com","50 aspmx3.googlemail.com"]
+   }
+   
+   records_txt = {
+     "example.com"                                             = ["v=spf1 include:_spf.google.com ~all"]
+     "google._domainkey.example.com"                           = ["v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3gtOkCHXv+kDJBpIkr1lq1Ywd4B8FJGPceSv9s7yhUtCk8pKwifLmSKWNEyOvuK5oxIms+4Vc9Pu46bi/wehi5zJynzhkOrzYXdOX6+m4Nb8NbFWr0zZqsM+pDGmYzRjeczY/+txXnOegcbxL+967bIRisnlH2CRD91h1t0NJwsvvN23T5MAMaeJr726piDdE\"\"C6P2nF1apYbGXp0DZGz/RvtpCGjASjlpejA8I/xLclZOBn4Ir9pk8gajRSG48D21UKJ3d+PFzYEj9X5n1p1i2trjCqkdyCzU+f3vTUxma5F7fQncKYIeRJwVNbmR03IYfGuicCu13hnVP36aT5yuQIDAQAB"]
+   }
+   
+   records_ns = {
+     "clusters.example.com"                                    = ["ns-128.awsdns-16.com","ns-1533.awsdns-63.org","ns-1554.awsdns-02.co.uk","ns-956.awsdns-55.net"]
+     "envs.example.com"                                        = ["ns-1103.awsdns-09.org","ns-1587.awsdns-06.co.uk","ns-378.awsdns-47.com","ns-693.awsdns-22.net"]
+   }
+}

example/outputs.tf

@@ -0,0 +1,9 @@
+output "zone_id" {
+  description = "Zone ID of Route53 zone"
+  value       = module.example-com[0].this_route53_zone_zone_id
+}
+
+output "name_servers" {
+  description = "Name servers of Route53 zone"
+  value       = module.example-com[0].this_route53_zone_name_servers
+}

example/provider.tf

@@ -0,0 +1,3 @@
+provider "aws" {
+  region = "us-west-2"
+}

test/terraform_module_test.go

@@ -0,0 +1,19 @@
+package test
+
+import (
+  "testing"
+  "github.com/gruntwork-io/terratest/modules/terraform"
+  "github.com/stretchr/testify/assert"
+)
+
+func TestTerraformRoute53Module(t *testing.T) {
+  terraformOptions := &terraform.Options{
+    TerraformDir: "../example",
+  }
+
+  defer terraform.Destroy(t, terraformOptions)
+  terraform.InitAndApply(t, terraformOptions)
+
+  zoneID := terraform.Output(t, terraformOptions, "zone_id")
+  assert.NotEmpty(t, zoneID)
+}