Run terraform query and echo the output

Author: bbasata

helper/resource/query/query_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	r "github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testprovider"
+	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testsdk/list"
 	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testsdk/providerserver"
 	"github.com/hashicorp/terraform-plugin-testing/tfversion"
 )
@@ -19,24 +20,41 @@ func TestQuery(t *testing.T) {
 		},
 		ProtoV6ProviderFactories: map[string]func() (tfprotov6.ProviderServer, error){
 			"examplecloud": providerserver.NewProviderServer(testprovider.Provider{
+				ListResources: map[string]testprovider.ListResource{
+					"examplecloud_containerette": {
+						SchemaResponse: &list.SchemaResponse{
+							Schema: &tfprotov6.Schema{
+								Block: &tfprotov6.SchemaBlock{
+									Attributes: []*tfprotov6.SchemaAttribute{
+										ComputedStringAttribute("id"),
+									},
+								},
+							},
+						},
+						ListResultsStream: &list.ListResultsStream{
+							Results: func(push func(list.ListResult) bool) {
+							},
+						},
+					},
+				},
 				Resources: map[string]testprovider.Resource{
-					"examplecloud_container": examplecloudResource(),
+					"examplecloud_containerette": examplecloudResource(),
 				},
 			}),
 		},
 		Steps: []r.TestStep{
 			{
+				Query: true,
 				Config: `
-				resource "examplecloud_container" "test" {
-					location = "westeurope"
-					name     = "somevalue"
+				provider "examplecloud" {}
+				list "examplecloud_containerette" "test" {
+					provider = examplecloud
+
+					config {
+						id = "bat"
+					}
 				}`,
 			},
-			{
-				ResourceName:    "examplecloud_container.test",
-				ImportState:     true,
-				ImportStateKind: r.ImportBlockWithID,
-			},
 		},
 	})
 }

helper/resource/testing.go

@@ -835,6 +835,8 @@ type TestStep struct {
 	// for performing import testing where the prior TestStep configuration
 	// contained a provider outside the one under test.
 	ExternalProviders map[string]ExternalProvider
+
+	Query bool
 }
 
 // ConfigPlanChecks defines the different points in a Config TestStep when plan checks can be run.

helper/resource/testing_new.go

@@ -106,6 +106,7 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 			},
 		)
 
+		fmt.Println("Writing provider configuration:", c.providerConfig(ctx, false))
 		err := wd.SetConfig(ctx, config, nil)
 
 		if err != nil {
@@ -254,7 +255,10 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 
 			testStepConfig = teststep.Configuration(confRequest)
 
-			err = wd.SetConfig(ctx, testStepConfig, step.ConfigVariables)
+			if !step.Query {
+				fmt.Println("Writing pre-switch configuration:", rawCfg)
+				err = wd.SetConfig(ctx, testStepConfig, step.ConfigVariables)
+			}
 
 			if err != nil {
 				logging.HelperResourceError(ctx,
@@ -356,6 +360,39 @@ func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest
 			continue
 		}
 
+		if step.Query {
+			logging.HelperResourceTrace(ctx, "TestStep is Query mode")
+
+			queryConfigRequest := teststep.ConfigurationRequest{
+				Raw: &step.Config,
+			}
+			err := wd.SetQuery(ctx, teststep.Configuration(queryConfigRequest), step.ConfigVariables)
+			if err != nil {
+				t.Fatalf("Step %d/%d error setting query: %s", stepNumber, len(c.Steps), err)
+			}
+
+			err = runProviderCommand(ctx, t, wd, providers, func() error {
+				return wd.Init(ctx)
+			})
+			if err != nil {
+				t.Fatalf("Step %d/%d error running init: %s", stepNumber, len(c.Steps), err)
+			}
+
+			var queryOut []string
+			err = runProviderCommand(ctx, t, wd, providers, func() error {
+				var err error
+				queryOut, err = wd.Query(ctx)
+				return err
+			})
+			if err != nil {
+				fmt.Printf("Step %d/%d Query Output:\n%s\n", stepNumber, len(c.Steps), queryOut)
+				t.Fatalf("Step %d/%d error running query: %s", stepNumber, len(c.Steps), err)
+			}
+
+			fmt.Printf("Step %d/%d Query Output:\n%s\n", stepNumber, len(c.Steps), queryOut)
+			continue
+		}
+
 		if cfg != nil {
 			logging.HelperResourceTrace(ctx, "TestStep is Config mode")
 
@@ -567,6 +604,7 @@ func testIDRefresh(ctx context.Context, t testing.T, c TestCase, wd *plugintest.
 
 		testStepConfigDefer := teststep.Configuration(confRequest)
 
+		fmt.Println("Writing the reset to original configuration:", rawCfg)
 		err = wd.SetConfig(ctx, testStepConfigDefer, step.ConfigVariables)
 
 		if err != nil {

helper/resource/testing_new_config.go

@@ -435,6 +435,7 @@ func testStepNewConfig(ctx context.Context, t testing.T, c TestCase, wd *plugint
 		// this fails. If refresh isn't read-only, then this will have
 		// caught a different bug.
 		if idRefreshCheck != nil {
+			fmt.Println("Not Writing by testing ID Refresh")
 			if err := testIDRefresh(ctx, t, c, wd, step, idRefreshCheck, providers, stepIndex, helper); err != nil {
 				return fmt.Errorf(
 					"[ERROR] Test: ID-only test failed: %s", err)