feat: Align module with Snowflake provider changes (#34)

* ci: update pre-commit components * feat: Align module with Snowflake provider changes Due to breaking changes in Snowflake provider and additional code optimizations, **breaking changes** were introduced in this module. List of code and variable (API) changes: - Switched to `snowflake_database_role` module to leverage new `database_roles` mechanism - `default_roles` and `custom_roles` are now combined and controlled by single logic in snowflake_database_role module - snowflake_database resource was updated to use newly introduced changes in Snowflake provider - snowflake_schema resource was updated to use newly introduced changes in Snowflake provider - variable `add_grants_to_existing_objects` was removed as it is no longer needed - minimum Snowflake provider version is `0.90.0` For more information, refer to [variables.tf](variables.tf), list of inputs below and Snowflake provider documentation When upgrading from `v1.x`, expect most of the resources to be recreated - if recreation is impossible, then it is possible to import some existing resources. * add new variables into outputs * style: docs formatting * chore: remove version prefix * use provider default values for optional variables * chore: remove not needed tflint tf plugin config terraform plugin is already available in tflint * split default and custom roles to avoid deepmerge issues * docs: update examples * use provider default values for optional variables * chore: align variables between deps modules * chore: align locals * chore: align to schema and stage vars * docs: align examples * chore: more readable output * feat: database ownership configuration * chore: rename database ownership variables * docs: align example variables
getindata · Aug 5, 2024 · 2650829 · 2650829
1 parent 22446ef
commit 2650829
Show file tree

Hide file tree

Showing 18 changed files with 626 additions and 311 deletions.
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -12,3 +12,7 @@ on:
 jobs:
   main:
     uses: getindata/github-workflows/.github/workflows/tf-pre-commit.yml@v1
+    with:
+      # tflint v0.52.0 is the latest version we can use with pre-commit v0.1.23
+      # See .pre-commit-config.yaml for more details.
+      tflint-version: v0.52.0
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,27 +1,28 @@
 repos:
   - repo: https://github.com/gruntwork-io/pre-commit
-    # Stick to v0.1.20 until this bug is fixed: https://github.com/gruntwork-io/pre-commit/issues/102
     # When updating, also check if tflint version in pre-commit workflow can be updated.
     rev: "v0.1.23" # Get the latest from: https://github.com/gruntwork-io/pre-commit/releases
     hooks:
       - id: terraform-validate # It should be the first step as it runs terraform init required by tflint
       - id: terraform-fmt
       - id: tflint
+        args:
+          - "--config=__GIT_ROOT__/.tflint.hcl"
 
   - repo: https://github.com/terraform-docs/terraform-docs
-    rev: "v0.16.0" # Get the latest from: https://github.com/terraform-docs/terraform-docs/releases
+    rev: "v0.18.0" # Get the latest from: https://github.com/terraform-docs/terraform-docs/releases
     hooks:
       - id: terraform-docs-go
         args: ["."]
 
   - repo: https://github.com/bridgecrewio/checkov.git
-    rev: "2.5.13" # Get the latest from: https://github.com/bridgecrewio/checkov/releases
+    rev: "3.2.192" # Get the latest from: https://github.com/bridgecrewio/checkov/releases
     hooks:
       - id: checkov
         args: [--skip-check, "CKV_TF_1"] # Terraform module sources do not use a git url with a commit hash revision
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.5.0" # Get the latest from: https://github.com/pre-commit/pre-commit-hooks/releases
+    rev: "v4.6.0" # Get the latest from: https://github.com/pre-commit/pre-commit-hooks/releases
     hooks:
       - id: check-merge-conflict
         args: ["--assume-in-merge"]

diff --git a/.terraform-docs.yml b/.terraform-docs.yml
@@ -6,6 +6,10 @@ sections:
   hide: []
   show: [all]
 
+recursive:
+  enabled: true
+  path: examples
+
 content: |-
   {{ .Header }}
 

diff --git a/.tflint.hcl b/.tflint.hcl
@@ -1,16 +1,3 @@
-config {
-  ignore_module = {
-    "Invicton-Labs/deepmerge/null" = true
-  }
-}
-
-plugin "terraform" {
-    enabled = true
-    version = "0.5.0"
-    source  = "github.com/terraform-linters/tflint-ruleset-terraform"
-    preset  = "all"
-}
-
 rule "terraform_standard_module_structure" {
-  enabled = false  # Fails on context.tf
+  enabled = false # Fails on context.tf
 }
diff --git a/README.md b/README.md
diff --git a/examples/complete/README.md b/examples/complete/README.md
@@ -1,85 +1,6 @@
 # Complete Example
 
-```terraform
-resource "snowflake_user" "dbt" {
-  name       = "DBT user"
-  login_name = "dbt_user"
-  comment    = "DBT user."
-}
-
-module "snowflake_admin_role" {
-  source  = "getindata/role/snowflake"
-  version = "1.0.3"
-  context = module.this.context
-  name    = "admin"
-}
-
-module "snowflake_dev_role" {
-  source  = "getindata/role/snowflake"
-  version = "1.0.3"
-  context = module.this.context
-  name    = "dev"
-}
-
-module "prod_database" {
-  source      = "../../"
-  context     = module.this.context
-  environment = "prod"
-
-  name                        = "analytics"
-  comment                     = "my database"
-  data_retention_time_in_days = 1
-  is_transient                = false
-
-  create_default_roles = true
-
-  roles = {
-    readonly = {
-      granted_to_roles = [module.snowflake_dev_role.name]
-    }
-    admin = {
-      granted_to_roles = [module.snowflake_admin_role.name]
-    }
-  }
-
-  schemas = {
-    bronze = {
-      roles = {
-        admin = {
-          granted_to_roles = [module.snowflake_admin_role.name]
-        }
-        readonly = {
-          granted_to_roles = [module.snowflake_dev_role.name]
-        }
-      }
-    }
-    silver = {
-      roles = {
-        admin = {
-          granted_to_roles = [module.snowflake_admin_role.name]
-        }
-      }
-    }
-    gold = {
-      roles = {
-        admin = {
-          granted_to_roles = [module.snowflake_admin_role.name]
-        }
-      }
-    }
-  }
-}
-
-
-module "dev_database" {
-  source      = "../../"
-  context     = module.this.context
-  environment = "dev"
-
-  name          = "analytics"
-  from_database = module.prod_database.name
-}
-```
+This is complete usage example of the module.
 
 ## Usage
 Populate `.env` file with Snowflake credentials and make sure it's sourced to your shell.
@@ -89,3 +10,65 @@ terraform init
 terraform plan -var-file fixtures.tfvars -out tfplan
 terraform apply tfplan
 ```
+
+<!-- BEGIN_TF_DOCS -->
+
+
+
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |
+| <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. | `list(string)` | `[]` | no |
+| <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br>  "additional_tag_map": {},<br>  "attributes": [],<br>  "delimiter": null,<br>  "descriptor_formats": {},<br>  "enabled": true,<br>  "environment": null,<br>  "id_length_limit": null,<br>  "label_key_case": null,<br>  "label_order": [],<br>  "label_value_case": null,<br>  "labels_as_tags": [<br>    "unset"<br>  ],<br>  "name": null,<br>  "namespace": null,<br>  "regex_replace_chars": null,<br>  "stage": null,<br>  "tags": {},<br>  "tenant": null<br>}</pre> | no |
+| <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |
+| <a name="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br>   format = string<br>   labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |
+| <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
+| <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
+| <a name="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`. | `number` | `null` | no |
+| <a name="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. | `string` | `null` | no |
+| <a name="input_label_order"></a> [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no |
+| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`. | `string` | `null` | no |
+| <a name="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>**Notes:**<br>  The value of the `name` tag, if included, will be the `id`, not the `name`.<br>  Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br>  changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | <pre>[<br>  "default"<br>]</pre> | no |
+| <a name="input_name"></a> [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |
+| <a name="input_namespace"></a> [namespace](#input\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no |
+| <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |
+| <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
+| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |
+| <a name="input_tenant"></a> [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_prod_database"></a> [prod\_database](#module\_prod\_database) | ../../ | n/a |
+| <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_prod_database"></a> [prod\_database](#output\_prod\_database) | Prod database module outputs |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_snowflake"></a> [snowflake](#provider\_snowflake) | ~> 0.90 |
+
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
+| <a name="requirement_snowflake"></a> [snowflake](#requirement\_snowflake) | ~> 0.90 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [snowflake_account_role.admin_role](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/account_role) | resource |
+| [snowflake_account_role.dev_role](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/account_role) | resource |
+<!-- END_TF_DOCS -->
diff --git a/examples/complete/fixtures.tfvars b/examples/complete/fixtures.tfvars
@@ -1,5 +1,5 @@
 descriptor_formats = {
-  snowflake-role = {
+  snowflake-database-role = {
     labels = ["attributes", "name"]
     format = "%v_%v"
   }

diff --git a/examples/complete/main.tf b/examples/complete/main.tf
@@ -1,21 +1,9 @@
-resource "snowflake_user" "dbt" {
-  name       = "DBT user"
-  login_name = "dbt_user"
-  comment    = "DBT user."
+resource "snowflake_account_role" "admin_role" {
+  name = "administrator"
 }
 
-module "snowflake_admin_role" {
-  source  = "getindata/role/snowflake"
-  version = "1.0.3"
-  context = module.this.context
-  name    = "admin"
-}
-
-module "snowflake_dev_role" {
-  source  = "getindata/role/snowflake"
-  version = "1.0.3"
-  context = module.this.context
-  name    = "dev"
+resource "snowflake_account_role" "dev_role" {
+  name = "developer"
 }
 
 module "prod_database" {
@@ -30,52 +18,60 @@ module "prod_database" {
 
   create_default_roles = true
 
+  database_ownership_grant = snowflake_account_role.admin_role.name
+
   roles = {
     readonly = {
-      granted_to_roles = [module.snowflake_dev_role.name]
+      granted_to_roles = [snowflake_account_role.dev_role.name]
+    }
+    transformer = {
+      enabled = false
     }
     admin = {
-      granted_to_roles = [module.snowflake_admin_role.name]
+      granted_to_roles = [snowflake_account_role.admin_role.name]
     }
   }
 
   schemas = {
     bronze = {
+      data_retention_time_in_days = 7
+      comment                     = "my bronze schema"
       stages = {
-        example = {}
+        example = {
+          comment = "my example stage"
+        }
       }
       roles = {
         admin = {
-          granted_to_roles = [module.snowflake_admin_role.name]
+          granted_to_roles = [snowflake_account_role.admin_role.name]
         }
         readonly = {
-          granted_to_roles = [module.snowflake_dev_role.name]
+          granted_to_roles = [snowflake_account_role.dev_role.name]
+        }
+        transformer = {
+          enabled = false
         }
       }
     }
     silver = {
       roles = {
         admin = {
-          granted_to_roles = [module.snowflake_admin_role.name]
+          granted_to_roles = [snowflake_account_role.admin_role.name]
+        }
+        transformer = {
+          enabled = false
         }
       }
     }
     gold = {
       roles = {
         admin = {
-          granted_to_roles = [module.snowflake_admin_role.name]
+          granted_to_roles = [snowflake_account_role.admin_role.name]
+        }
+        transformer = {
+          enabled = false
         }
       }
     }
   }
 }
-
-
-module "dev_database" {
-  source      = "../../"
-  context     = module.this.context
-  environment = "dev"
-
-  name          = "analytics"
-  from_database = module.prod_database.name
-}
diff --git a/examples/complete/outputs.tf b/examples/complete/outputs.tf
@@ -1,8 +1,3 @@
-output "dev_database" {
-  description = "Dev database module outputs"
-  value       = module.dev_database
-}
-
 output "prod_database" {
   description = "Prod database module outputs"
   value       = module.prod_database

diff --git a/examples/complete/versions.tf b/examples/complete/versions.tf
@@ -3,7 +3,7 @@ terraform {
   required_providers {
     snowflake = {
       source  = "Snowflake-Labs/snowflake"
-      version = "~> 0.54"
+      version = "~> 0.90"
     }
   }
 }