Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

terraform_unused_required_providers: handle module provider overrides #1225

Merged
merged 1 commit into from
Sep 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions rules/terraformrules/terraform_unused_required_providers.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@ func (r *TerraformUnusedRequiredProvidersRule) checkProvider(runner *tflint.Runn
}
}

for _, module := range runner.TFConfig.Module.ModuleCalls {
for _, provider := range module.Providers {
if provider.InParent.Name == required.Name {
return
}
}
}

runner.EmitIssue(
r,
fmt.Sprintf("provider '%s' is declared in required_providers but not used by the module", required.Name),
Expand Down
76 changes: 76 additions & 0 deletions rules/terraformrules/terraform_unused_required_providers_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,49 @@ func Test_TerraformUnusedRequiredProvidersRule(t *testing.T) {
`,
Expected: tflint.Issues{},
},
{
Name: "used - module provider override",
Content: `
terraform {
required_providers {
custom-null = {
source = "custom/null"
}
}
}

module "m" {
source = "./m"

providers = {
null = custom-null
}
}
`,
Expected: tflint.Issues{},
},
{
Name: "used - module provider override with alias",
Content: `
terraform {
required_providers {
null = {
source = "hashicorp/null"
configuration_aliases = [null.a]
}
}
}

module "m" {
source = "./m"

providers = {
null = null.a
}
}
`,
Expected: tflint.Issues{},
},
{
Name: "used - provider",
Content: `
Expand Down Expand Up @@ -163,6 +206,39 @@ func Test_TerraformUnusedRequiredProvidersRule(t *testing.T) {
},
},
},
{
Name: "unused - module",
Content: `
terraform {
required_providers {
null = {
source = "hashicorp/null"
}
}
}

module "m" {
source = "./m"
}
`,
Expected: tflint.Issues{
{
Rule: NewTerraformUnusedRequiredProvidersRule(),
Message: "provider 'null' is declared in required_providers but not used by the module",
Range: hcl.Range{
Filename: "module.tf",
Start: hcl.Pos{
Line: 4,
Column: 14,
},
End: hcl.Pos{
Line: 6,
Column: 8,
},
},
},
},
},
}

rule := NewTerraformUnusedRequiredProvidersRule()
Expand Down