Add query to acceptance test support

Author: bbasata

internal/plugintest/working_dir.go

@@ -1,13 +1,16 @@
-// Copyright (c) HashiCorp, Inc.
+//ng Copyright (c) HashiCorp, Inc.
 // SPDX-License-Identifier: MPL-2.0
 
 package plugintest
 
 import (
+	"bytes"
 	"context"
+	"encoding/json"
 	"fmt"
 	"io"
 	"os"
+	"os/exec"
 	"path/filepath"
 
 	"github.com/hashicorp/terraform-exec/tfexec"
@@ -21,6 +24,7 @@ import (
 const (
 	ConfigFileName = "terraform_plugin_test.tf"
 	PlanFileName   = "tfplan"
+	QueryFileName  = "terraform_plugin_test.tfquery.hcl"
 )
 
 // WorkingDir represents a distinct working directory that can be used for
@@ -37,6 +41,10 @@ type WorkingDir struct {
 	// was stored; empty until SetConfig is called.
 	configFilename string
 
+	// queryFilename is the full filename where the latest query configuration
+	// was stored; empty until SetQuery is called.
+	queryFilename string
+
 	// tf is the instance of tfexec.Terraform used for running Terraform commands
 	tf *tfexec.Terraform
 
@@ -101,7 +109,7 @@ func (wd *WorkingDir) SetConfig(ctx context.Context, cfg teststep.Config, vars c
 
 	for _, file := range fi {
 		if file.Mode().IsRegular() {
-			if filepath.Ext(file.Name()) == ".tf" || filepath.Ext(file.Name()) == ".json" {
+			if filepath.Ext(file.Name()) == ".tf" || filepath.Ext(file.Name()) == ".json" || filepath.Ext(file.Name()) == ".hcl" {
 				err = os.Remove(filepath.Join(d.Name(), file.Name()))
 
 				if err != nil && !os.IsNotExist(err) {
@@ -151,6 +159,80 @@ func (wd *WorkingDir) SetConfig(ctx context.Context, cfg teststep.Config, vars c
 	return nil
 }
 
+// SetQuery sets a new query configuration for the working directory.
+//
+// This must be called at least once before any call to Init or Query Destroy
+// to establish the query configuration. Any previously-set configuration is
+// discarded and any saved plan is cleared.
+func (wd *WorkingDir) SetQuery(ctx context.Context, cfg teststep.Config, vars config.Variables) error {
+	// Remove old config and variables files first
+	d, err := os.Open(wd.baseDir)
+
+	if err != nil {
+		return err
+	}
+
+	defer d.Close()
+
+	fi, err := d.Readdir(-1)
+
+	if err != nil {
+		return err
+	}
+
+	for _, file := range fi {
+		if file.Mode().IsRegular() {
+			if filepath.Ext(file.Name()) == ".warioform" || filepath.Ext(file.Name()) == ".json" || filepath.Ext(file.Name()) == ".hcl" {
+				err = os.Remove(filepath.Join(d.Name(), file.Name()))
+
+				if err != nil && !os.IsNotExist(err) {
+					return err
+				}
+			}
+		}
+	}
+
+	logging.HelperResourceTrace(ctx, "Setting Terraform query configuration", map[string]any{logging.KeyTestTerraformConfiguration: cfg})
+
+	outFilename := filepath.Join(wd.baseDir, QueryFileName)
+
+	// This file has to be written otherwise wd.Init() will return an error.
+	err = os.WriteFile(outFilename, nil, 0700)
+
+	if err != nil {
+		return err
+	}
+
+	// wd.configFilename must be set otherwise wd.Init() will return an error.
+	wd.queryFilename = outFilename
+	wd.configFilename = outFilename
+
+	// Write configuration
+	if cfg != nil {
+		err = cfg.WriteQuery(ctx, wd.baseDir)
+
+		if err != nil {
+			return err
+		}
+	}
+
+	//Write configuration variables
+	err = vars.Write(wd.baseDir)
+
+	if err != nil {
+		return err
+	}
+
+	// Changing configuration invalidates any saved plan.
+	err = wd.ClearPlan(ctx)
+
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 // ClearState deletes any Terraform state present in the working directory.
 //
 // Any remote objects tracked by the state are not destroyed first, so this
@@ -444,3 +526,38 @@ func (wd *WorkingDir) Schemas(ctx context.Context) (*tfjson.ProviderSchemas, err
 
 	return providerSchemas, err
 }
+
+func (wd *WorkingDir) Query(ctx context.Context) ([]string, error) {
+	logging.HelperResourceTrace(ctx, "Calling Terraform CLI providers query command")
+
+	var reattachStr string
+	if wd.reattachInfo != nil {
+		reattachJson, err := json.Marshal(wd.reattachInfo)
+		if err != nil {
+			return nil, fmt.Errorf("error marshaling reattach info: %w", err)
+		}
+		reattachStr = string(reattachJson)
+	}
+
+	buffer := &bytes.Buffer{}
+	errBuffer := &bytes.Buffer{}
+	cmd := exec.CommandContext(ctx, wd.terraformExec, "query", "-json")
+	cmd.Dir = wd.baseDir
+	cmd.Stdout = buffer
+	cmd.Stderr = errBuffer
+	cmd.Env = os.Environ()
+	fmt.Println("Reattach info: ", reattachStr)
+	cmd.Env = append(cmd.Env, "TF_REATTACH_PROVIDERS="+reattachStr)
+
+	err := cmd.Run()
+	if err != nil {
+		output := buffer.String() + "\n\n" + errBuffer.String()
+		fmt.Println(output)
+		return nil, fmt.Errorf("error running terraform query command: %w", err)
+	}
+
+	logging.HelperResourceTrace(ctx, "Called Terraform CLI providers query command")
+
+	output := buffer.String()
+	return []string{output}, nil
+}

internal/teststep/config.go

@@ -18,6 +18,9 @@ import (
 const (
 	rawConfigFileName     = "terraform_plugin_test.tf"
 	rawConfigFileNameJSON = rawConfigFileName + ".json"
+
+	rawQueryConfigFileName = "terraform_plugin_test.tfquery.hcl"
+	// rawQueryConfigFileNameJSON = rawConfigFileName + ".json"
 )
 
 var (
@@ -45,6 +48,7 @@ type Config interface {
 	HasProviderBlock(context.Context) (bool, error)
 	HasTerraformBlock(context.Context) (bool, error)
 	Write(context.Context, string) error
+	WriteQuery(context.Context, string) error
 	Append(string) Config
 }
 

internal/teststep/directory.go

@@ -75,6 +75,10 @@ func (c configurationDirectory) HasTerraformBlock(ctx context.Context) (bool, er
 	return contains, nil
 }
 
+func (c configurationDirectory) WriteQuery(ctx context.Context, dest string) error {
+	panic("WriteQuery not supported for configurationDirectory")
+}
+
 // Write copies all files from directory to destination.
 func (c configurationDirectory) Write(ctx context.Context, dest string) error {
 	configDirectory := c.directory

internal/teststep/file.go

@@ -71,6 +71,10 @@ func (c configurationFile) HasTerraformBlock(ctx context.Context) (bool, error)
 	return contains, nil
 }
 
+func (c configurationFile) WriteQuery(ctx context.Context, dest string) error {
+	panic("WriteQuery not supported for configurationFile")
+}
+
 // Write copies file from c.file to destination.
 func (c configurationFile) Write(ctx context.Context, dest string) error {
 	configFile := c.file

internal/teststep/string.go

@@ -61,6 +61,20 @@ func (c configurationString) Write(ctx context.Context, dest string) error {
 	return nil
 }
 
+// WriteQuery creates a file and writes c.raw into it.
+func (c configurationString) WriteQuery(ctx context.Context, dest string) error {
+	outFilename := filepath.Join(dest, rawQueryConfigFileName)
+
+	bCfg := []byte(c.raw)
+
+	err := os.WriteFile(outFilename, bCfg, 0700)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func (c configurationString) Append(config string) Config {
 	return configurationString{
 		raw: strings.Join([]string{c.raw, config}, "\n"),