Skip to content

fix(okms_secret): detect drift on data change #1162

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+81 −6
Open

fix(okms_secret): detect drift on data change #1162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
87 changes: 81 additions & 6 deletions ovh/resource_okms_secret.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,28 +82,75 @@ func (r *okmsSecretResource) Create(ctx context.Context, req resource.CreateRequ
}

func (r *okmsSecretResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
var data, responseData OkmsSecretModel
var secretFromState, currentSecret OkmsSecretModel

// Read Terraform prior state data into the model
resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
resp.Diagnostics.Append(req.State.Get(ctx, &secretFromState)...)
if resp.Diagnostics.HasError() {
return
}

endpoint := "/v2/okms/resource/" + url.PathEscape(data.OkmsId.ValueString()) + "/secret/" + url.PathEscape(data.Path.ValueString()) + ""
endpoint := "/v2/okms/resource/" + url.PathEscape(secretFromState.OkmsId.ValueString()) + "/secret/" + url.PathEscape(secretFromState.Path.ValueString())

if err := r.config.OVHClient.Get(endpoint, &responseData); err != nil {
if err := r.config.OVHClient.Get(endpoint, &currentSecret); err != nil {
resp.Diagnostics.AddError(
fmt.Sprintf("Error calling Get %s", endpoint),
err.Error(),
)
return
}

data.MergeWith(&responseData)
// Update metadata and IAM from API response
secretFromState.Metadata = currentSecret.Metadata
secretFromState.Iam = currentSecret.Iam

// Fetch the current version details including data for drift detection
currentVersion := currentSecret.Metadata.CurrentVersion.ValueInt64()
versionEndpoint := "/v2/okms/resource/" + url.PathEscape(secretFromState.OkmsId.ValueString()) + "/secret/" + url.PathEscape(secretFromState.Path.ValueString()) + "/version/" + fmt.Sprintf("%d", currentVersion) + "?includeData=true"

var currentSecretVersion struct {
Id *int64 `json:"id"`
CreatedAt *string `json:"createdAt"`
State *string `json:"state"`
DeactivatedAt *string `json:"deactivatedAt"`
Data json.RawMessage `json:"data"`
}
if err := r.config.OVHClient.Get(versionEndpoint, &currentSecretVersion); err == nil {
// Update version computed fields
if currentSecretVersion.Id != nil {
secretFromState.Version.Id = ovhtypes.NewTfInt64Value(*currentSecretVersion.Id)
}
if currentSecretVersion.CreatedAt != nil {
secretFromState.Version.CreatedAt = ovhtypes.NewTfStringValue(*currentSecretVersion.CreatedAt)
}
if currentSecretVersion.State != nil {
secretFromState.Version.State = ovhtypes.NewTfStringValue(*currentSecretVersion.State)
}
if currentSecretVersion.DeactivatedAt != nil {
secretFromState.Version.DeactivatedAt = ovhtypes.NewTfStringValue(*currentSecretVersion.DeactivatedAt)
} else {
secretFromState.Version.DeactivatedAt = ovhtypes.NewTfStringNull()
}

// Check version state and data for drift detection
if currentSecretVersion.State != nil && *currentSecretVersion.State == "DELETED" {
// Version is deleted - mark data as empty to force drift detection
secretFromState.Version.Data = ovhtypes.NewTfStringValue("")
} else if len(currentSecretVersion.Data) > 0 {
// Version is active - compare data for drift
actualData := string(currentSecretVersion.Data)
configData := secretFromState.Version.Data.ValueString()

if !semanticJSONEqual(configData, actualData) {
// Data differs - update state with actual value so Terraform shows drift
secretFromState.Version.Data = ovhtypes.NewTfStringValue(actualData)
}
}
}
// Silently ignore errors - drift detection is best-effort

// Save updated data into Terraform state
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
resp.Diagnostics.Append(resp.State.Set(ctx, &secretFromState)...)
}

func (r *okmsSecretResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
Expand Down Expand Up @@ -244,6 +291,34 @@ func buildMetadataPayload(meta *MetadataValue) map[string]any {
return mp
}

// semanticJSONEqual compares two JSON strings for semantic equality,
// ignoring formatting differences like whitespace and key ordering.
func semanticJSONEqual(a, b string) bool {
var objA, objB interface{}

// Try to parse both as JSON
if err := json.Unmarshal([]byte(a), &objA); err != nil {
// Not valid JSON, fall back to string comparison
return a == b
}
if err := json.Unmarshal([]byte(b), &objB); err != nil {
// Not valid JSON, fall back to string comparison
return a == b
}

// Re-marshal both in canonical form and compare
normalizedA, err := json.Marshal(objA)
if err != nil {
return a == b
}
normalizedB, err := json.Marshal(objB)
if err != nil {
return a == b
}

return string(normalizedA) == string(normalizedB)
}

// populateVersionComputedFields fills secret version attributes
func populateVersionComputedFields(r *okmsSecretResource, model *OkmsSecretModel, okmsId, path string) {
// If currentVersion unknown or zero, nothing to enrich
Expand Down