add pre-commit + workflow (#82)

* add workflow

* add pre-commit config

* fix typo

Author: AlejandroTerron

.github/git-chglog/CHANGELOG.tpl.md

@@ -13,4 +13,4 @@ Reverts
 {{- if .NoteGroups -}} {{ range .NoteGroups -}}
 
 {{ .Title }}
-{{ range .Notes }} {{ .Body }} {{ end }} {{ end -}} {{ end -}} {{ end -}}
+{{ range .Notes }} {{ .Body }} {{ end }} {{ end -}} {{ end -}} {{ end -}}

.github/git-chglog/config.yml

@@ -23,4 +23,4 @@ options:
       - Subject
   notes:
     keywords:
-      - BREAKING CHANGE
+      - BREAKING CHANGE

.github/workflows/ci-pull-request.yaml

@@ -51,4 +51,4 @@ jobs:
         run: |
           go install github.com/onsi/ginkgo/ginkgo@latest
       - name: Test
-        run: make test
+        run: make test

.github/workflows/pre-commit-check.yml

@@ -0,0 +1,32 @@
+name: Pre-commit Check
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Get changed files
+      uses: tj-actions/changed-files@v41
+      id: changed-files
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+
+    - name: Set up Terraform
+      uses: hashicorp/setup-terraform@v3
+      with:
+        terraform_version: latest
+
+    - name: Install pre-commit
+      run: pip install pre-commit
+
+    - name: Run pre-commit on changed files
+      run: |
+        pre-commit run --files ${{ steps.changed-files.outputs.all_changed_files }} --hook-stage push

.gitignore

@@ -31,4 +31,4 @@ crash.log
 .envrc
 .direnv
 .DS_Store
-.idea/
+.idea/

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: local
+    hooks:
+      - id: terraform_clean
+        name: "Terraform Cleanup"
+        pass_filenames: false
+        language: system
+        entry: bash -c "find . \( -iname ".terraform*" ! -iname ".terraform-docs*" ! -path "*/test/*" \) -print0 | xargs -0 rm -r; true"
+  - repo: https://github.com/antonbabenko/pre-commit-terraform
+    rev: v1.88.4
+    hooks:
+      - id: terraform_fmt
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: no-commit-to-branch
+        args: [--branch, main, --pattern, ".*/.*"]

CONTRIBUTING.md

@@ -31,4 +31,4 @@ It's recommended to use an .envrc file to keep environment variables under contr
 
 ## Release
 
-- push a new tag and the Github Action will draft a release (with notes)
+- push a new tag and the Github Action will draft a release (with notes)

LICENSE.txt

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

Makefile

@@ -27,4 +27,4 @@ clean:
 
 .PHONY: test
 test:
-	$(MAKE) -C test test
+	$(MAKE) -C test test

modules/agentless-scanning/locals.tf

@@ -9,10 +9,10 @@ data "aws_organizations_organization" "org" {
 locals {
   # check if both old and new org parameters are provided, we fail early
   both_org_configuration_params = var.is_organizational && length(var.org_units) > 0 && (
-  length(var.include_ouids) > 0 ||
-  length(var.exclude_ouids) > 0 ||
-  length(var.include_accounts) > 0 ||
-  length(var.exclude_accounts) > 0
+    length(var.include_ouids) > 0 ||
+    length(var.exclude_ouids) > 0 ||
+    length(var.include_accounts) > 0 ||
+    length(var.exclude_accounts) > 0
   )
 
   # check if old org_units parameter is provided, for backwards compatibility we will always give preference to it
@@ -25,14 +25,14 @@ locals {
 
 check "validate_org_configuration_params" {
   assert {
-    condition     = length(var.org_units) == 0  # if this condition is false we throw warning
+    condition     = length(var.org_units) == 0 # if this condition is false we throw warning
     error_message = <<-EOT
     WARNING: TO BE DEPRECATED 'org_units' on 30th November, 2025. Please work with Sysdig to migrate your Terraform installs to use 'include_ouids' instead.
     EOT
   }
 
   assert {
-    condition     = !local.both_org_configuration_params  # if this condition is false we throw error
+    condition     = !local.both_org_configuration_params # if this condition is false we throw error
     error_message = <<-EOT
     ERROR: If both org_units and include_ouids/exclude_ouids/include_accounts/exclude_accounts variables are populated,
     ONLY org_units will be considered. Please use only one of the two methods.
@@ -70,19 +70,19 @@ locals {
     # case1 - if old method is used where ONLY org_units is provided, use those
     local.check_old_ouid_param ? (
       "old_ouid_param"
-    ) : (
+      ) : (
       # case2 - if no include/exclude ous provided, include entire org
       var.is_organizational && length(var.include_ouids) == 0 && length(var.exclude_ouids) == 0 ? (
         "entire_org"
-      ) : (
+        ) : (
         # case3 - if only included ouids provided, include those ous only
         var.is_organizational && length(var.include_ouids) > 0 && length(var.exclude_ouids) == 0 ? (
           "included_ous_only"
-        ) : (
+          ) : (
           # case4 - if only excluded ouids provided, exclude their accounts from rest of org
           var.is_organizational && length(var.include_ouids) == 0 && length(var.exclude_ouids) > 0 ? (
             "excluded_ous_only"
-          ) : (
+            ) : (
             # case5 - if both include and exclude ouids are provided, includes override excludes
             var.is_organizational && length(var.include_ouids) > 0 && length(var.exclude_ouids) > 0 ? (
               "mixed_ous"
@@ -99,7 +99,7 @@ locals {
       org_units_to_deploy = var.org_units
     }
     entire_org = {
-       org_units_to_deploy = local.root_org_unit
+      org_units_to_deploy = local.root_org_unit
     }
     included_ous_only = {
       org_units_to_deploy = var.include_ouids
@@ -140,15 +140,15 @@ locals {
     # case1 - if old method is used where ONLY org_units is provided, this configuration is a noop
     local.check_old_ouid_param ? (
       "NONE"
-    ) : (
+      ) : (
       # case2 - if only included accounts provided, include those accts as well
       var.is_organizational && length(var.include_accounts) > 0 && length(var.exclude_accounts) == 0 ? (
         "UNION"
-      ) : (
+        ) : (
         # case3 - if only excluded accounts or only excluded ouids provided, exclude those accounts
-        var.is_organizational && length(var.include_accounts) == 0 && ( length(var.exclude_accounts) > 0 || local.org_configuration == "excluded_ous_only" ) ? (
+        var.is_organizational && length(var.include_accounts) == 0 && (length(var.exclude_accounts) > 0 || local.org_configuration == "excluded_ous_only") ? (
           "DIFFERENCE"
-        ) : (
+          ) : (
           # case4 - if both include and exclude accounts are provided, includes override excludes
           var.is_organizational && length(var.include_accounts) > 0 && length(var.exclude_accounts) > 0 ? (
             "MIXED"
@@ -158,30 +158,30 @@ locals {
     )
   )
 
-  ou_accounts_to_exclude = flatten([ for ou_accounts in data.aws_organizations_organizational_unit_descendant_accounts.ou_accounts_to_exclude: [ ou_accounts.accounts[*].id ] ])
-  accounts_to_exclude = setunion(local.ou_accounts_to_exclude, var.exclude_accounts)
+  ou_accounts_to_exclude = flatten([for ou_accounts in data.aws_organizations_organizational_unit_descendant_accounts.ou_accounts_to_exclude : [ou_accounts.accounts[*].id]])
+  accounts_to_exclude    = setunion(local.ou_accounts_to_exclude, var.exclude_accounts)
 
   # switch cases for various user provided accounts configuration to be onboarded
   deployment_account_options = {
     NONE = {
-      accounts_to_deploy = []
+      accounts_to_deploy  = []
       account_filter_type = "NONE"
     }
     UNION = {
-      accounts_to_deploy = var.include_accounts
+      accounts_to_deploy  = var.include_accounts
       account_filter_type = "UNION"
     }
     DIFFERENCE = {
-      accounts_to_deploy = local.accounts_to_exclude
+      accounts_to_deploy  = local.accounts_to_exclude
       account_filter_type = "DIFFERENCE"
     }
     MIXED = {
-      accounts_to_deploy = var.include_accounts
+      accounts_to_deploy  = var.include_accounts
       account_filter_type = "UNION"
     }
     default = {
       # default when neither of include/exclude accounts are provided
-      accounts_to_deploy = []
+      accounts_to_deploy  = []
       account_filter_type = "NONE"
     }
   }
@@ -198,6 +198,6 @@ locals {
   # XXX: due to AWS bug of not having UNION filter fully working, there is no way to add those extra accounts requested.
   # to not miss out on those extra accounts, deploy the cloud resources across entire org and noop the UNION filter.
   # i.e till we can't deploy UNION, we deploy it all
-  deployment_targets_org_units = local.deployment_targets_accounts.account_filter_type == "UNION" ? local.root_org_unit : local.deployment_targets_ous.org_units_to_deploy
+  deployment_targets_org_units       = local.deployment_targets_accounts.account_filter_type == "UNION" ? local.root_org_unit : local.deployment_targets_ous.org_units_to_deploy
   deployment_targets_accounts_filter = local.deployment_targets_accounts.account_filter_type == "UNION" ? "NONE" : local.deployment_targets_accounts.account_filter_type
-}
+}