datasource images support snapshotSet

Author: crab21

tencentcloud/data_source_tc_images.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	cbs "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cbs/v20170312"
 	cvm "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm/v20170312"
 	"github.com/terraform-providers/terraform-provider-tencentcloud/tencentcloud/internal/helper"
 )
@@ -136,6 +137,35 @@ func dataSourceTencentCloudImages() *schema.Resource {
 							Computed:    true,
 							Description: "Whether support cloud-init.",
 						},
+						"snapshots": {
+							Type:        schema.TypeSet,
+							Computed:    true,
+							Description: "List of snapshot details.",
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"snapshot_id": {
+										Type:        schema.TypeString,
+										Computed:    true,
+										Description: "Snapshot ID.",
+									},
+									"snapshot_name": {
+										Type:        schema.TypeString,
+										Computed:    true,
+										Description: "Snapshot name, the user-defined snapshot alias.",
+									},
+									"disk_usage": {
+										Type:        schema.TypeString,
+										Computed:    true,
+										Description: "Type of the cloud disk used to create the snapshot.",
+									},
+									"disk_size": {
+										Type:        schema.TypeInt,
+										Computed:    true,
+										Description: "Size of the cloud disk used to create the snapshot; unit: GB.",
+									},
+								},
+							},
+						},
 					},
 				},
 			},
@@ -153,6 +183,10 @@ func dataSourceTencentCloudImagesRead(d *schema.ResourceData, meta interface{})
 		client: meta.(*TencentCloudClient).apiV3Conn,
 	}
 
+	cbsService := CbsService{
+		client: meta.(*TencentCloudClient).apiV3Conn,
+	}
+
 	var (
 		imageId        string
 		imageType      []string
@@ -234,6 +268,11 @@ func dataSourceTencentCloudImagesRead(d *schema.ResourceData, meta interface{})
 	imageList := make([]map[string]interface{}, 0, len(results))
 	ids := make([]string, 0, len(results))
 	for _, image := range results {
+		snapshots, err := imagesReadSnapshotByIds(image, cbsService, ctx)
+		if err != nil {
+			return err
+		}
+
 		mapping := map[string]interface{}{
 			"image_id":           image.ImageId,
 			"os_name":            image.OsName,
@@ -249,6 +288,7 @@ func dataSourceTencentCloudImagesRead(d *schema.ResourceData, meta interface{})
 			"image_source":       image.ImageSource,
 			"sync_percent":       image.SyncPercent,
 			"support_cloud_init": image.IsSupportCloudinit,
+			"snapshots":          snapshots,
 		}
 		imageList = append(imageList, mapping)
 		ids = append(ids, *image.ImageId)
@@ -270,3 +310,50 @@ func dataSourceTencentCloudImagesRead(d *schema.ResourceData, meta interface{})
 
 	return nil
 }
+
+func imagesReadSnapshotByIds(image *cvm.Image, cbsService CbsService, ctx context.Context) (snapshotResults []map[string]interface{}, errSnap error) {
+	if len(image.SnapshotSet) == 0 {
+		return
+	}
+
+	snapshotSetMap := map[string]interface{}{}
+	snapshotByIds := make([]*string, 0, len(image.SnapshotSet))
+	for _, snapshot := range image.SnapshotSet {
+		snapshotByIds = append(snapshotByIds, snapshot.SnapshotId)
+	}
+
+	var snapshots []*cbs.Snapshot
+	errSnap = resource.Retry(readRetryTimeout, func() *resource.RetryError {
+		snapshots, errSnap = cbsService.DescribeSnapshotByIds(ctx, snapshotByIds)
+		if errSnap != nil {
+			return retryError(errSnap, InternalError)
+		}
+		return nil
+	})
+	if errSnap != nil {
+		return
+	}
+
+	for _, snapshot := range snapshots {
+		snapshotSetMap[*snapshot.SnapshotId] = snapshot
+	}
+
+	snapshotSet := image.SnapshotSet
+	snapshotResults = make([]map[string]interface{}, 0, len(snapshotSet))
+	if len(snapshotSet) > 0 {
+		for _, snapshot := range snapshotSet {
+			snapshotMap := make(map[string]interface{}, 4)
+			id := snapshot.SnapshotId
+			snapshotMap["snapshot_id"] = *id
+			snapshotMap["disk_usage"] = snapshot.DiskUsage
+			snapshotMap["disk_size"] = snapshot.DiskSize
+
+			if v, ok := snapshotSetMap[*id]; ok {
+				snapshotMap["snapshot_name"] = v.(*cbs.Snapshot).SnapshotName
+			}
+			snapshotResults = append(snapshotResults, snapshotMap)
+		}
+	}
+
+	return
+}

tencentcloud/data_source_tc_images_test.go

@@ -45,12 +45,13 @@ func TestAccTencentCloudDataSourceImagesBase(t *testing.T) {
 
 const testAccTencentCloudDataSourceImagesBase = `
 data "tencentcloud_images" "foo" {
+	result_output_file = "data_source_tc_images_test.txt"
 }
 `
 
 const testAccTencentCloudDataSourceImagesBaseWithFilter = `
 data "tencentcloud_images" "foo" {
-	image_type = ["PUBLIC_IMAGE"]
+	image_type = ["PRIVATE_IMAGE"]
 }
 `
 

tencentcloud/service_tencentcloud_cbs.go

@@ -226,6 +226,44 @@ func (me *CbsService) DescribeSnapshotById(ctx context.Context, snapshotId strin
 	return
 }
 
+func (me *CbsService) DescribeSnapshotByIds(ctx context.Context, snapshotIdsParam []*string) (snapshots []*cbs.Snapshot, errRet error) {
+	logId := getLogId(ctx)
+	request := cbs.NewDescribeSnapshotsRequest()
+	if len(snapshotIdsParam) == 0 {
+		return
+	}
+	request.SnapshotIds = snapshotIdsParam
+
+	offset := 0
+	pageSize := 100
+	for {
+		request.Offset = helper.IntUint64(offset)
+		request.Limit = helper.IntUint64(pageSize)
+		ratelimit.Check(request.GetAction())
+		response, err := me.client.UseCbsClient().DescribeSnapshots(request)
+		if err != nil {
+			log.Printf("[CRITAL]%s api[%s] fail, request body [%s], reason[%s]\n",
+				logId, request.GetAction(), request.ToJsonString(), err.Error())
+			errRet = err
+			return
+		}
+		log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n",
+			logId, request.GetAction(), request.ToJsonString(), response.ToJsonString())
+
+		if response == nil || len(response.Response.SnapshotSet) < 1 {
+			break
+		}
+
+		snapshots = append(snapshots, response.Response.SnapshotSet...)
+
+		if len(response.Response.SnapshotSet) < pageSize {
+			break
+		}
+		offset += pageSize
+	}
+	return
+}
+
 func (me *CbsService) DescribeSnapshotsByFilter(ctx context.Context, params map[string]string) (snapshots []*cbs.Snapshot, errRet error) {
 	logId := getLogId(ctx)
 	request := cbs.NewDescribeSnapshotsRequest()

website/docs/d/images.html.markdown

@@ -46,6 +46,11 @@ In addition to all arguments above, the following attributes are exported:
   * `image_type` - Type of the image.
   * `os_name` - OS name of the image.
   * `platform` - Platform of the image.
+  * `snapshots` - List of snapshot details.
+    * `disk_size` - Size of the cloud disk used to create the snapshot; unit: GB.
+    * `disk_usage` - Type of the cloud disk used to create the snapshot.
+    * `snapshot_id` - Snapshot ID.
+    * `snapshot_name` - Snapshot name, the user-defined snapshot alias.
   * `support_cloud_init` - Whether support cloud-init.
   * `sync_percent` - Sync percent of the image.