update CheckQueryRequest to provide ListResourceFoundData and ListCompleteData and refactor a little

Author: stephybun

helper/resource/query/query_checks.go

@@ -6,6 +6,7 @@ package query
 import (
 	"context"
 	"errors"
+	"fmt"
 
 	tfjson "github.com/hashicorp/terraform-json"
 	"github.com/mitchellh/go-testing-interface"
@@ -18,9 +19,35 @@ func RunQueryChecks(ctx context.Context, t testing.T, query *[]tfjson.LogMsg, qu
 
 	var result []error
 
+	if query == nil || len(*query) == 0 {
+		// TODO return error
+	}
+
+	found := make([]tfjson.ListResourceFoundData, 0)
+	complete := tfjson.ListCompleteData{}
+
+	for _, msg := range *query {
+		switch v := msg.(type) {
+		case tfjson.ListResourceFoundMessage:
+			found = append(found, v.ListResourceFound)
+		case tfjson.ListCompleteMessage:
+			complete = v.ListComplete
+			// TODO diagnostics and errors?
+		}
+	}
+
+	// TODO check diagnostics in LogMsg to see if there are any errors we can return here?
+	var err error
+	if len(found) == 0 {
+		return fmt.Errorf("no resources found by query: %+v", err)
+	}
+
 	for _, queryCheck := range queryChecks {
 		resp := querycheck.CheckQueryResponse{}
-		queryCheck.CheckQuery(ctx, querycheck.CheckQueryRequest{Query: query}, &resp)
+		queryCheck.CheckQuery(ctx, querycheck.CheckQueryRequest{
+			Query:          &found,
+			CompletedQuery: &complete,
+		}, &resp)
 
 		result = append(result, resp.Error)
 	}

helper/resource/query/query_test.go

@@ -134,7 +134,6 @@ func TestQuery(t *testing.T) {
 				ConfigQueryResultChecks: []querycheck.QueryResultCheck{
 					querycheck.ExpectLengthAtLeast("examplecloud_containerette.test", 2),
 					querycheck.ExpectLengthAtLeast("examplecloud_containerette.test2", 1),
-					querycheck.Contains(),
 				},
 			},
 		},

querycheck/contains.go

@@ -4,8 +4,6 @@ import (
 	"context"
 	"fmt"
 	"strings"
-
-	tfjson "github.com/hashicorp/terraform-json"
 )
 
 var _ QueryResultCheck = contains{}
@@ -16,37 +14,11 @@ type contains struct {
 }
 
 func (c contains) CheckQuery(_ context.Context, req CheckQueryRequest, resp *CheckQueryResponse) {
-	// TODO refactor below
-	foundResources := make([]string, 0)
-
-	if req.Query == nil {
-		resp.Error = fmt.Errorf("Query is nil")
-		return
-	}
-
-	for _, v := range *req.Query {
-		switch i := v.(type) {
-		case tfjson.ListResourceFoundMessage:
-			prefix := "list."
-			if strings.TrimPrefix(i.ListResourceFound.Address, prefix) == c.resourceAddress {
-				foundResources = append(foundResources, i.ListResourceFound.DisplayName)
-			}
-		default:
-			continue
-		}
-	}
-
-	if len(foundResources) == 0 {
-		resp.Error = fmt.Errorf("%s - no resources found by query.", c.resourceAddress)
-
-		return
-	}
-	// TODO refactor above
-
-	for _, res := range foundResources {
-		if c.check == res {
+	for _, res := range *req.Query {
+		if strings.EqualFold(c.check, res.DisplayName) {
 			return
 		}
+
 	}
 
 	resp.Error = fmt.Errorf("expected to find resource with display name %q in results but resource was not found", c.check)

querycheck/expect_identity.go

@@ -8,9 +8,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"strings"
 
-	tfjson "github.com/hashicorp/terraform-json"
 	"github.com/hashicorp/terraform-plugin-testing/knownvalue"
 )
 
@@ -23,42 +21,15 @@ type expectIdentity struct {
 
 // CheckQuery implements the query check logic.
 func (e expectIdentity) CheckQuery(ctx context.Context, req CheckQueryRequest, resp *CheckQueryResponse) {
-	var foundIdentities []map[string]json.RawMessage
-
-	if req.Query == nil {
-		resp.Error = fmt.Errorf("Query is nil")
-		return
-	}
-
-	for _, v := range *req.Query {
-		switch i := v.(type) {
-		case tfjson.ListResourceFoundMessage:
-			prefix := "list."
-			if strings.TrimPrefix(i.ListResourceFound.Address, prefix) == e.resourceAddress {
-				foundIdentities = append(foundIdentities, i.ListResourceFound.Identity)
-			}
-		default:
-			continue
-		}
-	}
-
-	if len(foundIdentities) == 0 {
-		resp.Error = fmt.Errorf("%s - Identity not found in query.", e.resourceAddress)
-
-		return
-	}
-
-	var err error
-
-	for _, resultIdentity := range foundIdentities {
+	for _, res := range *req.Query {
 		var errCollection []error
 
 		for attribute := range e.check {
 			var val any
-			var ok bool
 			var unmarshalledVal any
 
-			if val, ok = resultIdentity[attribute]; !ok {
+			val, ok := res.Identity[attribute]
+			if !ok {
 				resp.Error = fmt.Errorf("%s - expected attribute %q not in actual identity object", e.resourceAddress, attribute)
 				return
 			}
@@ -68,7 +39,7 @@ func (e expectIdentity) CheckQuery(ctx context.Context, req CheckQueryRequest, r
 				resp.Error = fmt.Errorf("%s - expected json.RawMessage but got %T", e.resourceAddress, val)
 				return
 			}
-			err = json.Unmarshal(rawMessage, &unmarshalledVal)
+			err := json.Unmarshal(rawMessage, &unmarshalledVal)
 
 			if err != nil {
 				resp.Error = fmt.Errorf("%s - Error decoding message type: %s", e.resourceAddress, err)
@@ -79,7 +50,6 @@ func (e expectIdentity) CheckQuery(ctx context.Context, req CheckQueryRequest, r
 				errCollection = append(errCollection, fmt.Errorf("%s - %q identity attribute: %s\n", e.resourceAddress, e.check, err))
 			}
 		}
-
 		if errCollection == nil {
 			return
 		}

querycheck/expect_result_length_atleast.go

@@ -6,9 +6,6 @@ package querycheck
 import (
 	"context"
 	"fmt"
-	"strings"
-
-	tfjson "github.com/hashicorp/terraform-json"
 )
 
 var _ QueryResultCheck = expectLengthAtLeast{}
@@ -19,32 +16,17 @@ type expectLengthAtLeast struct {
 }
 
 // CheckQuery implements the query check logic.
-func (e expectLengthAtLeast) CheckQuery(ctx context.Context, req CheckQueryRequest, resp *CheckQueryResponse) {
-	if req.Query == nil {
-		resp.Error = fmt.Errorf("Query is nil")
+func (e expectLengthAtLeast) CheckQuery(_ context.Context, req CheckQueryRequest, resp *CheckQueryResponse) {
+	if req.CompletedQuery == nil {
+		resp.Error = fmt.Errorf("no completed query information available")
 		return
 	}
 
-	for _, v := range *req.Query {
-		switch i := v.(type) {
-		case tfjson.ListCompleteMessage:
-			prefix := "list."
-
-			if strings.TrimPrefix(i.ListComplete.Address, prefix) == e.resourceAddress {
-				if i.ListComplete.Total < e.check {
-					resp.Error = fmt.Errorf("Query result of at least length %v - expected but got %v.", e.check, i.ListComplete.Total)
-					return
-				} else {
-					return
-				}
-			}
-		default:
-			continue
-		}
+	if req.CompletedQuery.Total < e.check {
+		resp.Error = fmt.Errorf("Query result of at least length %v - expected but got %v.", e.check, req.CompletedQuery.Total)
+		return
 	}
 
-	resp.Error = fmt.Errorf("%s - Address not found in query result.", e.resourceAddress)
-
 	return
 }
 

querycheck/expect_result_length_exact.go

@@ -8,9 +8,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"strconv"
-	"strings"
 
-	tfjson "github.com/hashicorp/terraform-json"
 	"github.com/hashicorp/terraform-plugin-testing/knownvalue"
 )
 
@@ -22,32 +20,18 @@ type expectLength struct {
 }
 
 // CheckQuery implements the query check logic.
-func (e expectLength) CheckQuery(ctx context.Context, req CheckQueryRequest, resp *CheckQueryResponse) {
-	if req.Query == nil {
-		resp.Error = fmt.Errorf("Query is nil")
+func (e expectLength) CheckQuery(_ context.Context, req CheckQueryRequest, resp *CheckQueryResponse) {
+	if req.CompletedQuery == nil {
+		resp.Error = fmt.Errorf("no completed query information available")
 		return
 	}
 
-	for _, v := range *req.Query {
-		switch i := v.(type) {
-		case tfjson.ListCompleteMessage:
-			prefix := "list."
-			lengthCheck := json.Number((strconv.Itoa(i.ListComplete.Total)))
-
-			if strings.TrimPrefix(i.ListComplete.Address, prefix) == e.resourceAddress {
-				if err := e.check.CheckValue(lengthCheck); err != nil {
-					resp.Error = fmt.Errorf("Query result of length %v - expected but got %v.", e.check, i.ListComplete.Total)
-					return
-				} else {
-					return
-				}
-			}
-		default:
-			continue
-		}
-	}
+	lengthCheck := json.Number(strconv.Itoa(req.CompletedQuery.Total))
 
-	resp.Error = fmt.Errorf("%s - Address not found in query result.", e.resourceAddress)
+	if err := e.check.CheckValue(lengthCheck); err != nil {
+		resp.Error = fmt.Errorf("Query result of length %v - expected but got %v.", e.check, req.CompletedQuery.Total)
+		return
+	}
 
 	return
 }

querycheck/query_check.go

@@ -19,7 +19,10 @@ type QueryResultCheck interface {
 // CheckQueryRequest is a request for an invoke of the CheckQuery function.
 type CheckQueryRequest struct {
 	// Query represents a parsed query file, retrieved via the `terraform show -json` command.
-	Query *[]tfjson.LogMsg
+	Query *[]tfjson.ListResourceFoundData
+
+	// CompletedQuery contains a summary of the completed query operation.
+	CompletedQuery *tfjson.ListCompleteData
 }
 
 // CheckQueryResponse is a response to an invoke of the CheckQuery function.