Fix instance data sources to use id (IBM-Cloud#6506)

* Deprecate Arg_InstanceName for Arg_InstanceID

* Update documentation

* Add ibm_pi_instance_ip data source

* Deprecate Arg_InstanceName for Arg_InstanceID

Update documentation

Add ibm_pi_instance_ip data source

Remove non zero check

* Fix placement of deprecation message and remove zero validation check

Author: ismirlia

ibm/acctest/acctest.go

@@ -237,6 +237,7 @@ var (
 	Pi_image_bucket_region            string
 	Pi_image_bucket_secret_key        string
 	Pi_image_id                       string
+	Pi_instance_id                    string
 	Pi_instance_name                  string
 	Pi_key_name                       string
 	Pi_network_address_group_id       string
@@ -1324,10 +1325,16 @@ func init() {
 		fmt.Println("[INFO] Set the environment variable PI_SNAPSHOT_ID for testing ibm_pi_instance_snapshot data source else it is set to default value '1ea33118-4c43-4356-bfce-904d0658de82'")
 	}
 
-	Pi_instance_name = os.Getenv("PI_PVM_INSTANCE_NAME")
+	Pi_instance_id = os.Getenv("PI_INSTANCE_ID")
+	if Pi_instance_id == "" {
+		Pi_instance_id = "terraform-test-power"
+		fmt.Println("[INFO] Set the environment variable PI_INSTANCE_ID for testing ibm_pi_instance resource else it is set to default value 'terraform-test-power'")
+	}
+
+	Pi_instance_name = os.Getenv("PI_INSTANCE_NAME")
 	if Pi_instance_name == "" {
 		Pi_instance_name = "terraform-test-power"
-		fmt.Println("[INFO] Set the environment variable PI_PVM_INSTANCE_ID for testing Pi_instance_name resource else it is set to default value 'terraform-test-power'")
+		fmt.Println("[INFO] Set the environment variable PI_INSTANCE_NAME for testing ibm_pi_instance resource else it is set to default value 'terraform-test-power'")
 	}
 
 	Pi_dhcp_id = os.Getenv("PI_DHCP_ID")

ibm/service/power/data_source_ibm_pi_instance.go

@@ -27,11 +27,20 @@ func DataSourceIBMPIInstance() *schema.Resource {
 				Type:         schema.TypeString,
 				ValidateFunc: validation.NoZeroValues,
 			},
+			Arg_InstanceID: {
+				AtLeastOneOf:  []string{Arg_InstanceID, Arg_InstanceName},
+				ConflictsWith: []string{Arg_InstanceName},
+				Description:   "The ID of the PVM instance.",
+				Optional:      true,
+				Type:          schema.TypeString,
+			},
 			Arg_InstanceName: {
-				Description:  "The unique identifier or name of the instance.",
-				Required:     true,
-				Type:         schema.TypeString,
-				ValidateFunc: validation.NoZeroValues,
+				AtLeastOneOf:  []string{Arg_InstanceID, Arg_InstanceName},
+				ConflictsWith: []string{Arg_InstanceID},
+				Deprecated:    "The pi_instance_name field is deprecated. Please use pi_instance_id instead",
+				Description:   "The name of the PVM instance.",
+				Optional:      true,
+				Type:          schema.TypeString,
 			},
 
 			// Attributes
@@ -301,9 +310,15 @@ func dataSourceIBMPIInstancesRead(ctx context.Context, d *schema.ResourceData, m
 	}
 
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
+	var instanceID string
+	if v, ok := d.GetOk(Arg_InstanceID); ok {
+		instanceID = v.(string)
+	} else if v, ok := d.GetOk(Arg_InstanceName); ok {
+		instanceID = v.(string)
+	}
 
 	powerC := instance.NewIBMPIInstanceClient(ctx, sess, cloudInstanceID)
-	powervmdata, err := powerC.Get(d.Get(Arg_InstanceName).(string))
+	powervmdata, err := powerC.Get(instanceID)
 	if err != nil {
 		tfErr := flex.TerraformErrorf(err, fmt.Sprintf("Get failed: %s", err.Error()), "(Data) ibm_pi_instance", "read")
 		log.Printf("[DEBUG]\n%s", tfErr.GetDebugMessage())

ibm/service/power/data_source_ibm_pi_instance_console_languages.go

@@ -29,11 +29,20 @@ func DataSourceIBMPIInstanceConsoleLanguages() *schema.Resource {
 				Type:         schema.TypeString,
 				ValidateFunc: validation.NoZeroValues,
 			},
+			Arg_InstanceID: {
+				AtLeastOneOf:  []string{Arg_InstanceID, Arg_InstanceName},
+				ConflictsWith: []string{Arg_InstanceName},
+				Description:   "The ID of the PVM instance.",
+				Optional:      true,
+				Type:          schema.TypeString,
+			},
 			Arg_InstanceName: {
-				Description:  "The unique identifier or name of the instance.",
-				Required:     true,
-				Type:         schema.TypeString,
-				ValidateFunc: validation.NoZeroValues,
+				AtLeastOneOf:  []string{Arg_InstanceID, Arg_InstanceName},
+				ConflictsWith: []string{Arg_InstanceID},
+				Deprecated:    "The pi_instance_name field is deprecated. Please use pi_instance_id instead",
+				Description:   "The name of the PVM instance.",
+				Optional:      true,
+				Type:          schema.TypeString,
 			},
 
 			// Attributes
@@ -69,10 +78,15 @@ func dataSourceIBMPIInstanceConsoleLanguagesRead(ctx context.Context, d *schema.
 	}
 
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
-	instanceName := d.Get(Arg_InstanceName).(string)
+	var instanceID string
+	if v, ok := d.GetOk(Arg_InstanceID); ok {
+		instanceID = v.(string)
+	} else if v, ok := d.GetOk(Arg_InstanceName); ok {
+		instanceID = v.(string)
+	}
 
 	client := instance.NewIBMPIInstanceClient(ctx, sess, cloudInstanceID)
-	languages, err := client.GetConsoleLanguages(instanceName)
+	languages, err := client.GetConsoleLanguages(instanceID)
 	if err != nil {
 		tfErr := flex.TerraformErrorf(err, fmt.Sprintf("GetConsoleLanguages failed: %s", err.Error()), "(Data) ibm_pi_instance_console_languages", "read")
 		log.Printf("[DEBUG]\n%s", tfErr.GetDebugMessage())

ibm/service/power/data_source_ibm_pi_instance_console_languages_test.go

@@ -31,7 +31,7 @@ func TestAccIBMPIInstanceConsoleLanguages(t *testing.T) {
 func testAccCheckIBMPIInstanceConsoleLanguagesConfig() string {
 	return fmt.Sprintf(`
 		data "ibm_pi_console_languages" "example" {
-			pi_cloud_instance_id = "%s"
-			pi_instance_name     = "%s"
-		}`, acc.Pi_cloud_instance_id, acc.Pi_instance_name)
+			pi_cloud_instance_id = "%[1]s"
+			pi_instance_id       = "%[2]s"
+		}`, acc.Pi_cloud_instance_id, acc.Pi_instance_id)
 }

ibm/service/power/data_source_ibm_pi_instance_ip.go

@@ -29,11 +29,20 @@ func DataSourceIBMPIInstanceIP() *schema.Resource {
 				Type:         schema.TypeString,
 				ValidateFunc: validation.NoZeroValues,
 			},
+			Arg_InstanceID: {
+				AtLeastOneOf:  []string{Arg_InstanceID, Arg_InstanceName},
+				ConflictsWith: []string{Arg_InstanceName},
+				Description:   "The ID of the PVM instance.",
+				Optional:      true,
+				Type:          schema.TypeString,
+			},
 			Arg_InstanceName: {
-				Description:  "The unique identifier or name of the instance.",
-				Required:     true,
-				Type:         schema.TypeString,
-				ValidateFunc: validation.NoZeroValues,
+				AtLeastOneOf:  []string{Arg_InstanceID, Arg_InstanceName},
+				ConflictsWith: []string{Arg_InstanceID},
+				Deprecated:    "The pi_instance_name field is deprecated. Please use pi_instance_id instead",
+				Description:   "The name of the PVM instance.",
+				Optional:      true,
+				Type:          schema.TypeString,
 			},
 			Arg_NetworkName: {
 				Description:  "The subnet that the instance belongs to.",
@@ -109,10 +118,16 @@ func dataSourceIBMPIInstancesIPRead(ctx context.Context, d *schema.ResourceData,
 	}
 
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
+	var instanceID string
+	if v, ok := d.GetOk(Arg_InstanceID); ok {
+		instanceID = v.(string)
+	} else if v, ok := d.GetOk(Arg_InstanceName); ok {
+		instanceID = v.(string)
+	}
 	networkName := d.Get(Arg_NetworkName).(string)
 	powerC := instance.NewIBMPIInstanceClient(ctx, sess, cloudInstanceID)
 
-	powervmdata, err := powerC.Get(d.Get(Arg_InstanceName).(string))
+	powervmdata, err := powerC.Get(instanceID)
 	if err != nil {
 		tfErr := flex.TerraformErrorf(err, fmt.Sprintf("Get failed: %s", err.Error()), "(Data) ibm_pi_instance_ip", "read")
 		log.Printf("[DEBUG]\n%s", tfErr.GetDebugMessage())

ibm/service/power/data_source_ibm_pi_instance_ip_test.go

@@ -30,8 +30,8 @@ func TestAccIBMPIInstanceIPDataSource_basic(t *testing.T) {
 func testAccCheckIBMPIInstanceIPDataSourceConfig() string {
 	return fmt.Sprintf(`
 		data "ibm_pi_instance_ip" "testacc_ds_instance_ip" {
-			pi_network_name = "%[1]s"
-			pi_instance_name = "%[2]s"
-			pi_cloud_instance_id = "%[3]s"
-		}`, acc.Pi_network_name, acc.Pi_instance_name, acc.Pi_cloud_instance_id)
+			pi_cloud_instance_id = "%[1]s"
+			pi_instance_id       = "%[2]s"
+			pi_network_name      = "%[3]s"
+		}`, acc.Pi_cloud_instance_id, acc.Pi_instance_id, acc.Pi_network_name)
 }

ibm/service/power/data_source_ibm_pi_instance_test.go

@@ -31,7 +31,7 @@ func TestAccIBMPIInstanceDataSource_basic(t *testing.T) {
 func testAccCheckIBMPIInstanceDataSourceConfig() string {
 	return fmt.Sprintf(`
 		data "ibm_pi_instance" "testacc_ds_instance" {
-			pi_instance_name="%s"
-			pi_cloud_instance_id = "%s"
-		}`, acc.Pi_instance_name, acc.Pi_cloud_instance_id)
+			pi_cloud_instance_id = "%[1]s"
+			pi_instance_id       = "%[2]s"
+		}`, acc.Pi_cloud_instance_id, acc.Pi_instance_id)
 }