The code generator fails to generate valid code for plan_modifiers

[TheNilesh]

tfplugingen-framework CLI version

tfplugingen-framework module: v0.3.1

Provider Code Spec File

{
  "provider": {
    "name": "hashibug",
    "schema": {
      "attributes": [
        {
          "name": "server",
          "string": {
            "optional_required": "optional",
            "description": "API server"
          }
        }
      ]
    }
  },
  "resources": [
    {
      "name": "myresource",
      "schema": {
        "attributes": [
          {
            "name": "id",
            "string": {
              "computed_optional_required": "computed",
              "description": "The id of the resource.",
              "plan_modifiers": [
                {
                  "use_state_for_unknown": {}
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "datasources": [],
  "version": "0.1"
}

Expected Behavior

For the id field generated code to be similar to this

Imports:

  "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
  "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"

And the generated schema function should be:

func MyresourceSchema(ctx context.Context) schema.Schema {
  return schema.Schema{
    Attributes: map[string]schema.Attribute{
      "id": schema.StringAttribute{
        Computed:            true,
        Description:         "The id of the resource.",
        MarkdownDescription: "The id of the resource.",
        PlanModifiers:       []planmodifier.String{
          stringplanmodifier.UseStateForUnknown(),
        },
      },
    },
  }
}

Actual Behavior

The generated code does not generate import statements. Hence the IDE complains: planmodifier is undefined.

func MyresourceSchema(ctx context.Context) schema.Schema {
  return schema.Schema{
    Attributes: map[string]schema.Attribute{
      "id": schema.StringAttribute{
        Computed:            true,
        Description:         "The id of the resource.",
        MarkdownDescription: "The id of the resource.",
        PlanModifiers:       []planmodifier.String{},
      },
    },
  }
}

Additional Information

The schema is available at https://github.com/hashicorp/terraform-plugin-codegen-spec/blob/main/spec/v0.1/schema.json#L3589

Code of Conduct

• I agree to follow this project's Code of Conduct

[TheNilesh]

@bendbennett Is this under development?

[bendbennett]

Hi @TheNilesh 👋

Sorry you ran into trouble here.

The processing of plan modifiers specified with requires_replace, or use_state_for_unknown is currently under development/review. In the meanwhile, you should be able to achieve the desired outcome by modifying your spec file,

Replace the following:

              "plan_modifiers": [
                {
                  "use_state_for_unknown": {}
                }
              ]

Replace with:

              "plan_modifiers": [
                {
                  "custom": {
                    "imports": [
                      {
                        "path": "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
                      }
                    ],
                    "schema_definition": "stringplanmodifier.UseStateForUnknown()"
                  }
                }
              ]

We will discuss handling of requires_replace, or use_state_for_unknown within the team and provide further feedback.

[bendbennett]

References:

• Removing framework-specific implementation details from plan modifiers terraform-plugin-codegen-spec#84
• Consider Adding Terraform-specific Behaviour Properties terraform-plugin-codegen-spec#85
• Consider Handling of Terraform-specific Behaviour Properties #116

A PR has been opened to remove Framework-specific implementation details from the codegen-spec schema.

Issues have been opened on codegen-spec, and codegen-framework to consider inclusion, and handling of Terraform-specific behaviour properties, respectively.

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.