Modern s3 terraform test

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Terraform Test
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Integration test
+    strategy:
+      fail-fast: false
+      max-parallel: 2
+      matrix:
+        module: ["s3"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: terraform test ${{ matrix.module }}
+        uses: dflook/terraform-test@v1
+        with:
+          path: ${{ matrix.module }}
+          variables: |
+            cf_user = "${{ secrets.CF_USER }}"
+            cf_password = "${{ secrets.CF_PASSWORD }}"

.gitignore

@@ -1,5 +1,6 @@
 # Local .terraform directories
 **/.terraform/*
+**/.terraform.lock.hcl
 
 # .tfstate files
 *.tfstate

README.md

@@ -140,3 +140,15 @@ module "egress_space" {
   ]
 }
 ```
+
+## Testing
+
+[Terraform tests](https://developer.hashicorp.com/terraform/language/tests) are in progress of being written. To run for any module with a `tests` directory:
+
+1. cd to module root. Example: `cd s3`
+1. Run `terraform init`
+1. Run `terraform test -var cf_user="SERVICE_DEPLOYER_USERNAME" -var cf_password="SERVICE_DEPLOYER_PASSWORD"`
+
+### tf-cg-test-support
+
+This module is used to help setup the cloudfoundry provider for each test. It is not a useful module on its own

s3/tests/creation.tftest.hcl

@@ -0,0 +1,35 @@
+provider "cloudfoundry" {
+  api_url  = "https://api.fr.cloud.gov"
+  user     = run.setup.cf_user
+  password = run.setup.cf_password
+}
+
+variables {
+  cf_org_name   = "sandbox-gsa"
+  cf_space_name = "ryan.ahearn"
+  s3_plan_name  = "basic-sandbox"
+  name          = "terraform-cloudgov-s3-test"
+}
+
+run "setup" {
+  module {
+    source = "../tf-cg-test-support"
+  }
+}
+
+run "test_creation" {
+  assert {
+    condition     = can(regex("^\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}$", output.bucket_id))
+    error_message = "Bucket ID should be a GUID"
+  }
+
+  assert {
+    condition     = cloudfoundry_service_instance.bucket.id == output.bucket_id
+    error_message = "Bucket ID output must match the service instance"
+  }
+
+  assert {
+    condition     = cloudfoundry_service_instance.bucket.service_plan == data.cloudfoundry_service.s3.service_plans["basic-sandbox"]
+    error_message = "Service Plan should be 'basic-sandbox'"
+  }
+}

tf-cg-test-support/echo_cf_vars.tf

@@ -0,0 +1,13 @@
+variable "cf_user" {}
+variable "cf_password" {
+  sensitive = true
+}
+
+output "cf_user" {
+  value = var.cf_user
+}
+
+output "cf_password" {
+  value     = var.cf_password
+  sensitive = true
+}