feat: (storage) added contexts for resource google_storage_bucket_object (#15693)

Author: gurusai-voleti

mmv1/third_party/terraform/services/storage/resource_storage_bucket_object.go

@@ -14,6 +14,7 @@ import (
 	"github.com/hashicorp/terraform-provider-google/google/tpgresource"
 	transport_tpg "github.com/hashicorp/terraform-provider-google/google/transport"
 
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/customdiff"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 
@@ -28,11 +29,14 @@ import (
 
 func ResourceStorageBucketObject() *schema.Resource {
 	return &schema.Resource{
-		Create:        resourceStorageBucketObjectCreate,
-		Read:          resourceStorageBucketObjectRead,
-		Update:        resourceStorageBucketObjectUpdate,
-		Delete:        resourceStorageBucketObjectDelete,
-		CustomizeDiff: resourceStorageBucketObjectCustomizeDiff,
+		Create: resourceStorageBucketObjectCreate,
+		Read:   resourceStorageBucketObjectRead,
+		Update: resourceStorageBucketObjectUpdate,
+		Delete: resourceStorageBucketObjectDelete,
+		CustomizeDiff: customdiff.All(
+			resourceStorageBucketObjectCustomizeDiff,
+			validateContexts,
+		),
 
 		Timeouts: &schema.ResourceTimeout{
 			Create: schema.DefaultTimeout(4 * time.Minute),
@@ -109,6 +113,46 @@ func ResourceStorageBucketObject() *schema.Resource {
 				Description:  `Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive. To view the raw contents of the object, please define an output.`,
 			},
 
+			"contexts": {
+				Type:        schema.TypeList,
+				Optional:    true,
+				MaxItems:    1,
+				Description: "Contexts attached to an object, in key-value pairs.",
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"custom": {
+							Type:        schema.TypeList,
+							Required:    true,
+							Description: "A list of custom context key-value pairs.",
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"key": {
+										Type:        schema.TypeString,
+										Required:    true,
+										Description: "An individual object context. Context keys and their corresponding values must start with an alphanumeric character.",
+									},
+									"value": {
+										Type:        schema.TypeString,
+										Required:    true,
+										Description: "The value associated with this context. This field holds the primary information for the given context key.",
+									},
+									"create_time": {
+										Type:        schema.TypeString,
+										Computed:    true,
+										Description: "The time when context was first added to the storage#object in RFC 3339 format.",
+									},
+									"update_time": {
+										Type:        schema.TypeString,
+										Computed:    true,
+										Description: "The time when context was last updated in RFC 3339 format.",
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+
 			"generation": {
 				Type:        schema.TypeInt,
 				Computed:    true,
@@ -393,6 +437,10 @@ func resourceStorageBucketObjectCreate(d *schema.ResourceData, meta interface{})
 		object.TemporaryHold = v.(bool)
 	}
 
+	if v, ok := d.GetOk("contexts"); ok {
+		object.Contexts = expandCustomObjectContexts(v.([]interface{}))
+	}
+
 	insertCall := objectsService.Insert(bucket, object)
 	insertCall.Name(name)
 	if v, ok := d.GetOk("force_empty_content_type"); ok && v.(bool) {
@@ -461,6 +509,11 @@ func resourceStorageBucketObjectUpdate(d *schema.ResourceData, meta interface{})
 			res.TemporaryHold = v.(bool)
 		}
 
+		if d.HasChange("contexts") {
+			v := d.Get("contexts")
+			res.Contexts = expandCustomObjectContexts(v.([]interface{}))
+		}
+
 		updateCall := objectsService.Update(bucket, name, res)
 		if hasRetentionChanges {
 			updateCall.OverrideUnlockedRetention(true)
@@ -471,7 +524,7 @@ func resourceStorageBucketObjectUpdate(d *schema.ResourceData, meta interface{})
 			return fmt.Errorf("Error updating object %s: %s", name, err)
 		}
 
-		return nil
+		return resourceStorageBucketObjectRead(d, meta)
 	}
 }
 
@@ -565,6 +618,9 @@ func resourceStorageBucketObjectRead(d *schema.ResourceData, meta interface{}) e
 	if err := d.Set("temporary_hold", res.TemporaryHold); err != nil {
 		return fmt.Errorf("Error setting temporary_hold: %s", err)
 	}
+	if err := d.Set("contexts", flattenContexts(d, res.Contexts)); err != nil {
+		return fmt.Errorf("Error reading Contexts: %s", err)
+	}
 
 	d.SetId(objectGetID(res))
 
@@ -651,6 +707,35 @@ func expandObjectRetention(configured interface{}) *storage.ObjectRetention {
 	return objectRetention
 }
 
+func expandCustomObjectContexts(objectContexts []interface{}) *storage.ObjectContexts {
+	if len(objectContexts) == 0 {
+		return nil
+	}
+
+	contextsObj := objectContexts[0].(map[string]interface{})
+
+	customList := contextsObj["custom"]
+
+	tfCustomList := customList.([]interface{})
+
+	objContextPayload := make(map[string]storage.ObjectCustomContextPayload)
+	for _, item := range tfCustomList {
+		itemMap := item.(map[string]interface{})
+
+		key := itemMap["key"].(string)
+		value := itemMap["value"].(string)
+
+		objContextPayload[key] = storage.ObjectCustomContextPayload{
+			Value: value,
+		}
+	}
+
+	contexts := &storage.ObjectContexts{
+		Custom: objContextPayload,
+	}
+	return contexts
+}
+
 func flattenObjectRetention(objectRetention *storage.ObjectRetention) []map[string]interface{} {
 	retentions := make([]map[string]interface{}, 0, 1)
 
@@ -667,6 +752,51 @@ func flattenObjectRetention(objectRetention *storage.ObjectRetention) []map[stri
 	return retentions
 }
 
+func flattenContexts(d *schema.ResourceData, contexts *storage.ObjectContexts) interface{} {
+	if contexts == nil || contexts.Custom == nil || len(contexts.Custom) == 0 {
+		return nil
+	}
+	c, _ := d.GetOk("contexts")
+	contextsList := c.([]interface{})
+	if len(contextsList) == 0 {
+		return nil
+	}
+
+	contextsObj := contextsList[0].(map[string]interface{})
+
+	customObjectList := contextsObj["custom"]
+
+	customkeyValueList := customObjectList.([]interface{})
+
+	flattenKeyValueList := make([]interface{}, 0, len(contexts.Custom))
+	for _, customKv := range customkeyValueList {
+		customKvItem := customKv.(map[string]interface{})
+
+		k := customKvItem["key"].(string)
+		customItem, ok := contexts.Custom[k]
+		if !ok {
+			continue
+		} else {
+			itemMap := make(map[string]interface{})
+
+			itemMap["key"] = k
+			itemMap["value"] = customItem.Value
+			itemMap["create_time"] = customItem.CreateTime
+			itemMap["update_time"] = customItem.UpdateTime
+
+			flattenKeyValueList = append(flattenKeyValueList, itemMap)
+		}
+	}
+
+	customList := map[string]interface{}{
+		"custom": flattenKeyValueList,
+	}
+
+	contextList := []interface{}{customList}
+
+	return contextList
+}
+
 func resourceStorageBucketObjectCustomizeDiff(ctx context.Context, d *schema.ResourceDiff, meta interface{}) error {
 	localMd5Hash := ""
 
@@ -707,3 +837,36 @@ func showDiff(d *schema.ResourceDiff) error {
 
 	return nil
 }
+
+// validate keys for duplicates in custom object contexts
+func validateContexts(ctx context.Context, d *schema.ResourceDiff, meta interface{}) error {
+	if !d.HasChange("contexts") {
+		return nil
+	}
+
+	_, new := d.GetChange("contexts")
+
+	contextsList := new.([]interface{})
+	if len(contextsList) == 0 {
+		return nil
+	}
+
+	contextsObj := contextsList[0].(map[string]interface{})
+
+	customList := contextsObj["custom"]
+
+	keyValueList := customList.([]interface{})
+
+	keys := make(map[string]bool)
+	for _, item := range keyValueList {
+		itemMap := item.(map[string]interface{})
+
+		key := itemMap["key"].(string)
+
+		if keys[key] {
+			return fmt.Errorf("duplicate key found in 'contexts' block: %s. Each 'key' must be unique", key)
+		}
+		keys[key] = true
+	}
+	return nil
+}

mmv1/third_party/terraform/services/storage/resource_storage_bucket_object_test.go

@@ -593,6 +593,47 @@ func TestAccStorageObject_objectDeletionPolicy(t *testing.T) {
 	})
 }
 
+func TestAccStorageObject_addUpdateObjectContexts(t *testing.T) {
+	t.Parallel()
+
+	bucketName := acctest.TestBucketName(t)
+
+	acctest.VcrTest(t, resource.TestCase{
+		PreCheck:                 func() { acctest.AccTestPreCheck(t) },
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
+		CheckDestroy:             testAccStorageObjectDestroyProducer(t),
+		Steps: []resource.TestStep{
+			{
+				Config: testGoogleStorageBucketsObjectContent(bucketName),
+			},
+			{
+				Config: testGoogleStorageBucketsObjectContexts(bucketName, "testKey", "value"),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckStorageObjectContexts(t, bucketName, "testKey"),
+				),
+			},
+			{
+				Config: testGoogleStorageBucketsObjectContexts(bucketName, "testKey1", "value1"),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckStorageObjectContexts(t, bucketName, "testKey"),
+				),
+			},
+			{
+				Config: testGoogleStorageBucketsMultipleObjectContexts(bucketName),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckStorageObjectContextsExists(t, bucketName, 2),
+				),
+			},
+			{
+				Config: testGoogleStorageBucketsObjectContent(bucketName),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckStorageObjectContextsExists(t, bucketName, 0),
+				),
+			},
+		},
+	})
+}
+
 func testAccCheckGoogleStorageObjectCrc32cHash(t *testing.T, bucket, object, crc32 string) resource.TestCheckFunc {
 	return testAccCheckGoogleStorageObjectCrc32cWithEncryption(t, bucket, object, crc32, "")
 }
@@ -1097,3 +1138,87 @@ func testAccCheckStorageObjectExists(t *testing.T, bucketName string) resource.T
 		return nil
 	}
 }
+
+func testAccCheckStorageObjectContextsExists(t *testing.T, bucketName string, customKeys int) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+
+		config := acctest.GoogleProviderConfig(t)
+
+		res, err := config.NewStorageClient(config.UserAgent).Objects.Get(bucketName, objectName).Do()
+		if err != nil {
+			return err
+		}
+
+		if res.Contexts != nil && len(res.Contexts.Custom) == customKeys {
+			return nil
+		}
+		return nil
+	}
+}
+
+func testAccCheckStorageObjectContexts(t *testing.T, bucketName, customKey string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		config := acctest.GoogleProviderConfig(t)
+
+		res, err := config.NewStorageClient(config.UserAgent).Objects.Get(bucketName, objectName).Do()
+		if err != nil {
+			return err
+		}
+
+		if res.Contexts != nil && len(res.Contexts.Custom) > 0 {
+			kvPairs := res.Contexts.Custom
+			for k := range kvPairs {
+				if k == customKey {
+					return nil
+				}
+			}
+		}
+		return nil
+	}
+}
+
+func testGoogleStorageBucketsObjectContexts(bucketName string, key, value string) string {
+	return fmt.Sprintf(`
+resource "google_storage_bucket" "bucket" {
+  name          = "%s"
+  location      = "US"
+}
+
+resource "google_storage_bucket_object" "object" {
+  name            = "%s"
+  bucket          = google_storage_bucket.bucket.name
+  content         = "%s"
+  contexts {
+    custom{
+		key="%s"
+		value="%s"
+	}
+  }
+}
+`, bucketName, objectName, content, key, value)
+}
+
+func testGoogleStorageBucketsMultipleObjectContexts(bucketName string) string {
+	return fmt.Sprintf(`
+resource "google_storage_bucket" "bucket" {
+  name          = "%s"
+  location      = "US"
+}
+
+resource "google_storage_bucket_object" "object" {
+  name            = "%s"
+  bucket          = google_storage_bucket.bucket.name
+  content         = "%s"
+  contexts {
+    custom {
+		key="cloud"
+		value="gcp"
+	}
+    custom {
+		key="backup"
+		value="storage"
+	}
+  }
+}
+`, bucketName, objectName, content)
+}