Deprecating ExpectNullOutputValue and ExpectNullOutputValueAtPath pla…

…n checks (#266)
hashicorp · Jan 18, 2024 · c542a70 · c542a70
1 parent 178c2c4
commit c542a70
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/plancheck/expect_null_output_value.go b/plancheck/expect_null_output_value.go
@@ -64,6 +64,12 @@ func (e expectNullOutputValue) CheckPlan(ctx context.Context, req CheckPlanReque
 // Due to implementation differences between the terraform-plugin-sdk and the terraform-plugin-framework, representation of null
 // values may differ. For example, terraform-plugin-sdk based providers may have less precise representations of null values, such
 // as marking whole maps as null rather than individual element values.
+//
+// Deprecated: Use ExpectKnownOutputValue with knownvalue.NullExact instead.
+// ExpectNullOutputValue will be removed in the next major version release.
+//
+// [ExpectKnownOutputValue]: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-testing/plancheck#ExpectKnownOutputValue
+// [NullExact]: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-testing/knownvalue#NullExact
 func ExpectNullOutputValue(outputAddress string) PlanCheck {
 	return expectNullOutputValue{
 		outputAddress: outputAddress,

diff --git a/plancheck/expect_null_output_value_at_path.go b/plancheck/expect_null_output_value_at_path.go
@@ -65,6 +65,12 @@ func (e expectNullOutputValueAtPath) CheckPlan(ctx context.Context, req CheckPla
 // Due to implementation differences between the terraform-plugin-sdk and the terraform-plugin-framework, representation of null
 // values may differ. For example, terraform-plugin-sdk based providers may have less precise representations of null values, such
 // as marking whole maps as null rather than individual element values.
+//
+// Deprecated: Use ExpectKnownOutputValueAtPath with knownvalue.NullExact instead.
+// ExpectNullOutputValueAtPath will be removed in the next major version release.
+//
+// [ExpectKnownOutputValueAtPath]: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-testing/plancheck#ExpectKnownOutputValueAtPath
+// [NullExact]: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-testing/knownvalue#NullExact
 func ExpectNullOutputValueAtPath(outputAddress string, valuePath tfjsonpath.Path) PlanCheck {
 	return expectNullOutputValueAtPath{
 		outputAddress: outputAddress,