aws_db_instance_invalid_option_group.go

// This file generated by `generator/main.go`. DO NOT EDIT

package api

import (
	"fmt"

	"github.com/terraform-linters/tflint-plugin-sdk/hclext"
	"github.com/terraform-linters/tflint-plugin-sdk/logger"
	"github.com/terraform-linters/tflint-plugin-sdk/tflint"
	"github.com/terraform-linters/tflint-ruleset-aws/aws"
)

// AwsDBInstanceInvalidOptionGroupRule checks whether attribute value actually exists
type AwsDBInstanceInvalidOptionGroupRule struct {
	tflint.DefaultRule

	resourceType  string
	attributeName string
	data          map[string]bool
	dataPrepared  bool
}

// NewAwsDBInstanceInvalidOptionGroupRule returns new rule with default attributes
func NewAwsDBInstanceInvalidOptionGroupRule() *AwsDBInstanceInvalidOptionGroupRule {
	return &AwsDBInstanceInvalidOptionGroupRule{
		resourceType:  "aws_db_instance",
		attributeName: "option_group_name",
		data:          map[string]bool{},
		dataPrepared:  false,
	}
}

// Name returns the rule name
func (r *AwsDBInstanceInvalidOptionGroupRule) Name() string {
	return "aws_db_instance_invalid_option_group"
}

// Enabled returns whether the rule is enabled by default
func (r *AwsDBInstanceInvalidOptionGroupRule) Enabled() bool {
	return true
}

// Severity returns the rule severity
func (r *AwsDBInstanceInvalidOptionGroupRule) Severity() tflint.Severity {
	return tflint.ERROR
}

// Link returns the rule reference link
func (r *AwsDBInstanceInvalidOptionGroupRule) Link() string {
	return ""
}

// Metadata returns the metadata about deep checking
func (r *AwsDBInstanceInvalidOptionGroupRule) Metadata() interface{} {
	return map[string]bool{"deep": true}
}

// Check checks whether the attributes are included in the list retrieved by DescribeOptionGroups
func (r *AwsDBInstanceInvalidOptionGroupRule) Check(rr tflint.Runner) error {
	runner := rr.(*aws.Runner)

	resources, err := runner.GetResourceContent(r.resourceType, &hclext.BodySchema{
		Attributes: []hclext.AttributeSchema{
			{Name: r.attributeName},
			{Name: "provider"},
		},
	}, nil)
	if err != nil {
		return err
	}

	for _, resource := range resources.Blocks {
		attribute, exists := resource.Body.Attributes[r.attributeName]
		if !exists {
			continue
		}

		if !r.dataPrepared {
			awsClient, err := runner.AwsClient(resource.Body.Attributes)
			if err != nil {
				return err
			}
			logger.Debug("invoking DescribeOptionGroups")
			r.data, err = awsClient.DescribeOptionGroups()
			if err != nil {
				err := fmt.Errorf("An error occurred while invoking DescribeOptionGroups; %w", err)
				logger.Error("%s", err)
				return err
			}
			r.dataPrepared = true
		}

		err := runner.EvaluateExpr(attribute.Expr, func (val string) error {
			if !r.data[val] {
				runner.EmitIssue(
					r,
					fmt.Sprintf(`"%s" is invalid option group name.`, val),
					attribute.Expr.Range(),
				)
			}
			return nil
		}, nil)
		if err != nil {
			return err
		}
	}

	return nil
}