scripts, ci, validation

Author: ndbroadbent

.github/workflows/ci.yml

@@ -14,8 +14,12 @@ on:
 jobs:
   fmt-validate:
     runs-on: ubuntu-latest
+    env:
+      TF_PLUGIN_CACHE_DIR: ${{ runner.temp }}/tf-plugin-cache
     steps:
       - uses: actions/checkout@v4
+      - name: Create plugin cache
+        run: mkdir -p "$TF_PLUGIN_CACHE_DIR"
       - name: Setup Terraform
         uses: hashicorp/setup-terraform@v3
         with:
@@ -45,8 +49,12 @@ jobs:
 
   tflint:
     runs-on: ubuntu-latest
+    env:
+      TF_PLUGIN_CACHE_DIR: ${{ runner.temp }}/tf-plugin-cache
     steps:
       - uses: actions/checkout@v4
+      - name: Create plugin cache
+        run: mkdir -p "$TF_PLUGIN_CACHE_DIR"
       - name: Setup TFLint
         uses: terraform-linters/setup-tflint@v4
       - name: TFLint init

.gitignore

@@ -1,6 +1,7 @@
 # Terraform local artifacts
 **/.terraform/
 **/.terraform.lock.hcl
+/.terraform.d/
 *.tfstate
 *.tfstate.backup
 

Makefile

@@ -0,0 +1,40 @@
+SHELL := /bin/bash
+
+export TF_PLUGIN_CACHE_DIR ?= $(CURDIR)/.terraform.d/plugin-cache
+
+DIRS := . \
+	modules/metric-filter \
+	modules/subscription-filter \
+	examples/metric_filter_basic \
+	examples/subscription_filter_basic
+
+.PHONY: validate fmt lint _init_validate ensure-cache
+
+validate: ensure-cache fmt ## Format, init (cached), and validate all modules/examples
+	@echo "Using TF_PLUGIN_CACHE_DIR=$(TF_PLUGIN_CACHE_DIR)"
+	@$(MAKE) _init_validate
+
+ensure-cache:
+	@mkdir -p "$(TF_PLUGIN_CACHE_DIR)"
+
+_init_validate:
+	@set -euo pipefail; \
+	for d in $(DIRS); do \
+	  echo "==> $$d"; \
+	  terraform -chdir=$$d init -backend=false -upgrade=false >/dev/null; \
+	  terraform -chdir=$$d validate; \
+	done
+
+fmt: ## Run terraform fmt -check -recursive
+	@terraform fmt -check -recursive
+
+lint: ## Run TFLint across repo, modules, and examples
+	@tflint --init || true
+	@tflint -c .tflint.hcl .
+	@tflint --chdir modules/metric-filter -c ../../.tflint.hcl
+	@tflint --chdir modules/subscription-filter -c ../../.tflint.hcl
+	@tflint --chdir examples/metric_filter_basic -c ../../.tflint.hcl
+	@tflint --chdir examples/subscription_filter_basic -c ../../.tflint.hcl
+
+help: ## Show help
+	@grep -E '^[a-zA-Z_-]+:.*?## ' $(MAKEFILE_LIST) | awk 'BEGIN {FS=":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

modules/metric-filter/versions.tf

@@ -3,12 +3,11 @@ terraform {
   required_providers {
     logstruct = {
       source  = "DocSpring/logstruct"
-      version = ">= 0.0.4"
+      version = ">= 0.0.6"
     }
     aws = {
       source  = "hashicorp/aws"
       version = ">= 5.0"
     }
   }
 }
-

modules/subscription-filter/versions.tf

@@ -3,12 +3,11 @@ terraform {
   required_providers {
     logstruct = {
       source  = "DocSpring/logstruct"
-      version = ">= 0.0.4"
+      version = ">= 0.0.6"
     }
     aws = {
       source  = "hashicorp/aws"
       version = ">= 5.0"
     }
   }
 }
-

scripts/sync_provider_version.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Usage: VERSION=0.0.6 bash scripts/sync_provider_version.sh
+VERSION="${VERSION:-}"
+if [[ -z "$VERSION" ]]; then
+  echo "Usage: VERSION=X.Y.Z $0" >&2
+  exit 1
+fi
+
+update_file() {
+  local file="$1"
+  if [[ -f "$file" ]]; then
+    sed -i.bak -E "s|(source\s*=\s*\"DocSpring/logstruct\"[\s\S]*version\s*=\s*\")>=?\s*[0-9.]+\"|\1>= $VERSION\"|" "$file" && rm -f "$file.bak"
+  fi
+}
+
+update_file modules/metric-filter/versions.tf
+update_file modules/subscription-filter/versions.tf
+
+echo "Synchronized provider constraints to >= $VERSION"
+