#30 wip support for WalkResources API

Author: iwarapter

tflint/client.go

@@ -140,6 +140,47 @@ func (c *Client) WalkResourceBlocks(resource, blockName string, walker func(*hcl
 	return nil
 }
 
+// ResourcesRequest is the interface used to communicate via RPC.
+type ResourcesRequest struct {
+	Name string
+}
+
+// ResourcesResponse is the interface used to communicate via RPC.
+type ResourcesResponse struct {
+	Resources []*Resource
+	Err       error
+}
+
+// Resource is an intermediate representation of configs.Resource.
+type Resource struct {
+	Name string
+	Type string
+
+	DeclRange hcl.Range
+	TypeRange hcl.Range
+}
+
+// WalkResources queries the host process, receives a list of blocks that match the conditions,
+// and passes each to the walker function.
+func (c *Client) WalkResources(resource string, walker func(*Resource) error) error {
+	log.Printf("[DEBUG] Walk `%s` resource", resource)
+
+	var response ResourcesResponse
+	if err := c.rpcClient.Call("Plugin.Resources", ResourcesRequest{Name: resource}, &response); err != nil {
+		return err
+	}
+	if response.Err != nil {
+		return response.Err
+	}
+
+	for _, block := range response.Resources {
+		if err := walker(block); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 // EvalExprRequest is the interface used to communicate via RPC.
 type EvalExprRequest struct {
 	Expr      []byte

tflint/client_test.go

@@ -56,6 +56,18 @@ func (*mockServer) Blocks(req *BlocksRequest, resp *BlocksResponse) error {
 	return nil
 }
 
+func (*mockServer) Resources(req *ResourcesRequest, resp *ResourcesResponse) error {
+	*resp = ResourcesResponse{Resources: []*Resource{
+		{
+			Name:      "example",
+			Type:      "resource",
+			DeclRange: hcl.Range{Filename: "example.tf", Start: hcl.Pos{Line: 1, Column: 1}, End: hcl.Pos{Line: 1, Column: 29}},
+			TypeRange: hcl.Range{Filename: "example.tf", Start: hcl.Pos{Line: 1, Column: 1}, End: hcl.Pos{Line: 1, Column: 8}},
+		},
+	}, Err: nil}
+	return nil
+}
+
 func (*mockServer) EvalExpr(req *EvalExprRequest, resp *EvalExprResponse) error {
 	*resp = EvalExprResponse{Val: cty.StringVal("1"), Err: nil}
 	return nil
@@ -179,6 +191,39 @@ func Test_WalkResourceBlocks(t *testing.T) {
 	}
 }
 
+func Test_WalkResources(t *testing.T) {
+	client, server := startMockServer(t)
+	defer server.Listener.Close()
+
+	walked := []*Resource{}
+	walker := func(block *Resource) error {
+		walked = append(walked, block)
+		return nil
+	}
+
+	if err := client.WalkResources("example", walker); err != nil {
+		t.Fatal(err)
+	}
+
+	expected := []*Resource{
+		{
+			Name:      "example",
+			Type:      "resource",
+			DeclRange: hcl.Range{Filename: "example.tf", Start: hcl.Pos{Line: 1, Column: 1}, End: hcl.Pos{Line: 1, Column: 29}},
+			TypeRange: hcl.Range{Filename: "example.tf", Start: hcl.Pos{Line: 1, Column: 1}, End: hcl.Pos{Line: 1, Column: 8}},
+		},
+	}
+
+	opts := []cmp.Option{
+		cmpopts.IgnoreUnexported(hclsyntax.Body{}),
+		cmpopts.IgnoreFields(hclsyntax.LiteralValueExpr{}, "Val"),
+		cmpopts.IgnoreFields(hcl.Pos{}, "Byte"),
+	}
+	if !cmp.Equal(expected, walked, opts...) {
+		t.Fatalf("Diff: %s", cmp.Diff(expected, walked, opts...))
+	}
+}
+
 func Test_EvaluateExpr(t *testing.T) {
 	client, server := startMockServer(t)
 	defer server.Listener.Close()