Terraform Plugin Framework中能否实现多资源预创建验证？

可以实现让provider_resource_builder.my_builder在创建前验证provider_resource.thing.do_build的值为true，核心是利用Terraform Plugin Framework的验证机制和资源引用解析能力，在资源的配置校验或计划修改阶段完成检查。

实现思路 #

通过在provider_resource_builder的资源逻辑中添加验证步骤，解析build字段中引用的provider_resource实例，获取其do_build属性值并校验是否为true。主要有两个阶段可以实现：

• 配置校验阶段（ValidateConfig）：在配置被解析后立即检查依赖资源的属性
• 计划修改阶段（PlanModifyAttribute）：在生成执行计划时验证依赖资源的计划/状态值

代码示例 #

以下是基于ValidateConfig阶段的实现代码：

package provider

import (
    "context"
    "fmt"

    "github.com/hashicorp/terraform-plugin-framework/resource"
    "github.com/hashicorp/terraform-plugin-framework/types"
)

// ProviderResourceBuilderModel 对应provider_resource_builder的配置模型
type ProviderResourceBuilderModel struct {
    Build types.List `tfsdk:"build"`
}

// ProviderResourceModel 对应provider_resource的配置模型
type ProviderResourceModel struct {
    DoBuild types.Bool `tfsdk:"do_build"`
}

// ValidateConfig 实现资源的配置校验逻辑
func (r *ProviderResourceBuilderResource) ValidateConfig(ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse) {
    var data ProviderResourceBuilderModel
    resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
    if resp.Diagnostics.HasError() {
        return
    }

    // 遍历build列表中的每个资源名称
    for _, buildElement := range data.Build.Elements() {
        buildName, ok := buildElement.(types.String)
        if !ok || buildName.IsNull() || buildName.IsUnknown() {
            resp.Diagnostics.AddError(
                "无效的构建资源名称",
                fmt.Sprintf("构建项 %q 不是有效的字符串类型", buildName.ValueString()),
            )
            continue
        }

        // 构建目标资源的地址
        targetResourceAddr := fmt.Sprintf("provider_resource.%s", buildName.ValueString())
        // 获取引用资源的状态/计划数据
        targetResource, diags := req.ProviderMeta.GetResource(ctx, targetResourceAddr)
        resp.Diagnostics.Append(diags...)
        if resp.Diagnostics.HasError() {
            continue
        }

        // 解析目标资源的do_build属性
        var targetData ProviderResourceModel
        diags = targetResource.State.Get(ctx, &targetData)
        resp.Diagnostics.Append(diags...)
        if resp.Diagnostics.HasError() {
            continue
        }

        // 验证do_build是否为true
        if !targetData.DoBuild.ValueBool() {
            resp.Diagnostics.AddError(
                "构建资源配置无效",
                fmt.Sprintf("资源 %q 的do_build属性为false，必须设置为true才能被用于构建", buildName.ValueString()),
            )
        }
    }
}

注意事项 #

1. 依赖顺序：确保provider_resource.thing先于provider_resource_builder.my_builder被处理，可以通过Terraform的自动依赖解析（基于资源引用）或显式设置depends_on来保证。
2. 未知值处理：如果引用的资源还未生成状态（比如首次创建），可能会获取到Unknown值，此时可以选择跳过校验或提示用户先创建依赖资源。
3. 阶段选择：ValidateConfig阶段适合提前拦截无效配置，PlanModify阶段则可以结合资源的计划值做更精准的校验。

内容的提问来源于stack exchange，提问作者user219820