Deprecate Arg_PlacementGroupName for Arg_PlacementGroupID (IBM-Cloud#6507)

You can currently put either the name or the id in the current name
field, but we prefer if customers use the id and as such we are trying
to improve guidance.

Update deprecation message

Remove non zero check

Author: ismirlia

ibm/acctest/acctest.go

@@ -247,7 +247,7 @@ var (
 	Pi_network_security_group_id      string
 	Pi_network_security_group_rule_id string
 	Pi_peer_interface_id              string
-	Pi_placement_group_name           string
+	Pi_placement_group_id             string
 	Pi_remote_id                      string
 	Pi_remote_type                    string
 	Pi_replication_volume_name        string
@@ -1346,10 +1346,10 @@ func init() {
 		fmt.Println("[INFO] Set the environment variable PI_SAP_PROFILE_ID for testing ibm_pi_sap_profile resource else it is set to default value 'terraform-test-power'")
 	}
 
-	Pi_placement_group_name = os.Getenv("PI_PLACEMENT_GROUP_NAME")
-	if Pi_placement_group_name == "" {
-		Pi_placement_group_name = "tf-pi-placement-group"
-		fmt.Println("[WARN] Set the environment variable PI_PLACEMENT_GROUP_NAME for testing ibm_pi_placement_group resource else it is set to default value 'tf-pi-placement-group'")
+	Pi_placement_group_id = os.Getenv("PI_PLACEMENT_GROUP_ID")
+	if Pi_placement_group_id == "" {
+		Pi_placement_group_id = "tf-pi-placement-group"
+		fmt.Println("[WARN] Set the environment variable PI_PLACEMENT_GROUP_ID for testing ibm_pi_placement_group resource else it is set to default value 'tf-pi-placement-group'")
 	}
 
 	Pi_remote_id = os.Getenv("PI_REMOTE_ID")

ibm/service/power/data_source_ibm_pi_placement_group.go

@@ -5,6 +5,7 @@ package power
 
 import (
 	"context"
+	"fmt"
 	"log"
 
 	"github.com/IBM-Cloud/power-go-client/clients/instance"
@@ -26,11 +27,20 @@ func DataSourceIBMPIPlacementGroup() *schema.Resource {
 				Type:         schema.TypeString,
 				ValidateFunc: validation.NoZeroValues,
 			},
+			Arg_PlacementGroupID: {
+				AtLeastOneOf:  []string{Arg_PlacementGroupID, Arg_PlacementGroupName},
+				ConflictsWith: []string{Arg_PlacementGroupName},
+				Description:   "The placement group ID.",
+				Optional:      true,
+				Type:          schema.TypeString,
+			},
 			Arg_PlacementGroupName: {
-				Description:  "The name of the placement group.",
-				Required:     true,
-				Type:         schema.TypeString,
-				ValidateFunc: validation.NoZeroValues,
+				AtLeastOneOf:  []string{Arg_PlacementGroupID, Arg_PlacementGroupName},
+				ConflictsWith: []string{Arg_PlacementGroupID},
+				Deprecated:    "The pi_placement_group_name field is deprecated. Please use pi_placement_group_id instead.",
+				Description:   "The name of the placement group.",
+				Optional:      true,
+				Type:          schema.TypeString,
 			},
 
 			// Attribute
@@ -45,6 +55,11 @@ func DataSourceIBMPIPlacementGroup() *schema.Resource {
 				Elem:        &schema.Schema{Type: schema.TypeString},
 				Type:        schema.TypeList,
 			},
+			Attr_Name: {
+				Computed:    true,
+				Description: "The name of the placement group.",
+				Type:        schema.TypeString,
+			},
 			Attr_Policy: {
 				Computed:    true,
 				Description: "The value of the group's affinity policy. Valid values are affinity and anti-affinity.",
@@ -61,33 +76,42 @@ func DataSourceIBMPIPlacementGroup() *schema.Resource {
 	}
 }
 
-func dataSourceIBMPIPlacementGroupRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+func dataSourceIBMPIPlacementGroupRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	sess, err := meta.(conns.ClientSession).IBMPISession()
 	if err != nil {
-		return diag.FromErr(err)
+		tfErr := flex.TerraformErrorf(err, fmt.Sprintf("IBMPISession failed: %s", err.Error()), "(Data) ibm_pi_placement_group", "read")
+		log.Printf("[DEBUG]\n%s", tfErr.GetDebugMessage())
+		return tfErr.GetDiag()
 	}
 
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
-	placementGroupName := d.Get(Arg_PlacementGroupName).(string)
-	client := instance.NewIBMPIPlacementGroupClient(ctx, sess, cloudInstanceID)
+	var placementGroupID string
+	if v, ok := d.GetOk(Arg_PlacementGroupID); ok {
+		placementGroupID = v.(string)
+	} else if v, ok := d.GetOk(Arg_PlacementGroupName); ok {
+		placementGroupID = v.(string)
+	}
 
-	response, err := client.Get(placementGroupName)
+	client := instance.NewIBMPIPlacementGroupClient(ctx, sess, cloudInstanceID)
+	placementGroup, err := client.Get(placementGroupID)
 	if err != nil {
-		log.Printf("[DEBUG]  err %s", err)
-		return diag.FromErr(err)
+		tfErr := flex.TerraformErrorf(err, fmt.Sprintf("Get failed: %s", err.Error()), "(Data) ibm_pi_placement_group", "read")
+		log.Printf("[DEBUG]  err \n%s", tfErr.GetDebugMessage())
+		return tfErr.GetDiag()
 	}
 
-	d.SetId(*response.ID)
-	if response.Crn != "" {
-		d.Set(Attr_CRN, response.Crn)
-		userTags, err := flex.GetGlobalTagsUsingCRN(meta, string(response.Crn), "", UserTagType)
+	d.SetId(*placementGroup.ID)
+	if placementGroup.Crn != "" {
+		d.Set(Attr_CRN, placementGroup.Crn)
+		userTags, err := flex.GetGlobalTagsUsingCRN(meta, string(placementGroup.Crn), "", UserTagType)
 		if err != nil {
-			log.Printf("Error on get of placement group (%s) user_tags: %s", *response.ID, err)
+			log.Printf("Error on get of placement group (%s) user_tags: %s", *placementGroup.ID, err)
 		}
 		d.Set(Attr_UserTags, userTags)
 	}
-	d.Set(Attr_Members, response.Members)
-	d.Set(Attr_Policy, response.Policy)
+	d.Set(Attr_Members, placementGroup.Members)
+	d.Set(Attr_Name, placementGroup.Name)
+	d.Set(Attr_Policy, placementGroup.Policy)
 
 	return nil
 }

ibm/service/power/data_source_ibm_pi_placement_group_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 )
 
-func TestAccIBMPIPlacementGroupDataSource_basic(t *testing.T) {
+func TestAccIBMPIPlacementGroupDataSourceBasic(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:  func() { acc.TestAccPreCheck(t) },
 		Providers: acc.TestAccProviders,
@@ -29,7 +29,7 @@ func TestAccIBMPIPlacementGroupDataSource_basic(t *testing.T) {
 func testAccCheckIBMPIPlacementGroupDataSourceConfig() string {
 	return fmt.Sprintf(`
 		data "ibm_pi_placement_group" "testacc_ds_placement_group" {
-			pi_placement_group_name = "%s"
-			pi_cloud_instance_id = "%s"
-		}`, acc.Pi_placement_group_name, acc.Pi_cloud_instance_id)
+			pi_cloud_instance_id = "%[1]s"
+			pi_placement_group_id = "%[2]s"
+		}`, acc.Pi_cloud_instance_id, acc.Pi_placement_group_id)
 }

ibm/service/power/data_source_ibm_pi_placement_groups.go

@@ -5,6 +5,7 @@ package power
 
 import (
 	"context"
+	"fmt"
 	"log"
 
 	"github.com/IBM-Cloud/power-go-client/clients/instance"
@@ -52,7 +53,7 @@ func DataSourceIBMPIPlacementGroups() *schema.Resource {
 						},
 						Attr_Name: {
 							Computed:    true,
-							Description: "User defined name for the placement group.",
+							Description: "The name of the placement group.",
 							Type:        schema.TypeString,
 						},
 						Attr_Policy: {
@@ -74,24 +75,27 @@ func DataSourceIBMPIPlacementGroups() *schema.Resource {
 	}
 }
 
-func dataSourceIBMPIPlacementGroupsRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+func dataSourceIBMPIPlacementGroupsRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	sess, err := meta.(conns.ClientSession).IBMPISession()
 	if err != nil {
-		return diag.FromErr(err)
+		tfErr := flex.TerraformErrorf(err, fmt.Sprintf("IBMPISession failed: %s", err.Error()), "(Data) ibm_pi_placement_groups", "read")
+		log.Printf("[DEBUG]\n%s", tfErr.GetDebugMessage())
+		return tfErr.GetDiag()
 	}
 
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
 
 	client := instance.NewIBMPIPlacementGroupClient(ctx, sess, cloudInstanceID)
 	groups, err := client.GetAll()
 	if err != nil {
-		log.Printf("[ERROR] get all placement groups failed %v", err)
-		return diag.FromErr(err)
+		tfErr := flex.TerraformErrorf(err, fmt.Sprintf("GetAll failed: %s", err.Error()), "(Data) ibm_pi_placement_groups", "read")
+		log.Printf("[DEBUG]\n%s", tfErr.GetDebugMessage())
+		return tfErr.GetDiag()
 	}
 
-	result := make([]map[string]interface{}, 0, len(groups.PlacementGroups))
+	result := make([]map[string]any, 0, len(groups.PlacementGroups))
 	for _, placementGroup := range groups.PlacementGroups {
-		key := map[string]interface{}{
+		key := map[string]any{
 			Attr_ID:      placementGroup.ID,
 			Attr_Members: placementGroup.Members,
 			Attr_Name:    placementGroup.Name,

ibm/service/power/data_source_ibm_pi_placement_groups_test.go

@@ -11,13 +11,13 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 )
 
-func TestAccIBMPIPlacementGrousDataSourceBasic(t *testing.T) {
+func TestAccIBMPIPlacementGroupsDataSourceBasic(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck:  func() { acc.TestAccPreCheck(t) },
 		Providers: acc.TestAccProviders,
 		Steps: []resource.TestStep{
 			{
-				Config: testAccCheckIBMPIPlacementGrousDataSourceConfig(),
+				Config: testAccCheckIBMPIPlacementGroupsDataSourceConfig(),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttrSet("data.ibm_pi_placement_groups.test", "id"),
 				),
@@ -26,7 +26,7 @@ func TestAccIBMPIPlacementGrousDataSourceBasic(t *testing.T) {
 	})
 }
 
-func testAccCheckIBMPIPlacementGrousDataSourceConfig() string {
+func testAccCheckIBMPIPlacementGroupsDataSourceConfig() string {
 	return fmt.Sprintf(`
 		data "ibm_pi_placement_groups" "test" {
 			pi_cloud_instance_id = "%s"

website/docs/d/pi_placement_group.html.markdown

@@ -14,8 +14,8 @@ Retrieve information about a placement group. For more information, about placem
 
 ```terraform
 data "ibm_pi_placement_group" "ds_placement_group" {
-  pi_placement_group_name   = "my-pg"
-  pi_cloud_instance_id = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
+  pi_cloud_instance_id      = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
+  pi_placement_group_id     = "7f8e2a9d-3b4c-4e4f-8e8d-f7e7e1e23456"
 }
 ```
 
@@ -40,7 +40,8 @@ Example usage:
 Review the argument references that you can specify for your data source.
 
 - `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
-- `pi_placement_group_name` - (Required, String) The name of the placement group.
+- `pi_placement_group_id` - (Optional, String) The placement group ID.
+- `pi_placement_group_name` - (Deprecated, Optional, String) The id of the placement group. Passing the name of the placement group could fail or fetch stale data. Please pass an id and use `pi_placement_group_id` instead.
 
 ## Attribute Reference
 
@@ -49,5 +50,6 @@ In addition to all argument reference list, you can access the following attribu
 - `crn` - (String) The CRN of this resource.
 - `id` - (String) The ID of the placement group.
 - `members` - (List) List of server instances IDs that are members of the placement group.
+- `name` - (String) The name of the placement group.
 - `policy` - (String) The value of the group's affinity policy. Valid values are affinity and anti-affinity.
 - `user_tags` - (List) List of user tags attached to the resource.

website/docs/d/pi_placement_groups.html.markdown

@@ -10,7 +10,7 @@ description: |-
 
 Retrieve information about all placement groups. For more information, see [getting started with IBM Power Systems Virtual Servers](https://cloud.ibm.com/docs/power-iaas?topic=power-iaas-getting-started).
 
-## Example usage
+## Example Usage
 
 ```terraform
 data "ibm_pi_placement_groups" "example" {