[keyvault] azsecret renames (Azure#20861)

* azsecret renames

* update perf test

* Charles feedback

Co-authored-by: Charles Lowell <10964656+chlowell@users.noreply.github.com>

Author: gracewilcox

eng/config.json

@@ -50,7 +50,7 @@
         },
         {
             "Name": "keyvault/azsecrets",
-            "CoverageGoal": 0.80
+            "CoverageGoal": 0.86
         },
         {
             "Name": "data",

sdk/security/keyvault/azsecrets/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Release History
 
-## 1.0.0 (2023-05-11)
+## 1.0.0 (Unreleased)
+
+### Breaking Changes
+* Renamed `Client.ListSecrets` to `Client.ListSecretProperties`
+* Renamed `Client.ListSecretVersions` to `Client.ListSecretPropertiesVersions`
+* Renamed `SecretBundle` to `Secret`
+* Renamed `DeletedSecretBundle` to `DeletedSecret`
+* Renamed `SecretItem` to `SecretProperties`
+* Renamed `DeletedSecretItem` to `DeletedSecretProperties`
+* Renamed `Kid` to `KID`
+* Removed `DeletionRecoveryLevel` type
 
 ### Other Changes
 * Updated dependencies

sdk/security/keyvault/azsecrets/autorest.md

@@ -16,7 +16,6 @@ security: "AADToken"
 security-scopes: "https://vault.azure.net/.default"
 use: "@autorest/go@4.0.0-preview.46"
 version: "^3.0.0"
-
 directive:
   # delete unused model
   - remove-model: SecretProperties
@@ -36,17 +35,54 @@ directive:
   - rename-model:
       from: SecretUpdateParameters
       to: UpdateSecretParameters
+  - rename-model:
+      from: SecretBundle
+      to: Secret
+  - rename-model:
+      from: DeletedSecretBundle
+      to: DeletedSecret
+  - rename-model:
+      from: SecretItem
+      to: SecretProperties
+  - rename-model:
+      from: DeletedSecretItem
+      to: DeletedSecretProperties
+  - rename-model:
+      from: UpdateSecretParameters
+      to: UpdateSecretPropertiesParameters
+  - rename-model:
+      from: DeletedSecretListResult
+      to: DeletedSecretPropertiesListResult
+  - rename-model:
+      from: SecretListResult
+      to: SecretPropertiesListResult
 
-  # rename paged operations from Get* to List*
+  # rename operations
   - rename-operation:
       from: GetDeletedSecrets
-      to: ListDeletedSecrets
+      to: ListDeletedSecretProperties
   - rename-operation:
       from: GetSecrets
-      to: ListSecrets
+      to: ListSecretProperties
   - rename-operation:
       from: GetSecretVersions
-      to: ListSecretVersions
+      to: ListSecretPropertiesVersions
+  - rename-operation:
+      from: UpdateSecret
+      to: UpdateSecretProperties
+
+  # rename fields
+  - from: swagger-document
+    where: $.definitions.RestoreSecretParameters.properties.value
+    transform: $["x-ms-client-name"] = "SecretBackup"
+  - from: swagger-document
+    where: $.definitions.Secret.properties.kid
+    transform: $["x-ms-client-name"] = "KID"
+
+  # remove type DeletionRecoveryLevel, use string instead
+  - from: models.go
+    where: $
+    transform: return $.replace(/DeletionRecoveryLevel/g, "string");
 
   # delete unused error models
   - from: models.go

sdk/security/keyvault/azsecrets/build.go

@@ -2,6 +2,7 @@
 // +build go1.18
 
 //go:generate autorest ./autorest.md
+//go:generate rm ./constants.go
 //go:generate gofmt -w .
 
 // Copyright (c) Microsoft Corporation. All rights reserved.

sdk/security/keyvault/azsecrets/client.go

@@ -8,51 +8,18 @@ package azsecrets_test
 
 import (
 	"context"
-	"encoding/json"
-	"errors"
 	"fmt"
 	"strings"
 	"testing"
 	"time"
 
-	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
 	"github.com/Azure/azure-sdk-for-go/sdk/internal/mock"
-	"github.com/Azure/azure-sdk-for-go/sdk/internal/recording"
 	"github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azsecrets"
 	"github.com/stretchr/testify/require"
 )
 
-// pollStatus calls a function until it stops returning a response error with the given status code.
-// If this takes more than 2 minutes, it fails the test.
-func pollStatus(t *testing.T, expectedStatus int, fn func() error) {
-	var err error
-	for i := 0; i < 12; i++ {
-		err = fn()
-		var respErr *azcore.ResponseError
-		if !(errors.As(err, &respErr) && respErr.StatusCode == expectedStatus) {
-			break
-		}
-		if i < 11 {
-			recording.Sleep(10 * time.Second)
-		}
-	}
-	require.NoError(t, err)
-}
-
-type serdeModel interface {
-	json.Marshaler
-	json.Unmarshaler
-}
-
-func testSerde[T serdeModel](t *testing.T, model T) {
-	data, err := model.MarshalJSON()
-	require.NoError(t, err)
-	err = model.UnmarshalJSON(data)
-	require.NoError(t, err)
-}
-
 func TestBackupRestore(t *testing.T) {
 	client := startTest(t)
 
@@ -114,7 +81,7 @@ func TestCRUD(t *testing.T) {
 	require.Equal(t, setParams.Value, setResp.Value)
 	require.Equal(t, name, setResp.ID.Name())
 	require.NotEmpty(t, setResp.ID.Version())
-	testSerde(t, &setResp.SecretBundle)
+	testSerde(t, &setResp.Secret)
 
 	getResp, err := client.GetSecret(context.Background(), setResp.ID.Name(), "", nil)
 	require.NoError(t, err)
@@ -128,13 +95,13 @@ func TestCRUD(t *testing.T) {
 	require.Equal(t, setParams.Tags, getResp.Tags)
 	require.Equal(t, setParams.Value, getResp.Value)
 
-	updateParams := azsecrets.UpdateSecretParameters{
+	updateParams := azsecrets.UpdateSecretPropertiesParameters{
 		SecretAttributes: &azsecrets.SecretAttributes{
 			Expires: to.Ptr(time.Date(2040, 1, 1, 1, 1, 1, 0, time.UTC)),
 		},
 	}
 	testSerde(t, &updateParams)
-	updateResp, err := client.UpdateSecret(context.Background(), name, setResp.ID.Version(), updateParams, nil)
+	updateResp, err := client.UpdateSecretProperties(context.Background(), name, setResp.ID.Version(), updateParams, nil)
 	require.NoError(t, err)
 	require.Equal(t, setParams.ContentType, updateResp.ContentType)
 	require.Equal(t, setResp.ID, updateResp.ID)
@@ -153,7 +120,7 @@ func TestCRUD(t *testing.T) {
 	require.Equal(t, setParams.Tags, deleteResp.Tags)
 	require.Equal(t, name, deleteResp.ID.Name())
 	require.Equal(t, updateResp.ID.Version(), deleteResp.ID.Version())
-	testSerde(t, &deleteResp.DeletedSecretBundle)
+	testSerde(t, &deleteResp.DeletedSecret)
 	pollStatus(t, 404, func() error {
 		_, err := client.GetDeletedSecret(context.Background(), name, nil)
 		return err
@@ -212,7 +179,7 @@ func TestDisableChallengeResourceVerification(t *testing.T) {
 			}
 			client, err := azsecrets.NewClient(vaultURL, &FakeCredential{}, options)
 			require.NoError(t, err)
-			pager := client.NewListSecretsPager(nil)
+			pager := client.NewListSecretPropertiesPager(nil)
 			_, err = pager.NextPage(context.Background())
 			if test.err {
 				require.Error(t, err)
@@ -270,11 +237,11 @@ func TestListDeletedSecrets(t *testing.T) {
 	})
 
 	expected := map[string]struct{}{secret1: {}, secret2: {}}
-	pager := client.NewListDeletedSecretsPager(&azsecrets.ListDeletedSecretsOptions{MaxResults: to.Ptr(int32(1))})
+	pager := client.NewListDeletedSecretPropertiesPager(&azsecrets.ListDeletedSecretPropertiesOptions{MaxResults: to.Ptr(int32(1))})
 	for pager.More() && len(expected) > 0 {
 		page, err := pager.NextPage(context.Background())
 		require.NoError(t, err)
-		testSerde(t, &page.DeletedSecretListResult)
+		testSerde(t, &page.DeletedSecretPropertiesListResult)
 		for _, secret := range page.Value {
 			testSerde(t, secret)
 			delete(expected, secret.ID.Name())
@@ -298,11 +265,11 @@ func TestListSecrets(t *testing.T) {
 		defer cleanUpSecret(t, client, name)
 	}
 
-	pager := client.NewListSecretsPager(&azsecrets.ListSecretsOptions{MaxResults: to.Ptr(int32(1))})
+	pager := client.NewListSecretPropertiesPager(&azsecrets.ListSecretPropertiesOptions{MaxResults: to.Ptr(int32(1))})
 	for pager.More() {
 		page, err := pager.NextPage(context.Background())
 		require.NoError(t, err)
-		testSerde(t, &page.SecretListResult)
+		testSerde(t, &page.SecretPropertiesListResult)
 		for _, secret := range page.Value {
 			testSerde(t, secret)
 			if strings.HasPrefix(secret.ID.Name(), "listsecrets") {
@@ -335,11 +302,11 @@ func TestListSecretVersions(t *testing.T) {
 	}
 	defer cleanUpSecret(t, client, name)
 
-	pager := client.NewListSecretVersionsPager(name, &azsecrets.ListSecretVersionsOptions{MaxResults: to.Ptr(int32(1))})
+	pager := client.NewListSecretPropertiesVersionsPager(name, &azsecrets.ListSecretPropertiesVersionsOptions{MaxResults: to.Ptr(int32(1))})
 	for pager.More() {
 		page, err := pager.NextPage(context.Background())
 		require.NoError(t, err)
-		testSerde(t, &page.SecretListResult)
+		testSerde(t, &page.SecretPropertiesListResult)
 		for i, secret := range page.Value {
 			testSerde(t, secret)
 			if i > 0 {
@@ -377,7 +344,7 @@ func TestNameRequired(t *testing.T) {
 	require.EqualError(t, err, expected)
 	_, err = client.SetSecret(context.Background(), "", azsecrets.SetSecretParameters{}, nil)
 	require.EqualError(t, err, expected)
-	_, err = client.UpdateSecret(context.Background(), "", "", azsecrets.UpdateSecretParameters{}, nil)
+	_, err = client.UpdateSecretProperties(context.Background(), "", "", azsecrets.UpdateSecretPropertiesParameters{}, nil)
 	require.EqualError(t, err, expected)
 }
 

sdk/security/keyvault/azsecrets/client_test.go

@@ -70,8 +70,8 @@ func ExampleClient_DeleteSecret() {
 }
 
 // List pages don't include secret values. Use [Client.GetSecret] to retrieve secret values.
-func ExampleClient_NewListSecretsPager() {
-	pager := client.NewListSecretsPager(nil)
+func ExampleClient_NewListSecretPropertiesPager() {
+	pager := client.NewListSecretPropertiesPager(nil)
 	for pager.More() {
 		page, err := pager.NextPage(context.TODO())
 		if err != nil {
@@ -89,7 +89,7 @@ func ExampleClient_BackupSecret() {
 		// TODO: handle error
 	}
 
-	restoreResp, err := client.RestoreSecret(context.TODO(), azsecrets.RestoreSecretParameters{SecretBundleBackup: backup.Value}, nil)
+	restoreResp, err := client.RestoreSecret(context.TODO(), azsecrets.RestoreSecretParameters{SecretBackup: backup.Value}, nil)
 	if err != nil {
 		// TODO: handle error
 	}
@@ -103,7 +103,7 @@ func ExampleClient_RestoreSecret() {
 		// TODO: handle error
 	}
 
-	restoreResp, err := client.RestoreSecret(context.TODO(), azsecrets.RestoreSecretParameters{SecretBundleBackup: backup.Value}, nil)
+	restoreResp, err := client.RestoreSecret(context.TODO(), azsecrets.RestoreSecretParameters{SecretBackup: backup.Value}, nil)
 	if err != nil {
 		// TODO: handle error
 	}
@@ -113,7 +113,7 @@ func ExampleClient_RestoreSecret() {
 
 func ExampleClient_PurgeDeletedSecret() {
 	// this loop purges all the deleted secrets in the vault
-	pager := client.NewListDeletedSecretsPager(nil)
+	pager := client.NewListDeletedSecretPropertiesPager(nil)
 	for pager.More() {
 		page, err := pager.NextPage(context.TODO())
 		if err != nil {
@@ -137,8 +137,8 @@ func ExampleClient_RecoverDeletedSecret() {
 }
 
 // UpdateSecret updates a secret's metadata. It can't change the secret's value; use [Client.SetSecret] to set a secret's value.
-func ExampleClient_UpdateSecret() {
-	updateParams := azsecrets.UpdateSecretParameters{
+func ExampleClient_UpdateSecretProperties() {
+	updateParams := azsecrets.UpdateSecretPropertiesParameters{
 		SecretAttributes: &azsecrets.SecretAttributes{
 			Expires: to.Ptr(time.Now().Add(48 * time.Hour)),
 		},
@@ -147,7 +147,7 @@ func ExampleClient_UpdateSecret() {
 	}
 	// an empty version updates the latest version of the secret
 	version := ""
-	resp, err := client.UpdateSecret(context.Background(), "mySecretName", version, updateParams, nil)
+	resp, err := client.UpdateSecretProperties(context.Background(), "mySecretName", version, updateParams, nil)
 	if err != nil {
 		// TODO: handle error
 	}