Allow evaluation of resources including count and for_each

[janritter]

We have created an internal tflint plugin which checks checks for our naming convention on all resources in a state. With the update to the new v10 plugin sdk I noticed that some resources are skipped when they include for example a count.

In the following example only the aws_eip.two is evaluated:

variable "test" {
  type = number
}

resource "aws_eip" "one" {
  count    = var.test
  vpc      = true
  instance = "i-123456789"
}

resource "aws_eip" "two" {
  vpc      = true
  instance = "i-123456789"
}

aws_eip.one is skipped with the following warning:

16:40:36 runner.go:317: [WARN] Skip walking `aws_eip.one` because it may not be created

I'm getting a list of resources via GetModuleContent, this list doesn't include the skipped resources:

func (r *TerraformMyRule) Check(runner tflint.Runner) error {
	content, err := runner.GetModuleContent(&hclext.BodySchema{
		Blocks: []hclext.BlockSchema{
			{
				Type:       "resource",
				LabelNames: []string{"type", "name"},
			},
		},
	}, nil)

Is there any option to disable this skipping behaviour for specific plugins?

Similar issue in tflint: terraform-linters/tflint#1068

[wata727]

Unfortunately, there is currently no way to do that, but we could add an option to control whether GetModuleContent returns resources that aren't created.

tflint-plugin-sdk/tflint/option.go

Lines 16 to 22 in 3d6d075

	// GetModuleContentOption is an option that controls the behavior when getting a module content.
	type GetModuleContentOption struct {
	// Specify the module to be acquired.
	ModuleCtx ModuleCtxType
	// 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
	}

As far as I remember, this should have had the same problem in v0.9. The major API update in v0.10 is just to resolve these problems.

[janritter]

Interesting, then I just noticed this by testing the 0.10 update 😄

Adding an option to GetModuleContent sounds like a good idea.

[janritter]

I updated to the plugin-sdk version 0.11.0 including the new GetModuleContent option.
With the following code snippet, I still get the "Skip walking aws_eip.one because it may not be created` warning":

	content, err := runner.GetModuleContent(
		&hclext.BodySchema{
			Blocks: []hclext.BlockSchema{
				{
					Type:       "resource",
					LabelNames: []string{"type", "name"},
				},
			},
		},
		&tflint.GetModuleContentOption{
			IncludeNotCreated: true,
		},
	)

[wata727]

Are you using it with TFLint v0.36.2? In v0.35, this option is simply ignored.

[janritter]

Thanks, my TFLint version was outdated