Add GetProviderContent helper (#172)

Author: wata727

helper/runner.go

@@ -91,6 +91,29 @@ func (r *Runner) GetResourceContent(name string, schema *hclext.BodySchema, opts
 	return content, nil
 }
 
+// GetProviderContent gets a provider content of the current module
+func (r *Runner) GetProviderContent(name string, schema *hclext.BodySchema, opts *tflint.GetModuleContentOption) (*hclext.BodyContent, error) {
+	body, err := r.GetModuleContent(&hclext.BodySchema{
+		Blocks: []hclext.BlockSchema{
+			{Type: "provider", LabelNames: []string{"name"}, Body: schema},
+		},
+	}, opts)
+	if err != nil {
+		return nil, err
+	}
+
+	content := &hclext.BodyContent{Blocks: []*hclext.Block{}}
+	for _, provider := range body.Blocks {
+		if provider.Labels[0] != name {
+			continue
+		}
+
+		content.Blocks = append(content.Blocks, provider)
+	}
+
+	return content, nil
+}
+
 // GetFile returns the hcl.File object
 func (r *Runner) GetFile(filename string) (*hcl.File, error) {
 	return r.files[filename], nil

plugin/plugin2host/client.go

@@ -66,6 +66,34 @@ func (c *GRPCClient) GetResourceContent(name string, inner *hclext.BodySchema, o
 	return content, nil
 }
 
+// GetProviderContent gets the contents of providers based on the schema.
+// This is shorthand of GetModuleContent for providers
+func (c *GRPCClient) GetProviderContent(name string, inner *hclext.BodySchema, opts *tflint.GetModuleContentOption) (*hclext.BodyContent, error) {
+	if opts == nil {
+		opts = &tflint.GetModuleContentOption{}
+	}
+
+	body, err := c.GetModuleContent(&hclext.BodySchema{
+		Blocks: []hclext.BlockSchema{
+			{Type: "provider", LabelNames: []string{"name"}, Body: inner},
+		},
+	}, opts)
+	if err != nil {
+		return nil, err
+	}
+
+	content := &hclext.BodyContent{Blocks: []*hclext.Block{}}
+	for _, provider := range body.Blocks {
+		if provider.Labels[0] != name {
+			continue
+		}
+
+		content.Blocks = append(content.Blocks, provider)
+	}
+
+	return content, nil
+}
+
 // GetModuleContent gets the contents of the module based on the schema.
 func (c *GRPCClient) GetModuleContent(schema *hclext.BodySchema, opts *tflint.GetModuleContentOption) (*hclext.BodyContent, error) {
 	if opts == nil {

plugin/plugin2host/plugin2host_test.go

@@ -321,6 +321,103 @@ resource "aws_instance" "foo" {
 	}
 }
 
+func TestGetProviderContent(t *testing.T) {
+	// default error check helper
+	neverHappend := func(err error) bool { return err != nil }
+
+	// default getFileImpl function
+	files := map[string][]byte{}
+	fileExists := func() map[string][]byte {
+		return files
+	}
+
+	// test util functions
+	hclFile := func(filename string, code string) *hcl.File {
+		file, diags := hclsyntax.ParseConfig([]byte(code), filename, hcl.InitialPos)
+		if diags.HasErrors() {
+			panic(diags)
+		}
+		files[filename] = file.Bytes
+		return file
+	}
+
+	tests := []struct {
+		Name       string
+		Args       func() (string, *hclext.BodySchema, *tflint.GetModuleContentOption)
+		ServerImpl func(*hclext.BodySchema, tflint.GetModuleContentOption) (*hclext.BodyContent, hcl.Diagnostics)
+		Want       func(string, *hclext.BodySchema, *tflint.GetModuleContentOption) (*hclext.BodyContent, hcl.Diagnostics)
+		ErrCheck   func(error) bool
+	}{
+		{
+			Name: "get HCL content",
+			Args: func() (string, *hclext.BodySchema, *tflint.GetModuleContentOption) {
+				return "aws", &hclext.BodySchema{
+					Attributes: []hclext.AttributeSchema{{Name: "region"}},
+				}, nil
+			},
+			ServerImpl: func(schema *hclext.BodySchema, opts tflint.GetModuleContentOption) (*hclext.BodyContent, hcl.Diagnostics) {
+				file := hclFile("test.tf", `
+provider "aws" {
+  region = "us-east-1"
+}
+
+provider "google" {
+  region = "us-central1"
+}`)
+				return hclext.PartialContent(file.Body, schema)
+			},
+			Want: func(resource string, schema *hclext.BodySchema, opts *tflint.GetModuleContentOption) (*hclext.BodyContent, hcl.Diagnostics) {
+				// Removed "google" provider
+				file := hclFile("test.tf", `
+provider "aws" {
+  region = "us-east-1"
+}`)
+				return hclext.Content(file.Body, &hclext.BodySchema{
+					Blocks: []hclext.BlockSchema{
+						{
+							Type:       "provider",
+							LabelNames: []string{"name"},
+							Body: &hclext.BodySchema{
+								Attributes: []hclext.AttributeSchema{{Name: "region"}},
+							},
+						},
+					},
+				})
+			},
+			ErrCheck: neverHappend,
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.Name, func(t *testing.T) {
+			client := startTestGRPCServer(t, newMockServer(mockServerImpl{getModuleContent: test.ServerImpl, getFiles: fileExists}))
+
+			got, err := client.GetProviderContent(test.Args())
+			if test.ErrCheck(err) {
+				t.Fatalf("failed to call GetProviderContent: %s", err)
+			}
+			want, diags := test.Want(test.Args())
+			if diags.HasErrors() {
+				t.Fatalf("failed to get want: %d diagsnotics", len(diags))
+				for _, diag := range diags {
+					t.Logf("  - %s", diag.Error())
+				}
+			}
+
+			opts := cmp.Options{
+				cmp.Comparer(func(x, y cty.Value) bool {
+					return x.GoString() == y.GoString()
+				}),
+				cmpopts.EquateEmpty(),
+				allowAllUnexported,
+			}
+			if diff := cmp.Diff(got, want, opts); diff != "" {
+				t.Errorf("diff: %s", diff)
+			}
+		})
+	}
+}
+
 func TestGetModuleContent(t *testing.T) {
 	// default error check helper
 	neverHappend := func(err error) bool { return err != nil }

tflint/interface.go

@@ -91,8 +91,12 @@ type Runner interface {
 	// ```
 	GetResourceContent(resourceName string, schema *hclext.BodySchema, option *GetModuleContentOption) (*hclext.BodyContent, error)
 
+	// GetProviderContent retrieves the content of providers based on the passed schema.
+	// This method is GetResourceContent for providers.
+	GetProviderContent(providerName string, schema *hclext.BodySchema, option *GetModuleContentOption) (*hclext.BodyContent, error)
+
 	// GetModuleContent retrieves the content of the module based on the passed schema.
-	// GetResourceContent is syntactic sugar for GetModuleContent, which you can use to access structures other than resources.
+	// GetResourceContent/GetProviderContent are syntactic sugar for GetModuleContent, which you can use to access other structures.
 	GetModuleContent(schema *hclext.BodySchema, option *GetModuleContentOption) (*hclext.BodyContent, error)
 
 	// GetFile returns the hcl.File object.