enha: added option to define global secondary index keys

kfc-manager · kfc-manager · commit 53ed39de6949 · 2024-03-31T18:51:38.000+02:00
diff --git a/main.tf b/main.tf
@@ -1,29 +1,40 @@
 ################################
-# DynamoDB                     #
+# Table                        #
 ################################
 
-resource "aws_dynamodb_table" "main" {
-  billing_mode = "PAY_PER_REQUEST"
-  hash_key     = try(var.partition_key["name"], null)
-  range_key    = try(var.sort_key["name"], null)
-  name         = var.identifier
-
-  attribute {
-    name = try(var.partition_key["name"], null)
-    type = try(var.partition_key["type"], null)
-  }
+locals {
+  key_attributes      = var.sort_key != null ? [var.hash_key, var.sort_key] : [var.hash_key]
+  gsi_hash_attributes = [for v in var.gsi_keys : v["hash_key"]]
+  gsi_sort_attributes = [for v in var.gsi_keys : try(v["sort_key"], null) if try(v["sort_key"], null) != null]
+  attributes          = toset(concat(local.key_attributes, local.gsi_hash_attributes, local.gsi_sort_attributes))
+}
 
-  attribute {
-    name = try(var.sort_key["name"], null)
-    type = try(var.sort_key["type"], null)
-  }
+resource "aws_dynamodb_table" "main" {
+  billing_mode   = var.provisioned != null ? "PROVISIONED" : "PAY_PER_REQUEST"
+  hash_key       = var.hash_key["name"]
+  range_key      = try(var.sort_key["name"], null)
+  name           = var.identifier
+  read_capacity  = try(var.provisioned["read_capacity"], null)
+  write_capacity = try(var.provisioned["write_capacity"], null)
 
   dynamic "attribute" {
-    for_each = var.attributes
+    for_each = local.attributes
+    content {
+      name = attribute.value["name"]
+      type = attribute.value["type"]
+    }
+  }
 
+  dynamic "global_secondary_index" {
+    for_each = var.gsi_keys
     content {
-      name = try(attribute.value["name"], null)
-      type = try(attribute.value["type"], null)
+      name               = global_secondary_index.value["name"] != null ? global_secondary_index.value["name"] : global_secondary_index.value["hash_key"]["name"]
+      hash_key           = global_secondary_index.value["hash_key"]["name"]
+      range_key          = try(global_secondary_index.value["sort_key"]["name"], null)
+      projection_type    = try(global_secondary_index.value["projection_type"], null)
+      non_key_attributes = try(global_secondary_index.value["non_key_attributes"], null)
+      read_capacity      = try(global_secondary_index.value["read_capacity"], null)
+      write_capacity     = try(global_secondary_index.value["write_capacity"], null)
     }
   }
 
diff --git a/outputs.tf b/outputs.tf
@@ -1,3 +1,8 @@
+output "name" {
+  description = "Name of the DynamoDB table."
+  value       = try(aws_dynamodb_table.main.id, null)
+}
+
 output "arn" {
   description = "ARN of the DynamoDB table."
   value       = try(aws_dynamodb_table.main.arn, null)
diff --git a/tests/attributes.tftest.hcl b/tests/attributes.tftest.hcl
@@ -0,0 +1,221 @@
+provider "aws" {
+  region = "eu-central-1"
+  default_tags {
+    tags = {
+      Environment = "Test"
+    }
+  }
+}
+
+run "hash_key" {
+  command = plan
+
+  variables {
+    identifier = "abc"
+    hash_key = {
+      name = "TestPKey"
+      type = "S"
+    }
+  }
+
+  assert {
+    condition     = length(local.attributes) == 1
+    error_message = "Unexpected amount of attributes were created"
+  }
+}
+
+run "hash_and_sort_key" {
+  command = plan
+
+  variables {
+    identifier = "abc"
+    hash_key = {
+      name = "TestPKey"
+      type = "S"
+    }
+    sort_key = {
+      name = "TestSKey"
+      type = "S"
+    }
+  }
+
+  assert {
+    condition     = length(local.attributes) == 2
+    error_message = "Unexpected amount of attributes were created"
+  }
+}
+
+run "single_gsi_hash_key" {
+  command = plan
+
+  variables {
+    identifier = "abc"
+    hash_key = {
+      name = "TestPKey"
+      type = "S"
+    }
+    gsi_keys = [{
+      hash_key = {
+        name = "GSIPKey"
+        type = "S"
+      }
+    }]
+  }
+
+  assert {
+    condition     = length(local.attributes) == 2
+    error_message = "Unexpected amount of attributes were created"
+  }
+}
+
+run "single_gsi_hash_and_sort_key" {
+  command = plan
+
+  variables {
+    identifier = "abc"
+    hash_key = {
+      name = "TestPKey"
+      type = "S"
+    }
+    gsi_keys = [{
+      hash_key = {
+        name = "GSIPKey"
+        type = "S"
+      }
+      sort_key = {
+        name = "GSISKey"
+        type = "S"
+      }
+    }]
+  }
+
+  assert {
+    condition     = length(local.attributes) == 3
+    error_message = "Unexpected amount of attributes were created"
+  }
+}
+
+run "duplicate_gsi_sort_key" {
+  command = plan
+
+  variables {
+    identifier = "abc"
+    hash_key = {
+      name = "TestPKey"
+      type = "S"
+    }
+    gsi_keys = [{
+      hash_key = {
+        name = "GSIPKey"
+        type = "S"
+      }
+      sort_key = {
+        name = "TestPKey"
+        type = "S"
+      }
+    }]
+  }
+
+  assert {
+    condition     = length(local.attributes) == 2
+    error_message = "Unexpected amount of attributes were created"
+  }
+}
+
+run "multiple_gsi_keys" {
+  command = plan
+
+  variables {
+    identifier = "abc"
+    hash_key = {
+      name = "TestPKey"
+      type = "S"
+    }
+    gsi_keys = [{
+      hash_key = {
+        name = "1GSIPKey"
+        type = "S"
+      }
+      sort_key = {
+        name = "1GSISKey"
+        type = "S"
+      }
+      },
+      {
+        hash_key = {
+          name = "2GSIPKey"
+          type = "S"
+        }
+        sort_key = {
+          name = "2GSISKey"
+          type = "S"
+        }
+      },
+      {
+        hash_key = {
+          name = "3GSIPKey"
+          type = "S"
+        }
+        sort_key = {
+          name = "3GSISKey"
+          type = "S"
+        }
+    }]
+  }
+
+  assert {
+    condition     = length(local.attributes) == 7
+    error_message = "Unexpected amount of attributes were created"
+  }
+}
+
+run "multiple_duplicate_gsi_keys" {
+  command = plan
+
+  variables {
+    identifier = "abc"
+    hash_key = {
+      name = "TestPKey"
+      type = "S"
+    }
+    sort_key = {
+      name = "TestSKey"
+      type = "S"
+    }
+    gsi_keys = [{
+      hash_key = {
+        name = "1GSIPKey"
+        type = "S"
+      }
+      sort_key = {
+        name = "TestPKey"
+        type = "S"
+      }
+      },
+      {
+        hash_key = {
+          name = "TestSKey"
+          type = "S"
+        }
+        sort_key = {
+          name = "2GSISKey"
+          type = "S"
+        }
+      },
+      {
+        hash_key = {
+          name = "1GSIPKey"
+          type = "S"
+        }
+        sort_key = {
+          name = "2GSISKey"
+          type = "S"
+        }
+    }]
+  }
+
+  assert {
+    condition     = length(local.attributes) == 4
+    error_message = "Unexpected amount of attributes were created"
+  }
+}
diff --git a/tests/table.tftest.hcl b/tests/table.tftest.hcl
@@ -12,14 +12,10 @@ run "invalid_identifier" {
 
   variables {
     identifier = "a"
-    partition_key = {
+    hash_key = {
       name = "TestPKey"
       type = "S"
     }
-    sort_key = {
-      name = "TestSKey"
-      type = "S"
-    }
   }
 
   expect_failures = [var.identifier]
@@ -30,13 +26,11 @@ run "valid_identifier" {
 
   variables {
     identifier = "abc"
-    partition_key = {
+    hash_key = {
       name = "TestPKey"
       type = "S"
     }
-    sort_key = {
-      name = "TestSKey"
-      type = "S"
-    }
   }
 }
+
+
diff --git a/variables.tf b/variables.tf
@@ -7,27 +7,48 @@ variable "identifier" {
   }
 }
 
-variable "partition_key" {
-  description = "Partition key of the table."
+variable "hash_key" {
+  description = "Partition or hash key of the table."
   type = object({
     name = string
     type = string
   })
 }
 
 variable "sort_key" {
-  description = "Sort key of the table."
+  description = "Sort or range key of the table."
   type = object({
     name = string
     type = string
   })
+  default = null
 }
 
-variable "attributes" {
-  description = "List of attributes of the table."
+variable "provisioned" {
+  description = "Objetct to define read and write capacity for a provisioned table. If not defined an on demand table will be created."
+  type = object({
+    read_capacity  = number
+    write_capacity = number
+  })
+  default = null
+}
+
+variable "gsi_keys" {
+  description = "Global secondary index keys of the table."
   type = list(object({
-    name = string
-    type = string
+    name = optional(string, null)
+    hash_key = object({
+      name = string
+      type = string
+    })
+    sort_key = optional(object({
+      name = string
+      type = string
+    }), null)
+    projection_type    = optional(string, "ALL")
+    non_key_attributes = optional(list(string), null)
+    read_capacity      = optional(number, null)
+    write_capacity     = optional(number, null)
   }))
   default = []
 }

Original file line number	Diff line number	Diff line change
`@@ -12,14 +12,10 @@ run "invalid_identifier" {`
`12`	`12`
`13`	`13`	`variables {`
`14`	`14`	`identifier = "a"`
`15`		`- partition_key = {`
	`15`	`+ hash_key = {`
`16`	`16`	`name = "TestPKey"`
`17`	`17`	`type = "S"`
`18`	`18`	`}`
`19`		`- sort_key = {`
`20`		`- name = "TestSKey"`
`21`		`- type = "S"`
`22`		`- }`
`23`	`19`	`}`
`24`	`20`
`25`	`21`	`expect_failures = [var.identifier]`
`@@ -30,13 +26,11 @@ run "valid_identifier" {`
`30`	`26`
`31`	`27`	`variables {`
`32`	`28`	`identifier = "abc"`
`33`		`- partition_key = {`
	`29`	`+ hash_key = {`
`34`	`30`	`name = "TestPKey"`
`35`	`31`	`type = "S"`
`36`	`32`	`}`
`37`		`- sort_key = {`
`38`		`- name = "TestSKey"`
`39`		`- type = "S"`
`40`		`- }`
`41`	`33`	`}`
`42`	`34`	`}`
	`35`	`+`
	`36`	`+`