fix: New checkov version (#12)

* new checkov version

* add args

* feat: Allign examples

* chore: Bump min TF version

* docs: Improve usage example

* Update examples/simple/versions.tf

Co-authored-by: Piotr Mossakowski <[email protected]>

* chore: Bump TF version in examples

Co-authored-by: Jakub Igla <[email protected]>
Co-authored-by: Piotr Mossakowski <[email protected]>

.github/workflows/pre-commit.yml

@@ -8,7 +8,6 @@ on:
 
 env:
   TERRAFORM_DOCS_VERSION: v0.16.0
-  # TFLINT_VERSION: v0.41.0 # use this version with "Invicton-Labs/deepmerge/null" module
 
 jobs:
   collectInputs:

.gitignore

@@ -29,3 +29,7 @@ override.tf.json
 # Include override files you do wish to add to version control using negated pattern
 #
 # !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+*tfplan*

.pre-commit-config.yaml

@@ -16,9 +16,10 @@ repos:
         args: ["."]
 
   - repo: https://github.com/bridgecrewio/checkov.git
-    rev: "2.2.168" # Get the latest from: https://github.com/bridgecrewio/checkov/releases
+    rev: "2.2.246" # Get the latest from: https://github.com/bridgecrewio/checkov/releases
     hooks:
       - id: checkov
+        args: [--skip-check, "CKV2_GHA_1"] #Flase positive for top-level permissions
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: "v4.3.0" # Get the latest from: https://github.com/pre-commit/pre-commit-hooks/releases

.tflint.hcl

@@ -1,3 +1,9 @@
+config {
+  ignore_module = {
+    "Invicton-Labs/deepmerge/null" = true
+  }
+}
+
 rule "terraform_deprecated_interpolation" {
   enabled = true
 }

README.md

@@ -36,7 +36,8 @@ _Example usage of the module - terraform code snippet_
 
 ```terraform
 module "template" {
-  source = "github.com/getindata/terraform-module-template"
+  source = "getindata/template/null"
+  # version  = "x.x.x"
 
   example_var = "foo"
 }
@@ -48,7 +49,8 @@ _Additional information that should be made public, for ex. how to solve known i
 
 ## EXAMPLES
 
-- [Full example](examples/full-example)
+- [Simple](examples/simple) - Basic usage of the module
+- [Complete](examples/complete) - Advanced usage of the module
 
 <!-- BEGIN_TF_DOCS -->
 
@@ -101,7 +103,7 @@ _Additional information that should be made public, for ex. how to solve known i
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15.0 |
 | <a name="requirement_null"></a> [null](#requirement\_null) | 3.1.1 |
 
 ## Resources

examples/complete/.envrc

@@ -0,0 +1,2 @@
+#Override defaults
+command -v dotenv && test -f .env && dotenv

examples/complete/Makefile

@@ -0,0 +1,11 @@
+init:
+	terraform init
+
+plan:
+	terraform plan -var-file fixtures.tfvars -out tfplan
+
+apply:
+	terraform apply tfplan
+
+destroy:
+	terraform destroy -var-file fixtures.tfvars

examples/complete/README.md

@@ -0,0 +1,17 @@
+# Complete Example
+
+```terraform
+module "terraform_module_template" {
+  source  = "../../"
+  context = module.this.context
+
+  example_var = "This is a example value."
+}
+```
+
+## Usage
+```
+terraform init
+terraform plan -var-file fixtures.tfvars -out tfplan
+terraform apply tfplan
+```

examples/complete/fixtures.tfvars

@@ -0,0 +1,7 @@
+descriptor_formats = {
+
+}
+
+tags = {
+  Terraform = "True"
+}

examples/full-example/versions.tf → examples/complete/versions.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 0.13.0"
+  required_version = ">= 0.15.0"
 
   required_providers {
     null = {

examples/simple/.envrc

@@ -0,0 +1,2 @@
+#Override defaults
+command -v dotenv && test -f .env && dotenv

examples/simple/Makefile

@@ -0,0 +1,11 @@
+init:
+	terraform init
+
+plan:
+	terraform plan -out tfplan
+
+apply:
+	terraform apply tfplan
+
+destroy:
+	terraform destroy

examples/simple/README.md

@@ -0,0 +1,16 @@
+# Simple Example
+
+```terraform
+module "terraform_module_template" {
+  source  = "../../"
+
+  example_var = "This is a example value."
+}
+```
+
+## Usage
+```
+terraform init
+terraform plan -out tfplan
+terraform apply tfplan
+```

examples/simple/main.tf

@@ -0,0 +1,5 @@
+module "terraform_module_template" {
+  source = "../../"
+
+  example_var = "This is a example value."
+}

examples/simple/outputs.tf

@@ -0,0 +1,4 @@
+output "example_output" {
+  description = "Example output of the module"
+  value       = module.terraform_module_template
+}

examples/simple/providers.tf

@@ -0,0 +1,3 @@
+provider "null" {
+  # Configuration options
+}

examples/simple/versions.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = ">= 0.15.0"
+
+  required_providers {
+    null = {
+      source  = "hashicorp/null"
+      version = "3.1.1"
+    }
+  }
+}

locals.tf

@@ -2,6 +2,8 @@ locals {
   # Get a name from the descriptor. If not available, use default naming convention.
   # Trim and replace function are used to avoid bare delimiters on both ends of the name and situation of adjacent delimiters.
   name_from_descriptor = trim(replace(
-    lookup(module.this.descriptors, "module-resource-name", module.this.id), "/${module.this.delimiter}${module.this.delimiter}+/", ""
+    lookup(module.this.descriptors, "module-resource-name", module.this.id), "/${module.this.delimiter}${module.this.delimiter}+/", module.this.delimiter
   ), module.this.delimiter)
+
+  enabled = module.this.enabled
 }

main.tf

@@ -2,6 +2,8 @@
 # echoes it's base64 encoded version locally 
 
 resource "null_resource" "output_input" {
+  count = local.enabled ? 1 : 0
+
   triggers = {
     name  = local.name_from_descriptor
     input = var.example_var

outputs.tf

@@ -2,5 +2,5 @@
 
 output "example_output" {
   description = "Example output of the module"
-  value       = var.example_var
+  value       = one(null_resource.output_input[*].id)
 }

versions.tf

@@ -1,7 +1,7 @@
 # Example configuration of terraform providers
 
 terraform {
-  required_version = ">= 0.13.0"
+  required_version = ">= 0.15.0"
 
   required_providers {
     null = {