test(codegen): refactor examples testing out of GitHub workflows so they can be used as part of Makefile

Author: kklimonda-cl

.github/workflows/pr_ci.yml

@@ -1,7 +1,7 @@
 # This workflow will build and test a golang project
 
 name: PR CI
-run-name: 'CI pipeline for PR - (#${{ github.event.number }}) ${{ github.event.pull_request.title }}'
+run-name: "CI pipeline for PR - (#${{ github.event.number }}) ${{ github.event.pull_request.title }}"
 
 on:
   pull_request:
@@ -19,7 +19,7 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: actions/setup-go@0aaccfd150d50ccaeb58ebd88d36e91967a5f35b # v5
         with:
-          go-version: '1.23'
+          go-version: "1.23"
       - name: golangci-lint
         uses: golangci/golangci-lint-action@55c2c1448f86e01eaae002a5a3a9624417608d84 # v6
         with:
@@ -34,7 +34,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@0aaccfd150d50ccaeb58ebd88d36e91967a5f35b # v5
         with:
-          go-version: '1.23'
+          go-version: "1.23"
 
       - name: Download Go dependencies
         run: go get  ./... && go mod tidy
@@ -65,7 +65,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@0aaccfd150d50ccaeb58ebd88d36e91967a5f35b # v5
         with:
-          go-version: '1.23'
+          go-version: "1.23"
 
       - name: Download Go dependencies
         run: go get  ./... && go mod tidy
@@ -98,52 +98,11 @@ jobs:
       - name: Setup Terraform
         uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3
         with:
-          terraform_version: '1.11.2'
+          terraform_version: "1.11.2"
 
       - name: Validate Terraform Examples
-        working-directory: assets/terraform/examples
         run: |
-          # Create provider configuration template
-          cat << EOF > provider.tf.template
-          terraform {
-            required_providers {
-              panos = {
-                source = "PaloAltoNetworks/panos"
-                version = "1.0.0"
-              }
-            }
-          }
-  
-          provider "panos" {
-            alias = "ci"
-          }
-          EOF
-  
-          # Find all directories containing .tf files except ephemeral-resources
-          DIRS=$(find . -type f -name "*.tf" -exec dirname {} \; | sort -u)
-          
-          # Loop through each directory and validate
-          for dir in $DIRS; do
-          
-            # Copy provider configuration for validation
-            cp provider.tf.template $dir/provider.tf
-            
-            echo "Validating configurations in: $dir"
-            cd "$dir"
-
-            # Initialize and validate
-            terraform init -no-color
-            terraform validate -no-color
-            
-            # Clean up provider configuration
-            rm provider.tf
-            
-            # Return to the examples directory
-            cd - > /dev/null
-          done
-          
-          # Clean up template
-          rm provider.tf.template
+          ./scripts/validate-terraform-examples.sh
 
       - name: Workaround actions/upload-artifact#176
         run: |

.gitignore

@@ -29,6 +29,9 @@
 # IDE
 .idea/
 
+/assets/terraform/examples/**/provider.tf
+/assets/terraform/examples/provider.tf.template
+
 # Local semantic-release configuration if you create one for testing
 release.config.local.js
 release.config.local.json

Makefile

@@ -28,6 +28,14 @@ $(GENERATED_OUT_PATH)/%: assets/%
 	@mkdir -p $(@D)
 	cp $< $@
 
+.PHONY: install
+install: codegen
+	cd $(GENERATED_OUT_PATH)/terraform/ && go install
+
+.PHONY: examples
+examples: install
+	TF_CLI_CONFIG_FILE= ./scripts/validate-terraform-examples.sh
+
 .PHONY: test
 test: test/codegen test/pango test/terraform
 

scripts/validate-terraform-examples.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+set -e
+
+# This script validates all terraform examples.
+# It should be run from the root of the repository.
+
+cd assets/terraform/examples
+
+# Create provider configuration template
+cat << EOF > provider.tf.template
+terraform {
+  required_providers {
+    panos = {
+      source = "PaloAltoNetworks/panos"
+      version = "1.0.0"
+    }
+  }
+}
+
+provider "panos" {
+  alias = "ci"
+}
+EOF
+
+# Find all directories containing .tf files
+DIRS=$(find . -type f -name "*.tf" -exec dirname {} \; | sort -u)
+
+# Loop through each directory and validate
+for dir in $DIRS; do
+
+  # Copy provider configuration for validation
+  cp provider.tf.template "$dir/provider.tf"
+  
+  echo "Validating configurations in: $dir"
+  (
+    cd "$dir"
+
+    # Initialize and validate
+    [[ $CI == "true" ]] && terraform init -no-color
+    OUTPUT=$(terraform validate -no-color)
+    if [ $? -ne 0 ]; then
+        echo "Vailed to validate examples: $dir"
+        echo "${OUTPUT}"
+        exit 1
+    fi
+    
+    # Clean up provider configuration
+    rm provider.tf
+  )
+done
+
+# Clean up template
+rm provider.tf.template
+
+echo "All examples validated successfully."