Add ExpandMode to GetModuleContentOption (#208)

Author: wata727

plugin/fromproto/fromproto.go

@@ -236,6 +236,7 @@ func GetModuleContentOption(opts *proto.GetModuleContent_Option) tflint.GetModul
 	return tflint.GetModuleContentOption{
 		ModuleCtx:         ModuleCtxType(opts.ModuleCtx),
 		IncludeNotCreated: opts.IncludeNotCreated,
+		ExpandMode:        ExpandMode(opts.ExpandMode),
 		Hint:              GetModuleContentHint(opts.Hint),
 	}
 }
@@ -254,6 +255,20 @@ func ModuleCtxType(ty proto.ModuleCtxType) tflint.ModuleCtxType {
 	}
 }
 
+// ExpandMode converts proto.GetModuleContent_ExpandMode to tflint.ExpandMode
+func ExpandMode(mode proto.GetModuleContent_ExpandMode) tflint.ExpandMode {
+	switch mode {
+	case proto.GetModuleContent_EXPAND_MODE_UNSPECIFIED:
+		return tflint.ExpandModeExpand
+	case proto.GetModuleContent_EXPAND_MODE_EXPAND:
+		return tflint.ExpandModeExpand
+	case proto.GetModuleContent_EXPAND_MODE_NONE:
+		return tflint.ExpandModeNone
+	default:
+		panic(fmt.Sprintf("invalid ExpandMode: %s", mode))
+	}
+}
+
 // GetModuleContentHint converts proto.GetModuleContent_Hint to tflint.GetModuleContentHint
 func GetModuleContentHint(hint *proto.GetModuleContent_Hint) tflint.GetModuleContentHint {
 	if hint == nil {

plugin/plugin2host/plugin2host_test.go

@@ -601,6 +601,7 @@ volume_size = 10`)
 				return &hclext.BodySchema{}, &tflint.GetModuleContentOption{
 					ModuleCtx:         tflint.RootModuleCtxType,
 					IncludeNotCreated: true,
+					ExpandMode:        tflint.ExpandModeNone,
 					Hint:              tflint.GetModuleContentHint{ResourceType: "aws_instance"},
 				}
 			},
@@ -615,6 +616,11 @@ volume_size = 10`)
 						&hcl.Diagnostic{Severity: hcl.DiagError, Summary: "unexpected includeNotCreatedResources options"},
 					}
 				}
+				if opts.ExpandMode != tflint.ExpandModeNone {
+					return &hclext.BodyContent{}, hcl.Diagnostics{
+						&hcl.Diagnostic{Severity: hcl.DiagError, Summary: "unexpected expand mode options"},
+					}
+				}
 				if opts.Hint.ResourceType != "aws_instance" {
 					return &hclext.BodyContent{}, hcl.Diagnostics{
 						&hcl.Diagnostic{Severity: hcl.DiagError, Summary: "unexpected hint options"},

plugin/proto/tflint.pb.go

@@ -115,10 +115,16 @@ message GetModuleContent {
     message Hint {
         string resource_type = 1;
     }
+    enum ExpandMode {
+        EXPAND_MODE_UNSPECIFIED = 0;
+        EXPAND_MODE_NONE = 1;
+        EXPAND_MODE_EXPAND = 2;
+    }
     message Option {
         ModuleCtxType module_ctx = 1;
         Hint hint = 2;
-        bool include_not_created = 3;
+        bool include_not_created = 3 [deprecated = true];
+        ExpandMode expand_mode = 4;
     }
 
     message Request {

plugin/proto/tflint.proto

@@ -186,7 +186,8 @@ func GetModuleContentOption(opts *tflint.GetModuleContentOption) *proto.GetModul
 
 	return &proto.GetModuleContent_Option{
 		ModuleCtx:         ModuleCtxType(opts.ModuleCtx),
-		IncludeNotCreated: opts.IncludeNotCreated,
+		IncludeNotCreated: opts.IncludeNotCreated || opts.ExpandMode == tflint.ExpandModeNone,
+		ExpandMode:        ExpandMode(opts.ExpandMode),
 		Hint:              GetModuleContentHint(opts.Hint),
 	}
 }
@@ -203,6 +204,18 @@ func ModuleCtxType(ty tflint.ModuleCtxType) proto.ModuleCtxType {
 	}
 }
 
+// ExpandMode converts tflint.ExpandMode to proto.GetModuleContent_ExpandMode
+func ExpandMode(mode tflint.ExpandMode) proto.GetModuleContent_ExpandMode {
+	switch mode {
+	case tflint.ExpandModeExpand:
+		return proto.GetModuleContent_EXPAND_MODE_EXPAND
+	case tflint.ExpandModeNone:
+		return proto.GetModuleContent_EXPAND_MODE_NONE
+	default:
+		panic(fmt.Sprintf("invalid ExpandMode: %s", mode))
+	}
+}
+
 // GetModuleContentHint converts tflint.GetModuleContentHint to proto.GetModuleContentHint
 func GetModuleContentHint(hint tflint.GetModuleContentHint) *proto.GetModuleContent_Hint {
 	return &proto.GetModuleContent_Hint{

plugin/toproto/toproto.go

@@ -14,14 +14,29 @@ const (
 	RootModuleCtxType
 )
 
+// ExpandMode represents whether the block retrieved by GetModuleContent is expanded by the meta-arguments.
+//
+//go:generate stringer -type=ExpandMode
+type ExpandMode int32
+
+const (
+	// ExpandModeExpand is the mode for expanding blocks based on the meta-arguments. The default is this behavior.
+	ExpandModeExpand ExpandMode = iota
+	// ExpandModeNone is the mode that does not expand blocks.
+	ExpandModeNone
+)
+
 // GetModuleContentOption is an option that controls the behavior when getting a module content.
 type GetModuleContentOption struct {
 	// Specify the module to be acquired.
 	ModuleCtx ModuleCtxType
-	// Whether it includes resources that are not created, for example because count is 0 or unknown.
-	IncludeNotCreated bool
+	// Whether resources and modules are expanded by the count/for_each meta-arguments.
+	ExpandMode ExpandMode
 	// Hint is info for optimizing a query. This is an advanced option and it is not intended to be used directly from plugins.
 	Hint GetModuleContentHint
+
+	// Deprecated: Use ExpandMode instead.
+	IncludeNotCreated bool
 }
 
 // GetModuleContentHint is info for optimizing a query. This is an advanced option and it is not intended to be used directly from plugins.