[Resource] [Datasource] Replace SSH Key API with new API (IBM-Cloud#6375)

* [Resource] [Datasource] Replace SSH Key API with new API

* Fix deprecation message

* Update and tidy documentation

* Tidy code and update unit-tests with new default

---------

Co-authored-by: Alexander Kita <[email protected]>

Author: ismirlia

ibm/service/power/data_source_ibm_pi_key.go

@@ -38,12 +38,37 @@ func DataSourceIBMPIKey() *schema.Resource {
 				Description: "Date of SSH Key creation.",
 				Type:        schema.TypeString,
 			},
+			Attr_Description: {
+				Computed:    true,
+				Description: "Description of the ssh key.",
+				Type:        schema.TypeString,
+			},
+			Attr_KeyName: {
+				Computed:    true,
+				Description: "Name of SSH key.",
+				Type:        schema.TypeString,
+			},
+			Attr_PrimaryWorkspace: {
+				Computed:    true,
+				Description: "Indicates if the current workspace owns the ssh key or not.",
+				Type:        schema.TypeBool,
+			},
 			Attr_SSHKey: {
 				Computed:    true,
 				Description: "SSH RSA key.",
 				Sensitive:   true,
 				Type:        schema.TypeString,
 			},
+			Attr_SSHKeyID: {
+				Computed:    true,
+				Description: "Unique ID of SSH key.",
+				Type:        schema.TypeString,
+			},
+			Attr_Visibility: {
+				Computed:    true,
+				Description: "Visibility of the ssh key.",
+				Type:        schema.TypeString,
+			},
 		},
 	}
 }
@@ -56,15 +81,20 @@ func dataSourceIBMPIKeyRead(ctx context.Context, d *schema.ResourceData, meta in
 
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
 
-	sshkeyC := instance.NewIBMPIKeyClient(ctx, sess, cloudInstanceID)
+	sshkeyC := instance.NewIBMPISSHKeyClient(ctx, sess, cloudInstanceID)
 	sshkeydata, err := sshkeyC.Get(d.Get(helpers.PIKeyName).(string))
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
 	d.SetId(*sshkeydata.Name)
 	d.Set(Attr_CreationDate, sshkeydata.CreationDate.String())
+	d.Set(Attr_Description, sshkeydata.Description)
+	d.Set(Attr_KeyName, sshkeydata.Name)
+	d.Set(Attr_PrimaryWorkspace, sshkeydata.PrimaryWorkspace)
 	d.Set(Attr_SSHKey, sshkeydata.SSHKey)
+	d.Set(Attr_SSHKeyID, sshkeydata.ID)
+	d.Set(Attr_Visibility, sshkeydata.Visibility)
 
 	return nil
 }

ibm/service/power/data_source_ibm_pi_keys.go

@@ -38,16 +38,36 @@ func DataSourceIBMPIKeys() *schema.Resource {
 							Description: "Date of SSH key creation.",
 							Type:        schema.TypeString,
 						},
+						Attr_Description: {
+							Computed:    true,
+							Description: "Description of the ssh key.",
+							Type:        schema.TypeString,
+						},
 						Attr_Name: {
 							Computed:    true,
 							Description: "User defined name for the SSH key.",
 							Type:        schema.TypeString,
 						},
+						Attr_PrimaryWorkspace: {
+							Computed:    true,
+							Description: "Indicates if the current workspace owns the ssh key or not.",
+							Type:        schema.TypeBool,
+						},
 						Attr_SSHKey: {
 							Computed:    true,
 							Description: "SSH RSA key.",
 							Type:        schema.TypeString,
 						},
+						Attr_SSHKeyID: {
+							Computed:    true,
+							Description: "Unique ID of SSH key.",
+							Type:        schema.TypeString,
+						},
+						Attr_Visibility: {
+							Computed:    true,
+							Description: "Visibility of the ssh key.",
+							Type:        schema.TypeString,
+						},
 					},
 				},
 				Type: schema.TypeList,
@@ -64,7 +84,7 @@ func dataSourceIBMPIKeysRead(ctx context.Context, d *schema.ResourceData, meta i
 
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
 
-	client := instance.NewIBMPIKeyClient(ctx, sess, cloudInstanceID)
+	client := instance.NewIBMPISSHKeyClient(ctx, sess, cloudInstanceID)
 	sshKeys, err := client.GetAll()
 	if err != nil {
 		log.Printf("[ERROR] get all keys failed %v", err)
@@ -74,9 +94,13 @@ func dataSourceIBMPIKeysRead(ctx context.Context, d *schema.ResourceData, meta i
 	result := make([]map[string]interface{}, 0, len(sshKeys.SSHKeys))
 	for _, sshKey := range sshKeys.SSHKeys {
 		key := map[string]interface{}{
-			Attr_CreationDate: sshKey.CreationDate.String(),
-			Attr_Name:         sshKey.Name,
-			Attr_SSHKey:       sshKey.SSHKey,
+			Attr_CreationDate:     sshKey.CreationDate.String(),
+			Attr_Description:      sshKey.Description,
+			Attr_Name:             sshKey.Name,
+			Attr_PrimaryWorkspace: sshKey.PrimaryWorkspace,
+			Attr_SSHKey:           sshKey.SSHKey,
+			Attr_SSHKeyID:         sshKey.ID,
+			Attr_Visibility:       sshKey.Visibility,
 		}
 		result = append(result, key)
 	}

ibm/service/power/ibm_pi_constants.go

@@ -158,6 +158,7 @@ const (
 	Arg_VirtualCoresAssigned                 = "pi_virtual_cores_assigned"
 	Arg_VirtualOpticalDevice                 = "pi_virtual_optical_device"
 	Arg_VirtualSerialNumber                  = "pi_virtual_serial_number"
+	Arg_Visibility                           = "pi_visibility"
 	Arg_VolumeCloneName                      = "pi_volume_clone_name"
 	Arg_VolumeCloneTaskID                    = "pi_volume_clone_task_id"
 	Arg_VolumeGroupAction                    = "pi_volume_group_action"
@@ -389,6 +390,7 @@ const (
 	Attr_PowerEdgeRouter                 = "power_edge_router"
 	Attr_Primary                         = "primary"
 	Attr_PrimaryRole                     = "primary_role"
+	Attr_PrimaryWorkspace                = "primary_workspace"
 	Attr_Processors                      = "processors"
 	Attr_ProcType                        = "proctype"
 	Attr_Product                         = "product"
@@ -446,6 +448,7 @@ const (
 	Attr_SPPPlacementGroupPolicy         = "policy"
 	Attr_SPPPlacementGroups              = "spp_placement_groups"
 	Attr_SSHKey                          = "ssh_key"
+	Attr_SSHKeyID                        = "ssh_key_id"
 	Attr_Start                           = "start"
 	Attr_StartTime                       = "start_time"
 	Attr_State                           = "state"
@@ -497,6 +500,7 @@ const (
 	Attr_VirtualCoresAssigned            = "virtual_cores_assigned"
 	Attr_VirtualSerialNumber             = "virtual_serial_number"
 	Attr_VirtualSerialNumbers            = "virtual_serial_numbers"
+	Attr_Visibility                      = "visibility"
 	Attr_VLanID                          = "vlan_id"
 	Attr_VolumeGroupID                   = "volume_group_id"
 	Attr_VolumeGroupName                 = "volume_group_name"
@@ -528,6 +532,7 @@ const (
 	StockVTL = "stock-vtl"
 
 	// Allowed Values
+	Account                   = "account"
 	Affinity                  = "affinity"
 	All                       = "all"
 	Allow                     = "allow"
@@ -591,6 +596,7 @@ const (
 	Vlan                      = "vlan"
 	vSCSI                     = "vSCSI"
 	Warning                   = "WARNING"
+	Workspace                 = "workspace"
 
 	// Actions
 	Action_HardReboot        = "hard-reboot"

ibm/service/power/resource_ibm_pi_key.go

@@ -13,21 +13,28 @@ import (
 	"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/customdiff"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 )
 
 func ResourceIBMPIKey() *schema.Resource {
 	return &schema.Resource{
+		CustomizeDiff: customdiff.Sequence(
+			func(_ context.Context, diff *schema.ResourceDiff, v interface{}) error {
+				return customizeNameAndSSHKeyPIKeyDiff(diff)
+			},
+		),
 		CreateContext: resourceIBMPIKeyCreate,
 		ReadContext:   resourceIBMPIKeyRead,
 		UpdateContext: resourceIBMPIKeyUpdate,
 		DeleteContext: resourceIBMPIKeyDelete,
 		Importer:      &schema.ResourceImporter{},
 
 		Timeouts: &schema.ResourceTimeout{
-			Create: schema.DefaultTimeout(60 * time.Minute),
-			Delete: schema.DefaultTimeout(60 * time.Minute),
+			Create: schema.DefaultTimeout(10 * time.Minute),
+			Update: schema.DefaultTimeout(10 * time.Minute),
+			Delete: schema.DefaultTimeout(10 * time.Minute),
 		},
 
 		Schema: map[string]*schema.Schema{
@@ -39,6 +46,11 @@ func ResourceIBMPIKey() *schema.Resource {
 				Type:         schema.TypeString,
 				ValidateFunc: validation.NoZeroValues,
 			},
+			Arg_Description: {
+				Description: "Description of the ssh key.",
+				Optional:    true,
+				Type:        schema.TypeString,
+			},
 			Arg_KeyName: {
 				Description:  "User defined name for the SSH key.",
 				Required:     true,
@@ -51,7 +63,13 @@ func ResourceIBMPIKey() *schema.Resource {
 				Type:         schema.TypeString,
 				ValidateFunc: validation.NoZeroValues,
 			},
-
+			Arg_Visibility: {
+				Default:      Workspace,
+				Description:  "Visibility of the ssh key. Valid values are: [\"account\", \"workspace\"].",
+				Optional:     true,
+				Type:         schema.TypeString,
+				ValidateFunc: validation.StringInSlice([]string{Account, Workspace}, false),
+			},
 			// Attributes
 			Attr_CreationDate: {
 				Computed:    true,
@@ -60,14 +78,26 @@ func ResourceIBMPIKey() *schema.Resource {
 			},
 			Attr_Name: {
 				Computed:    true,
+				Deprecated:  "This field is deprecated and will be removed in a future release. Use pi_key_name instead.",
 				Description: "User defined name for the SSH key.",
 				Type:        schema.TypeString,
 			},
 			Attr_Key: {
 				Computed:    true,
+				Deprecated:  "This field is deprecated and will be removed in a future release. Use pi_ssh_key instead.",
 				Description: "SSH RSA key.",
 				Type:        schema.TypeString,
 			},
+			Attr_PrimaryWorkspace: {
+				Computed:    true,
+				Description: "Indicates if the current workspace owns the ssh key or not.",
+				Type:        schema.TypeBool,
+			},
+			Attr_SSHKeyID: {
+				Computed:    true,
+				Description: "Unique ID of SSH key.",
+				Type:        schema.TypeString,
+			},
 		},
 	}
 }
@@ -83,21 +113,29 @@ func resourceIBMPIKeyCreate(ctx context.Context, d *schema.ResourceData, meta in
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
 	name := d.Get(Arg_KeyName).(string)
 	sshkey := d.Get(Arg_SSHKey).(string)
+	visibility := d.Get(Arg_Visibility).(string)
 
 	// create key
-	client := instance.NewIBMPIKeyClient(ctx, sess, cloudInstanceID)
-	body := &models.SSHKey{
-		Name:   &name,
-		SSHKey: &sshkey,
+	client := instance.NewIBMPISSHKeyClient(ctx, sess, cloudInstanceID)
+	body := &models.CreateWorkspaceSSHKey{
+		Name:       &name,
+		SSHKey:     &sshkey,
+		Visibility: &visibility,
 	}
+
+	if v, ok := d.GetOk(Arg_Description); ok {
+		description := v.(string)
+		body.Description = description
+	}
+
 	sshResponse, err := client.Create(body)
 	if err != nil {
 		log.Printf("[DEBUG]  err %s", err)
 		return diag.FromErr(err)
 	}
 
 	log.Printf("Printing the sshkey %+v", *sshResponse)
-	d.SetId(fmt.Sprintf("%s/%s", cloudInstanceID, name))
+	d.SetId(fmt.Sprintf("%s/%s", cloudInstanceID, *sshResponse.ID))
 	return resourceIBMPIKeyRead(ctx, d, meta)
 }
 
@@ -115,21 +153,70 @@ func resourceIBMPIKeyRead(ctx context.Context, d *schema.ResourceData, meta inte
 	}
 
 	// get key
-	sshkeyC := instance.NewIBMPIKeyClient(ctx, sess, cloudInstanceID)
+	sshkeyC := instance.NewIBMPISSHKeyClient(ctx, sess, cloudInstanceID)
 	sshkeydata, err := sshkeyC.Get(key)
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
-	// set attributes
+	// Arguments
+	d.Set(Arg_CloudInstanceID, cloudInstanceID)
+	d.Set(Arg_Description, sshkeydata.Description)
+	d.Set(Arg_KeyName, sshkeydata.Name)
+	d.Set(Arg_SSHKey, sshkeydata.SSHKey)
+	d.Set(Arg_Visibility, sshkeydata.Visibility)
+
+	// Attributes
 	d.Set(Attr_CreationDate, sshkeydata.CreationDate.String())
 	d.Set(Attr_Key, sshkeydata.SSHKey)
 	d.Set(Attr_Name, sshkeydata.Name)
+	d.Set(Attr_PrimaryWorkspace, sshkeydata.PrimaryWorkspace)
+	d.Set(Attr_SSHKeyID, sshkeydata.ID)
 
 	return nil
 }
 
 func resourceIBMPIKeyUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	// session
+	sess, err := meta.(conns.ClientSession).IBMPISession()
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	// arguments
+	cloudInstanceID, key, err := splitID(d.Id())
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	client := instance.NewIBMPISSHKeyClient(ctx, sess, cloudInstanceID)
+	updateBody := &models.UpdateWorkspaceSSHKey{}
+
+	if d.HasChange(Arg_Description) {
+		newDescription := d.Get(Arg_Description).(string)
+		updateBody.Description = &newDescription
+	}
+
+	if d.HasChange(Arg_KeyName) {
+		newKeyName := d.Get(Arg_KeyName).(string)
+		updateBody.Name = &newKeyName
+	}
+
+	if d.HasChange(Arg_SSHKey) {
+		newSSHKey := d.Get(Arg_SSHKey).(string)
+		updateBody.SSHKey = &newSSHKey
+	}
+
+	if d.HasChange(Arg_Visibility) {
+		newVisibility := d.Get(Arg_Visibility).(string)
+		updateBody.Visibility = &newVisibility
+	}
+
+	_, err = client.Update(key, updateBody)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
 	return resourceIBMPIKeyRead(ctx, d, meta)
 }
 
@@ -147,11 +234,21 @@ func resourceIBMPIKeyDelete(ctx context.Context, d *schema.ResourceData, meta in
 	}
 
 	// delete key
-	sshkeyC := instance.NewIBMPIKeyClient(ctx, sess, cloudInstanceID)
+	sshkeyC := instance.NewIBMPISSHKeyClient(ctx, sess, cloudInstanceID)
 	err = sshkeyC.Delete(key)
 	if err != nil {
 		return diag.FromErr(err)
 	}
 	d.SetId("")
 	return nil
 }
+
+func customizeNameAndSSHKeyPIKeyDiff(diff *schema.ResourceDiff) error {
+	if diff.Id() != "" && diff.HasChange(Arg_KeyName) {
+		diff.SetNewComputed(Attr_Name)
+	}
+	if diff.Id() != "" && diff.HasChange(Arg_SSHKey) {
+		diff.SetNewComputed(Attr_Key)
+	}
+	return nil
+}