rules

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 2, 2024 License: MPL-2.0 Imports: 21 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var PresetRules = map[string][]tflint.Rule{
	"all": {
		NewTerraformCommentSyntaxRule(),
		NewTerraformDeprecatedIndexRule(),
		NewTerraformDeprecatedInterpolationRule(),
		NewTerraformDeprecatedLookupRule(),
		NewTerraformDocumentedOutputsRule(),
		NewTerraformDocumentedVariablesRule(),
		NewTerraformEmptyListEqualityRule(),
		NewTerraformModulePinnedSourceRule(),
		NewTerraformModuleVersionRule(),
		NewTerraformNamingConventionRule(),
		NewTerraformRequiredProvidersRule(),
		NewTerraformRequiredVersionRule(),
		NewTerraformStandardModuleStructureRule(),
		NewTerraformTypedVariablesRule(),
		NewTerraformUnusedDeclarationsRule(),
		NewTerraformUnusedRequiredProvidersRule(),
		NewTerraformWorkspaceRemoteRule(),
	},
	"recommended": {
		NewTerraformDeprecatedIndexRule(),
		NewTerraformDeprecatedInterpolationRule(),
		NewTerraformDeprecatedLookupRule(),
		NewTerraformEmptyListEqualityRule(),
		NewTerraformModulePinnedSourceRule(),
		NewTerraformModuleVersionRule(),
		NewTerraformRequiredProvidersRule(),
		NewTerraformRequiredVersionRule(),
		NewTerraformTypedVariablesRule(),
		NewTerraformUnusedDeclarationsRule(),
		NewTerraformWorkspaceRemoteRule(),
	},
}

Functions

This section is empty.

Types

type BlockFormatConfig 

type BlockFormatConfig struct {
	Format string `hclext:"format,optional"`
	Custom string `hclext:"custom,optional"`
}

BlockFormatConfig defines the pre-defined format or custom regular expression to use

type CustomFormatConfig 

type CustomFormatConfig struct {
	Regexp      string `cty:"regex"`
	Description string `cty:"description"`
}

CustomFormatConfig defines a custom format that can be used instead of the predefined formats

type NameValidator 

type NameValidator struct {
	Format        string
	IsNamedFormat bool
	Regexp        *regexp.Regexp
}

NameValidator contains the regular expression to validate block name, if it was a named format, and the format name/regular expression string

type TerraformCommentSyntaxRule 

type TerraformCommentSyntaxRule struct {
	tflint.DefaultRule
}

TerraformCommentSyntaxRule checks whether comments use the preferred syntax

func NewTerraformCommentSyntaxRule 

func NewTerraformCommentSyntaxRule() *TerraformCommentSyntaxRule

NewTerraformCommentSyntaxRule returns a new rule

func (*TerraformCommentSyntaxRule) Check 

func (r *TerraformCommentSyntaxRule) Check(runner tflint.Runner) error

Check checks whether single line comments is used

func (*TerraformCommentSyntaxRule) Enabled 

func (r *TerraformCommentSyntaxRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformCommentSyntaxRule) Link() string

Link returns the rule reference link

func (*TerraformCommentSyntaxRule) Name 

func (r *TerraformCommentSyntaxRule) Name() string

Name returns the rule name

func (*TerraformCommentSyntaxRule) Severity 

func (r *TerraformCommentSyntaxRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformDeprecatedIndexRule 

type TerraformDeprecatedIndexRule struct {
	tflint.DefaultRule
}

TerraformDeprecatedIndexRule warns about usage of the legacy dot syntax for indexes (foo.0)

func NewTerraformDeprecatedIndexRule 

func NewTerraformDeprecatedIndexRule() *TerraformDeprecatedIndexRule

NewTerraformDeprecatedIndexRule return a new rule

func (*TerraformDeprecatedIndexRule) Check 

func (r *TerraformDeprecatedIndexRule) Check(runner tflint.Runner) error

Check walks all expressions and emit issues if deprecated index syntax is found

func (*TerraformDeprecatedIndexRule) Enabled 

func (r *TerraformDeprecatedIndexRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformDeprecatedIndexRule) Link() string

Link returns the rule reference link

func (*TerraformDeprecatedIndexRule) Name 

func (r *TerraformDeprecatedIndexRule) Name() string

Name returns the rule name

func (*TerraformDeprecatedIndexRule) Severity 

func (r *TerraformDeprecatedIndexRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformDeprecatedInterpolationRule 

type TerraformDeprecatedInterpolationRule struct {
	tflint.DefaultRule
}

TerraformDeprecatedInterpolationRule warns of deprecated interpolation in Terraform v0.11 or earlier.

func NewTerraformDeprecatedInterpolationRule 

func NewTerraformDeprecatedInterpolationRule() *TerraformDeprecatedInterpolationRule

NewTerraformDeprecatedInterpolationRule return a new rule

func (*TerraformDeprecatedInterpolationRule) Check 

func (r *TerraformDeprecatedInterpolationRule) Check(runner tflint.Runner) error

Check emits issues on the deprecated interpolation syntax. This logic is equivalent to the warning logic implemented in Terraform. See https://github.com/hashicorp/terraform/pull/23348

func (*TerraformDeprecatedInterpolationRule) Enabled 

func (r *TerraformDeprecatedInterpolationRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformDeprecatedInterpolationRule) Link() string

Link returns the rule reference link

func (*TerraformDeprecatedInterpolationRule) Name 

func (r *TerraformDeprecatedInterpolationRule) Name() string

Name returns the rule name

func (*TerraformDeprecatedInterpolationRule) Severity 

func (r *TerraformDeprecatedInterpolationRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformDeprecatedLookupRule added in v0.5.0 

type TerraformDeprecatedLookupRule struct {
	tflint.DefaultRule
}

TerraformDeprecatedLookupRule warns about usage of the legacy dot syntax for indexes (foo.0)

func NewTerraformDeprecatedLookupRule added in v0.5.0 

func NewTerraformDeprecatedLookupRule() *TerraformDeprecatedLookupRule

NewTerraformDeprecatedIndexRule return a new rule

func (*TerraformDeprecatedLookupRule) Check added in v0.5.0 

func (r *TerraformDeprecatedLookupRule) Check(runner tflint.Runner) error

Check walks all expressions and emit issues if deprecated index syntax is found

func (*TerraformDeprecatedLookupRule) Enabled added in v0.5.0 

func (r *TerraformDeprecatedLookupRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformDeprecatedLookupRule) Link() string

Link returns the rule reference link

func (*TerraformDeprecatedLookupRule) Name added in v0.5.0 

func (r *TerraformDeprecatedLookupRule) Name() string

Name returns the rule name

func (*TerraformDeprecatedLookupRule) Severity added in v0.5.0 

func (r *TerraformDeprecatedLookupRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformDocumentedOutputsRule 

type TerraformDocumentedOutputsRule struct {
	tflint.DefaultRule
}

TerraformDocumentedOutputsRule checks whether outputs have descriptions

func NewTerraformDocumentedOutputsRule 

func NewTerraformDocumentedOutputsRule() *TerraformDocumentedOutputsRule

NewTerraformDocumentedOutputsRule returns a new rule

func (*TerraformDocumentedOutputsRule) Check 

func (r *TerraformDocumentedOutputsRule) Check(runner tflint.Runner) error

Check checks whether outputs have descriptions

func (*TerraformDocumentedOutputsRule) Enabled 

func (r *TerraformDocumentedOutputsRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformDocumentedOutputsRule) Link() string

Link returns the rule reference link

func (*TerraformDocumentedOutputsRule) Name 

func (r *TerraformDocumentedOutputsRule) Name() string

Name returns the rule name

func (*TerraformDocumentedOutputsRule) Severity 

func (r *TerraformDocumentedOutputsRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformDocumentedVariablesRule 

type TerraformDocumentedVariablesRule struct {
	tflint.DefaultRule
}

TerraformDocumentedVariablesRule checks whether variables have descriptions

func NewTerraformDocumentedVariablesRule 

func NewTerraformDocumentedVariablesRule() *TerraformDocumentedVariablesRule

NewTerraformDocumentedVariablesRule returns a new rule

func (*TerraformDocumentedVariablesRule) Check 

func (r *TerraformDocumentedVariablesRule) Check(runner tflint.Runner) error

Check checks whether variables have descriptions

func (*TerraformDocumentedVariablesRule) Enabled 

func (r *TerraformDocumentedVariablesRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformDocumentedVariablesRule) Link() string

Link returns the rule reference link

func (*TerraformDocumentedVariablesRule) Name 

func (r *TerraformDocumentedVariablesRule) Name() string

Name returns the rule name

func (*TerraformDocumentedVariablesRule) Severity 

func (r *TerraformDocumentedVariablesRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformEmptyListEqualityRule 

type TerraformEmptyListEqualityRule struct {
	tflint.DefaultRule
}

TerraformEmptyListEqualityRule checks whether is there a comparison with an empty list

func NewTerraformEmptyListEqualityRule 

func NewTerraformEmptyListEqualityRule() *TerraformEmptyListEqualityRule

NewTerraformCommentSyntaxRule returns a new rule

func (*TerraformEmptyListEqualityRule) Check 

func (r *TerraformEmptyListEqualityRule) Check(runner tflint.Runner) error

Check checks whether the list is being compared with static empty list

func (*TerraformEmptyListEqualityRule) Enabled 

func (r *TerraformEmptyListEqualityRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformEmptyListEqualityRule) Link() string

Link returns the rule reference link

func (*TerraformEmptyListEqualityRule) Name 

func (r *TerraformEmptyListEqualityRule) Name() string

Name returns the rule name

func (*TerraformEmptyListEqualityRule) Severity 

func (r *TerraformEmptyListEqualityRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformModulePinnedSourceRule 

type TerraformModulePinnedSourceRule struct {
	tflint.DefaultRule
	// contains filtered or unexported fields
}

TerraformModulePinnedSourceRule checks unpinned or default version module source

func NewTerraformModulePinnedSourceRule 

func NewTerraformModulePinnedSourceRule() *TerraformModulePinnedSourceRule

NewTerraformModulePinnedSourceRule returns new rule with default attributes

func (*TerraformModulePinnedSourceRule) Check 

func (r *TerraformModulePinnedSourceRule) Check(rr tflint.Runner) error

Check checks if module source version is pinned Note that this rule is valid only for Git or Mercurial source

func (*TerraformModulePinnedSourceRule) Enabled 

func (r *TerraformModulePinnedSourceRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformModulePinnedSourceRule) Link() string

Link returns the rule reference link

func (*TerraformModulePinnedSourceRule) Name 

func (r *TerraformModulePinnedSourceRule) Name() string

Name returns the rule name

func (*TerraformModulePinnedSourceRule) Severity 

func (r *TerraformModulePinnedSourceRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformModuleVersionRule 

type TerraformModuleVersionRule struct {
	tflint.DefaultRule
}

TerraformModuleVersionRule checks that Terraform modules sourced from a registry specify a version

func NewTerraformModuleVersionRule 

func NewTerraformModuleVersionRule() *TerraformModuleVersionRule

NewTerraformModuleVersionRule returns a new rule

func (*TerraformModuleVersionRule) Check 

func (r *TerraformModuleVersionRule) Check(rr tflint.Runner) error

Check checks whether module source attributes resolve to a Terraform registry If they do, it checks a version (or range) is set

func (*TerraformModuleVersionRule) Enabled 

func (r *TerraformModuleVersionRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformModuleVersionRule) Link() string

Link returns the rule reference link

func (*TerraformModuleVersionRule) Name 

func (r *TerraformModuleVersionRule) Name() string

Name returns the rule name

func (*TerraformModuleVersionRule) Severity 

func (r *TerraformModuleVersionRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformModuleVersionRuleConfig 

type TerraformModuleVersionRuleConfig struct {
	Exact bool `hclext:"exact,optional"`
}

TerraformModuleVersionRuleConfig is the config structure for the TerraformModuleVersionRule rule

type TerraformNamingConventionRule 

type TerraformNamingConventionRule struct {
	tflint.DefaultRule
}

TerraformNamingConventionRule checks whether blocks follow naming convention

func NewTerraformNamingConventionRule 

func NewTerraformNamingConventionRule() *TerraformNamingConventionRule

NewTerraformNamingConventionRule returns new rule with default attributes

func (*TerraformNamingConventionRule) Check 

func (r *TerraformNamingConventionRule) Check(rr tflint.Runner) error

Check checks whether blocks follow naming convention

func (*TerraformNamingConventionRule) Enabled 

func (r *TerraformNamingConventionRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformNamingConventionRule) Link() string

Link returns the rule reference link

func (*TerraformNamingConventionRule) Name 

func (r *TerraformNamingConventionRule) Name() string

Name returns the rule name

func (*TerraformNamingConventionRule) Severity 

func (r *TerraformNamingConventionRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformRequiredProvidersRule 

type TerraformRequiredProvidersRule struct {
	tflint.DefaultRule
}

TerraformRequiredProvidersRule checks whether Terraform sets version constraints for all configured providers

func NewTerraformRequiredProvidersRule 

func NewTerraformRequiredProvidersRule() *TerraformRequiredProvidersRule

NewTerraformRequiredProvidersRule returns new rule with default attributes

func (*TerraformRequiredProvidersRule) Check 

func (r *TerraformRequiredProvidersRule) Check(rr tflint.Runner) error

Check Checks whether provider required version is set

func (*TerraformRequiredProvidersRule) Enabled 

func (r *TerraformRequiredProvidersRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformRequiredProvidersRule) Link() string

Link returns the rule reference link

func (*TerraformRequiredProvidersRule) Name 

func (r *TerraformRequiredProvidersRule) Name() string

Name returns the rule name

func (*TerraformRequiredProvidersRule) Severity 

func (r *TerraformRequiredProvidersRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformRequiredVersionRule 

type TerraformRequiredVersionRule struct {
	tflint.DefaultRule
}

TerraformRequiredVersionRule checks whether a terraform version has required_version attribute

func NewTerraformRequiredVersionRule 

func NewTerraformRequiredVersionRule() *TerraformRequiredVersionRule

NewTerraformRequiredVersionRule returns new rule with default attributes

func (*TerraformRequiredVersionRule) Check 

func (r *TerraformRequiredVersionRule) Check(runner tflint.Runner) error

Check Checks whether required_version is set

func (*TerraformRequiredVersionRule) Enabled 

func (r *TerraformRequiredVersionRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformRequiredVersionRule) Link() string

Link returns the rule reference link

func (*TerraformRequiredVersionRule) Name 

func (r *TerraformRequiredVersionRule) Name() string

Name returns the rule name

func (*TerraformRequiredVersionRule) Severity 

func (r *TerraformRequiredVersionRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformStandardModuleStructureRule 

type TerraformStandardModuleStructureRule struct {
	tflint.DefaultRule
}

TerraformStandardModuleStructureRule checks whether modules adhere to Terraform's standard module structure

func NewTerraformStandardModuleStructureRule 

func NewTerraformStandardModuleStructureRule() *TerraformStandardModuleStructureRule

NewTerraformStandardModuleStructureRule returns a new rule

func (*TerraformStandardModuleStructureRule) Check 

func (r *TerraformStandardModuleStructureRule) Check(runner tflint.Runner) error

Check emits errors for any missing files and any block types that are included in the wrong file

func (*TerraformStandardModuleStructureRule) Enabled 

func (r *TerraformStandardModuleStructureRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformStandardModuleStructureRule) Link() string

Link returns the rule reference link

func (*TerraformStandardModuleStructureRule) Name 

func (r *TerraformStandardModuleStructureRule) Name() string

Name returns the rule name

func (*TerraformStandardModuleStructureRule) Severity 

func (r *TerraformStandardModuleStructureRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformTypedVariablesRule 

type TerraformTypedVariablesRule struct {
	tflint.DefaultRule
}

TerraformTypedVariablesRule checks whether variables have a type declared

func NewTerraformTypedVariablesRule 

func NewTerraformTypedVariablesRule() *TerraformTypedVariablesRule

NewTerraformTypedVariablesRule returns a new rule

func (*TerraformTypedVariablesRule) Check 

func (r *TerraformTypedVariablesRule) Check(runner tflint.Runner) error

Check checks whether variables have type

func (*TerraformTypedVariablesRule) Enabled 

func (r *TerraformTypedVariablesRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformTypedVariablesRule) Link() string

Link returns the rule reference link

func (*TerraformTypedVariablesRule) Name 

func (r *TerraformTypedVariablesRule) Name() string

Name returns the rule name

func (*TerraformTypedVariablesRule) Severity 

func (r *TerraformTypedVariablesRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformUnusedDeclarationsRule 

type TerraformUnusedDeclarationsRule struct {
	tflint.DefaultRule
}

TerraformUnusedDeclarationsRule checks whether variables, data sources, or locals are declared but unused

func NewTerraformUnusedDeclarationsRule 

func NewTerraformUnusedDeclarationsRule() *TerraformUnusedDeclarationsRule

NewTerraformUnusedDeclarationsRule returns a new rule

func (*TerraformUnusedDeclarationsRule) Check 

func (r *TerraformUnusedDeclarationsRule) Check(rr tflint.Runner) error

Check emits issues for any variables, locals, and data sources that are declared but not used

func (*TerraformUnusedDeclarationsRule) Enabled 

func (r *TerraformUnusedDeclarationsRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformUnusedDeclarationsRule) Link() string

Link returns the rule reference link

func (*TerraformUnusedDeclarationsRule) Name 

func (r *TerraformUnusedDeclarationsRule) Name() string

Name returns the rule name

func (*TerraformUnusedDeclarationsRule) Severity 

func (r *TerraformUnusedDeclarationsRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformUnusedRequiredProvidersRule 

type TerraformUnusedRequiredProvidersRule struct {
	tflint.DefaultRule
}

TerraformUnusedRequiredProvidersRule checks whether required providers are used in the module

func NewTerraformUnusedRequiredProvidersRule 

func NewTerraformUnusedRequiredProvidersRule() *TerraformUnusedRequiredProvidersRule

NewTerraformUnusedRequiredProvidersRule returns new rule with default attributes

func (*TerraformUnusedRequiredProvidersRule) Check 

func (r *TerraformUnusedRequiredProvidersRule) Check(rr tflint.Runner) error

Check checks whether required providers are used

func (*TerraformUnusedRequiredProvidersRule) Enabled 

func (r *TerraformUnusedRequiredProvidersRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformUnusedRequiredProvidersRule) Link() string

Link returns the rule reference link

func (*TerraformUnusedRequiredProvidersRule) Name 

func (r *TerraformUnusedRequiredProvidersRule) Name() string

Name returns the rule name

func (*TerraformUnusedRequiredProvidersRule) Severity 

func (r *TerraformUnusedRequiredProvidersRule) Severity() tflint.Severity

Severity returns the rule severity

type TerraformWorkspaceRemoteRule 

type TerraformWorkspaceRemoteRule struct {
	tflint.DefaultRule
}

TerraformWorkspaceRemoteRule warns of the use of terraform.workspace with a remote backend

func NewTerraformWorkspaceRemoteRule 

func NewTerraformWorkspaceRemoteRule() *TerraformWorkspaceRemoteRule

NewTerraformWorkspaceRemoteRule return a new rule

func (*TerraformWorkspaceRemoteRule) Check 

func (r *TerraformWorkspaceRemoteRule) Check(runner tflint.Runner) error

Check checks for a "remote" backend and if found emits issues for each use of terraform.workspace in an expression.

func (*TerraformWorkspaceRemoteRule) Enabled 

func (r *TerraformWorkspaceRemoteRule) Enabled() bool

Enabled returns whether the rule is enabled by default 

func (r *TerraformWorkspaceRemoteRule) Link() string

Link returns the rule reference link

func (*TerraformWorkspaceRemoteRule) Name 

func (r *TerraformWorkspaceRemoteRule) Name() string

Name returns the rule name

func (*TerraformWorkspaceRemoteRule) Severity 

func (r *TerraformWorkspaceRemoteRule) Severity() tflint.Severity

Severity returns the rule severity

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.