基于Terraform Plugin Framework实现必填资源校验的技术问询

可以在执行REST操作前通过Terraform计划（Plan）校验必填资源是否存在，无需完全重写Provider，只需扩展现有Provider配置或在依赖资源中添加校验逻辑即可。以下是两种可行方案及示例：

方案1：Provider级别全局校验 #

在Provider定义中添加ValidateProviderConfig函数，全局检查所有依赖资源是否有对应的必填资源存在，适用于所有资源都依赖该必填资源的场景。

func Provider() schema.Provider {
    return schema.Provider{
        Schema: map[string]schema.Schema{
            // 你的Provider配置字段
        },
        ResourcesMap: map[string]schema.Resource{
            "example_required": resourceRequired(),
            "example_dependent": resourceDependent(),
        },
        DataSourcesMap: map[string]schema.DataSource{
            // 你的数据源定义
        },
        ConfigureContextFunc: configureProvider,
        // 新增全局校验函数
        ValidateProviderConfig: validateProviderConfig,
    }
}

func validateProviderConfig(ctx context.Context, req provider.ValidateConfigRequest, resp *provider.ValidateConfigResponse) {
    // 获取当前计划中的所有资源
    plan, err := req.Plan.Get(ctx)
    if err != nil {
        resp.Diagnostics.AddError("计划获取失败", err.Error())
        return
    }

    // 检查必填资源是否存在
    requiredResourceExists := false
    for _, res := range plan.Resources {
        if res.TypeName == "example_required" {
            requiredResourceExists = true
            break
        }
    }

    // 若必填资源不存在，检查是否有依赖资源要变更并报错
    if !requiredResourceExists {
        for _, res := range plan.Resources {
            if res.TypeName == "example_dependent" {
                resp.Diagnostics.AddError(
                    "缺失必填资源",
                    fmt.Sprintf("使用资源 %q 前，必须声明至少一个 %q 资源", res.TypeName, "example_required"),
                )
            }
        }
    }
}

方案2：资源级别针对性校验 #

在依赖资源的PlanModifyResource方法中添加校验，仅当该资源被变更时触发检查，适用于特定资源依赖必填资源的场景。

func resourceDependent() schema.Resource {
    return schema.Resource{
        Schema: map[string]schema.Schema{
            // 依赖资源的字段定义
        },
        CreateContext: resourceDependentCreate,
        ReadContext:   resourceDependentRead,
        UpdateContext: resourceDependentUpdate,
        DeleteContext: resourceDependentDelete,
        // 新增计划修改阶段的校验
        PlanModifyResource: resourceDependentPlanModify,
    }
}

func resourceDependentPlanModify(ctx context.Context, req resource.PlanModifyRequest, resp *resource.PlanModifyResponse) {
    // 获取当前计划
    plan, err := req.Plan.Get(ctx)
    if err != nil {
        resp.Diagnostics.AddError("计划获取失败", err.Error())
        return
    }

    // 检查必填资源是否存在
    requiredExists := false
    for _, res := range plan.Resources {
        if res.TypeName == "example_required" {
            requiredExists = true
            break
        }
    }

    if !requiredExists {
        resp.Diagnostics.AddError(
            "缺失必填资源",
            "使用 'example_dependent' 资源前，必须先声明至少一个 'example_required' 资源",
        )
    }
}

注意事项 #

• 确保使用Terraform Plugin Framework v1.0及以上版本，该版本支持在校验阶段访问计划数据。
• 校验逻辑会在terraform plan和terraform apply阶段触发，提前拦截无效配置，避免执行后续REST操作。
• 若必填资源是数据源而非资源，需调整逻辑检查计划中的数据源实例。

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