feat: add datastores list under d/datastore_cluster (#2274)

vsphere/data_source_vsphere_datastore_cluster.go

@@ -4,9 +4,11 @@
 package vsphere
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-provider-vsphere/vsphere/internal/helper/datastore"
 )
 
 func dataSourceVSphereDatastoreCluster() *schema.Resource {
@@ -24,15 +26,39 @@ func dataSourceVSphereDatastoreCluster() *schema.Resource {
 				Optional:    true,
 				Description: "The managed object ID of the datacenter the cluster is located in. Not required if using an absolute path.",
 			},
+			"datastores": {
+				Type:        schema.TypeSet,
+				Computed:    true,
+				Description: "The names of datastores included in the datastore cluster.",
+				Elem:        &schema.Schema{Type: schema.TypeString},
+			},
 		},
 	}
 }
 
 func dataSourceVSphereDatastoreClusterRead(d *schema.ResourceData, meta interface{}) error {
+	ctx := context.Background()
+	client := meta.(*Client).vimClient
 	pod, err := resourceVSphereDatastoreClusterGetPodFromPath(meta, d.Get("name").(string), d.Get("datacenter_id").(string))
 	if err != nil {
 		return fmt.Errorf("error loading datastore cluster: %s", err)
 	}
 	d.SetId(pod.Reference().Value)
+	dsNames := []string{}
+	childDatastores, err := pod.Children(ctx)
+	if err != nil {
+		return fmt.Errorf("error retrieving datastores in datastore cluster: %s", err)
+	}
+	for d := range childDatastores {
+		ds, err := datastore.FromID(client, childDatastores[d].Reference().Value)
+		if err != nil {
+			return fmt.Errorf("error retrieving datastore: %s", err)
+		}
+		dsNames = append(dsNames, ds.Name())
+	}
+	err = d.Set("datastores", dsNames)
+	if err != nil {
+		return fmt.Errorf("cannot set datastores: %s", err)
+	}
 	return nil
 }

vsphere/data_source_vsphere_datastore_cluster_test.go

@@ -5,6 +5,7 @@ package vsphere
 
 import (
 	"fmt"
+	"os"
 	"testing"
 
 	"github.com/hashicorp/terraform-provider-vsphere/vsphere/internal/helper/testhelper"
@@ -55,6 +56,27 @@ func TestAccDataSourceVSphereDatastoreCluster_absolutePathNoDatacenter(t *testin
 		},
 	})
 }
+func TestAccDataSourceVSphereDatastoreCluster_getDatastores(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			RunSweepers()
+			testAccPreCheck(t)
+			testAccResourceVSphereDatastoreClusterPreCheck(t)
+		},
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceVSphereDatastoreClusterGetDatastores(),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrPair(
+						"data.vsphere_datastore_cluster.datastore_cluster_data", "id",
+						"vsphere_datastore_cluster.datastore_cluster", "id",
+					),
+				),
+			},
+		},
+	})
+}
 
 func testAccDataSourceVSphereDatastoreClusterConfigBasic() string {
 	return fmt.Sprintf(`
@@ -66,8 +88,8 @@ resource "vsphere_datastore_cluster" "datastore_cluster" {
 }
 
 data "vsphere_datastore_cluster" "datastore_cluster_data" {
-  name          = "${vsphere_datastore_cluster.datastore_cluster.name}"
-  datacenter_id = "${vsphere_datastore_cluster.datastore_cluster.datacenter_id}"
+  name          = vsphere_datastore_cluster.datastore_cluster.name
+  datacenter_id = vsphere_datastore_cluster.datastore_cluster.datacenter_id
 }
 `,
 		testhelper.CombineConfigs(testhelper.ConfigDataRootDC1(), testhelper.ConfigDataRootPortGroup1()),
@@ -90,3 +112,22 @@ data "vsphere_datastore_cluster" "datastore_cluster_data" {
 		testhelper.CombineConfigs(testhelper.ConfigDataRootDC1(), testhelper.ConfigDataRootPortGroup1()),
 	)
 }
+
+func testAccDataSourceVSphereDatastoreClusterGetDatastores() string {
+	return fmt.Sprintf(`
+resource "vsphere_datastore_cluster" "datastore_cluster" {
+  name          = "%s"
+  datacenter_id = "%s"
+}
+
+data "vsphere_datastore_cluster" "datastore_cluster_data" {
+  name          = "${vsphere_datastore_cluster.datastore_cluster.name}"
+  datacenter_id = "${vsphere_datastore_cluster.datastore_cluster.datacenter_id}"
+}
+
+output "found_datastores" {
+	value = "${length(data.vsphere_datastore_cluster.datastore_cluster_data.datastores) >= 1 ? "true" : "false" }"
+}
+`, os.Getenv("TF_VAR_VSPHERE_DATASTORE_CLUSTER_NAME"), os.Getenv("TF_VAR_VSPHERE_DATACENTER_ID"),
+	)
+}

website/docs/d/datastore_cluster.html.markdown

@@ -45,9 +45,22 @@ The following arguments are supported:
   For default datacenters, use the id attribute from an empty
   `vsphere_datacenter` data source.
 
+
 [docs-about-morefs]: /docs/providers/vsphere/index.html#use-of-managed-object-references-by-the-vsphere-provider
 
 ## Attribute Reference
 
-The only exported attribute from this data source is `id`, which represents the
-ID of the datastore cluster.
+The following attributes are exported:
+
+* `id` - The [managed objectID][docs-about-morefs] of the vSphere datastore cluster object.
+
+* `datastores` - (Optional) The names of the datastores included in the specific 
+  cluster.
+
+### Example Usage for `datastores` attribute:
+
+```hcl
+output "datastores" {
+  value = data.vsphere_datastore_cluster.datastore_cluster.datastores
+}
+```