Merge pull request #25 from getindata/feature/align_module_with_provi…

…der_changes feat!: Align module with latest Snowflake provider changes (removals and deprecations
getindata · Aug 1, 2024 · c996050 · c996050
2 parents 6ea8903 + 7ec5f7c
commit c996050
Show file tree

Hide file tree

Showing 15 changed files with 976 additions and 843 deletions.
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
@@ -13,6 +13,6 @@ jobs:
   main:
     uses: getindata/github-workflows/.github/workflows/tf-pre-commit.yml@v1
     with:
-      # tflint v0.46.0 is the latest version we can use with pre-commit v0.1.20
+      # 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.46.0
+      tflint-version: v0.52.0
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,30 +1,27 @@
 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.20" # Get the latest from: https://github.com/gruntwork-io/pre-commit/releases
+    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:
-          - --module
-          - --config=.tflint.hcl
+          - "--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.216" # 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,59 +1,94 @@
 # Complete Example
 
-```terraform
-resource "snowflake_user" "dbt" {
-  name       = "DBT user"
-  login_name = "dbt_user"
-  comment    = "DBT user."
-}
-
-resource "snowflake_role" "admin" {
-  name    = "ADMIN"
-  comment = "Role for Snowflake Administrators"
-}
-
-resource "snowflake_role" "dev" {
-  name    = "DEV"
-  comment = "Role for Snowflake Developers"
-}
-
-resource "snowflake_database" "test" {
-  name = "ANALYTICS_DB"
-}
-
-module "this_schema" {
-  source = "../../"
-  context = module.this.context
-
-  name     = "raw"
-  database = snowflake_database.test.name
-
-  create_default_roles = true
-  roles = {
-    admin = {
-      granted_to_roles = [snowflake_role.admin.name]
-    }
-    readwrite = {
-      granted_to_users = [snowflake_user.dbt.name]
-    }
-    readonly = {
-      granted_to_roles = [snowflake_role.dev.name]
-    }
-    read_classified = {
-      enabled = false
-    }
-    custom_access = {
-      granted_to_users = [snowflake_user.dbt.name]
-    }
-  }
-}
-```
+This is complete usage example of `snowflake-schema` terraform module.
 
 ## Usage
 Populate `.env` file with Snowflake credentials and make sure it's sourced to your shell.
 
+## How to plan
+
+```shell
+terraform init
+terraform plan -var-file=fixtures.tfvars
 ```
+
+## How to apply
+
+```shell
 terraform init
-terraform plan -var-file fixtures.tfvars -out tfplan
-terraform apply tfplan
+terraform apply -var-file=fixtures.tfvars
 ```
+
+## How to destroy
+
+```shell
+terraform destroy -var-file=fixtures.tfvars
+```
+
+
+<!-- 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_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 |
+| <a name="module_this_schema"></a> [this\_schema](#module\_this\_schema) | ../../ | n/a |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_schema"></a> [schema](#output\_schema) | Schema module outputs |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_snowflake"></a> [snowflake](#provider\_snowflake) | ~> 0.94 |
+
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 |
+| <a name="requirement_snowflake"></a> [snowflake](#requirement\_snowflake) | ~> 0.94 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [snowflake_account_role.role_1](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/account_role) | resource |
+| [snowflake_database.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/database) | resource |
+| [snowflake_database_role.db_role_1](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/database_role) | resource |
+| [snowflake_database_role.db_role_2](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/database_role) | resource |
+| [snowflake_database_role.db_role_3](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/database_role) | resource |
+| [snowflake_table.table_1](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/table) | resource |
+| [snowflake_table.table_2](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/table) | resource |
+<!-- END_TF_DOCS -->
diff --git a/examples/complete/main.tf b/examples/complete/main.tf
@@ -1,54 +1,140 @@
-resource "snowflake_user" "dbt" {
-  name       = "DBT user"
-  login_name = "dbt_user"
-  comment    = "DBT user."
+resource "snowflake_account_role" "role_1" {
+  name = "ROLE_1"
 }
 
-resource "snowflake_role" "admin" {
-  name    = "ADMIN"
-  comment = "Role for Snowflake Administrators"
+resource "snowflake_database_role" "db_role_1" {
+  database = snowflake_database.this.name
+  name     = "DB_ROLE_1"
 }
 
-resource "snowflake_role" "dev" {
-  name    = "DEV"
-  comment = "Role for Snowflake Developers"
+resource "snowflake_database_role" "db_role_2" {
+  database = snowflake_database.this.name
+  name     = "DB_ROLE_2"
 }
 
-resource "snowflake_database" "test" {
+resource "snowflake_database_role" "db_role_3" {
+  database = snowflake_database.this.name
+  name     = "DB_ROLE_3"
+}
+
+resource "snowflake_database" "this" {
   name = "ANALYTICS_DB"
 }
 
+resource "snowflake_table" "table_1" {
+  database = snowflake_database.this.name
+  schema   = module.this_schema.name
+  name     = "TEST_TABLE_1"
+
+  column {
+    name     = "identity"
+    type     = "NUMBER(38,0)"
+    nullable = true
+
+    identity {
+      start_num = 1
+      step_num  = 3
+    }
+  }
+}
+
+resource "snowflake_table" "table_2" {
+  database = snowflake_database.this.name
+  schema   = module.this_schema.name
+  name     = "TEST_TABLE_2"
+
+  column {
+    name     = "identity"
+    type     = "NUMBER(38,0)"
+    nullable = true
+
+    identity {
+      start_num = 1
+      step_num  = 3
+    }
+  }
+}
+
 module "this_schema" {
   source  = "../../"
   context = module.this.context
 
-  name     = "raw"
-  database = snowflake_database.test.name
-
-  is_managed          = false
-  is_transient        = false
-  data_retention_days = 1
+  name     = "RAW"
+  database = snowflake_database.this.name
 
-  stages = {
-    my_stage = {}
-  }
+  with_managed_access         = false
+  is_transient                = false
+  data_retention_time_in_days = 1
 
   create_default_roles = true
+
   roles = {
-    admin = {
-      granted_to_roles = [snowflake_role.admin.name]
+    readwrite = { # Disables the default readwrite role
+      enabled = false
     }
-    readwrite = {
-      granted_to_users = [snowflake_user.dbt.name]
+    transformer = { # Modifies the default transformer role
+      granted_to_roles = [snowflake_account_role.role_1.name]
+      schema_objects_grants = {
+        "EXTERNAL TABLE" = [
+          {
+            all_privileges    = true
+            with_grant_option = true
+            on_all            = true
+            on_future         = false
+          }
+        ]
+        "FILE FORMAT" = [
+          {
+            all_privileges    = true
+            with_grant_option = false
+            on_all            = false
+            on_future         = true
+          }
+        ]
+        "HYBRID TABLE" = [
+          {
+            all_privileges = true
+            on_all         = true
+            on_future      = true
+          }
+        ]
+      }
     }
-    readonly = {
-      granted_to_roles = [snowflake_role.dev.name]
+    database_role_1 = {
+      granted_to_database_roles = [
+        "${snowflake_database.this.name}.${snowflake_database_role.db_role_1.name}",
+        "${snowflake_database.this.name}.${snowflake_database_role.db_role_2.name}",
+        "${snowflake_database.this.name}.${snowflake_database_role.db_role_3.name}"
+      ]
+      schema_grants = [
+        {
+          all_schemas_in_database = true
+          all_privileges          = true
+        }
+      ]
+      schema_objects_grants = {
+        "ALERT" = [
+          {
+            all_privileges    = true
+            schema_name       = "RAW"
+            with_grant_option = true
+            on_all            = true
+          }
+        ]
+      }
     }
-    read_classified = {
-      enabled = false
+  }
+
+  stages = {
+    my_stage = {
+      comment = "Stage used to ingest data"
+
+      create_default_roles = false
     }
-    custom_access = {
-      granted_to_users = [snowflake_user.dbt.name]
+    my_second_stage = {
+      comment = "Stage used to transform data from other source"
+
+      create_default_roles = true
     }
   }
 }