adding pre-commit file

Author: tomarv2

.github/workflows/pre-commit.yml

@@ -0,0 +1,117 @@
+name: Pre-Commit
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - develop
+
+jobs:
+# Min Terraform version(s)
+  getDirectories:
+    name: Get root directories
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+
+      - name: Build matrix
+        id: matrix
+        run: |
+          DIRS=$(python -c "import json; import glob; print(json.dumps([x.replace('/versions.tf', '') for x in glob.glob('./**/versions.tf', recursive=True)]))")
+          echo "::set-output name=directories::$DIRS"
+    outputs:
+      directories: ${{ steps.matrix.outputs.directories }}
+
+  preCommitMinVersions:
+    name: Min TF validate
+    needs: getDirectories
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        directory: ${{ fromJson(needs.getDirectories.outputs.directories) }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+
+      - name: Terraform min/max versions
+        id: minMax
+        uses: clowdhaus/terraform-min-max@v1.0.1
+        with:
+          directory: ${{ matrix.directory }}
+
+      - name: Install Terraform v${{ steps.minMax.outputs.minVersion }}
+        uses: hashicorp/setup-terraform@v1
+        with:
+          terraform_version: ${{ steps.minMax.outputs.minVersion }}
+
+      - name: Install pre-commit dependencies
+        run: pip install pre-commit
+
+#      - name: Execute pre-commit
+#        # Run only validate pre-commit check on min version supported
+#        if: ${{ matrix.directory !=  '.' }}
+#        run:
+#          pre-commit run terraform_validate --color=always --show-diff-on-failure --files ${{ matrix.directory }}/*
+#
+#      - name: Execute pre-commit
+#        # Run only validate pre-commit check on min version supported
+#        if: ${{ matrix.directory ==  '.' }}
+#        run:
+#          pre-commit run terraform_validate --color=always --show-diff-on-failure --files $(ls *.tf)
+
+
+# Max Terraform version
+  getBaseVersion:
+    name: Module max TF version
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Terraform min/max versions
+        id: minMax
+        uses: clowdhaus/terraform-min-max@v1.0.1
+    outputs:
+      minVersion: ${{ steps.minMax.outputs.minVersion }}
+      maxVersion: ${{ steps.minMax.outputs.maxVersion }}
+
+  preCommitMaxVersion:
+    name: Max TF pre-commit
+    runs-on: ubuntu-latest
+    needs: getBaseVersion
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - ${{ needs.getBaseVersion.outputs.maxVersion }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+
+      - name: Install Terraform v${{ matrix.version }}
+        uses: hashicorp/setup-terraform@v1
+        with:
+          terraform_version: ${{ matrix.version }}
+
+      - name: Install pre-commit dependencies
+        run: |
+          pip install pre-commit
+          pip install checkov
+          curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-v0.12.1-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
+          curl -L "$(curl -s https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" > tflint.zip && unzip tflint.zip && rm tflint.zip && sudo mv tflint /usr/bin/
+
+      - name: Execute pre-commit
+        # Run all pre-commit checks on max version supported
+        if: ${{ matrix.version ==  needs.getBaseVersion.outputs.maxVersion }}
+        run: pre-commit run --color=always --show-diff-on-failure --all-files

.github/workflows/security_scans.yml

@@ -80,4 +80,4 @@ _testmain.go
 /test/times.out
 
 # ignore test file(s)
-**test**
+**test**

.gitignore

@@ -0,0 +1,36 @@
+repos:
+  - repo: git://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.48.0
+    hooks:
+      - id: terraform_fmt
+#      - id: terraform_validate
+      - id: terraform_tflint
+        args:
+          - '--args=--only=terraform_deprecated_interpolation'
+          - '--args=--only=terraform_deprecated_index'
+#          - '--args=--only=terraform_unused_declarations'
+          - '--args=--only=terraform_comment_syntax'
+          - '--args=--only=terraform_documented_outputs'
+          - '--args=--only=terraform_documented_variables'
+          - '--args=--only=terraform_typed_variables'
+          - '--args=--only=terraform_module_pinned_source'
+          - '--args=--only=terraform_naming_convention'
+          - '--args=--only=terraform_required_providers'
+#          - '--args=--only=terraform_standard_module_structure'
+          - '--args=--only=terraform_workspace_remote'
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: check-yaml
+
+  - repo: https://github.com/bridgecrewio/checkov.git
+    rev: '1.0.864' # change to tag or sha
+    hooks:
+    - id: checkov
+      verbose: true
+      args:
+      - -d . --framework terraform -o output_format json

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 <p align="center">
-    <a href="https://github.com/tomarv2/terraform-databricks-workspace/actions/workflows/security_scans.yml" alt="Security Scans">
-        <img src="https://github.com/tomarv2/terraform-databricks-workspace/actions/workflows/security_scans.yml/badge.svg?branch=main" /></a>
+    <a href="https://github.com/tomarv2/terraform-databricks-aws-workspace/actions/workflows/pre-commit.yml" alt="Precommit">
+        <img src="https://github.com/tomarv2/terraform-databricks-aws-workspace/actions/workflows/pre-commit.yml/badge.svg?branch=main" /></a>
     <a href="https://www.apache.org/licenses/LICENSE-2.0" alt="license">
-        <img src="https://img.shields.io/github/license/tomarv2/terraform-databricks-workspace" /></a>
-    <a href="https://github.com/tomarv2/terraform-databricks-workspace/tags" alt="GitHub tag">
-        <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-databricks-workspace" /></a>
-    <a href="https://github.com/tomarv2/terraform-databricks-workspace/pulse" alt="Activity">
-        <img src="https://img.shields.io/github/commit-activity/m/tomarv2/terraform-databricks-workspace" /></a>
+        <img src="https://img.shields.io/github/license/tomarv2/terraform-databricks-aws-workspace" /></a>
+    <a href="https://github.com/tomarv2/terraform-databricks-aws-workspace/tags" alt="GitHub tag">
+        <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-databricks-aws-workspace" /></a>
+    <a href="https://github.com/tomarv2/terraform-databricks-aws-workspace/pulse" alt="Activity">
+        <img src="https://img.shields.io/github/commit-activity/m/tomarv2/terraform-databricks-aws-workspace" /></a>
     <a href="https://stackoverflow.com/users/6679867/tomarv2" alt="Stack Exchange reputation">
         <img src="https://img.shields.io/stackexchange/stackoverflow/r/6679867"></a>
     <a href="https://discord.gg/XH975bzN" alt="chat on Discord">
@@ -15,38 +15,38 @@
         <img src="https://img.shields.io/twitter/follow/varuntomar2019?style=social&logo=twitter"></a>
 </p>
 
-# Terraform module for Databricks Workspace E2 (Part 1)
+# Terraform module for [Databricks AWS Workspace E2 (Part 1)](https://registry.terraform.io/providers/databrickslabs/databricks/latest/docs/guides/aws-workspace)
 
-> ❗️ **Important** 
-> 
+> ❗️ **Important**
+>
 > :point_right: This Terraform module assumes you have, access to: [https://accounts.cloud.databricks.com](https://accounts.cloud.databricks.com)
-> 
+>
 > :point_right: Databricks account username: `databricks_account_username`
 >
-> :point_right: Databricks account password: `databricks_account_password` 
-> 
+> :point_right: Databricks account password: `databricks_account_password`
+>
 > :point_right: Databricks account id, `databricks_account_id` can be found on the top right corner of the page, once you're logged in.
 >
-> :point_right: Part 2: Terraform module for [Databricks Workspace management](https://github.com/tomarv2/terraform-databricks-workspace-management)
+> :point_right: Part 2: Terraform module for [Databricks Workspace management](https://github.com/tomarv2/terraform-databricks-aws-workspace-management)
 
 ## Versions
 
 - Module tested for Terraform 0.14.
 - `databrickslabs/databricks` provider version [0.3.1](https://registry.terraform.io/providers/databrickslabs/databricks/latest)
 - AWS provider version [3.29.0](https://registry.terraform.io/providers/hashicorp/aws/latest)
 - `main` branch: Provider versions not pinned to keep up with Terraform releases
-- `tags` releases: Tags are pinned with versions (use <a href="https://github.com/tomarv2/terraform-databricks-workspace/tags" alt="GitHub tag">
-        <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-databricks-workspace" /></a> in your releases)
+- `tags` releases: Tags are pinned with versions (use <a href="https://github.com/tomarv2/terraform-databricks-aws-workspace/tags" alt="GitHub tag">
+        <img src="https://img.shields.io/github/v/tag/tomarv2/terraform-databricks-aws-workspace" /></a> in your releases)
 
-**NOTE:** 
+**NOTE:**
 
 - Read more on [tfremote](https://github.com/tomarv2/tfremote)
 
 ## Usage
 
 Recommended method:
 
-- Create python 3.6+ virtual environment 
+- Create python 3.6+ virtual environment
 ```
 python3 -m venv <venv name>
 ```
@@ -61,9 +61,9 @@ pip install tfremote
 export TF_AWS_BUCKET=<remote state bucket name>
 export TF_AWS_PROFILE=default
 export TF_AWS_BUCKET_REGION=us-west-2
-```  
+```
 
-- Updated `examples` directory to required values. 
+- Updated `examples` directory to required values.
 
 - Run and verify the output before deploying:
 ```
@@ -95,7 +95,7 @@ tf -cloud aws destroy -var='teamid=foo' -var='prjid=bar'
 
 ```
 module "databricks_workspace" {
-  source = "git::git@github.com:tomarv2/terraform-databricks-workspace.git?ref=v0.0.1"
+  source = "git::git@github.com:tomarv2/terraform-databricks-aws-workspace.git?ref=v0.0.1"
 
   profile_for_iam             = "iam-admin"
   databricks_account_username = "example@example.com"
@@ -110,8 +110,6 @@ module "databricks_workspace" {
 
 Please refer to examples directory [link](examples) for references.
 
-### Read more: [link](https://registry.terraform.io/providers/databrickslabs/databricks/latest/docs/guides/aws-workspace)
-
 ## Troubleshooting:
 
 ### IAM policy error
@@ -124,10 +122,8 @@ Error: MALFORMED_REQUEST: Failed credentials validation checks: Spot Cancellatio
 
 - Try creating workspace from UI:
 
-![create_workspace_error](https://github.com/tomarv2/terraform-databricks-workspace/raw/main/docs/images/create_workspace_error.png)
+![create_workspace_error](https://github.com/tomarv2/terraform-databricks-aws-workspace/raw/main/docs/images/create_workspace_error.png)
 
 - Verify if the role and policy exists (assume role should allow external id)
 
-![iam_role_trust_error](https://github.com/tomarv2/terraform-databricks-workspace/raw/main/docs/images/iam_role_trust_error.png)
-
-
+![iam_role_trust_error](https://github.com/tomarv2/terraform-databricks-aws-workspace/raw/main/docs/images/iam_role_trust_error.png)

README.md

@@ -9,4 +9,4 @@ module "databricks_workspace" {
   # Do not change the teamid, prjid once set.
   teamid = var.teamid
   prjid  = var.prjid
-}
+}

examples/sample/main.tf

@@ -23,19 +23,17 @@ output "storage_configuration_id" {
   value       = module.databricks_workspace.databricks_mws_storage_id
 }
 
-//output "databricks_dapi" {
-//  description = "databricks dapi"
-//  value = module.databricks_workspace.databricks_dapi
-//}
-
 output "databricks_host" {
-  value = module.databricks_workspace.workspace_url
+  description = "databricks workspace url"
+  value       = module.databricks_workspace.workspace_url
 }
 
 output "databricks_credentials_id" {
-  value = module.databricks_workspace.databricks_credentials_id
+  description = "databricks credentials id"
+  value       = module.databricks_workspace.databricks_credentials_id
 }
 
 output "databricks_deployment_name" {
-  value = module.databricks_workspace.databricks_deployment_name
+  description = "databricks deployment name"
+  value       = module.databricks_workspace.databricks_deployment_name
 }

examples/sample/output.tf examples/sample/outputs.tfexamples/sample/output.tf renamed to examples/sample/outputs.tf

@@ -1,7 +1,9 @@
 variable "teamid" {
   description = "(Required) Name of the team/group e.g. devops, dataengineering. Should not be changed after running 'tf apply'"
+  type        = string
 }
 
 variable "prjid" {
   description = "(Required) Name of the project/stack e.g: mystack, nifieks, demoaci. Should not be changed after running 'tf apply'"
+  type        = string
 }