Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

allow syncing with out-of-band changes for kv v1 and v2 #2207

Merged
merged 5 commits into from
Mar 25, 2024
Merged

allow syncing with out-of-band changes for kv v1 and v2 #2207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9b5a223
fixed resource vault_kv_secret_v2 : not reading data_json
NightOwl998 Nov 13, 2023
a76a189
fixed resource vault_kv_secret : not reading data_json
NightOwl998 Nov 14, 2023
7443dc1
modified resource kv secret v2 test
NightOwl998 Nov 14, 2023
947c913
updated tests for kv secret and kv secret v2
NightOwl998 Nov 23, 2023
1a7edf3
add changelog
fairclothjm Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ FEATURES:

BUGS:
* fix `vault_approle_auth_backend_role_secret_id` regression to handle 404 errors ([#2204](https://github.com/hashicorp/terraform-provider-vault/pull/2204))
* fix `vault_kv_secret` and `vault_kv_secret_v2` failure to update secret data modified outside terraform ([#1933](https://github.com/hashicorp/terraform-provider-vault/pull/1933))

## 4.1.0 (Mar 20, 2024)

Expand Down
8 changes: 8 additions & 0 deletions vault/resource_kv_secret.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,14 @@ func kvSecretRead(_ context.Context, d *schema.ResourceData, meta interface{}) d
log.Printf("[DEBUG] secret: %#v", secret)

data := secret.Data
jsonData, err := json.Marshal(data)
if err != nil {
return diag.Errorf("error marshaling JSON for %q: %s", path, err)
}

if err := d.Set(consts.FieldDataJSON, string(jsonData)); err != nil {
return diag.FromErr(err)
}

if err := d.Set(consts.FieldData, serializeDataMapToString(data)); err != nil {
return diag.FromErr(err)
Expand Down
43 changes: 43 additions & 0 deletions vault/resource_kv_secret_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,49 @@ func TestAccKVSecret(t *testing.T) {
},
})
}
func TestAccKVSecret_UpdateOutsideTerraform(t *testing.T) {
t.Parallel()
resourceName := "vault_kv_secret.test"
mount := acctest.RandomWithPrefix("tf-kvv2")
name := acctest.RandomWithPrefix("tf-secret")

resource.Test(t, resource.TestCase{
ProviderFactories: providerFactories,
PreCheck: func() { testutil.TestAccPreCheck(t) },
Steps: []resource.TestStep{
{
Config: testKVSecretConfig_basic(mount, name),
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr(resourceName, consts.FieldPath, fmt.Sprintf("%s/%s", mount, name)),
resource.TestCheckResourceAttr(resourceName, "data.%", "2"),
resource.TestCheckResourceAttr(resourceName, "data.zip", "zap"),
resource.TestCheckResourceAttr(resourceName, "data.foo", "bar"),
assertKVV1Data(resourceName),
),
},
{
PreConfig: func() {
client := testProvider.Meta().(*provider.ProviderMeta).MustGetClient()

// Simulate external change using Vault CLI for KV v1
path := fmt.Sprintf("%s/%s", mount, name)
_, err := client.Logical().Write(path, map[string]interface{}{"testkey3": "testvalue3"})
if err != nil {
t.Fatalf("error simulating external change; err=%s", err)
}
},
Config: testKVSecretConfig_basic(mount, name),
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr(resourceName, consts.FieldPath, fmt.Sprintf("%s/%s", mount, name)),
resource.TestCheckResourceAttr(resourceName, "data.%", "2"),
resource.TestCheckResourceAttr(resourceName, "data.zip", "zap"),
resource.TestCheckResourceAttr(resourceName, "data.foo", "bar"),
assertKVV1Data(resourceName),
),
},
},
})
}

func kvV1MountConfig(path string) string {
ret := fmt.Sprintf(`
Expand Down
7 changes: 7 additions & 0 deletions vault/resource_kv_secret_v2.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,14 @@ func kvSecretV2Read(_ context.Context, d *schema.ResourceData, meta interface{})
log.Printf("[DEBUG] secret: %#v", secret)

data := secret.Data["data"]
jsonData, err := json.Marshal(data)
if err != nil {
return diag.Errorf("error marshaling JSON for %q: %s", path, err)
}

if err := d.Set(consts.FieldDataJSON, string(jsonData)); err != nil {
return diag.FromErr(err)
}
if v, ok := data.(map[string]interface{}); ok {
if err := d.Set(consts.FieldData, serializeDataMapToString(v)); err != nil {
return diag.FromErr(err)
Expand Down
53 changes: 53 additions & 0 deletions vault/resource_kv_secret_v2_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,58 @@ func TestAccKVSecretV2_DisableRead(t *testing.T) {
})
}

// Fadia u have added this
func TestAccKVSecretV2_UpdateOutsideTerraform(t *testing.T) {
resourceName := "vault_kv_secret_v2.test"
mount := acctest.RandomWithPrefix("tf-kv")
name := acctest.RandomWithPrefix("foo")

resource.Test(t, resource.TestCase{
ProviderFactories: providerFactories,
PreCheck: func() { testutil.TestAccPreCheck(t) },
Steps: []resource.TestStep{
{
Config: testKVSecretV2Config_initial(mount, name),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(resourceName, consts.FieldMount, mount),
resource.TestCheckResourceAttr(resourceName, consts.FieldName, name),
resource.TestCheckResourceAttr(resourceName, consts.FieldPath, fmt.Sprintf("%s/data/%s", mount, name)),
resource.TestCheckResourceAttr(resourceName, "delete_all_versions", "true"),
resource.TestCheckResourceAttr(resourceName, "data.zip", "zap"),
resource.TestCheckResourceAttr(resourceName, "data.foo", "bar"),
resource.TestCheckResourceAttr(resourceName, "data.flag", "false"),
resource.TestCheckResourceAttr(resourceName, "metadata.version", "1"),
),
},
{
PreConfig: func() {
client := testProvider.Meta().(*provider.ProviderMeta).MustGetClient()

// Simulate external change using Vault CLI
path := fmt.Sprintf("%s/data/%s", mount, name)
_, err := client.Logical().Write(path, map[string]interface{}{"data": map[string]interface{}{"testkey3": "testvalue3"}})
if err != nil {
t.Fatalf(fmt.Sprintf("error simulating external change; err=%s", err))
}

},

Config: testKVSecretV2Config_initial(mount, name),

Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(resourceName, "data.zip", "zap"),
resource.TestCheckResourceAttr(resourceName, "data.foo", "bar"),
resource.TestCheckResourceAttr(resourceName, "data.flag", "false"),
resource.TestCheckResourceAttr(resourceName, "data_json", "{\"flag\":false,\"foo\":\"bar\",\"zip\":\"zap\"}"),
//we check that the provider updated vault to match the the terraform config therefor creating a new version the secret.
resource.TestCheckResourceAttr(resourceName, "metadata.version", "3"),
),
},
},
},
)
}

func readKVData(t *testing.T, mount, name string) {
t.Helper()
client := testProvider.Meta().(*provider.ProviderMeta).MustGetClient()
Expand All @@ -235,6 +287,7 @@ func readKVData(t *testing.T, mount, name string) {
if !reflect.DeepEqual(resp.Data["data"], testKVV2Data) {
t.Fatalf("kvv2 secret data does not match got: %#+v, want: %#+v", resp.Data["data"], testKVV2Data)
}

}

func writeKVData(t *testing.T, mount, name string) {
Expand Down
Loading