Validation and Modifiers Issues (#836)

* Initial plan for issue

* Fix validation and modifiers issues

Co-authored-by: mawasile <50197777+mawasile@users.noreply.github.com>

* Fix linting issue, generate docs, and add changie entry

Co-authored-by: mawasile <50197777+mawasile@users.noreply.github.com>

* Update internal/modifiers/set_bool_value_unknown_if_checksum_change_modifier.go

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: mawasile <50197777+mawasile@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Matt Dotson <mattdot@users.noreply.github.com>

Author: 4 people

.changes/unreleased/fixed-20250605-102519.yaml

@@ -0,0 +1,5 @@
+kind: fixed
+body: 'Fixed validation and modifiers issues: improved error handling in validators and plan modifiers, corrected error messages for SHA256 checksums, and enhanced diagnostic context'
+time: 2025-06-05T10:25:19.227038423Z
+custom:
+    Issue: "821"

internal/modifiers/set_bool_value_unknown_if_checksum_change_modifier.go

@@ -61,7 +61,7 @@ func (d *setBoolValueToUnknownIfChecksumsChangeModifier) hasChecksumChanged(ctx
 
 	value, err := helpers.CalculateSHA256(attribute.ValueString())
 	if err != nil {
-		resp.Diagnostics.AddError(fmt.Sprintf("Error calculating MD5 checksum for %s", attribute), err.Error())
+		resp.Diagnostics.AddError(fmt.Sprintf("Error calculating SHA256 checksum for %q", attribute), err.Error())
 	}
 
 	return value != attributeChecksum.ValueString()

internal/modifiers/set_string_value_unknown_if_checksum_change_modifier.go

@@ -54,14 +54,20 @@ func (d *setStringValueToUnknownIfChecksumsChangeModifier) hasChecksumChanged(ct
 	var attribute types.String
 	diags := req.Plan.GetAttribute(ctx, path.Root(attributeName), &attribute)
 	resp.Diagnostics.Append(diags...)
+	if diags.HasError() {
+		return false
+	}
 
 	var attributeChecksum types.String
 	diags = req.State.GetAttribute(ctx, path.Root(checksumAttributeName), &attributeChecksum)
 	resp.Diagnostics.Append(diags...)
+	if diags.HasError() {
+		return false
+	}
 
 	value, err := helpers.CalculateSHA256(attribute.ValueString())
 	if err != nil {
-		resp.Diagnostics.AddError(fmt.Sprintf("Error calculating MD5 checksum for %s", attribute), err.Error())
+		resp.Diagnostics.AddError(fmt.Sprintf("Error calculating SHA256 checksum for attribute %q", attributeName), err.Error())
 	}
 
 	return value != attributeChecksum.ValueString()

internal/modifiers/sync_attribute_plan_modifier.go

@@ -47,11 +47,12 @@ func (d *syncAttributePlanModifier) PlanModifyString(ctx context.Context, req pl
 	} else {
 		value, err := helpers.CalculateSHA256(settingsFile.ValueString())
 		if err != nil {
-			resp.Diagnostics.AddError(fmt.Sprintf("Error calculating MD5 checksum for %s", d.syncAttribute), err.Error())
+			resp.Diagnostics.AddError(fmt.Sprintf("Error calculating SHA256 checksum for %s", d.syncAttribute), err.Error())
 			return
 		}
 
 		if value == "" {
+			resp.Diagnostics.AddError(fmt.Sprintf("Checksum is empty for %s", d.syncAttribute), "Calculated SHA256 checksum resulted in an empty value, which is unexpected.")
 			resp.PlanValue = types.StringUnknown()
 		} else {
 			resp.PlanValue = types.StringValue(value)

internal/services/data_record/dynamic_columns_validator.go

@@ -60,7 +60,10 @@ func (v DynamicsColumnsValidator) Validate(ctx context.Context, config tfsdk.Con
 	}
 
 	var dynamicColumns types.Dynamic
-	_ = config.GetAttribute(ctx, matchedPaths[0], &dynamicColumns)
+	diags.Append(config.GetAttribute(ctx, matchedPaths[0], &dynamicColumns)...)
+	if diags.HasError() {
+		return diags
+	}
 
 	terraformDynamicColumns, err := dynamicColumns.UnderlyingValue().ToTerraformValue(ctx)
 	if err != nil {

internal/validators/make_field_required_when_other_field_does_not_have_value_validator.go

@@ -62,7 +62,10 @@ func (av MakeFieldRequiredWhenOtherFieldDoesNotHaveValueValidator) ValidateStrin
 func (av MakeFieldRequiredWhenOtherFieldDoesNotHaveValueValidator) Validate(ctx context.Context, req MakeFieldRequiredWhenOtherFieldDoesNotHaveValueValidatorRequest, res *MakeFieldRequiredWhenOtherFieldDoesNotHaveValueValidatorResponse) {
 	paths, _ := req.Config.PathMatches(ctx, av.OtherFieldExpression)
 	if paths == nil || len(paths) != 1 {
-		res.Diagnostics.AddError("Other field required when value of validator should have exactly one match", "")
+		res.Diagnostics.AddError(
+			"Validator Configuration Error: Other field match failed",
+			"The validator could not uniquely locate the other field in the configuration. Ensure that 'OtherFieldExpression' matches exactly one attribute.",
+		)
 		return
 	}
 	otherFieldValue := ""

internal/validators/other_field_required_when_value_of_validator.go

@@ -84,7 +84,10 @@ func (av OtherFieldRequiredWhenValueOfValidator) Validate(ctx context.Context, r
 
 		if (av.OtherFieldValueRegex != nil && otherFieldValue != nil && !av.OtherFieldValueRegex.MatchString(*otherFieldValue)) ||
 			(av.OtherFieldValueRegex == nil && (otherFieldValue == nil || *otherFieldValue == "") && !isUnknown) {
-			res.Diagnostics.AddError(av.ErrorMessage, av.ErrorMessage)
+			res.Diagnostics.AddError(
+				av.ErrorMessage,
+				"Field \""+paths[0].String()+"\" does not meet required value conditions.",
+			)
 		}
 	}
 }