feat: cdn - support url push and purge (#1105)

Author: Kagashino

tencentcloud/provider.go

@@ -130,6 +130,8 @@ Content Delivery Network(CDN)
 
   Resource
 	tencentcloud_cdn_domain
+	tencentcloud_cdn_url_push
+	tencentcloud_cdn_url_purge
 
 Ckafka
   Data Source
@@ -1039,6 +1041,8 @@ func Provider() terraform.ResourceProvider {
 			"tencentcloud_tcaplus_idl":                             resourceTencentCloudTcaplusIdl(),
 			"tencentcloud_tcaplus_table":                           resourceTencentCloudTcaplusTable(),
 			"tencentcloud_cdn_domain":                              resourceTencentCloudCdnDomain(),
+			"tencentcloud_cdn_url_push":                            resourceTencentCloudUrlPush(),
+			"tencentcloud_cdn_url_purge":                           resourceTencentCloudUrlPurge(),
 			"tencentcloud_monitor_policy_group":                    resourceTencentMonitorPolicyGroup(),
 			"tencentcloud_monitor_binding_object":                  resourceTencentMonitorBindingObject(),
 			"tencentcloud_monitor_policy_binding_object":           resourceTencentMonitorPolicyBindingObject(),

tencentcloud/resource_tc_cdn_domain_test.go

@@ -3,6 +3,7 @@ package tencentcloud
 import (
 	"context"
 	"fmt"
+	"log"
 	"testing"
 
 	sdkErrors "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/errors"
@@ -35,6 +36,11 @@ func init() {
 			for i := range domains {
 				item := domains[i]
 				name := *item.Domain
+
+				if isResourcePersist(name, nil) {
+					continue
+				}
+
 				if *item.Status != "offline" {
 					_ = service.StopDomain(ctx, name)
 				}
@@ -61,7 +67,13 @@ func testAccTencentCloudCdnDomainResource(t *testing.T) {
 	t.Parallel()
 
 	resource.Test(t, resource.TestCase{
-		PreCheck:     func() { testAccPreCheckCommon(t, ACCOUNT_TYPE_PREPAY) },
+		PreCheck: func() {
+			testAccPreCheckCommon(t, ACCOUNT_TYPE_PREPAY)
+			if err := testAccCdnDomainVerify("www"); err != nil {
+				log.Printf("[TestAccTencentCloudCdnDomainResource] Domain Verify failed: %s", err)
+				t.Fatalf("[TestAccTencentCloudCdnDomainResource] Domain Verify failed: %s", err)
+			}
+		},
 		Providers:    testAccProviders,
 		CheckDestroy: testAccCheckCdnDomainDestroy,
 		Steps: []resource.TestStep{
@@ -90,7 +102,8 @@ func TestAccTencentCloudCdnDomainWithHTTPs(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck: func() {
 			testAccPreCheckCommon(t, ACCOUNT_TYPE_PREPAY)
-			if err := testAccCdnDomainVerify(); err != nil {
+			if err := testAccCdnDomainVerify("c"); err != nil {
+				log.Printf("[TestAccCentcentCloudCdnDomainWithHTTPs] Domain Verify failed: %s", err)
 				t.Fatalf("[TestAccCentcentCloudCdnDomainWithHTTPs] Domain Verify failed: %s", err)
 			}
 		},
@@ -202,9 +215,12 @@ func testAccGetTestingDomain() (string, error) {
 	return *domains[0].DomainName, nil
 }
 
-func testAccCdnDomainVerify() error {
+func testAccCdnDomainVerify(domainPrefix string) error {
+	logId := getLogId(contextNil)
+	ctx := context.WithValue(context.TODO(), logIdKey, logId)
 	cli, _ := sharedClientForRegion("ap-guangzhou")
 	client := cli.(*TencentCloudClient).apiV3Conn
+	service := CdnService{client}
 	continueCode := []string{
 		// no record
 		cdn.UNAUTHORIZEDOPERATION_CDNDOMAINRECORDNOTVERIFIED,
@@ -213,16 +229,13 @@ func testAccCdnDomainVerify() error {
 	}
 
 	domainName, err := testAccGetTestingDomain()
-	l3domain := fmt.Sprintf("c.%s", domainName)
+	l3domain := fmt.Sprintf("%s.%s", domainPrefix, domainName)
 
 	if err != nil {
 		return err
 	}
 
-	vRequest := cdn.NewVerifyDomainRecordRequest()
-	vRequest.Domain = &l3domain
-
-	vRes, err := client.UseCdnClient().VerifyDomainRecord(vRequest)
+	result, err := service.VerifyDomainRecord(ctx, l3domain)
 
 	if err != nil {
 
@@ -233,20 +246,18 @@ func testAccCdnDomainVerify() error {
 		}
 	}
 
-	if vRes.Response != nil && *vRes.Response.Result {
+	log.Printf("[Precheck] Domain Record Verify: %t", result)
+	if result {
 		return nil
 	}
 
-	cRequest := cdn.NewCreateVerifyRecordRequest()
-	cRequest.Domain = &l3domain
-
-	cRes, err := client.UseCdnClient().CreateVerifyRecord(cRequest)
+	cRes, err := service.CreateVerifyRecord(ctx, l3domain)
 	if err != nil {
 		return err
 	}
 
-	recordType := *cRes.Response.RecordType
-	record := *cRes.Response.Record
+	recordType := *cRes.RecordType
+	record := *cRes.Record
 
 	err = testAccSetDnsPodRecord(domainName, recordType, record)
 
@@ -255,11 +266,11 @@ func testAccCdnDomainVerify() error {
 	}
 
 	err = resource.Retry(readRetryTimeout*3, func() *resource.RetryError {
-		vRes, err = client.UseCdnClient().VerifyDomainRecord(vRequest)
+		result, err = service.VerifyDomainRecord(ctx, l3domain)
 		if err != nil {
 			return retryError(err, continueCode...)
 		}
-		if vRes.Response != nil && *vRes.Response.Result {
+		if result {
 			return nil
 		}
 		return resource.RetryableError(fmt.Errorf("verifying domain, retry"))

tencentcloud/resource_tc_cdn_url_purge.go

@@ -0,0 +1,259 @@
+/*
+Provide a resource to invoke a Url Purge Request.
+
+Example Usage
+
+```hcl
+resource "tencentcloud_cdn_url_purge" "foo" {
+  urls = [
+    "https://www.example.com/a"
+  ]
+}
+```
+
+Change `redo` argument to request new purge task with same urls
+
+```hcl
+resource "tencentcloud_cdn_url_purge" "foo" {
+  urls = [
+    "https://www.example.com/a"
+  ]
+  redo = 1
+}
+```
+
+*/
+package tencentcloud
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+
+	cdn "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cdn/v20180606"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/internal/helper"
+)
+
+func resourceTencentCloudUrlPurge() *schema.Resource {
+	return &schema.Resource{
+		Read:   resourceTencentCloudUrlPurgeRead,
+		Create: resourceTencentCloudUrlPurgeCreate,
+		Update: resourceTencentCloudUrlPurgeUpdate,
+		Delete: resourceTencentCloudUrlPurgeDelete,
+		Schema: map[string]*schema.Schema{
+			"urls": {
+				Type:        schema.TypeList,
+				Required:    true,
+				ForceNew:    true,
+				Elem:        &schema.Schema{Type: schema.TypeString},
+				Description: "List of url to purge. NOTE: urls need include protocol prefix `http://` or `https://`.",
+			},
+			"redo": {
+				Type:        schema.TypeInt,
+				Optional:    true,
+				Description: "Change to purge again. NOTE: this argument only works while resource update, if set to `0` or null will not be triggered.",
+			},
+			"area": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "Specify purge area. NOTE: only purge same area cache contents.",
+			},
+			"url_encode": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Description: "Whether to encode urls, if set to `true` will auto encode instead of manual process.",
+			},
+			"task_id": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "Task id of last operation.",
+			},
+			"purge_history": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "logs of latest purge task.",
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"task_id": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Purge task id.",
+						},
+						"url": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Purge url.",
+						},
+						"status": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Purge status of `fail`, `done`, `process`.",
+						},
+						"purge_type": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Purge category in of `url` or `path`.",
+						},
+						"flush_type": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Purge flush type of `flush` or `delete`.",
+						},
+						"create_time": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Purge task create time.",
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func resourceTencentCloudUrlPurgeRead(d *schema.ResourceData, meta interface{}) error {
+	defer logElapsed("resource.tencentcloud_cdn_url_purge.read")()
+	defer inconsistentCheck(d, meta)()
+
+	logId := getLogId(contextNil)
+	ctx := context.WithValue(context.TODO(), logIdKey, logId)
+	client := meta.(*TencentCloudClient).apiV3Conn
+	service := CdnService{client}
+
+	taskId, ok := d.Get("task_id").(string)
+
+	if !ok || taskId == "" {
+		return fmt.Errorf("no task id provided")
+	}
+
+	request := cdn.NewDescribePurgeTasksRequest()
+	request.TaskId = &taskId
+
+	var (
+		logs []*cdn.PurgeTask
+		err  error
+	)
+
+	err = resource.Retry(readRetryTimeout*2, func() *resource.RetryError {
+		logs, err = service.DescribePurgeTasks(ctx, request)
+		if err != nil {
+			return retryError(err)
+		}
+		if len(logs) == 0 {
+			return resource.RetryableError(fmt.Errorf("task %s returns nil logs, retrying", taskId))
+		}
+		for i := range logs {
+			item := logs[i]
+			status := item.Status
+			if status == nil {
+				continue
+			}
+			switch *status {
+			case "process":
+				return resource.RetryableError(fmt.Errorf("processing %s", *item.Url))
+			case "fail":
+				return resource.NonRetryableError(fmt.Errorf("purge url %s failed", *item.Url))
+			default:
+				continue
+			}
+		}
+		return nil
+	})
+
+	if err != nil {
+		return err
+	}
+
+	urls := d.Get("urls").([]interface{})
+	d.SetId("purges-" + GetUrlsHash(helper.InterfacesStrings(urls)))
+
+	purgeHistory := make([]interface{}, 0)
+
+	if len(logs) > 0 {
+		for i := range logs {
+			item := logs[i]
+			purge := map[string]interface{}{
+				"task_id":     item.TaskId,
+				"url":         item.Url,
+				"create_time": item.CreateTime,
+				"status":      item.Status,
+				"purge_type":  item.PurgeType,
+				"flush_type":  item.FlushType,
+			}
+			purgeHistory = append(purgeHistory, purge)
+		}
+	}
+
+	_ = d.Set("purge_history", purgeHistory)
+
+	return nil
+}
+
+func resourceTencentCloudUrlPurgeCreate(d *schema.ResourceData, meta interface{}) error {
+	defer logElapsed("resource.tencentcloud_cdn_url_purge.create")()
+
+	taskId, err := tencentcloudCdnUrlPurge(d, meta)
+
+	if err != nil {
+		return err
+	}
+
+	_ = d.Set("task_id", taskId)
+
+	urls := d.Get("urls").([]interface{})
+	d.SetId("purges-" + GetUrlsHash(helper.InterfacesStrings(urls)))
+
+	return resourceTencentCloudUrlPurgeRead(d, meta)
+}
+
+func resourceTencentCloudUrlPurgeUpdate(d *schema.ResourceData, meta interface{}) error {
+	defer logElapsed("resource.tencentcloud_cdn_url_purge.update")()
+
+	redo, ok := d.GetOk("redo")
+
+	if !d.HasChange("redo") || !ok || redo.(int) == 0 {
+		return nil
+	}
+
+	taskId, err := tencentcloudCdnUrlPurge(d, meta)
+
+	if err != nil {
+		return err
+	}
+
+	_ = d.Set("task_id", taskId)
+
+	return resourceTencentCloudUrlPurgeRead(d, meta)
+}
+
+func resourceTencentCloudUrlPurgeDelete(d *schema.ResourceData, meta interface{}) error {
+	defer logElapsed("resource.tencentcloud_cdn_url_purge.delete")()
+	log.Printf("noop deleting resoruce %s", "tencentcloud_cdn_url_purge")
+	return nil
+}
+
+func tencentcloudCdnUrlPurge(d *schema.ResourceData, meta interface{}) (string, error) {
+	logId := getLogId(contextNil)
+	ctx := context.WithValue(context.TODO(), logIdKey, logId)
+
+	client := meta.(*TencentCloudClient).apiV3Conn
+	service := CdnService{client}
+
+	urls := d.Get("urls").([]interface{})
+	request := cdn.NewPurgeUrlsCacheRequest()
+	request.Urls = helper.InterfacesStringsPoint(urls)
+
+	if v, ok := d.GetOk("area"); ok {
+		request.Area = helper.String(v.(string))
+	}
+
+	if v, ok := d.GetOk("url_encode"); ok {
+		request.UrlEncode = helper.Bool(v.(bool))
+	}
+
+	return service.PurgeUrlsCache(ctx, request)
+}