hashicorp · vinay-gopalan · Jun 14, 2022 · May 13, 2022 · May 18, 2022 · May 19, 2022
@@ -4,13 +4,23 @@ const (
 	/*
 		common field names
 	*/
-	FieldPath        = "path"
-	FieldParameters  = "parameters"
-	FieldMethod      = "method"
-	FieldNamespace   = "namespace"
-	FieldNamespaceID = "namespace_id"
-	FieldBackend     = "backend"
-
+	FieldPath           = "path"
+	FieldParameters     = "parameters"
+	FieldMethod         = "method"
+	FieldNamespace      = "namespace"
+	FieldNamespaceID    = "namespace_id"
+	FieldBackend        = "backend"
+	FieldData           = "data"
+	FieldMount          = "mount"
+	FieldName           = "name"
+	FieldVersion        = "version"
+	FieldMetadata       = "metadata"
+	FieldNames          = "names"
+	FieldLeaseID        = "lease_id"
+	FieldLeaseDuration  = "lease_duration"
+	FieldLeaseRenewable = "lease_renewable"
+	FieldDepth          = "depth"
+	FieldDataJSON       = "data_json"
 	/*
 		common environment variables
 	*/

@@ -601,3 +601,34 @@ func GetResourceFromRootModule(s *terraform.State, resourceName string) (*terraf
 
 	return nil, fmt.Errorf("expected resource %q, not found in state", resourceName)
 }
+
+// CheckJSONData from an expected string for a given resource attribute.
+func CheckJSONData(resourceName, attr, expected string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		rs, err := GetResourceFromRootModule(s, resourceName)
+		if err != nil {
+			return err
+		}
+
+		actual, ok := rs.Primary.Attributes[attr]
+		if !ok {
+			return fmt.Errorf("resource %q has no attribute %q", resourceName, attr)
+		}
+
+		var e map[string]interface{}
+		if err := json.Unmarshal([]byte(expected), &e); err != nil {
+			return nil
+		}
+
+		var a map[string]interface{}
+		if err := json.Unmarshal([]byte(actual), &a); err != nil {
+			return nil
+		}
+
+		if !reflect.DeepEqual(e, a) {
+			return fmt.Errorf("expected %#v, got %#v for resource attr %s.%s", e, a, resourceName, attr)
+		}
+
+		return nil
+	}
+}
@@ -6,11 +6,10 @@ import (
 	"log"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
-	"github.com/hashicorp/vault/api"
-
 	"github.com/hashicorp/terraform-provider-vault/internal/consts"
 	"github.com/hashicorp/terraform-provider-vault/internal/identity/entity"
 	"github.com/hashicorp/terraform-provider-vault/internal/provider"
+	"github.com/hashicorp/vault/api"
 )
 
 var (
@@ -64,7 +63,7 @@ var (
 			},
 			Computed: true,
 		},
-		"metadata": {
+		consts.FieldMetadata: {
 			Type:     schema.TypeMap,
 			Computed: true,
 		},
@@ -123,7 +122,7 @@ func identityEntityDataSource() *schema.Resource {
 				Description: "Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with `alias_name`.",
 			},
 
-			"data_json": {
+			consts.FieldDataJSON: {
 				Type:        schema.TypeString,
 				Computed:    true,
 				Description: "Entity data from Vault in JSON String form",
@@ -169,7 +168,7 @@ func identityEntityDataSource() *schema.Resource {
 				},
 				Computed: true,
 			},
-			"metadata": {
+			consts.FieldMetadata: {
 				Type:     schema.TypeMap,
 				Computed: true,
 			},
@@ -277,7 +276,7 @@ func identityEntityDataSourceRead(d *schema.ResourceData, meta interface{}) erro
 	// Ignoring error because this value came from JSON in the
 	// first place so no reason why it should fail to re-encode.
 	jsonDataBytes, _ := json.Marshal(resp.Data)
-	d.Set("data_json", string(jsonDataBytes))
+	d.Set(consts.FieldDataJSON, string(jsonDataBytes))
 
 	return nil
 }
@@ -77,7 +77,7 @@ func identityGroupDataSource() *schema.Resource {
 				Description: "Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with `alias_name`.",
 			},
 
-			"data_json": {
+			consts.FieldDataJSON: {
 				Type:        schema.TypeString,
 				Computed:    true,
 				Description: "Group data from Vault in JSON String form",
@@ -251,7 +251,7 @@ func identityGroupDataSourceRead(d *schema.ResourceData, meta interface{}) error
 	// Ignoring error because this value came from JSON in the
 	// first place so no reason why it should fail to re-encode.
 	jsonDataBytes, _ := json.Marshal(resp.Data)
-	d.Set("data_json", string(jsonDataBytes))
+	d.Set(consts.FieldDataJSON, string(jsonDataBytes))
 
 	return nil
 }
@@ -15,6 +15,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 
+	"github.com/hashicorp/terraform-provider-vault/internal/consts"
 	"github.com/hashicorp/terraform-provider-vault/internal/provider"
 )
 
@@ -93,13 +94,13 @@ func awsAccessCredentialsDataSource() *schema.Resource {
 				Description: "AWS security token read from Vault. (Only returned if type is 'sts').",
 			},
 
-			"lease_id": {
+			consts.FieldLeaseID: {
 				Type:        schema.TypeString,
 				Computed:    true,
 				Description: "Lease identifier assigned by vault.",
 			},
 
-			"lease_duration": {
+			consts.FieldLeaseDuration: {
 				Type:        schema.TypeInt,
 				Computed:    true,
 				Description: "Lease duration in seconds relative to the time in lease_start_time.",
@@ -111,7 +112,7 @@ func awsAccessCredentialsDataSource() *schema.Resource {
 				Description: "Time at which the lease was read, using the clock of the system where Terraform was running",
 			},
 
-			"lease_renewable": {
+			consts.FieldLeaseRenewable: {
 				Type:        schema.TypeBool,
 				Computed:    true,
 				Description: "True if the duration of this lease can be extended through renewal.",
@@ -168,10 +169,10 @@ func awsAccessCredentialsDataSourceRead(d *schema.ResourceData, meta interface{}
 	d.Set("access_key", secret.Data["access_key"])
 	d.Set("secret_key", secret.Data["secret_key"])
 	d.Set("security_token", secret.Data["security_token"])
-	d.Set("lease_id", secret.LeaseID)
-	d.Set("lease_duration", secret.LeaseDuration)
+	d.Set(consts.FieldLeaseID, secret.LeaseID)
+	d.Set(consts.FieldLeaseDuration, secret.LeaseDuration)
 	d.Set("lease_start_time", time.Now().Format(time.RFC3339))
-	d.Set("lease_renewable", secret.Renewable)
+	d.Set(consts.FieldLeaseRenewable, secret.Renewable)
 
 	awsConfig := &aws.Config{
 		Credentials: credentials.NewStaticCredentials(accessKey, secretKey, securityToken),

@@ -15,6 +15,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 
+	"github.com/hashicorp/terraform-provider-vault/internal/consts"
 	"github.com/hashicorp/terraform-provider-vault/testutil"
 )
 
@@ -34,7 +35,7 @@ func TestAccDataSourceAWSAccessCredentials_basic(t *testing.T) {
 					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "secret_key"),
 					resource.TestCheckResourceAttr("data.vault_aws_access_credentials.test", "security_token", ""),
 					resource.TestCheckResourceAttr("data.vault_aws_access_credentials.test", "type", "creds"),
-					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "lease_id"),
+					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", consts.FieldLeaseID),
 					testAccDataSourceAWSAccessCredentialsCheck_tokenWorks(region),
 				),
 			},
@@ -116,7 +117,7 @@ func TestAccDataSourceAWSAccessCredentials_sts(t *testing.T) {
 							resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "secret_key"),
 							resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "security_token"),
 							resource.TestCheckResourceAttr("data.vault_aws_access_credentials.test", "type", "sts"),
-							resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "lease_id"),
+							resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", consts.FieldLeaseID),
 							testAccDataSourceAWSAccessCredentialsCheck_tokenWorks(region),
 						),
 					},
@@ -143,7 +144,7 @@ func TestAccDataSourceAWSAccessCredentials_sts_ttl(t *testing.T) {
 					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "secret_key"),
 					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "security_token"),
 					resource.TestCheckResourceAttr("data.vault_aws_access_credentials.test", "type", "sts"),
-					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "lease_id"),
+					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", consts.FieldLeaseID),
 					testAccDataSourceAWSAccessCredentialsCheck_tokenWorks(region),
 				),
 			},
@@ -155,7 +156,7 @@ func TestAccDataSourceAWSAccessCredentials_sts_ttl(t *testing.T) {
 					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "security_token"),
 					resource.TestCheckResourceAttr("data.vault_aws_access_credentials.test", "type", "sts"),
 					resource.TestCheckResourceAttr("data.vault_aws_access_credentials.test", "ttl", ttl),
-					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", "lease_id"),
+					resource.TestCheckResourceAttrSet("data.vault_aws_access_credentials.test", consts.FieldLeaseID),
 					testAccDataSourceAWSAccessCredentialsCheck_tokenWorks(region),
 				),
 			},

@@ -15,6 +15,7 @@ import (
 	"github.com/hashicorp/vault/api"
 	"github.com/hashicorp/vault/sdk/helper/pointerutil"
 
+	"github.com/hashicorp/terraform-provider-vault/internal/consts"
 	"github.com/hashicorp/terraform-provider-vault/internal/provider"
 )
 
@@ -67,12 +68,12 @@ func azureAccessCredentialsDataSource() *schema.Resource {
 				Computed:    true,
 				Description: "The client secret for credentials to query the Azure APIs.",
 			},
-			"lease_id": {
+			consts.FieldLeaseID: {
 				Type:        schema.TypeString,
 				Computed:    true,
 				Description: "Lease identifier assigned by vault.",
 			},
-			"lease_duration": {
+			consts.FieldLeaseDuration: {
 				Type:        schema.TypeInt,
 				Computed:    true,
 				Description: "Lease duration in seconds relative to the time in lease_start_time.",
@@ -82,7 +83,7 @@ func azureAccessCredentialsDataSource() *schema.Resource {
 				Computed:    true,
 				Description: "Time at which the lease was read, using the clock of the system where Terraform was running",
 			},
-			"lease_renewable": {
+			consts.FieldLeaseRenewable: {
 				Type:        schema.TypeBool,
 				Computed:    true,
 				Description: "True if the duration of this lease can be extended through renewal.",
@@ -137,10 +138,10 @@ func azureAccessCredentialsDataSourceRead(d *schema.ResourceData, meta interface
 	d.SetId(secret.LeaseID)
 	_ = d.Set("client_id", secret.Data["client_id"])
 	_ = d.Set("client_secret", secret.Data["client_secret"])
-	_ = d.Set("lease_id", secret.LeaseID)
-	_ = d.Set("lease_duration", secret.LeaseDuration)
+	_ = d.Set(consts.FieldLeaseID, secret.LeaseID)
+	_ = d.Set(consts.FieldLeaseDuration, secret.LeaseDuration)
 	_ = d.Set("lease_start_time", time.Now().Format(time.RFC3339))
-	_ = d.Set("lease_renewable", secret.Renewable)
+	_ = d.Set(consts.FieldLeaseRenewable, secret.Renewable)
 
 	// If we're not supposed to validate creds, or we don't have enough
 	// information to do it, there's nothing further to do here.

@@ -8,6 +8,7 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 
+	"github.com/hashicorp/terraform-provider-vault/internal/consts"
 	"github.com/hashicorp/terraform-provider-vault/internal/provider"
 )
 
@@ -16,13 +17,13 @@ func genericSecretDataSource() *schema.Resource {
 		Read: genericSecretDataSourceRead,
 
 		Schema: map[string]*schema.Schema{
-			"path": {
+			consts.FieldPath: {
 				Type:        schema.TypeString,
 				Required:    true,
 				Description: "Full path from which a secret will be read.",
 			},
 
-			"version": {
+			consts.FieldVersion: {
 				Type:     schema.TypeInt,
 				Required: false,
 				Optional: true,
@@ -37,27 +38,27 @@ func genericSecretDataSource() *schema.Resource {
 					"in the TF state.",
 			},
 
-			"data_json": {
+			consts.FieldDataJSON: {
 				Type:        schema.TypeString,
 				Computed:    true,
 				Description: "JSON-encoded secret data read from Vault.",
 				Sensitive:   true,
 			},
 
-			"data": {
+			consts.FieldData: {
 				Type:        schema.TypeMap,
 				Computed:    true,
 				Description: "Map of strings read from Vault.",
 				Sensitive:   true,
 			},
 
-			"lease_id": {
+			consts.FieldLeaseID: {
 				Type:        schema.TypeString,
 				Computed:    true,
 				Description: "Lease identifier assigned by vault.",
 			},
 
-			"lease_duration": {
+			consts.FieldLeaseDuration: {
 				Type:        schema.TypeInt,
 				Computed:    true,
 				Description: "Lease duration in seconds relative to the time in lease_start_time.",
@@ -69,7 +70,7 @@ func genericSecretDataSource() *schema.Resource {
 				Description: "Time at which the lease was read, using the clock of the system where Terraform was running",
 			},
 
-			"lease_renewable": {
+			consts.FieldLeaseRenewable: {
 				Type:        schema.TypeBool,
 				Computed:    true,
 				Description: "True if the duration of this lease can be extended through renewal.",
@@ -102,7 +103,7 @@ func genericSecretDataSourceRead(d *schema.ResourceData, meta interface{}) error
 	// Ignoring error because this value came from JSON in the
 	// first place so no reason why it should fail to re-encode.
 	jsonDataBytes, _ := json.Marshal(secret.Data)
-	if err := d.Set("data_json", string(jsonDataBytes)); err != nil {
+	if err := d.Set(consts.FieldDataJSON, string(jsonDataBytes)); err != nil {
 		return err
 	}
 
@@ -126,15 +127,15 @@ func genericSecretDataSourceRead(d *schema.ResourceData, meta interface{}) error
 		return err
 	}
 
-	if err := d.Set("lease_id", secret.LeaseID); err != nil {
+	if err := d.Set(consts.FieldLeaseID, secret.LeaseID); err != nil {
 		return err
 	}
 
-	if err := d.Set("lease_duration", secret.LeaseDuration); err != nil {
+	if err := d.Set(consts.FieldLeaseDuration, secret.LeaseDuration); err != nil {
 		return err
 	}
 
-	if err := d.Set("lease_renewable", secret.Renewable); err != nil {
+	if err := d.Set(consts.FieldLeaseRenewable, secret.Renewable); err != nil {
 		return err
 	}