kms cancel deletion functionality and test (#369)

[KMS] Canceling the Scheduled Deletion of a CMK

What this PR does / why we need it
Add ability to canceling the Scheduled Deletion of a CMK
Which issue this PR fixes
Resolves: #368
Tests:
=== RUN   TestKmsKeysLifecycle
--- PASS: TestKmsKeysLifecycle(68.05s)
PASS

Reviewed-by: Artem Lifshits <None>
Reviewed-by: Rodion Gyrbu <fpsoff@outlook.com>
Reviewed-by: Vladimir Vshivkov <None>

Author: anton-sidelnikov

acceptance/openstack/kms/v1/keys_test.go

@@ -0,0 +1,71 @@
+package v1
+
+import (
+	"testing"
+
+	"github.com/opentelekomcloud/gophertelekomcloud/acceptance/clients"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/kms/v1/keys"
+	th "github.com/opentelekomcloud/gophertelekomcloud/testhelper"
+)
+
+func TestKmsKeysLifecycle(t *testing.T) {
+	client, err := clients.NewKMSV1Client()
+	th.AssertNoErr(t, err)
+
+	kmsID := clients.EnvOS.GetEnv("KMS_ID")
+	if kmsID == "" {
+		t.Skip("OS_KMS_ID env var is missing but KMSv1 grant test requires")
+	}
+
+	createOpts := keys.CreateOpts{
+		KeyAlias:       kmsID,
+		KeyDescription: "some description",
+	}
+	createKey, err := keys.Create(client, createOpts).ExtractKeyInfo()
+	th.AssertNoErr(t, err)
+
+	defer func() {
+		deleteOpts := keys.DeleteOpts{
+			KeyID:       createKey.KeyID,
+			PendingDays: "7",
+		}
+		_, err := keys.Delete(client, deleteOpts).Extract()
+		th.AssertNoErr(t, err)
+	}()
+
+	keyGet, err := keys.Get(client, createKey.KeyID).ExtractKeyInfo()
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, createOpts.KeyAlias, keyGet.KeyAlias)
+	th.AssertEquals(t, keyGet.KeyState, "2")
+
+	deleteOpts := keys.DeleteOpts{
+		KeyID:       createKey.KeyID,
+		PendingDays: "7",
+	}
+	_, err = keys.Delete(client, deleteOpts).Extract()
+	th.AssertNoErr(t, err)
+
+	keyGetDeleted, err := keys.Get(client, createKey.KeyID).ExtractKeyInfo()
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, keyGetDeleted.KeyState, "4")
+
+	cancelDeleteOpts := keys.CancelDeleteOpts{
+		KeyID: createKey.KeyID,
+	}
+	_, err = keys.CancelDelete(client, cancelDeleteOpts).Extract()
+	th.AssertNoErr(t, err)
+
+	_, err = keys.EnableKey(client, createKey.KeyID).Extract()
+	th.AssertNoErr(t, err)
+
+	keyGetEnabled, err := keys.Get(client, createKey.KeyID).ExtractKeyInfo()
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, keyGetEnabled.KeyState, "2")
+
+	_, err = keys.DisableKey(client, createKey.KeyID).Extract()
+	th.AssertNoErr(t, err)
+
+	keyGetDisabled, err := keys.Get(client, createKey.KeyID).ExtractKeyInfo()
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, keyGetDisabled.KeyState, "3")
+}

openstack/kms/v1/keys/requests.go

@@ -24,6 +24,11 @@ type DeleteOpts struct {
 	PendingDays string `json:"pending_days" required:"true"`
 }
 
+type CancelDeleteOpts struct {
+	// ID of a CMK
+	KeyID string `json:"key_id" required:"true"`
+}
+
 type UpdateAliasOpts struct {
 	// ID of a CMK
 	KeyID string `json:"key_id" required:"true"`
@@ -89,6 +94,12 @@ func (opts DeleteOpts) ToKeyDeleteMap() (map[string]interface{}, error) {
 	return golangsdk.BuildRequestBody(opts, "")
 }
 
+// ToKeyCancelDeleteMap assembles a request body based on the contents of a
+// CancelDeleteOpts.
+func (opts CancelDeleteOpts) ToKeyCancelDeleteMap() (map[string]interface{}, error) {
+	return golangsdk.BuildRequestBody(opts, "")
+}
+
 // ToKeyUpdateAliasMap assembles a request body based on the contents of a
 // UpdateAliasOpts.
 func (opts UpdateAliasOpts) ToKeyUpdateAliasMap() (map[string]interface{}, error) {
@@ -127,6 +138,10 @@ type DeleteOptsBuilder interface {
 	ToKeyDeleteMap() (map[string]interface{}, error)
 }
 
+type CancelDeleteOptsBuilder interface {
+	ToKeyCancelDeleteMap() (map[string]interface{}, error)
+}
+
 type UpdateAliasOptsBuilder interface {
 	ToKeyUpdateAliasMap() (map[string]interface{}, error)
 }
@@ -339,3 +354,17 @@ func UpdateKeyRotationInterval(client *golangsdk.ServiceClient, opts RotationOpt
 	})
 	return
 }
+
+// CancelDelete will cancel the scheduled deletion for a CMK only when the CMK's status is Scheduled deletion with the provided ID.
+func CancelDelete(client *golangsdk.ServiceClient, opts CancelDeleteOptsBuilder) (r DeleteResult) {
+	b, err := opts.ToKeyCancelDeleteMap()
+	if err != nil {
+		r.Err = err
+		return
+	}
+	_, r.Err = client.Post(cancelDeleteURL(client), b, &r.Body, &golangsdk.RequestOpts{
+		OkCodes:      []int{200},
+		JSONResponse: &r.Body,
+	})
+	return
+}

openstack/kms/v1/keys/results.go

@@ -84,6 +84,11 @@ type DeleteResult struct {
 	commonResult
 }
 
+// CancelDeleteResult contains the response body and error from a CancelDelete request.
+type CancelDeleteResult struct {
+	commonResult
+}
+
 // UpdateAliasResult contains the response body and error from a UpdateAlias request.
 type UpdateAliasResult struct {
 	commonResult

openstack/kms/v1/keys/urls.go

@@ -61,3 +61,7 @@ func disableKeyURL(c *golangsdk.ServiceClient) string {
 func listURL(c *golangsdk.ServiceClient) string {
 	return c.ServiceURL(resourcePath, "list-keys")
 }
+
+func cancelDeleteURL(c *golangsdk.ServiceClient) string {
+	return c.ServiceURL(resourcePath, "cancel-key-deletion")
+}