Merge pull request #1 from ukhsa-collaboration/feature/doe-99-add-pre…

…commit-hooks DOE-99: Add pre-commit hooks for Terraform
ukhsa-collaboration · Dec 5, 2024 · 7bc419b · 7bc419b
2 parents e1d7b82 + fb19c3d
commit 7bc419b
Show file tree

Hide file tree

Showing 33 changed files with 39 additions and 31 deletions.
diff --git a/.github/workflows/dev_terraform_check.yml b/.github/workflows/dev_terraform_check.yml
@@ -25,4 +25,3 @@ jobs:
       AZURE_TENANT_ID: "${{ secrets.AZURE_TENANT_ID }}"
       AZURE_SUBSCRIPTION_ID: "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
       TF_MODULES_SSH_DEPLOY_KEY: ${{ secrets.TF_MODULES_SSH_DEPLOY_KEY }}
-
diff --git a/.github/workflows/scheduled_destroy.yml.disabled b/.github/workflows/scheduled_destroy.yml.disabled
@@ -23,4 +23,4 @@ jobs:
       AZURE_CLIENT_ID: "${{ secrets.AZURE_CLIENT_ID }}"
       AZURE_TENANT_ID: "${{ secrets.AZURE_TENANT_ID }}"
       AZURE_SUBSCRIPTION_ID: "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
-      TF_MODULES_SSH_DEPLOY_KEY: ${{ secrets.TF_MODULES_SSH_DEPLOY_KEY }}
+      TF_MODULES_SSH_DEPLOY_KEY: ${{ secrets.TF_MODULES_SSH_DEPLOY_KEY }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,31 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.92.0
+    hooks:
+      - id: terraform_fmt
+        args:
+         - --args=--recursive
+      - id: terraform_tflint
+        args:
+         - --args=--recursive
+         - --args=--disable-rule terraform_required_version --disable-rule terraform_required_providers
+      - id: terraform_validate
+        args:
+         - --hook-config=--retry-once-with-cleanup=true
+         - --tf-init-args=--backend=false
+  - repo: https://github.com/zricethezav/gitleaks
+    rev: v8.18.4
+    hooks:
+    - id: gitleaks
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+    - id: black
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1 +1 @@
-* @UKHSA-Internal/devops-cloud-engineering-team
+* @UKHSA-Internal/devops-cloud-engineering-team
diff --git a/README.md b/README.md
@@ -3,3 +3,9 @@
 *This repository establishes a foundational Terraform file and folder structure, encompassing configurations for multiple applications and core services. Each component is equipped with environment-specific variable files, facilitating adaptability and scalability across diverse deployment stages. The architecture is meticulously crafted to foster modularity, maintainability, and effective resource management.*
 
 For further details on DevOps standards, please refer to the [DevOps Standards Documentation](https://confluence.collab.test-and-trace.nhs.uk/display/DOE/Standards).
+
+### Pre-commit hooks
+
+A pre-commit hooks config is included in the repo. This can be installed by running the below command inside of the repository directory after cloning:
+
+```pre-commit install```
diff --git a/applications/example-application-1/locals.tf b/applications/example-application-1/locals.tf
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-1/main.tf b/applications/example-application-1/main.tf
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-1/tfvars/dev.tfvars b/applications/example-application-1/tfvars/dev.tfvars
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-1/tfvars/prd.tfvars b/applications/example-application-1/tfvars/prd.tfvars
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-1/tfvars/qat.tfvars b/applications/example-application-1/tfvars/qat.tfvars
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-1/variables.tf b/applications/example-application-1/variables.tf
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-2/locals.tf b/applications/example-application-2/locals.tf
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-2/main.tf b/applications/example-application-2/main.tf
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-2/tfvars/dev.tfvars b/applications/example-application-2/tfvars/dev.tfvars
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-2/tfvars/prd.tfvars b/applications/example-application-2/tfvars/prd.tfvars
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-2/tfvars/qat.tfvars b/applications/example-application-2/tfvars/qat.tfvars
@@ -1 +0,0 @@
-

diff --git a/applications/example-application-2/variables.tf b/applications/example-application-2/variables.tf
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-1/locals.tf b/core-services/example-service-1/locals.tf
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-1/main.tf b/core-services/example-service-1/main.tf
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-1/tfvars/dev.tfvars b/core-services/example-service-1/tfvars/dev.tfvars
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-1/tfvars/prd.tfvars b/core-services/example-service-1/tfvars/prd.tfvars
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-1/tfvars/qat.tfvars b/core-services/example-service-1/tfvars/qat.tfvars
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-1/variables.tf b/core-services/example-service-1/variables.tf
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-2/locals.tf b/core-services/example-service-2/locals.tf
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-2/main.tf b/core-services/example-service-2/main.tf
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-2/tfvars/dev.tfvars b/core-services/example-service-2/tfvars/dev.tfvars
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-2/tfvars/prd.tfvars b/core-services/example-service-2/tfvars/prd.tfvars
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-2/tfvars/qat.tfvars b/core-services/example-service-2/tfvars/qat.tfvars
@@ -1 +0,0 @@
-

diff --git a/core-services/example-service-2/variables.tf b/core-services/example-service-2/variables.tf
@@ -1 +0,0 @@
-

diff --git a/environment/dev.tfvars b/environment/dev.tfvars
@@ -1 +0,0 @@
-

diff --git a/environment/prd.tfvars b/environment/prd.tfvars
@@ -1 +0,0 @@
-

diff --git a/environment/qat.tfvars b/environment/qat.tfvars
@@ -1 +0,0 @@
-

diff --git a/global.tfvars b/global.tfvars
@@ -1 +0,0 @@
-
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,4 +25,3 @@ jobs:
		AZURE_TENANT_ID: "${{ secrets.AZURE_TENANT_ID }}"
		AZURE_SUBSCRIPTION_ID: "${{ secrets.AZURE_SUBSCRIPTION_ID }}"
		TF_MODULES_SSH_DEPLOY_KEY: ${{ secrets.TF_MODULES_SSH_DEPLOY_KEY }}
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		* @UKHSA-Internal/devops-cloud-engineering-team
		* @UKHSA-Internal/devops-cloud-engineering-team