Removing ConfigStateChecks type (#266)

hashicorp · Jan 23, 2024 · 04cf3c9 · 04cf3c9
1 parent 6d8f112
commit 04cf3c9
Show file tree

Hide file tree

Showing 11 changed files with 140 additions and 142 deletions.
diff --git a/helper/resource/testing.go b/helper/resource/testing.go
@@ -591,12 +591,12 @@ type TestStep struct {
 	// [plancheck]: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-testing/plancheck
 	RefreshPlanChecks RefreshPlanChecks
 
-	// ConfigStateChecks allow assertions to be made against the state file at different points of a Config (apply) test using a state check.
+	// ConfigStateChecks allow assertions to be made against the state file during a Config (apply) test using a state check.
 	// Custom state checks can be created by implementing the [StateCheck] interface, or by using a StateCheck implementation from the provided [statecheck] package
 	//
 	// [StateCheck]: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-testing/statecheck#StateCheck
 	// [statecheck]: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-testing/statecheck
-	ConfigStateChecks ConfigStateChecks
+	ConfigStateChecks []statecheck.StateCheck
 
 	// PlanOnly can be set to only run `plan` with this configuration, and not
 	// actually apply it. This is useful for ensuring config changes result in
@@ -803,10 +803,6 @@ type RefreshPlanChecks struct {
 	PostRefresh []plancheck.PlanCheck
 }
 
-// ConfigStateChecks runs all state checks in the slice. This occurs after the apply and refresh of a Config test are run.
-// All errors by state checks in this slice are aggregated, reported, and will result in a test failure.
-type ConfigStateChecks []statecheck.StateCheck
-
 // ParallelTest performs an acceptance test on a resource, allowing concurrency
 // with other ParallelTest. The number of concurrent tests is controlled by the
 // "go test" command -parallel flag.

diff --git a/helper/resource/testing_new_config_test.go b/helper/resource/testing_new_config_test.go
@@ -15,6 +15,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testsdk/providerserver"
 	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testsdk/resource"
 	"github.com/hashicorp/terraform-plugin-testing/plancheck"
+	"github.com/hashicorp/terraform-plugin-testing/statecheck"
 	"github.com/hashicorp/terraform-plugin-testing/tfversion"
 )
 
@@ -764,7 +765,7 @@ func Test_ConfigStateChecks_Called(t *testing.T) {
 		Steps: []TestStep{
 			{
 				Config: `resource "test_resource" "test" {}`,
-				ConfigStateChecks: ConfigStateChecks{
+				ConfigStateChecks: []statecheck.StateCheck{
 					spy1,
 					spy2,
 				},
@@ -831,7 +832,7 @@ func Test_ConfigStateChecks_Errors(t *testing.T) {
 		Steps: []TestStep{
 			{
 				Config: `resource "test_resource" "test" {}`,
-				ConfigStateChecks: ConfigStateChecks{
+				ConfigStateChecks: []statecheck.StateCheck{
 					spy1,
 					spy2,
 					spy3,

diff --git a/helper/resource/teststep_validate_test.go b/helper/resource/teststep_validate_test.go
@@ -16,6 +16,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/config"
 	"github.com/hashicorp/terraform-plugin-testing/internal/teststep"
 	"github.com/hashicorp/terraform-plugin-testing/plancheck"
+	"github.com/hashicorp/terraform-plugin-testing/statecheck"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
@@ -468,7 +469,7 @@ func TestTestStepValidate(t *testing.T) {
 		},
 		"configstatechecks-not-config-mode": {
 			testStep: TestStep{
-				ConfigStateChecks: ConfigStateChecks{
+				ConfigStateChecks: []statecheck.StateCheck{
 					&stateCheckSpy{},
 				},
 				RefreshState: true,