Merge pull request #684 from tencentcloudstack/feat/cos-object-tags

Feat/cos object tags

Author: Kagashino

tencentcloud/resource_tc_cos_bucket_object.go

@@ -105,6 +105,11 @@ func resourceTencentCloudCosBucketObject() *schema.Resource {
 				Optional:    true,
 				Description: "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.",
 			},
+			"tags": {
+				Type:        schema.TypeMap,
+				Optional:    true,
+				Description: "Tag of the object.",
+			},
 			"content_type": {
 				Type:        schema.TypeString,
 				Optional:    true,
@@ -192,6 +197,22 @@ func resourceTencentCloudCosBucketObjectCreate(d *schema.ResourceData, meta inte
 	log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n",
 		logId, "put object", request.String(), response.String())
 
+	if v, ok := d.GetOk("tags"); ok {
+		ctx := context.WithValue(context.TODO(), logIdKey, logId)
+		service := CosService{
+			client: meta.(*TencentCloudClient).apiV3Conn,
+		}
+		tags := make(map[string]string)
+
+		for key, val := range v.(map[string]interface{}) {
+			tags[key] = val.(string)
+		}
+
+		if err := service.SetObjectTags(ctx, bucket, key, tags); err != nil {
+			log.Printf("[WARN] set object tags error, skip processing")
+		}
+	}
+
 	d.SetId(bucket + key)
 	return resourceTencentCloudCosBucketObjectRead(d, meta)
 }
@@ -228,6 +249,18 @@ func resourceTencentCloudCosBucketObjectRead(d *schema.ResourceData, meta interf
 		_ = d.Set("storage_class", response.StorageClass)
 	}
 
+	var tags map[string]string
+	tags, err = cosService.GetObjectTags(ctx, bucket, key)
+	if err != nil {
+		if awsError, ok := err.(awserr.RequestFailure); ok && awsError.StatusCode() == 404 {
+			log.Printf("[WARN]%s tags in object (%s) of bucket (%s) not found, error code (404)", logId, key, bucket)
+			d.SetId("")
+			return nil
+		}
+		return err
+	}
+	err = d.Set("tags", tags)
+
 	return nil
 }
 
@@ -267,6 +300,17 @@ func resourceTencentCloudCosBucketObjectUpdate(d *schema.ResourceData, meta inte
 		}
 	}
 
+	if d.HasChange("tags") {
+		v := d.Get("tags").(map[string]interface{})
+		tags := make(map[string]string)
+		for key, val := range v {
+			tags[key] = val.(string)
+		}
+		if err := cosService.SetObjectTags(ctx, bucket, key, tags); err != nil {
+			return err
+		}
+	}
+
 	return nil
 }
 

tencentcloud/resource_tc_cos_bucket_object_test.go

@@ -70,6 +70,26 @@ func TestAccTencentCloudCosBucketObject_content(t *testing.T) {
 	})
 }
 
+func TestAccTencentCloudCosBucketObject_tags(t *testing.T) {
+	t.Parallel()
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckCosBucketObjectDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccCosBucketObject_tags(appid),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckCosBucketObjectExists("tencentcloud_cos_bucket_object.object_with_tags"),
+					resource.TestCheckResourceAttr("tencentcloud_cos_bucket_object.object_with_tags", "tags.test", "test"),
+					resource.TestCheckResourceAttr("tencentcloud_cos_bucket_object.object_with_tags", "tags.hello", "world"),
+				),
+			},
+		},
+	})
+}
+
 func TestAccTencentCloudCosBucketObject_storageClass(t *testing.T) {
 	t.Parallel()
 
@@ -192,6 +212,25 @@ resource "tencentcloud_cos_bucket_object" "object_content" {
 `, acctest.RandInt(), appid)
 }
 
+func testAccCosBucketObject_tags(appid string) string {
+	return fmt.Sprintf(`
+resource "tencentcloud_cos_bucket" "object_bucket" {
+  bucket = "tf-bucket-%d-%s"
+}
+
+resource "tencentcloud_cos_bucket_object" "object_with_tags" {
+  bucket       = tencentcloud_cos_bucket.object_bucket.bucket
+  key          = "tf-object-tags"
+  content       = "aaaaaaaaaaaaaaaa"
+  content_type = "binary/octet-stream"
+  tags = {
+    test = "test"
+    hello = "world"
+  }
+}
+`, acctest.RandInt(), appid)
+}
+
 func testAccCosBucketObject_storageClass(appid string) string {
 	return fmt.Sprintf(`
 resource "tencentcloud_cos_bucket" "object_bucket" {

tencentcloud/service_tencentcloud_cos.go

@@ -674,6 +674,91 @@ func (me *CosService) GetBucketTags(ctx context.Context, bucket string) (map[str
 	return tags, nil
 }
 
+func (me *CosService) GetObjectTags(ctx context.Context, bucket string, key string) (map[string]string, error) {
+	logId := getLogId(ctx)
+
+	req := &s3.GetObjectTaggingInput{
+		Bucket: &bucket,
+		Key:    &key,
+	}
+
+	ratelimit.Check("GetObjectTagging")
+	resp, err := me.client.UseCosClient().GetObjectTagging(req)
+	if err != nil {
+		if awsErr, ok := err.(awserr.Error); !ok || awsErr.Code() != "404" {
+			return nil, nil
+		}
+
+		log.Printf("[CRITAL]%s api[%s] fail, request body [%s], reason[%v]",
+			logId, "get object tags", req.String(), err)
+		return nil, err
+	}
+
+	tags := make(map[string]string, len(resp.TagSet))
+
+	for _, tag := range resp.TagSet {
+		tags[*tag.Key] = *tag.Value
+	}
+
+	log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]",
+		logId, "get tags", req.String(), resp.String())
+
+	return tags, nil
+}
+
+// SetObjectTags same as delete Bucket Tags
+func (me *CosService) SetObjectTags(ctx context.Context, bucket string, key string, tags map[string]string) error {
+	logId := getLogId(ctx)
+
+	deleteReq := &s3.DeleteObjectTaggingInput{
+		Bucket: aws.String(bucket),
+		Key:    aws.String(key),
+	}
+
+	ratelimit.Check("DeleteObjectTagging")
+
+	deleteResp, err := me.client.UseCosClient().DeleteObjectTagging(deleteReq)
+	if err != nil {
+		log.Printf("[CRITAL]%s api[%s] fail, request body [%s], reason[%s]",
+			logId, "delete olg object tags", deleteReq.String(), err)
+		return err
+	}
+
+	log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]",
+		logId, "delete olg object tags", deleteReq.String(), deleteResp.String())
+
+	if len(tags) == 0 {
+		return nil
+	}
+
+	putReq := &s3.PutObjectTaggingInput{
+		Key:     aws.String(key),
+		Bucket:  aws.String(bucket),
+		Tagging: new(s3.Tagging),
+	}
+
+	for k, v := range tags {
+		putReq.Tagging.TagSet = append(putReq.Tagging.TagSet, &s3.Tag{
+			Key:   aws.String(k),
+			Value: aws.String(v),
+		})
+	}
+
+	ratelimit.Check("PutObjectTagging")
+
+	resp, err := me.client.UseCosClient().PutObjectTagging(putReq)
+	if err != nil {
+		log.Printf("[CRITAL]%s api[%s] fail, request body [%s], reason[%v]",
+			logId, "put new object tags", deleteReq.String(), err)
+		return err
+	}
+
+	log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]",
+		logId, "put new object tags", putReq.String(), resp.String())
+
+	return nil
+}
+
 func (me *CosService) PutBucketPolicy(ctx context.Context, bucket, policy string) (errRet error) {
 	logId := getLogId(ctx)
 

website/docs/r/cos_bucket_object.html.markdown

@@ -53,6 +53,7 @@ The following arguments are supported:
 * `etag` - (Optional) The ETag generated for the object (an MD5 sum of the object content).
 * `source` - (Optional) The path to the source file being uploaded to the bucket.
 * `storage_class` - (Optional) Object storage type, Available values include `STANDARD`, `STANDARD_IA` and `ARCHIVE`.
+* `tags` - (Optional) Tag of the object.
 
 ## Attributes Reference