feat: Adding tofu hooks (#129)

* feat: Adding tofu hooks

* feat: Updating README.md

* fix: Updating `.pre-commit-hooks.yaml`

Author: yhakbar

.pre-commit-hooks.yaml

@@ -1,5 +1,23 @@
 # This configuration file allows our pre-commit hooks to be used with pre-commit: http://pre-commit.com/
 
+- id: tofu-fmt
+  name: OpenTofu fmt
+  description: Rewrites all OpenTofu configuration files to a canonical format
+  entry: hooks/tofu-fmt.sh
+  language: script
+  files: \.(tf|tofu)$
+  exclude: \.terraform\/.*$
+  require_serial: true
+
+- id: tofu-validate
+  name: OpenTofu validate
+  description: Validates all OpenTofu configuration files
+  entry: hooks/tofu-validate.sh
+  language: script
+  files: \.(tf|tofu)$
+  exclude: \.terraform\/.*$
+  require_serial: true
+
 - id: terraform-fmt
   name: Terraform fmt
   description: Rewrites all Terraform configuration files to a canonical format

README.md

@@ -5,11 +5,13 @@
 This repo defines Git pre-commit hooks intended for use with [pre-commit](http://pre-commit.com/). The currently
 supported hooks are:
 
+* **tofu-fmt**: Automatically run `tofu fmt` on all OpenTofu code (`*.tf`, `*.tofu` files).
+* **tofu-validate**: Automatically run `tofu validate` on all OpenTofu code (`*.tf`, `*.tofu` files).
 * **terraform-fmt**: Automatically run `terraform fmt` on all Terraform code (`*.tf` files).
 * **terraform-validate**: Automatically run `terraform validate` on all Terraform code (`*.tf` files).
 * **packer-validate**: Automatically run `packer validate` on all Packer code (`*.pkr.*` files).
 * **terragrunt-hclfmt**: Automatically run `terragrunt hclfmt` on all Terragrunt configurations.
-* **tflint**: Automatically run [`tflint`](https://github.com/terraform-linters/tflint) on all Terraform code (`*.tf` files).
+* **tflint**: Automatically run [`tflint`](https://github.com/terraform-linters/tflint) on all OpenTofu/Terraform code (`*.tf`, `*.tofu` files).
 * **shellcheck**: Run [`shellcheck`](https://www.shellcheck.net/) to lint files that contain a bash [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)).
 * **gofmt**: Automatically run `gofmt` on all Golang code (`*.go` files).
 * **goimports**: Automatically run `goimports` on all Golang code (`*.go` files).
@@ -34,8 +36,8 @@ repos:
   - repo: https://github.com/gruntwork-io/pre-commit
     rev: <VERSION> # Get the latest from: https://github.com/gruntwork-io/pre-commit/releases
     hooks:
-      - id: terraform-fmt
-      - id: terraform-validate
+      - id: tofu-fmt
+      - id: tofu-validate
       - id: tflint
       - id: shellcheck
       - id: gofmt
@@ -60,7 +62,7 @@ That’s it! Now every time you commit a code change (`.tf` file), the hooks in
 If you'd like to format all of your code at once (rather than one file at a time), you can run:
 
 ```bash
-pre-commit run terraform-fmt --all-files
+pre-commit run tofu-fmt --all-files
 ```
 
 

hooks/tofu-fmt.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -e
+
+# OSX GUI apps do not pick up environment variables the same way as Terminal apps and there are no easy solutions,
+# especially as Apple changes the GUI app behavior every release (see https://stackoverflow.com/q/135688/483528). As a
+# workaround to allow GitHub Desktop to work, add this (hopefully harmless) setting here.
+original_path=$PATH
+export PATH=$PATH:/usr/local/bin
+
+# Store and return last failure from fmt so this can validate every directory passed before exiting
+FMT_ERROR=0
+
+for file in "$@"; do
+  tofu fmt -diff -check "$file" || FMT_ERROR=$?
+done
+
+# reset path to the original value
+export PATH=$original_path
+
+exit ${FMT_ERROR}

hooks/tofu-validate.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+set -e
+
+# OSX GUI apps do not pick up environment variables the same way as Terminal apps and there are no easy solutions,
+# especially as Apple changes the GUI app behavior every release (see https://stackoverflow.com/q/135688/483528). As a
+# workaround to allow GitHub Desktop to work, add this (hopefully harmless) setting here.
+export PATH=$PATH:/usr/local/bin
+
+# Disable output not usually helpful when running in automation (such as guidance to run plan after init)
+export TF_IN_AUTOMATION=1
+
+# Store and return last failure from validate so this can validate every directory passed before exiting
+VALIDATE_ERROR=0
+
+for dir in $(echo "$@" | xargs -n1 dirname | sort -u | uniq); do
+  echo "--> Running 'tofu validate' in directory '$dir'"
+  pushd "$dir" >/dev/null
+  tofu init -backend=false || VALIDATE_ERROR=$?
+  tofu validate || VALIDATE_ERROR=$?
+  popd >/dev/null
+done
+
+exit ${VALIDATE_ERROR}