feat: pg - support prepaid arguments (#1502)

* feat: pg - support prepaid arguments

* fix: add readonly voucher arguments

* changelog 1502

* fix: cancel prepaid parallel test

Author: Kagashino

.changelog/1502.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+resource/tencentcloud_postgresql_instance: feat: pg - support prepaid arguments
+```

tencentcloud/internal/helper/helper.go

@@ -202,6 +202,17 @@ func ImportWithDefaultValue(defaultValues map[string]interface{}) schema.StateFu
 	}
 }
 
+func ImmutableArgsChek(d *schema.ResourceData, arguments ...string) error {
+	for _, v := range arguments {
+		if d.HasChange(v) {
+			o, _ := d.GetChange(v)
+			_ = d.Set(v, o)
+			return fmt.Errorf("argument `%s` cannot be changed", v)
+		}
+	}
+	return nil
+}
+
 func IsEmptyStr(s *string) bool {
 	if s == nil {
 		return true

tencentcloud/resource_tc_postgresql_instance.go

@@ -178,12 +178,33 @@ func resourceTencentCloudPostgresqlInstance() *schema.Resource {
 				Description:  "Name of the postgresql instance.",
 			},
 			"charge_type": {
-				Type:         schema.TypeString,
+				Type:        schema.TypeString,
+				Optional:    true,
+				Default:     COMMON_PAYTYPE_POSTPAID,
+				ForceNew:    true,
+				Description: "Pay type of the postgresql instance. Values `POSTPAID_BY_HOUR` (Default), `PREPAID`.",
+			},
+			"period": {
+				Type:        schema.TypeInt,
+				Optional:    true,
+				Description: "Specify Prepaid period in month. Default `1`. Values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`.",
+			},
+			"auto_renew_flag": {
+				Type:        schema.TypeInt,
+				Optional:    true,
+				Description: "Auto renew flag, `1` for enabled. NOTES: Only support prepaid instance.",
+			},
+			"auto_voucher": {
+				Type:        schema.TypeInt,
+				Optional:    true,
+				Description: "Whether to use voucher, `1` for enabled.",
+			},
+			"voucher_ids": {
+				Type:         schema.TypeList,
 				Optional:     true,
-				Default:      COMMON_PAYTYPE_POSTPAID,
-				ForceNew:     true,
-				ValidateFunc: validateAllowedStringValue(POSTGRESQL_PAYTYPE),
-				Description:  "Pay type of the postgresql instance. For now, only `POSTPAID_BY_HOUR` is valid.",
+				RequiredWith: []string{"auto_voucher"},
+				Description:  "Specify Voucher Ids if `auto_voucher` was `1`, only support using 1 vouchers for now.",
+				Elem:         &schema.Schema{Type: schema.TypeString},
 			},
 			"engine_version": {
 				Type:        schema.TypeString,
@@ -449,7 +470,6 @@ func resourceTencentCloudPostgresqlInstanceCreate(d *schema.ResourceData, meta i
 		nodeSet        = d.Get("db_node_set").(*schema.Set).List()
 	)
 
-	var period = 1
 	// the sdk asks to set value with 1 when paytype is postpaid
 
 	var instanceId, specVersion, specCode string
@@ -462,8 +482,18 @@ func resourceTencentCloudPostgresqlInstanceCreate(d *schema.ResourceData, meta i
 		needSupportTde  = 0
 		kmsKeyId        = ""
 		kmsRegion       = ""
+		period          = 1
+		autoRenewFlag   = 0
+		autoVoucher     = 0
+		voucherIds      []*string
 	)
 
+	if v, ok := d.GetOk("period"); ok {
+		log.Printf("period set")
+		period = v.(int)
+	} else {
+		log.Printf("period not set")
+	}
 	if v, ok := d.GetOk("db_major_vesion"); ok {
 		dbMajorVersion = v.(string)
 	}
@@ -482,6 +512,15 @@ func resourceTencentCloudPostgresqlInstanceCreate(d *schema.ResourceData, meta i
 	if v, ok := d.GetOk("kms_region"); ok {
 		kmsRegion = v.(string)
 	}
+	if v, ok := d.Get("auto_renew_flag").(int); ok {
+		autoRenewFlag = v
+	}
+	if v, ok := d.Get("auto_voucher").(int); ok {
+		autoVoucher = v
+	}
+	if v, ok := d.GetOk("voucher_ids"); ok {
+		voucherIds = helper.InterfacesStringsPoint(v.([]interface{}))
+	}
 	requestSecurityGroup := make([]string, 0, len(securityGroups))
 
 	for _, v := range securityGroups {
@@ -552,8 +591,9 @@ func resourceTencentCloudPostgresqlInstanceCreate(d *schema.ResourceData, meta i
 			dbVersion,
 			dbMajorVersion,
 			dbKernelVersion,
-			payType, specCode,
-			0,
+			payType,
+			specCode,
+			autoRenewFlag,
 			projectId,
 			period,
 			subnetId,
@@ -568,6 +608,8 @@ func resourceTencentCloudPostgresqlInstanceCreate(d *schema.ResourceData, meta i
 			needSupportTde,
 			kmsKeyId,
 			kmsRegion,
+			autoVoucher,
+			voucherIds,
 		)
 		if inErr != nil {
 			return retryError(inErr)
@@ -724,6 +766,16 @@ func resourceTencentCloudPostgresqlInstanceUpdate(d *schema.ResourceData, meta i
 	instanceId := d.Id()
 	d.Partial(true)
 
+	if err := helper.ImmutableArgsChek(d,
+		"charge_type",
+		"period",
+		"auto_renew_flag",
+		"auto_voucher",
+		"voucher_ids",
+	); err != nil {
+		return err
+	}
+
 	var outErr, inErr, checkErr error
 	// update name
 	if d.HasChange("name") {

tencentcloud/resource_tc_postgresql_instance_test.go

@@ -168,6 +168,42 @@ func TestAccTencentCloudPostgresqlInstanceResource(t *testing.T) {
 	})
 }
 
+func TestAccTencentCloudPostgresqlInstanceResource_prepaid(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheckCommon(t, ACCOUNT_TYPE_PREPAY) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckPostgresqlInstanceDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccPostgresqlInstancePrepaid,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckPostgresqlInstanceExists(testPostgresqlInstanceResourceKey),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "id"),
+					resource.TestCheckResourceAttr(testPostgresqlInstanceResourceKey, "name", "tf_postsql_pre"),
+					resource.TestCheckResourceAttr(testPostgresqlInstanceResourceKey, "charge_type", "PREPAID"),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "vpc_id"),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "subnet_id"),
+					resource.TestCheckResourceAttr(testPostgresqlInstanceResourceKey, "memory", "2"),
+					resource.TestCheckResourceAttr(testPostgresqlInstanceResourceKey, "storage", "50"),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "create_time"),
+					resource.TestCheckResourceAttr(testPostgresqlInstanceResourceKey, "public_access_switch", "false"),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "availability_zone"),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "private_access_ip"),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "private_access_port"),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "db_major_vesion"),
+					resource.TestCheckResourceAttrSet(testPostgresqlInstanceResourceKey, "db_major_version"),
+				),
+			},
+			{
+				ResourceName:            testPostgresqlInstanceResourceKey,
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"root_password", "spec_code", "public_access_switch", "charset", "backup_plan"},
+			},
+		},
+	})
+}
+
 func TestAccTencentCloudPostgresqlInstanceResource_MAZ(t *testing.T) {
 	t.Parallel()
 	resource.Test(t, resource.TestCase{
@@ -289,6 +325,34 @@ resource "tencentcloud_postgresql_instance" "test" {
 }
 `
 
+const testAccPostgresqlInstancePrepaid = defaultVpcSubnets + `
+data "tencentcloud_availability_zones_by_product" "zone" {
+  product = "postgres"
+}
+
+data "tencentcloud_security_groups" "internal" {
+  name = "default"
+}
+
+locals {
+  sg_id = data.tencentcloud_security_groups.internal.security_groups.0.security_group_id
+}
+
+resource "tencentcloud_postgresql_instance" "test" {
+  name 				= "tf_postsql_pre"
+  availability_zone = data.tencentcloud_availability_zones_by_product.zone.zones[5].name
+  charge_type 		= "PREPAID"
+  vpc_id  	  		= local.vpc_id
+  subnet_id 		= local.subnet_id
+  engine_version	= "10.4"
+  root_password	    = "t1qaA2k1wgvfa3?ZZZ"
+  security_groups   = [local.sg_id]
+  charset			= "LATIN1"
+  project_id 		= 0
+  memory 			= 2
+  storage 			= 50
+}`
+
 const testAccPostgresqlInstanceOpenPublic string = testAccPostgresqlInstanceBasic + defaultVpcSubnets + `
 resource "tencentcloud_postgresql_instance" "test" {
   name = "tf_postsql_instance_update"

tencentcloud/resource_tc_postgresql_readonly_instance.go

@@ -120,12 +120,28 @@ func resourceTencentCloudPostgresqlReadonlyInstance() *schema.Resource {
 				ValidateFunc: validateAllowedStringValue(POSTGRESQL_PAYTYPE),
 				Description:  "instance billing mode. Valid values: PREPAID (monthly subscription), POSTPAID_BY_HOUR (pay-as-you-go).",
 			},
+			"period": {
+				Type:        schema.TypeInt,
+				Optional:    true,
+				Description: "Specify Prepaid period in month. Default `1`. Values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `24`, `36`.",
+			},
 			"auto_renew_flag": {
 				Type:        schema.TypeInt,
 				Optional:    true,
 				Default:     0,
-				ForceNew:    true,
-				Description: "Renewal flag. Valid values: 0 (manual renewal), 1 (auto-renewal). Default value: 0.",
+				Description: "Auto renew flag, `1` for enabled. NOTES: Only support prepaid instance.",
+			},
+			"auto_voucher": {
+				Type:        schema.TypeInt,
+				Optional:    true,
+				Description: "Whether to use voucher, `1` for enabled.",
+			},
+			"voucher_ids": {
+				Type:         schema.TypeList,
+				Optional:     true,
+				RequiredWith: []string{"auto_voucher"},
+				Description:  "Specify Voucher Ids if `auto_voucher` was `1`, only support using 1 vouchers for now.",
+				Elem:         &schema.Schema{Type: schema.TypeString},
 			},
 			"need_support_ipv6": {
 				Type:        schema.TypeInt,
@@ -194,6 +210,15 @@ func resourceTencentCloudPostgresqlReadOnlyInstanceCreate(d *schema.ResourceData
 	if v, ok := d.GetOk("auto_renew_flag"); ok {
 		request.AutoRenewFlag = helper.IntInt64(v.(int))
 	}
+	if v, ok := d.Get("period").(int); ok && v > 0 {
+		request.Period = helper.IntUint64(v)
+	}
+	if v, ok := d.Get("auto_voucher").(int); ok && v > 0 {
+		request.AutoVoucher = helper.IntUint64(v)
+	}
+	if v, ok := d.GetOk("voucher_ids"); ok {
+		request.VoucherIds = helper.InterfacesStringsPoint(v.([]interface{}))
+	}
 	if v, ok := d.GetOk("vpc_id"); ok {
 		request.VpcId = helper.String(v.(string))
 	}
@@ -373,6 +398,16 @@ func resourceTencentCloudPostgresqlReadOnlyInstanceUpdate(d *schema.ResourceData
 	instanceId := d.Id()
 	d.Partial(true)
 
+	if err := helper.ImmutableArgsChek(d,
+		"charge_type",
+		"period",
+		"auto_renew_flag",
+		"auto_voucher",
+		"voucher_ids",
+	); err != nil {
+		return err
+	}
+
 	var outErr, inErr, checkErr error
 	// update name
 	if d.HasChange("name") {

tencentcloud/service_tencentcloud_postgresql.go

@@ -27,7 +27,7 @@ func (me *PostgresqlService) CreatePostgresqlInstance(
 	storage int,
 	username, password, charset string,
 	dbNodeSet []*postgresql.DBNode,
-	needSupportTde int, kmsKeyId, kmsRegion string,
+	needSupportTde int, kmsKeyId, kmsRegion string, autoVoucher int, voucherIds []*string,
 ) (instanceId string, errRet error) {
 	logId := getLogId(ctx)
 	request := postgresql.NewCreateInstancesRequest()
@@ -79,6 +79,14 @@ func (me *PostgresqlService) CreatePostgresqlInstance(
 		request.DBNodeSet = dbNodeSet
 	}
 
+	if autoVoucher > 0 {
+		request.AutoVoucher = helper.IntUint64(autoVoucher)
+	}
+
+	if len(voucherIds) > 0 {
+		request.VoucherIds = voucherIds
+	}
+
 	ratelimit.Check(request.GetAction())
 	response, err := me.client.UsePostgresqlClient().CreateInstances(request)
 	if err != nil {
@@ -89,13 +97,68 @@ func (me *PostgresqlService) CreatePostgresqlInstance(
 		errRet = fmt.Errorf("TencentCloud SDK return nil response, %s", request.GetAction())
 	}
 	if len(response.Response.DBInstanceIdSet) == 0 {
-		errRet = errors.New("TencentCloud SDK returns empty postgresql ID")
-		return
+		if len(response.Response.DealNames) == 0 {
+			errRet = errors.New("TencentCloud SDK returns empty postgresql ID and Deals")
+			return
+		}
+		log.Printf("[WARN] No postgresql ID returns, requesting Deal Id")
+		dealId := response.Response.DealNames[0]
+		deals, err := me.DescribeOrders(ctx, []*string{dealId})
+		if err != nil {
+			errRet = err
+			return
+		}
+		if len(deals) > 0 && len(deals[0].DBInstanceIdSet) > 0 {
+			instanceId = *deals[0].DBInstanceIdSet[0]
+		}
 	} else if len(response.Response.DBInstanceIdSet) > 1 {
 		errRet = errors.New("TencentCloud SDK returns more than one postgresql ID")
 		return
+	} else {
+		instanceId = *response.Response.DBInstanceIdSet[0]
+	}
+	return
+}
+
+func (me *PostgresqlService) DescribeOrders(ctx context.Context, dealIds []*string) (deals []*postgresql.PgDeal, errRet error) {
+	logId := getLogId(ctx)
+	request := postgresql.NewDescribeOrdersRequest()
+	defer func() {
+		if errRet != nil {
+			log.Printf("[CRITAL]%s api[%s] fail, request body [%s], reason[%s]\n",
+				logId, request.GetAction(), request.ToJsonString(), errRet.Error())
+		}
+	}()
+
+	request.DealNames = dealIds
+
+	ratelimit.Check(request.GetAction())
+
+	var response *postgresql.DescribeOrdersResponse
+	err := resource.Retry(readRetryTimeout*5, func() *resource.RetryError {
+		res, err := me.client.UsePostgresqlClient().DescribeOrders(request)
+		if err != nil {
+			return retryError(err)
+		}
+		if len(res.Response.Deals) == 0 {
+			return resource.RetryableError(fmt.Errorf("waiting for deal return instance id"))
+		}
+		response = res
+		return nil
+	})
+
+	if err != nil {
+		errRet = err
+		return
 	}
-	instanceId = *response.Response.DBInstanceIdSet[0]
+
+	if response != nil {
+		deals = response.Response.Deals
+	}
+
+	log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n",
+		logId, request.GetAction(), request.ToJsonString(), response.ToJsonString())
+
 	return
 }