Reimplement `mackerel_aws_integration` resource with terraform-plugin-framework #246

tosuke · 2024-10-29T07:20:59Z

Part of #243

Output from acceptance testing:

$ MACKEREL_EXPERIMENTAL_TFFRAMEWORK=1 make testacc TESTS='"AccMackerelAWSIntegration"'
TF_ACC=1 go test -v ./mackerel/... -run "AccMackerelAWSIntegration" -timeout 120m
2024/10/29 16:17:00 [INFO] mackerel: use terraform-plugin-framework based implementation
=== RUN   TestAccMackerelAWSIntegrationIAMRole
=== PAUSE TestAccMackerelAWSIntegrationIAMRole
=== RUN   TestAccMackerelAWSIntegrationCredentials
=== PAUSE TestAccMackerelAWSIntegrationCredentials
=== CONT  TestAccMackerelAWSIntegrationIAMRole
=== CONT  TestAccMackerelAWSIntegrationCredentials
--- PASS: TestAccMackerelAWSIntegrationCredentials (6.27s)
--- PASS: TestAccMackerelAWSIntegrationIAMRole (6.62s)
PASS
ok      github.com/mackerelio-labs/terraform-provider-mackerel/mackerel 7.743s

tosuke · 2024-10-29T07:26:58Z

mackerel/resource_mackerel_aws_integration_test.go

@@ -303,7 +303,6 @@ resource "mackerel_aws_integration" "foo" {

  ec2 {
    enable               = true
-    role                 = ""


The role field accepts a role ID($service_name: $role_name) or null. Empty string is some kind of pathological case and is not supported currently.

tosuke · 2024-10-29T07:36:06Z

internal/provider/resource_mackerel_aws_integration.go

+	serviceSchema := schema.SetNestedBlock{
+		Description: schemaAWSIntegrationServiceDesc,
+		Validators: []validator.Set{
+			setvalidator.SizeAtMost(1),
+		},
+		NestedObject: schema.NestedBlockObject{
+			Attributes: map[string]schema.Attribute{
+				"enable": schema.BoolAttribute{
+					Description: schemaAWSIntegrationServiceEnableDesc,
+					Optional:    true,
+					Computed:    true,
+					Default:     booldefault.StaticBool(true),
+				},
+				"role": schema.StringAttribute{
+					Description: schemaAWSIntegrationServiceRoleDesc,
+					Optional:    true,
+				},
+				"excluded_metrics": schema.ListAttribute{
+					Description: schemaAWSIntegrationServiceExcludedMetricsDesc,
+					ElementType: types.StringType,
+					Optional:    true,
+				},
+			},
+		},
+	}
+	serviceSchemaWithRetireAutomatically := schema.SetNestedBlock{
+		Description: schemaAWSIntegrationServiceDesc,
+		Validators: []validator.Set{
+			setvalidator.SizeAtMost(1),
+		},
+		NestedObject: schema.NestedBlockObject{
+			Attributes: map[string]schema.Attribute{
+				"enable": schema.BoolAttribute{
+					Description: schemaAWSIntegrationServiceEnableDesc,
+					Optional:    true,
+					Computed:    true,
+					Default:     booldefault.StaticBool(true),
+				},
+				"role": schema.StringAttribute{
+					Description: schemaAWSIntegrationServiceRoleDesc,
+					Optional:    true,
+				},
+				"excluded_metrics": schema.ListAttribute{
+					Description: schemaAWSIntegrationServiceExcludedMetricsDesc,
+					ElementType: types.StringType,
+					Optional:    true,
+				},
+				"retire_automatically": schema.BoolAttribute{
+					Description: schemaAWSIntegrationServiceRetireAutomaticallyDesc,
+					Optional:    true,
+					Computed:    true,
+					Default:     booldefault.StaticBool(false),
+				},
+			},
+		},
+	}


Original schema:

terraform-provider-mackerel/mackerel/resource_mackerel_aws_integration.go

Lines 11 to 69 in 5955898

var awsIntegrationServiceResourceWithRetireAutomatically = &schema.Resource{

Schema: map[string]*schema.Schema{

"enable": {

Type: schema.TypeBool,

Optional: true,

Default: true,

},

"role": {

Type: schema.TypeString,

Optional: true,

},

"excluded_metrics": {

Type: schema.TypeList,

Optional: true,

Elem: &schema.Schema{

Type: schema.TypeString,

},

},

"retire_automatically": {

Type: schema.TypeBool,

Optional: true,

},

},

}

var awsIntegrationServiceSchemaWithRetireAutomatically = &schema.Schema{

Type: schema.TypeSet,

Optional: true,

MaxItems: 1,

Elem: awsIntegrationServiceResourceWithRetireAutomatically,

}

var awsIntegrationServiceResource = &schema.Resource{

Schema: map[string]*schema.Schema{

"enable": {

Type: schema.TypeBool,

Optional: true,

Default: true,

},

"role": {

Type: schema.TypeString,

Optional: true,

},

"excluded_metrics": {

Type: schema.TypeList,

Optional: true,

Elem: &schema.Schema{

Type: schema.TypeString,

},

},

},

}

var awsIntegrationServiceSchema = &schema.Schema{

Type: schema.TypeSet,

Optional: true,

MaxItems: 1,

Elem: awsIntegrationServiceResource,

}

tosuke · 2024-10-29T07:36:58Z

internal/provider/resource_mackerel_aws_integration.go

+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				Description: schemaAWSIntegrationIDDesc,
+				Computed:    true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.UseStateForUnknown(), // immutable
+				},
+			},
+			"name": schema.StringAttribute{
+				Description: schemaAWSIntegrationNameDesc,
+				Required:    true,
+			},
+			"memo": schema.StringAttribute{
+				Description: schemaAWSIntegrationMemoDesc,
+				Optional:    true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+			},
+			"key": schema.StringAttribute{
+				Description: schemaAWSIntegrationKeyDesc,
+				Optional:    true,
+				Sensitive:   true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+				Validators: []validator.String{
+					// With Access Key, secret access key is need too.
+					stringvalidator.AlsoRequires(path.MatchRoot("secret_key")),
+				},
+			},
+			"secret_key": schema.StringAttribute{
+				Description: schemaAWSIntegrationSecretKeyDesc,
+				Optional:    true,
+				Sensitive:   true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+				Validators: []validator.String{
+					// Secret access key cannot be set alone
+					stringvalidator.AlsoRequires(path.MatchRoot("key")),
+				},
+			},
+			"role_arn": schema.StringAttribute{
+				Description: schemaAWSIntegrationRoleARNDesc,
+				Optional:    true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+			},
+			"external_id": schema.StringAttribute{
+				Description: schemaAWSIntegrationExternalIDDesc,
+				Optional:    true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+				Validators: []validator.String{
+					// External ID cannot be set alone
+					stringvalidator.AlsoRequires(path.MatchRoot("role_arn")),
+				},
+			},
+			"region": schema.StringAttribute{
+				Description: schemaAWSIntegrationRegionDesc,
+				Optional:    true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+			},
+			"included_tags": schema.StringAttribute{
+				Description: schemaAWSIntegrationIncludedTagsDesc,
+				Optional:    true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+			},
+			"excluded_tags": schema.StringAttribute{
+				Description: schemaAWSIntegrationExcludedTagsDesc,
+				Optional:    true,
+				Computed:    true,
+				Default:     stringdefault.StaticString(""),
+			},
+		},


Original schema:

terraform-provider-mackerel/mackerel/resource_mackerel_aws_integration.go

Lines 110 to 150 in 5955898

Schema: map[string]*schema.Schema{

"name": {

Type: schema.TypeString,

Required: true,

},

"memo": {

Type: schema.TypeString,

Optional: true,

},

"key": {

Type: schema.TypeString,

Optional: true,

Sensitive: true,

},

"secret_key": {

Type: schema.TypeString,

Optional: true,

Sensitive: true,

},

"role_arn": {

Type: schema.TypeString,

Optional: true,

},

"external_id": {

Type: schema.TypeString,

Optional: true,

Sensitive: true,

},

"region": {

Type: schema.TypeString,

Optional: true,

},

"included_tags": {

Type: schema.TypeString,

Optional: true,

},

"excluded_tags": {

Type: schema.TypeString,

Optional: true,

},

},

ne-sachirou

🙆‍♀️

tosuke added 5 commits October 22, 2024 14:21

fix: invalid empty role

0cbccd8

feat: add aws integration resource

aab6eba

test: mackerel_aws_integration resource schema

79dd8e5

doc: add descriptions

131a21d

refactor: define supported AWS service specs

5a159ef

tosuke commented Oct 29, 2024

View reviewed changes

ne-sachirou approved these changes Oct 31, 2024

View reviewed changes

tosuke merged commit 0f86842 into main Oct 31, 2024
1 check passed

tosuke deleted the framework-aws-integration-resource branch October 31, 2024 09:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reimplement `mackerel_aws_integration` resource with terraform-plugin-framework #246

Reimplement `mackerel_aws_integration` resource with terraform-plugin-framework #246

tosuke commented Oct 29, 2024

tosuke Oct 29, 2024 •

edited

Loading

tosuke Oct 29, 2024

tosuke Oct 29, 2024

ne-sachirou left a comment

	var awsIntegrationServiceResourceWithRetireAutomatically = &schema.Resource{
	Schema: map[string]*schema.Schema{
	"enable": {
	Type: schema.TypeBool,
	Optional: true,
	Default: true,
	},
	"role": {
	Type: schema.TypeString,
	Optional: true,
	},
	"excluded_metrics": {
	Type: schema.TypeList,
	Optional: true,
	Elem: &schema.Schema{
	Type: schema.TypeString,
	},
	},
	"retire_automatically": {
	Type: schema.TypeBool,
	Optional: true,
	},
	},
	}

	var awsIntegrationServiceSchemaWithRetireAutomatically = &schema.Schema{
	Type: schema.TypeSet,
	Optional: true,
	MaxItems: 1,
	Elem: awsIntegrationServiceResourceWithRetireAutomatically,
	}

	var awsIntegrationServiceResource = &schema.Resource{
	Schema: map[string]*schema.Schema{
	"enable": {
	Type: schema.TypeBool,
	Optional: true,
	Default: true,
	},
	"role": {
	Type: schema.TypeString,
	Optional: true,
	},
	"excluded_metrics": {
	Type: schema.TypeList,
	Optional: true,
	Elem: &schema.Schema{
	Type: schema.TypeString,
	},
	},
	},
	}

	var awsIntegrationServiceSchema = &schema.Schema{
	Type: schema.TypeSet,
	Optional: true,
	MaxItems: 1,
	Elem: awsIntegrationServiceResource,
	}

	Schema: map[string]*schema.Schema{
	"name": {
	Type: schema.TypeString,
	Required: true,
	},
	"memo": {
	Type: schema.TypeString,
	Optional: true,
	},
	"key": {
	Type: schema.TypeString,
	Optional: true,
	Sensitive: true,
	},
	"secret_key": {
	Type: schema.TypeString,
	Optional: true,
	Sensitive: true,
	},
	"role_arn": {
	Type: schema.TypeString,
	Optional: true,
	},
	"external_id": {
	Type: schema.TypeString,
	Optional: true,
	Sensitive: true,
	},
	"region": {
	Type: schema.TypeString,
	Optional: true,
	},
	"included_tags": {
	Type: schema.TypeString,
	Optional: true,
	},
	"excluded_tags": {
	Type: schema.TypeString,
	Optional: true,
	},
	},

Reimplement mackerel_aws_integration resource with terraform-plugin-framework #246

Reimplement mackerel_aws_integration resource with terraform-plugin-framework #246

Conversation

tosuke commented Oct 29, 2024

tosuke Oct 29, 2024 • edited Loading

Choose a reason for hiding this comment

tosuke Oct 29, 2024

Choose a reason for hiding this comment

tosuke Oct 29, 2024

Choose a reason for hiding this comment

ne-sachirou left a comment

Choose a reason for hiding this comment

Reimplement `mackerel_aws_integration` resource with terraform-plugin-framework #246

Reimplement `mackerel_aws_integration` resource with terraform-plugin-framework #246

tosuke Oct 29, 2024 •

edited

Loading