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

…der_changes

feat!: Align module with latest Snowflake provider changes (removals and deprecations)

.pre-commit-config.yaml

@@ -2,29 +2,29 @@ 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=.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"]

.terraform-docs.yml

@@ -6,6 +6,10 @@ sections:
   hide: []
   show: [all]
 
+recursive:
+  enabled: true
+  path: examples
+
 content: |-
   {{ .Header }}
 

examples/complete/README.md

@@ -0,0 +1,93 @@
+# Complete example
+
+This is complete usage example of `snowflake-role` terraform module.
+
+## How to plan
+
+```shell
+terraform init
+terraform plan -var-file=fixtures.tfvars
+```
+
+## How to apply
+
+```shell
+terraform init
+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_snowflake_role"></a> [snowflake\_role](#module\_snowflake\_role) | ../../ | n/a |
+| <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_snowflake_role_output"></a> [snowflake\_role\_output](#output\_snowflake\_role\_output) | Snowflake role 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.0 |
+| <a name="requirement_snowflake"></a> [snowflake](#requirement\_snowflake) | ~> 0.90 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [snowflake_database.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/database) | resource |
+| [snowflake_database_role.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/database_role) | resource |
+| [snowflake_dynamic_table.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/dynamic_table) | resource |
+| [snowflake_role.role_1](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/role) | resource |
+| [snowflake_role.role_2](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/role) | resource |
+| [snowflake_schema.schema_1](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/schema) | resource |
+| [snowflake_schema.schema_2](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/schema) | resource |
+| [snowflake_table.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/table) | resource |
+| [snowflake_user.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/user) | resource |
+| [snowflake_warehouse.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/warehouse) | resource |
+<!-- END_TF_DOCS -->

examples/complete/fixtures.tfvars

@@ -0,0 +1,13 @@
+namespace = "gid"
+stage     = "example"
+
+descriptor_formats = {
+  snowflake-role = {
+    labels = ["attributes", "name"]
+    format = "%v_%v_ROLE"
+  }
+}
+
+tags = {
+  Terraform = "True"
+}

examples/complete/main.tf

@@ -1,63 +1,156 @@
+resource "snowflake_database" "this" {
+  name = "SAMPLE_DB"
+}
+
+resource "snowflake_warehouse" "this" {
+  name = "SAMPLE_WAREHOUSE"
+}
+
+resource "snowflake_schema" "schema_1" {
+  name     = "BRONZE"
+  database = snowflake_database.this.name
+}
+
+resource "snowflake_schema" "schema_2" {
+  name     = "SILVER"
+  database = snowflake_database.this.name
+}
+
+resource "snowflake_role" "role_1" {
+  name = "SAMPLE_ROLE_1"
+}
+
+resource "snowflake_role" "role_2" {
+  name = "SAMPLE_ROLE_2"
+}
+
+resource "snowflake_database_role" "this" {
+  name     = "SAMPLE_DB_ROLE"
+  database = snowflake_database.this.name
+}
+
+resource "snowflake_user" "this" {
+  name = "SAMPLE_USER"
+}
+
+resource "snowflake_table" "this" {
+  name     = "EXAMPLE"
+  schema   = snowflake_schema.schema_1.name
+  database = snowflake_database.this.name
+
+  column {
+    name = "ID"
+    type = "NUMBER"
+  }
+}
+
+resource "snowflake_dynamic_table" "this" {
+  name = "EXAMPLE"
+
+  database  = snowflake_database.this.name
+  warehouse = snowflake_warehouse.this.name
+  schema    = snowflake_schema.schema_2.name
+  query     = "SELECT * from ${snowflake_table.this.database}.${snowflake_table.this.schema}.${snowflake_table.this.name}"
+  target_lag {
+    maximum_duration = 3600
+  }
+}
+
 module "snowflake_role" {
   source  = "../../"
   context = module.this.context
 
-  name = "LOGS_DATABASE_READER"
+  name = "SAMPLE_TEST"
 
-  granted_to_users = ["JANE_SMITH", "JOHN_DOE"]
+  role_ownership_grant = "SYSADMIN"
 
-  database_grants = [
-    {
-      database_name          = "LOGS_DB"
-      privileges             = ["USAGE"]
-      enable_multiple_grants = true
-    }
-  ]
+  granted_to_users = ["SAMPLE_USER"]
+  granted_to_roles = [snowflake_role.role_1.name]
 
-  schema_grants = [
-    {
-      database_name = "LOGS_DB"
-      schema_name   = "BRONZE"
-      privileges    = ["USAGE"]
-    }
-  ]
+  granted_roles          = [snowflake_role.role_2.name]
+  granted_database_roles = ["${snowflake_database.this.name}.${snowflake_database_role.this.name}"]
 
-  table_grants = [
-    {
-      database_name = "LOGS_DB"
-      schema_name   = "BRONZE"
-      on_future     = true
-      privileges    = ["SELECT"]
-    }
-  ]
+  account_grants = [{
+    privileges = ["CREATE DATABASE"]
+  }]
 
-  view_grants = [
-    {
-      database_name = "LOGS_DB"
-      schema_name   = "BRONZE"
-      on_all        = true
-      privileges    = ["SELECT"]
-    }
-  ]
+  account_objects_grants = {
+    DATABASE = [
+      {
+        privileges  = ["USAGE"]
+        object_name = snowflake_database.this.name
+      },
+    ]
+    WAREHOUSE = [
+      {
+        all_privileges    = true
+        with_grant_option = true
+        object_name       = snowflake_warehouse.this.name
+      }
+    ]
+  }
 
-  dynamic_table_grants = [
-    {
-      database_name  = "LOGS_DB"
-      on_all         = true
-      on_future      = true
-      all_privileges = true
-    },
+  schema_grants = [
     {
-      database_name  = "TEST_DB"
-      schema_name    = "BRONZE"
-      on_all         = true
-      all_privileges = true
+      database_name = snowflake_database.this.name
+      schema_name   = snowflake_schema.schema_1.name
+      privileges    = ["USAGE"]
     },
     {
-      database_name      = "TEST_DB"
-      schema_name        = "SILVER"
-      dynamic_table_name = "EXAMPLE"
-      privileges         = ["SELECT"]
+      database_name              = snowflake_database.this.name
+      schema_name                = snowflake_schema.schema_2.name
+      all_privileges             = true
+      future_schemas_in_database = true
+      with_grant_option          = true
     },
   ]
+
+  schema_objects_grants = {
+    TABLE = [
+      {
+        database_name     = snowflake_database.this.name
+        schema_name       = snowflake_schema.schema_1.name
+        on_all            = true
+        on_future         = true
+        all_privileges    = true
+        with_grant_option = true
+      }
+    ]
+
+    VIEW = [
+      {
+        database_name = snowflake_database.this.name
+        on_future     = true
+        privileges    = ["SELECT"]
+      }
+    ]
+
+    "DYNAMIC TABLE" = [
+      {
+        database_name  = snowflake_database.this.name
+        schema_name    = snowflake_schema.schema_1.name
+        on_all         = true
+        all_privileges = true
+      },
+      {
+        database_name = snowflake_database.this.name
+        schema_name   = snowflake_schema.schema_2.name
+        object_name   = "EXAMPLE"
+        privileges    = ["SELECT"]
+      },
+    ]
+  }
+
+  depends_on = [
+    snowflake_database.this,
+    snowflake_warehouse.this,
+    snowflake_schema.schema_1,
+    snowflake_schema.schema_2,
+    snowflake_role.role_1,
+    snowflake_role.role_2,
+    snowflake_database_role.this,
+    snowflake_user.this,
+    snowflake_table.this,
+    snowflake_dynamic_table.this,
+  ]
 }

examples/complete/versions.tf

@@ -1,3 +1,10 @@
 terraform {
   required_version = ">= 1.3.0"
+
+  required_providers {
+    snowflake = {
+      source  = "Snowflake-Labs/snowflake"
+      version = "~> 0.90"
+    }
+  }
 }