add support for object upload to gcs module

modules/gcs/README.md

@@ -90,14 +90,31 @@ module "bucket-gcs-notification" {
 }
 # tftest modules=1 resources=4 inventory=notification.yaml
 ```
-<!-- BEGIN TFDOC -->
 
+### Example with object upload
+
+```hcl
+module "bucket" {
+  source     = "./fabric/modules/gcs"
+  project_id = "myproject"
+  name       = "my-bucket"
+  objects_to_upload = {
+    sample-data = {
+      name         = "example-file.csv"
+      source       = "data/example-file.csv"
+      content_type = "text/csv"
+    }
+  }
+}
+# tftest modules=1 resources=2 inventory=object-upload.yaml
+```
+<!-- BEGIN TFDOC -->
 ## Variables
 
 | name | description | type | required | default |
 |---|---|:---:|:---:|:---:|
 | [name](variables.tf#L116) | Bucket name suffix. | <code>string</code> | ✓ |  |
-| [project_id](variables.tf#L145) | Bucket project id. | <code>string</code> | ✓ |  |
+| [project_id](variables.tf#L171) | Bucket project id. | <code>string</code> | ✓ |  |
 | [cors](variables.tf#L17) | CORS configuration for the bucket. Defaults to null. | <code title="object&#40;&#123;&#10;  origin          &#61; optional&#40;list&#40;string&#41;&#41;&#10;  method          &#61; optional&#40;list&#40;string&#41;&#41;&#10;  response_header &#61; optional&#40;list&#40;string&#41;&#41;&#10;  max_age_seconds &#61; optional&#40;number&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
 | [encryption_key](variables.tf#L28) | KMS key that will be used for encryption. | <code>string</code> |  | <code>null</code> |
 | [force_destroy](variables.tf#L34) | Optional map to set force destroy keyed by name, defaults to false. | <code>bool</code> |  | <code>false</code> |
@@ -107,12 +124,13 @@ module "bucket-gcs-notification" {
 | [location](variables.tf#L101) | Bucket location. | <code>string</code> |  | <code>&#34;EU&#34;</code> |
 | [logging_config](variables.tf#L107) | Bucket logging configuration. | <code title="object&#40;&#123;&#10;  log_bucket        &#61; string&#10;  log_object_prefix &#61; optional&#40;string&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
 | [notification_config](variables.tf#L121) | GCS Notification configuration. | <code title="object&#40;&#123;&#10;  enabled            &#61; bool&#10;  payload_format     &#61; string&#10;  topic_name         &#61; string&#10;  sa_email           &#61; string&#10;  event_types        &#61; optional&#40;list&#40;string&#41;&#41;&#10;  custom_attributes  &#61; optional&#40;map&#40;string&#41;&#41;&#10;  object_name_prefix &#61; optional&#40;string&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
-| [prefix](variables.tf#L135) | Optional prefix used to generate the bucket name. | <code>string</code> |  | <code>null</code> |
-| [retention_policy](variables.tf#L150) | Bucket retention policy. | <code title="object&#40;&#123;&#10;  retention_period &#61; number&#10;  is_locked        &#61; optional&#40;bool&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
-| [storage_class](variables.tf#L159) | Bucket storage class. | <code>string</code> |  | <code>&#34;MULTI_REGIONAL&#34;</code> |
-| [uniform_bucket_level_access](variables.tf#L169) | Allow using object ACLs (false) or not (true, this is the recommended behavior) , defaults to true (which is the recommended practice, but not the behavior of storage API). | <code>bool</code> |  | <code>true</code> |
-| [versioning](variables.tf#L175) | Enable versioning, defaults to false. | <code>bool</code> |  | <code>false</code> |
-| [website](variables.tf#L181) | Bucket website. | <code title="object&#40;&#123;&#10;  main_page_suffix &#61; optional&#40;string&#41;&#10;  not_found_page   &#61; optional&#40;string&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
+| [objects_to_upload](variables.tf#L135) | Objects to be uploaded to bucket. | <code title="map&#40;object&#40;&#123;&#10;  name                &#61; string&#10;  metadata            &#61; optional&#40;map&#40;string&#41;&#41;&#10;  content             &#61; optional&#40;string&#41;&#10;  source              &#61; optional&#40;string&#41;&#10;  cache_control       &#61; optional&#40;string&#41;&#10;  content_disposition &#61; optional&#40;string&#41;&#10;  content_encoding    &#61; optional&#40;string&#41;&#10;  content_language    &#61; optional&#40;string&#41;&#10;  content_type        &#61; optional&#40;string&#41;&#10;  event_based_hold    &#61; optional&#40;bool&#41;&#10;  temporary_hold      &#61; optional&#40;bool&#41;&#10;  detect_md5hash      &#61; optional&#40;string&#41;&#10;  storage_class       &#61; optional&#40;string&#41;&#10;  kms_key_name        &#61; optional&#40;string&#41;&#10;  customer_encryption &#61; optional&#40;object&#40;&#123;&#10;    encryption_algorithm &#61; optional&#40;string&#41;&#10;    encryption_key       &#61; string&#10;  &#125;&#41;&#41;&#10;&#125;&#41;&#41;">map&#40;object&#40;&#123;&#8230;&#125;&#41;&#41;</code> |  | <code>&#123;&#125;</code> |
+| [prefix](variables.tf#L161) | Optional prefix used to generate the bucket name. | <code>string</code> |  | <code>null</code> |
+| [retention_policy](variables.tf#L176) | Bucket retention policy. | <code title="object&#40;&#123;&#10;  retention_period &#61; number&#10;  is_locked        &#61; optional&#40;bool&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
+| [storage_class](variables.tf#L185) | Bucket storage class. | <code>string</code> |  | <code>&#34;MULTI_REGIONAL&#34;</code> |
+| [uniform_bucket_level_access](variables.tf#L195) | Allow using object ACLs (false) or not (true, this is the recommended behavior) , defaults to true (which is the recommended practice, but not the behavior of storage API). | <code>bool</code> |  | <code>true</code> |
+| [versioning](variables.tf#L201) | Enable versioning, defaults to false. | <code>bool</code> |  | <code>false</code> |
+| [website](variables.tf#L207) | Bucket website. | <code title="object&#40;&#123;&#10;  main_page_suffix &#61; optional&#40;string&#41;&#10;  not_found_page   &#61; optional&#40;string&#41;&#10;&#125;&#41;">object&#40;&#123;&#8230;&#125;&#41;</code> |  | <code>null</code> |
 
 ## Outputs
 
@@ -122,7 +140,7 @@ module "bucket-gcs-notification" {
 | [id](outputs.tf#L28) | Fully qualified bucket id. |  |
 | [name](outputs.tf#L37) | Bucket name. |  |
 | [notification](outputs.tf#L46) | GCS Notification self link. |  |
-| [topic](outputs.tf#L51) | Topic ID used by GCS. |  |
-| [url](outputs.tf#L56) | Bucket URL. |  |
-
+| [objects](outputs.tf#L51) | Objects in GCS bucket. |  |
+| [topic](outputs.tf#L63) | Topic ID used by GCS. |  |
+| [url](outputs.tf#L68) | Bucket URL. |  |
 <!-- END TFDOC -->

modules/gcs/main.tf

@@ -99,6 +99,35 @@ resource "google_storage_bucket" "bucket" {
   }
 }
 
+resource "google_storage_bucket_object" "objects" {
+  for_each = var.objects_to_upload
+
+  bucket              = google_storage_bucket.bucket.id
+  name                = each.value.name
+  metadata            = each.value.metadata
+  content             = each.value.content
+  source              = each.value.source
+  cache_control       = each.value.cache_control
+  content_disposition = each.value.content_disposition
+  content_encoding    = each.value.content_encoding
+  content_language    = each.value.content_language
+  content_type        = each.value.content_type
+  event_based_hold    = each.value.event_based_hold
+  temporary_hold      = each.value.temporary_hold
+  detect_md5hash      = each.value.detect_md5hash
+  storage_class       = each.value.storage_class
+  kms_key_name        = each.value.kms_key_name
+
+  dynamic "customer_encryption" {
+    for_each = each.value.customer_encryption == null ? [] : [""]
+
+    content {
+      encryption_algorithm = each.value.customer_encryption.encryption_algorithm
+      encryption_key       = each.value.customer_encryption.encryption_key
+    }
+  }
+}
+
 resource "google_storage_bucket_iam_binding" "bindings" {
   for_each = var.iam
   bucket   = google_storage_bucket.bucket.name

modules/gcs/outputs.tf

@@ -48,6 +48,18 @@ output "notification" {
   value       = local.notification ? google_storage_notification.notification[0].self_link : null
 }
 
+output "objects" {
+  description = "Objects in GCS bucket."
+  value = { for k, v in google_storage_bucket_object.objects : k => {
+    crc32c      = v.crc32c
+    md5hash     = v.md5hash
+    self_link   = v.self_link
+    output_name = v.output_name
+    media_link  = v.media_link
+    }
+  }
+}
+
 output "topic" {
   description = "Topic ID used by GCS."
   value       = local.notification ? google_pubsub_topic.topic[0].id : null

modules/gcs/variables.tf

@@ -132,6 +132,32 @@ variable "notification_config" {
   default = null
 }
 
+variable "objects_to_upload" {
+  description = "Objects to be uploaded to bucket."
+  type = map(object({
+    name                = string
+    metadata            = optional(map(string))
+    content             = optional(string)
+    source              = optional(string)
+    cache_control       = optional(string)
+    content_disposition = optional(string)
+    content_encoding    = optional(string)
+    content_language    = optional(string)
+    content_type        = optional(string)
+    event_based_hold    = optional(bool)
+    temporary_hold      = optional(bool)
+    detect_md5hash      = optional(string)
+    storage_class       = optional(string)
+    kms_key_name        = optional(string)
+    customer_encryption = optional(object({
+      encryption_algorithm = optional(string)
+      encryption_key       = string
+    }))
+  }))
+  default  = {}
+  nullable = false
+}
+
 variable "prefix" {
   description = "Optional prefix used to generate the bucket name."
   type        = string

tests/modules/gcs/examples/object-upload.yaml

@@ -0,0 +1,26 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+values:
+  module.bucket.google_storage_bucket.bucket:
+    name: my-bucket
+    project: myproject
+  module.bucket.google_storage_bucket_object.objects["sample-data"]:
+    name: example-file.csv
+    source: data/example-file.csv
+    content_type: text/csv
+
+counts:
+  google_storage_bucket: 1
+  google_storage_bucket_object: 1