automate fixing formatting in examples

dak1n1 · dak1n1 · commit da99ae37fab6 · 2021-01-21T12:10:41.000-08:00
diff --git a/GNUmakefile b/GNUmakefile
@@ -33,6 +33,18 @@ depscheck:
 	@git diff --exit-code -- vendor || \
 		(echo; echo "Unexpected difference in vendor/ directory. Run 'go mod vendor' command or revert any go.mod/go.sum/vendor changes and commit."; exit 1)
 
+examples-lint: tools
+	@echo "==> Checking _examples dir formatting..."
+	@./scripts/fmt-examples.sh || (echo; \
+		echo "Terraform formatting errors found in _examples dir."; \
+		echo "To see the full differences, run: ./scripts/fmt-examples.sh diff"; \
+		echo "To automatically fix the formatting, run 'make examples-lint-fix' and commit the changes."; \
+		exit 1)
+
+examples-lint-fix: tools
+	@echo "==> Fixing terraform formatting of _examples dir..."
+	@./scripts/fmt-examples.sh fix
+
 fmt:
 	gofmt -w $(GOFMT_FILES)
 
diff --git a/_examples/aks/main.tf b/_examples/aks/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     kubernetes = {
-      source  = "hashicorp/kubernetes"
+      source = "hashicorp/kubernetes"
     }
     azurerm = {
       source  = "hashicorp/azurerm"
@@ -35,15 +35,15 @@ provider "azurerm" {
 }
 
 module "aks-cluster" {
-  providers               = { azurerm = azurerm }
-  source                  = "./aks-cluster"
-  cluster_name            = local.cluster_name
-  location                = var.location
+  providers    = { azurerm = azurerm }
+  source       = "./aks-cluster"
+  cluster_name = local.cluster_name
+  location     = var.location
 }
 
 module "kubernetes-config" {
-  providers               = { kubernetes = kubernetes, helm = helm }
-  depends_on              = [module.aks-cluster]
-  source                  = "./kubernetes-config"
-  cluster_name            = local.cluster_name
+  providers    = { kubernetes = kubernetes, helm = helm }
+  depends_on   = [module.aks-cluster]
+  source       = "./kubernetes-config"
+  cluster_name = local.cluster_name
 }
diff --git a/_examples/aks/variables.tf b/_examples/aks/variables.tf
@@ -1,5 +1,5 @@
 variable "location" {
-  type = string
+  type    = string
   default = "westus2"
 }
 
@@ -8,5 +8,5 @@ resource "random_id" "cluster_name" {
 }
 
 locals {
-  cluster_name                = "tf-k8s-${random_id.cluster_name.hex}"
+  cluster_name = "tf-k8s-${random_id.cluster_name.hex}"
 }
diff --git a/_examples/certificate-signing-request/main.tf b/_examples/certificate-signing-request/main.tf
@@ -1,6 +1,6 @@
 resource "tls_private_key" "example" {
   algorithm = "ECDSA"
-  rsa_bits = "4096"
+  rsa_bits  = "4096"
 }
 
 resource "tls_cert_request" "example" {
@@ -19,7 +19,7 @@ resource "kubernetes_certificate_signing_request" "example" {
   }
   spec {
     request = tls_cert_request.example.cert_request_pem
-    usages = ["client auth", "server auth"]
+    usages  = ["client auth", "server auth"]
   }
   auto_approve = true
 }
@@ -41,12 +41,12 @@ resource "kubernetes_pod" "main" {
   }
   spec {
     container {
-      name = "default"
-      image = "alpine:latest"
+      name    = "default"
+      image   = "alpine:latest"
       command = ["cat", "/etc/test/tls.crt"]
       volume_mount {
         mount_path = "/etc/test"
-        name = "secretvol"
+        name       = "secretvol"
       }
     }
     volume {
diff --git a/_examples/certificate-signing-request/variables.tf b/_examples/certificate-signing-request/variables.tf
@@ -1,7 +1,7 @@
-variable example_user {
-        default = "admin"
+variable "example_user" {
+  default = "admin"
 }
 
-variable example_org {
-        default = "example cluster"
+variable "example_org" {
+  default = "example cluster"
 }
diff --git a/_examples/eks/main.tf b/_examples/eks/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     kubernetes = {
-      source  = "hashicorp/kubernetes"
+      source = "hashicorp/kubernetes"
     }
     helm = {
       source  = "hashicorp/helm"
@@ -50,9 +50,9 @@ module "cluster" {
 }
 
 module "kubernetes-config" {
-  source                  = "./kubernetes-config"
-  k8s_node_role_arn       = list(module.cluster.worker_iam_role_arn)
-  cluster_ca_cert         = module.cluster.cluster_certificate_authority_data
-  cluster_name            = module.cluster.cluster_id # creates dependency on cluster creation
-  cluster_endpoint        = module.cluster.cluster_endpoint
+  source            = "./kubernetes-config"
+  k8s_node_role_arn = list(module.cluster.worker_iam_role_arn)
+  cluster_ca_cert   = module.cluster.cluster_certificate_authority_data
+  cluster_name      = module.cluster.cluster_id # creates dependency on cluster creation
+  cluster_endpoint  = module.cluster.cluster_endpoint
 }
diff --git a/_examples/gke/main.tf b/_examples/gke/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     kubernetes = {
-      source  = "hashicorp/kubernetes"
+      source = "hashicorp/kubernetes"
     }
     google = {
       source  = "hashicorp/google"
@@ -23,15 +23,15 @@ locals {
 }
 
 module "gke-cluster" {
-  source                  = "./gke-cluster"
-  cluster_name            = local.cluster_name
+  source       = "./gke-cluster"
+  cluster_name = local.cluster_name
 }
 
 module "kubernetes-config" {
-  source                  = "./kubernetes-config"
-  cluster_name            = module.gke-cluster.cluster_name
-  cluster_id              = module.gke-cluster.cluster_id # creates dependency on cluster creation
-  cluster_endpoint        = module.gke-cluster.cluster_endpoint
-  cluster_ca_cert         = module.gke-cluster.cluster_ca_cert
+  source           = "./kubernetes-config"
+  cluster_name     = module.gke-cluster.cluster_name
+  cluster_id       = module.gke-cluster.cluster_id # creates dependency on cluster creation
+  cluster_endpoint = module.gke-cluster.cluster_endpoint
+  cluster_ca_cert  = module.gke-cluster.cluster_ca_cert
 }
 
diff --git a/_examples/google-gke-nfs-filestore/main.tf b/_examples/google-gke-nfs-filestore/main.tf
@@ -26,8 +26,8 @@ variable "workers_count" {
 }
 
 data "google_container_engine_versions" "supported" {
-  location           = data.google_compute_zones.available.names[0]
-  version_prefix     = var.kubernetes_version
+  location       = data.google_compute_zones.available.names[0]
+  version_prefix = var.kubernetes_version
 }
 
 # If the result is empty '[]', the GKE default_cluster_version will be used.
@@ -37,7 +37,7 @@ output "available_master_versions_matching_user_input" {
 
 # Shared network for GKE cluster and Filestore to use.
 resource "google_compute_network" "vpc" {
-  name = "shared"
+  name                    = "shared"
   auto_create_subnetworks = true
 }
 
@@ -49,7 +49,7 @@ resource "google_container_cluster" "primary" {
   min_master_version = data.google_container_engine_versions.supported.latest_master_version
   # node version must match master version
   # https://www.terraform.io/docs/providers/google/r/container_cluster.html#node_version
-  node_version       = data.google_container_engine_versions.supported.latest_master_version
+  node_version = data.google_container_engine_versions.supported.latest_master_version
 
   node_locations = [
     data.google_compute_zones.available.names[1],
@@ -109,7 +109,7 @@ resource "local_file" "kubeconfig" {
 }
 
 provider "kubernetes" {
-  version = "1.11.2"
+  version          = "1.11.2"
   load_config_file = "false"
 
   host = google_container_cluster.primary.endpoint
@@ -131,7 +131,7 @@ resource "kubernetes_storage_class" "nfs" {
   metadata {
     name = "filestore"
   }
-  reclaim_policy  = "Retain"
+  reclaim_policy      = "Retain"
   storage_provisioner = "nfs"
 }
 
@@ -144,25 +144,25 @@ resource "kubernetes_persistent_volume" "example" {
       storage = "1T"
     }
     storage_class_name = kubernetes_storage_class.nfs.metadata[0].name
-    access_modes = ["ReadWriteMany"]
+    access_modes       = ["ReadWriteMany"]
     persistent_volume_source {
       nfs {
         server = google_filestore_instance.test.networks[0].ip_addresses[0]
-        path = "/${google_filestore_instance.test.file_shares[0].name}"
+        path   = "/${google_filestore_instance.test.file_shares[0].name}"
       }
     }
   }
 }
 
 resource "kubernetes_persistent_volume_claim" "example" {
   metadata {
-    name = "mariadb-data"
+    name      = "mariadb-data"
     namespace = "test"
   }
   spec {
-    access_modes = ["ReadWriteMany"]
+    access_modes       = ["ReadWriteMany"]
     storage_class_name = kubernetes_storage_class.nfs.metadata[0].name
-    volume_name = kubernetes_persistent_volume.example.metadata[0].name
+    volume_name        = kubernetes_persistent_volume.example.metadata[0].name
     resources {
       requests = {
         storage = "1T"
@@ -173,7 +173,7 @@ resource "kubernetes_persistent_volume_claim" "example" {
 
 resource "kubernetes_deployment" "mariadb" {
   metadata {
-    name = "mariadb-example"
+    name      = "mariadb-example"
     namespace = "test"
     labels = {
       mylabel = "MyExampleApp"
@@ -202,7 +202,7 @@ resource "kubernetes_deployment" "mariadb" {
           name  = "example"
 
           env {
-            name = "MYSQL_RANDOM_ROOT_PASSWORD"
+            name  = "MYSQL_RANDOM_ROOT_PASSWORD"
             value = true
           }
 
diff --git a/_examples/ingress/main.tf b/_examples/ingress/main.tf
@@ -1,40 +1,40 @@
 terraform {
   required_providers {
     kubernetes = {
-      source  = "hashicorp/kubernetes"
+      source = "hashicorp/kubernetes"
     }
   }
 }
 
 resource "kubernetes_namespace" "test" {
   metadata {
-    name = "test"
+    name      = "test"
     namespace = "test"
   }
 }
 
 resource "kubernetes_service" "test" {
   metadata {
-    name = "test"
+    name      = "test"
     namespace = kubernetes_namespace.test.metadata.0.name
   }
   spec {
     port {
-      port = 80
+      port        = 80
       target_port = 80
-      protocol = "TCP"
+      protocol    = "TCP"
     }
     type = "NodePort"
   }
 }
 
 resource "kubernetes_ingress" "test" {
   metadata {
-    name = "test"
+    name      = "test"
     namespace = kubernetes_namespace.test.metadata.0.name
     annotations = {
-      "kubernetes.io/ingress.class" = "alb"
-      "alb.ingress.kubernetes.io/scheme" = "internet-facing"
+      "kubernetes.io/ingress.class"           = "alb"
+      "alb.ingress.kubernetes.io/scheme"      = "internet-facing"
       "alb.ingress.kubernetes.io/target-type" = "ip"
     }
   }
diff --git a/_examples/job/main.tf b/_examples/job/main.tf
@@ -21,15 +21,15 @@ resource "kubernetes_job" "test" {
   }
   spec {
     active_deadline_seconds = 120
-    backoff_limit = 10
-    completions = 10
-    parallelism = 2
+    backoff_limit           = 10
+    completions             = 10
+    parallelism             = 2
     template {
       metadata {}
       spec {
         container {
-          name = "hello"
-          image = "busybox"
+          name    = "hello"
+          image   = "busybox"
           command = ["sleep", "30"]
         }
       }
diff --git a/scripts/fmt-examples.sh b/scripts/fmt-examples.sh
@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+# Check examples dir for formatting errors.
+set -o errexit
+set -o errtrace
+set -o nounset
+set -o pipefail
+
+#--------------
+# Functions
+#--------------
+
+function formatting_check() {
+  cd _examples
+  for dir in $(ls); do
+    cd ${dir}
+    terraform fmt --check --list=false || (echo "Formatting errors found in dir: _examples/${dir}"; exit 1)
+    cd -
+  done
+}
+
+function formatting_diff() {
+  cd _examples
+  for dir in $(ls); do
+    cd ${dir}
+    terraform fmt --check -diff || (echo "Formatting errors found in dir: _examples/${dir}"; exit 1)
+    cd -
+  done
+}
+
+function formatting_fix() {
+  cd _examples
+  for dir in $(ls); do
+    cd ${dir}
+    terraform fmt
+    cd -
+  done
+}
+
+#--------------
+# Main
+#--------------
+
+input="${1:-}"
+
+case ${input} in
+diff)
+  formatting_diff
+  ;;
+fix)
+  formatting_fix
+  ;;
+*)
+  formatting_check
+  ;;
+esac

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`variable "location" {`
`2`		`- type = string`
	`2`	`+ type = string`
`3`	`3`	`default = "westus2"`
`4`	`4`	`}`
`5`	`5`
`@@ -8,5 +8,5 @@ resource "random_id" "cluster_name" {`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`locals {`
`11`		`- cluster_name = "tf-k8s-${random_id.cluster_name.hex}"`
	`11`	`+ cluster_name = "tf-k8s-${random_id.cluster_name.hex}"`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`resource "tls_private_key" "example" {`
`2`	`2`	`algorithm = "ECDSA"`
`3`		`- rsa_bits = "4096"`
	`3`	`+ rsa_bits = "4096"`
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`resource "tls_cert_request" "example" {`
`@@ -19,7 +19,7 @@ resource "kubernetes_certificate_signing_request" "example" {`
`19`	`19`	`}`
`20`	`20`	`spec {`
`21`	`21`	`request = tls_cert_request.example.cert_request_pem`
`22`		`- usages = ["client auth", "server auth"]`
	`22`	`+ usages = ["client auth", "server auth"]`
`23`	`23`	`}`
`24`	`24`	`auto_approve = true`
`25`	`25`	`}`
`@@ -41,12 +41,12 @@ resource "kubernetes_pod" "main" {`
`41`	`41`	`}`
`42`	`42`	`spec {`
`43`	`43`	`container {`
`44`		`- name = "default"`
`45`		`- image = "alpine:latest"`
	`44`	`+ name = "default"`
	`45`	`+ image = "alpine:latest"`
`46`	`46`	`command = ["cat", "/etc/test/tls.crt"]`
`47`	`47`	`volume_mount {`
`48`	`48`	`mount_path = "/etc/test"`
`49`		`- name = "secretvol"`
	`49`	`+ name = "secretvol"`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`	`volume {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`		`-variable example_user {`
`2`		`- default = "admin"`
	`1`	`+variable "example_user" {`
	`2`	`+ default = "admin"`
`3`	`3`	`}`
`4`	`4`
`5`		`-variable example_org {`
`6`		`- default = "example cluster"`
	`5`	`+variable "example_org" {`
	`6`	`+ default = "example cluster"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,40 +1,40 @@`
`1`	`1`	`terraform {`
`2`	`2`	`required_providers {`
`3`	`3`	`kubernetes = {`
`4`		`- source = "hashicorp/kubernetes"`
	`4`	`+ source = "hashicorp/kubernetes"`
`5`	`5`	`}`
`6`	`6`	`}`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`resource "kubernetes_namespace" "test" {`
`10`	`10`	`metadata {`
`11`		`- name = "test"`
	`11`	`+ name = "test"`
`12`	`12`	`namespace = "test"`
`13`	`13`	`}`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`resource "kubernetes_service" "test" {`
`17`	`17`	`metadata {`
`18`		`- name = "test"`
	`18`	`+ name = "test"`
`19`	`19`	`namespace = kubernetes_namespace.test.metadata.0.name`
`20`	`20`	`}`
`21`	`21`	`spec {`
`22`	`22`	`port {`
`23`		`- port = 80`
	`23`	`+ port = 80`
`24`	`24`	`target_port = 80`
`25`		`- protocol = "TCP"`
	`25`	`+ protocol = "TCP"`
`26`	`26`	`}`
`27`	`27`	`type = "NodePort"`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`resource "kubernetes_ingress" "test" {`
`32`	`32`	`metadata {`
`33`		`- name = "test"`
	`33`	`+ name = "test"`
`34`	`34`	`namespace = kubernetes_namespace.test.metadata.0.name`
`35`	`35`	`annotations = {`
`36`		`- "kubernetes.io/ingress.class" = "alb"`
`37`		`- "alb.ingress.kubernetes.io/scheme" = "internet-facing"`
	`36`	`+ "kubernetes.io/ingress.class" = "alb"`
	`37`	`+ "alb.ingress.kubernetes.io/scheme" = "internet-facing"`
`38`	`38`	`"alb.ingress.kubernetes.io/target-type" = "ip"`
`39`	`39`	`}`
`40`	`40`	`}`