[Refactor] Volume Onboarding

go.sum

@@ -138,8 +138,6 @@ github.com/IBM/container-registry-go-sdk v1.1.0 h1:sYyknIod8R4RJZQqAheiduP6wbSTp
 github.com/IBM/container-registry-go-sdk v1.1.0/go.mod h1:4TwsCnQtVfZ4Vkapy/KPvQBKFc3VOyUZYkwRU4FTPrs=
 github.com/IBM/continuous-delivery-go-sdk v1.6.0 h1:eAL/jIWHrDFlWDF+Qd9Y5UN99Pr5Mjd/H/bvTbXUbz4=
 github.com/IBM/continuous-delivery-go-sdk v1.6.0/go.mod h1:nZdKUnubXNLo+zo28R4Rd+TGDqiJ/xoE8WO/A3kLw1E=
-github.com/IBM/event-notifications-go-admin-sdk v0.8.0 h1:xk2CYTayQtKi6LSgGGFRxFJfWUxyM5SY8Rs64ducAhw=
-github.com/IBM/event-notifications-go-admin-sdk v0.8.0/go.mod h1:OByvqfrNVxs7G6ggv8pwQCEVw10/TBJCLh7NM3z707w=
 github.com/IBM/event-notifications-go-admin-sdk v0.9.0 h1:eaCd+GkxhNyot+8rA9WkAQdlVYrRD20LYiXjEytFO6M=
 github.com/IBM/event-notifications-go-admin-sdk v0.9.0/go.mod h1:OByvqfrNVxs7G6ggv8pwQCEVw10/TBJCLh7NM3z707w=
 github.com/IBM/eventstreams-go-sdk v1.4.0 h1:yS/Ns29sBOe8W2tynQmz9HTKqQZ0ckse4Py5Oy/F2rM=
@@ -187,8 +185,6 @@ github.com/IBM/scc-go-sdk/v5 v5.4.1 h1:RXIuxOo9/hxkWyHCI69ae+KIJgSbXcAkJwTEl+fO3
 github.com/IBM/scc-go-sdk/v5 v5.4.1/go.mod h1:2xQTDgNXG5QMEfQxBDKB067z+5ha6OgcaKCTcdGDAo8=
 github.com/IBM/schematics-go-sdk v0.2.3 h1:lgTt0Sbudii3cuSk1YSQgrtiZAXDbBABAoVj3eQuBrU=
 github.com/IBM/schematics-go-sdk v0.2.3/go.mod h1:Tw2OSAPdpC69AxcwoyqcYYaGTTW6YpERF9uNEU+BFRQ=
-github.com/IBM/secrets-manager-go-sdk/v2 v2.0.5 h1:VMc/Zd6RzB8j60CqZekkwYT2wQsCfrkGV2n01Gviuaw=
-github.com/IBM/secrets-manager-go-sdk/v2 v2.0.5/go.mod h1:5kUgJ1dG9cdiAcPDqVz46m362bPnoqZQSth24NiowSg=
 github.com/IBM/secrets-manager-go-sdk/v2 v2.0.6 h1:bF6bAdI4wDZSje6+Yx1mJxvirboxO+uMuKhzgfRCNxE=
 github.com/IBM/secrets-manager-go-sdk/v2 v2.0.6/go.mod h1:XWYnbcc5vN1RnKwk/fCzfD8aZd7At/Y1/b6c+oDyliU=
 github.com/IBM/vmware-go-sdk v0.1.2 h1:5lKWFyInWz9e2hwGsoFTEoLa1jYkD30SReN0fQ10w9M=

ibm/service/power/ibm_pi_constants.go

@@ -10,6 +10,8 @@ const (
 	Arg_AffinityVolume                      = "pi_affinity_volume"
 	Arg_AntiAffinityInstances               = "pi_anti_affinity_instances"
 	Arg_AntiAffinityVolumes                 = "pi_anti_affinity_volumes"
+	Arg_AuxiliaryVolumeName                 = "pi_auxiliary_volume_name"
+	Arg_AuxiliaryVolumes                    = "pi_auxiliary_volumes"
 	Arg_Cidr                                = "pi_cidr"
 	Arg_CloudConnectionID                   = "pi_cloud_connection_id"
 	Arg_CloudConnectionName                 = "pi_cloud_connection_name"
@@ -23,6 +25,7 @@ const (
 	Arg_DhcpID                              = "pi_dhcp_id"
 	Arg_DhcpName                            = "pi_dhcp_name"
 	Arg_DhcpSnatEnabled                     = "pi_dhcp_snat_enabled"
+	Arg_DisplayName                         = "pi_display_name"
 	Arg_DnsServer                           = "pi_dns_server"
 	Arg_HealthStatus                        = "pi_health_status"
 	Arg_Host                                = "pi_host"
@@ -46,6 +49,7 @@ const (
 	Arg_Name                                = "pi_name"
 	Arg_Network                             = "pi_network"
 	Arg_NetworkName                         = "pi_network_name"
+	Arg_OnboardingVolumes                   = "pi_onboarding_volumes"
 	Arg_PinPolicy                           = "pi_pin_policy"
 	Arg_PlacementGroupID                    = "pi_placement_group_id"
 	Arg_PlacementGroupName                  = "pi_placement_group_name"
@@ -74,6 +78,7 @@ const (
 	Arg_SharedProcessorPoolReservedCores    = "pi_shared_processor_pool_reserved_cores"
 	Arg_SnapshotID                          = "pi_snapshot_id"
 	Arg_SnapShotName                        = "pi_snap_shot_name"
+	Arg_SourceCRN                           = "pi_source_crn"
 	Arg_SPPPlacementGroupID                 = "pi_spp_placement_group_id"
 	Arg_SPPPlacementGroupName               = "pi_spp_placement_group_name"
 	Arg_SPPPlacementGroupPolicy             = "pi_spp_placement_group_policy"
@@ -101,10 +106,6 @@ const (
 	Arg_VolumeType                          = "pi_volume_type"
 	Arg_VTL                                 = "vtl"
 
-	// Duplicate Arguments, will be removed as refactoring take course.
-	PIVolumeGroupID      = "pi_volume_group_id"
-	PIVolumeOnboardingID = "pi_volume_onboarding_id"
-
 	// Attributes
 	Attr_Access                                      = "access"
 	Attr_AccessConfig                                = "access_config"
@@ -261,6 +262,7 @@ const (
 	Attr_NetworkPorts                                = "network_ports"
 	Attr_Networks                                    = "networks"
 	Attr_NumberOfVolumes                             = "number_of_volumes"
+	Attr_OnboardingID                                = "onboarding_id"
 	Attr_Onboardings                                 = "onboardings"
 	Attr_OperatingSystem                             = "operating_system"
 	Attr_OSType                                      = "os_type"
@@ -514,6 +516,7 @@ const (
 	PITargetStorageTier = "pi_target_storage_tier"
 
 	// IBM PI Volume Group
+	PIVolumeGroupID                   = "pi_volume_group_id"
 	PIVolumeGroupName                 = "pi_volume_group_name"
 	PIVolumeGroupConsistencyGroupName = "pi_consistency_group_name"
 	PIVolumeGroupAction               = "pi_volume_group_action"

ibm/service/power/resource_ibm_pi_volume_onboarding.go

@@ -8,23 +8,13 @@ import (
 	"fmt"
 	"time"
 
-	st "github.com/IBM-Cloud/power-go-client/clients/instance"
-	"github.com/IBM-Cloud/power-go-client/helpers"
+	"github.com/IBM-Cloud/power-go-client/clients/instance"
 	"github.com/IBM-Cloud/power-go-client/power/models"
 	"github.com/IBM-Cloud/terraform-provider-ibm/ibm/conns"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-const (
-	piOnboardingVolumes   = "pi_onboarding_volumes"
-	piAuxiliaryVolumes    = "pi_auxiliary_volumes"
-	piAuxiliaryVolumeName = "pi_auxiliary_volume_name"
-	piSourceCRN           = "pi_source_crn"
-	piDisplayName         = "pi_display_name"
-	piDescription         = "pi_description"
-)
-
 func ResourceIBMPIVolumeOnboarding() *schema.Resource {
 	return &schema.Resource{
 		CreateContext: resourceIBMPIVolumeOnboardingCreate,
@@ -38,105 +28,108 @@ func ResourceIBMPIVolumeOnboarding() *schema.Resource {
 		},
 
 		Schema: map[string]*schema.Schema{
-
-			helpers.PICloudInstanceId: {
-				Type:        schema.TypeString,
-				Required:    true,
+			// Arguments
+			Arg_CloudInstanceID: {
+				Description: "The GUID of the service instance associated with an account.",
 				ForceNew:    true,
-				Description: "Cloud Instance ID - This is the service_instance_id.",
+				Required:    true,
+				Type:        schema.TypeString,
 			},
-
-			piOnboardingVolumes: {
-				Type:     schema.TypeList,
-				Required: true,
-				ForceNew: true,
-				MinItems: 1,
+			Arg_Description: {
+				Computed:    true,
+				Description: "Description of the volume onboarding operation",
+				Optional:    true,
+				Type:        schema.TypeString,
+			},
+			Arg_OnboardingVolumes: {
+				Description: "List of onboarding volumes.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
-						piSourceCRN: {
-							Type:        schema.TypeString,
-							Required:    true,
-							Description: "CRN of source ServiceBroker instance from where auxiliary volumes need to be onboarded",
-						},
-						piAuxiliaryVolumes: {
-							Type:     schema.TypeList,
-							Optional: true,
-							MinItems: 1,
+						Arg_AuxiliaryVolumes: {
+							Description: "List auxiliary volumes.",
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
-									piAuxiliaryVolumeName: {
-										Type:        schema.TypeString,
+									Arg_AuxiliaryVolumeName: {
+										Description: "The auxiliary volume name.",
 										Required:    true,
-										Description: "Auxiliary volume name at storage host level",
-									},
-									piDisplayName: {
 										Type:        schema.TypeString,
+									},
+									Arg_DisplayName: {
+										Description: "The display name of auxiliary volume which is to be onboarded.",
 										Optional:    true,
-										Description: "Display name of auxVolumeName once onboarded,auxVolumeName will be set to display name if not provided.",
+										Type:        schema.TypeString,
 									},
 								},
 							},
+							MinItems: 1,
+							Optional: true,
+							Type:     schema.TypeList,
+						},
+						Arg_SourceCRN: {
+							Description: "The crn of source service broker instance from where auxiliary volumes need to be onboarded.",
+							Required:    true,
+							Type:        schema.TypeString,
 						},
 					},
 				},
-			},
-			piDescription: {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Computed:    true,
-				Description: "Description of the volume onboarding operation",
+				ForceNew: true,
+				MinItems: 1,
+				Required: true,
+				Type:     schema.TypeList,
 			},
 
-			// Computed Attribute
-			"create_time": {
-				Type:        schema.TypeString,
+			// Attributes
+			Attr_CreateTime: {
 				Computed:    true,
-				Description: "Indicates the create-time of volume onboarding operation",
-			},
-			"onboarding_id": {
+				Description: "The create time of volume onboarding operation.",
 				Type:        schema.TypeString,
-				Computed:    true,
-				Description: "Indicates the volume onboarding operation id",
 			},
-			"input_volumes": {
-				Type:        schema.TypeList,
+			Attr_InputVolumes: {
 				Computed:    true,
-				Description: "List of volumes requested to be onboarded",
+				Description: "List of volumes requested to be onboarded.",
 				Elem:        &schema.Schema{Type: schema.TypeString},
+				Type:        schema.TypeList,
 			},
-			"progress": {
-				Type:        schema.TypeFloat,
+			Attr_OnboardingID: {
 				Computed:    true,
-				Description: "Indicates the progress of volume onboarding operation",
+				Description: "The volume onboarding ID.",
+				Type:        schema.TypeString,
 			},
-			"results_onboarded_volumes": {
-				Type:        schema.TypeList,
+			Attr_Progress: {
+				Computed:    true,
+				Description: "The progress of volume onboarding operation.",
+				Type:        schema.TypeFloat,
+			},
+			Attr_ResultsOnboardedVolumes: {
 				Computed:    true,
-				Description: "List of volumes which are onboarded successfully",
+				Description: "List of volumes which are onboarded successfully.",
 				Elem:        &schema.Schema{Type: schema.TypeString},
+				Type:        schema.TypeList,
 			},
-			"results_volume_onboarding_failures": {
-				Type:     schema.TypeList,
-				Computed: true,
+			Attr_ResultsVolumeOnboardingFailures: {
+				Computed:    true,
+				Description: "The volume onboarding failure details.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
-						"failure_message": {
-							Type:        schema.TypeString,
+						Attr_FailureMessage: {
 							Computed:    true,
 							Description: "The failure reason for the volumes which have failed to be onboarded",
+							Type:        schema.TypeString,
 						},
-						"volumes": {
-							Type:        schema.TypeList,
+						Attr_Volumes: {
 							Computed:    true,
 							Description: "List of volumes which have failed to be onboarded",
 							Elem:        &schema.Schema{Type: schema.TypeString},
+							Type:        schema.TypeList,
 						},
-					}},
+					},
+				},
+				Type: schema.TypeList,
 			},
-			"status": {
-				Type:        schema.TypeString,
+			Attr_Status: {
 				Computed:    true,
-				Description: "Indicates the status of volume onboarding operation",
+				Description: "The status of volume onboarding operation.",
+				Type:        schema.TypeString,
 			},
 		},
 	}
@@ -147,10 +140,10 @@ func resourceIBMPIVolumeOnboardingCreate(ctx context.Context, d *schema.Resource
 	if err != nil {
 		return diag.FromErr(err)
 	}
-	cloudInstanceID := d.Get(helpers.PICloudInstanceId).(string)
-	client := st.NewIBMPIVolumeOnboardingClient(ctx, sess, cloudInstanceID)
+	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
+	client := instance.NewIBMPIVolumeOnboardingClient(ctx, sess, cloudInstanceID)
 
-	vol, err := expandCreateVolumeOnboarding(d.Get(piOnboardingVolumes).([]interface{}))
+	vol, err := expandCreateVolumeOnboarding(d.Get(Arg_OnboardingVolumes).([]interface{}))
 	if err != nil {
 		return diag.FromErr(err)
 	}
@@ -159,7 +152,7 @@ func resourceIBMPIVolumeOnboardingCreate(ctx context.Context, d *schema.Resource
 		Volumes: vol,
 	}
 
-	if v, ok := d.GetOk(piDescription); ok {
+	if v, ok := d.GetOk(Arg_Description); ok {
 		body.Description = v.(string)
 	}
 
@@ -184,21 +177,21 @@ func resourceIBMPIVolumeOnboardingRead(ctx context.Context, d *schema.ResourceDa
 		return diag.FromErr(err)
 	}
 
-	client := st.NewIBMPIVolumeOnboardingClient(ctx, sess, cloudInstanceID)
+	client := instance.NewIBMPIVolumeOnboardingClient(ctx, sess, cloudInstanceID)
 
 	onboardingData, err := client.Get(onboardingID)
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
-	d.Set("onboarding_id", *onboardingData.ID)
-	d.Set("create_time", onboardingData.CreationTimestamp.String())
-	d.Set(piDescription, onboardingData.Description)
-	d.Set("input_volumes", onboardingData.InputVolumes)
-	d.Set("progress", onboardingData.Progress)
-	d.Set("status", onboardingData.Status)
-	d.Set("results_onboarded_volumes", onboardingData.Results.OnboardedVolumes)
-	d.Set("results_volume_onboarding_failures", flattenVolumeOnboardingFailures(onboardingData.Results.VolumeOnboardingFailures))
+	d.Set(Arg_Description, onboardingData.Description)
+	d.Set(Attr_CreateTime, onboardingData.CreationTimestamp.String())
+	d.Set(Attr_InputVolumes, onboardingData.InputVolumes)
+	d.Set(Attr_OnboardingID, *onboardingData.ID)
+	d.Set(Attr_Progress, onboardingData.Progress)
+	d.Set(Attr_ResultsOnboardedVolumes, onboardingData.Results.OnboardedVolumes)
+	d.Set(Attr_ResultsVolumeOnboardingFailures, flattenVolumeOnboardingFailures(onboardingData.Results.VolumeOnboardingFailures))
+	d.Set(Attr_Status, onboardingData.Status)
 	return nil
 }
 
@@ -247,12 +240,12 @@ func expandAuxiliaryVolumeForOnboarding(data []interface{}) []*models.AuxiliaryV
 		var auxVolumeName, displayName string
 		resource := d.(map[string]interface{})
 
-		if v, ok := resource["pi_auxiliary_volume_name"]; ok && v != "" {
-			auxVolumeName = resource["pi_auxiliary_volume_name"].(string)
+		if v, ok := resource[Arg_AuxiliaryVolumeName]; ok && v != "" {
+			auxVolumeName = resource[Arg_AuxiliaryVolumeName].(string)
 		}
 
-		if v, ok := resource["pi_display_name"]; ok && v != "" {
-			displayName = resource["pi_display_name"].(string)
+		if v, ok := resource[Arg_DisplayName]; ok && v != "" {
+			displayName = resource[Arg_DisplayName].(string)
 		}
 
 		auxVolumeForOnboarding = append(auxVolumeForOnboarding, &models.AuxiliaryVolumeForOnboarding{

ibm/service/power/resource_ibm_pi_volume_onboarding_test.go

@@ -82,6 +82,5 @@ func testAccCheckIBMPIVolumeOnboardingConfig(name string) string {
 				pi_display_name = "%[2]s-1"
 			}
 		}
-	  }
-	`, acc.Pi_cloud_instance_id, name, acc.Pi_volume_onboarding_source_crn, acc.Pi_auxiliary_volume_name)
+	}`, acc.Pi_cloud_instance_id, name, acc.Pi_volume_onboarding_source_crn, acc.Pi_auxiliary_volume_name)
 }