Fix required properties with default in TF projecting as non-optional in Pulumi

pkg/pf/internal/pfutils/attr.go

@@ -31,13 +31,14 @@ import (
 // attrLike exposes these methods.
 //
 // GetAttributes method is special since it returns a NestedAttributes interface that is also internal and cannot be
-// linked to. Instead, NestedAttriutes information is recorded in a dedicated new field.
+// linked to. Instead, NestedAttributes information is recorded in a dedicated new field.
 type Attr interface {
 	AttrLike
 	IsNested() bool
 	Nested() map[string]Attr
 	NestingMode() NestingMode
 	HasNestedObject() bool
+	HasDefault() bool
 }
 
 type AttrLike interface {
@@ -66,16 +67,19 @@ func FromResourceAttribute(x rschema.Attribute) Attr {
 
 func FromAttrLike(attrLike AttrLike) Attr {
 	nested, nestingMode := extractNestedAttributes(attrLike)
+	hasDefault := hasDefault(attrLike)
 	return &attrAdapter{
 		nested:      nested,
 		nestingMode: nestingMode,
+		hasDefault:  hasDefault,
 		AttrLike:    attrLike,
 	}
 }
 
 type attrAdapter struct {
 	nested      map[string]Attr
 	nestingMode NestingMode
+	hasDefault  bool
 	AttrLike
 }
 
@@ -102,6 +106,10 @@ func (a *attrAdapter) NestingMode() NestingMode {
 	return a.nestingMode
 }
 
+func (a *attrAdapter) HasDefault() bool {
+	return a.hasDefault
+}
+
 type NestingMode uint8
 
 const (

pkg/pf/internal/pfutils/default.go

@@ -0,0 +1,99 @@
+package pfutils
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/defaults"
+)
+
+// These interfaces are re-implemented here from "github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
+// as we can not link to them directly.
+
+type attributeLikeWithBoolDefaultValue interface {
+	AttrLike
+	BoolDefaultValue() defaults.Bool
+}
+
+type attributeLikeWithFloat32DefaultValue interface {
+	AttrLike
+	Float32DefaultValue() defaults.Float32
+}
+
+type attributeLikeWithFloat64DefaultValue interface {
+	AttrLike
+	Float64DefaultValue() defaults.Float64
+}
+
+type attributeLikeWithInt32DefaultValue interface {
+	AttrLike
+	Int32DefaultValue() defaults.Int32
+}
+
+type attributeLikeWithInt64DefaultValue interface {
+	AttrLike
+	Int64DefaultValue() defaults.Int64
+}
+
+type attributeLikeWithListDefaultValue interface {
+	AttrLike
+	ListDefaultValue() defaults.List
+}
+
+type attributeLikeWithMapDefaultValue interface {
+	AttrLike
+	MapDefaultValue() defaults.Map
+}
+
+type attributeLikeWithNumberDefaultValue interface {
+	AttrLike
+	NumberDefaultValue() defaults.Number
+}
+
+type attributeLikeWithObjectDefaultValue interface {
+	AttrLike
+	ObjectDefaultValue() defaults.Object
+}
+
+type attributeLikeWithSetDefaultValue interface {
+	AttrLike
+	SetDefaultValue() defaults.Set
+}
+
+type attributeLikeWithStringDefaultValue interface {
+	AttrLike
+	StringDefaultValue() defaults.String
+}
+
+type attributeLikeWithDynamicDefaultValue interface {
+	AttrLike
+	DynamicDefaultValue() defaults.Dynamic
+}
+
+func hasDefault(attr AttrLike) bool {
+	switch a := attr.(type) {
+	case attributeLikeWithBoolDefaultValue:
+		return a.BoolDefaultValue() != nil
+	case attributeLikeWithFloat32DefaultValue:
+		return a.Float32DefaultValue() != nil
+	case attributeLikeWithFloat64DefaultValue:
+		return a.Float64DefaultValue() != nil
+	case attributeLikeWithInt32DefaultValue:
+		return a.Int32DefaultValue() != nil
+	case attributeLikeWithInt64DefaultValue:
+		return a.Int64DefaultValue() != nil
+	case attributeLikeWithListDefaultValue:
+		return a.ListDefaultValue() != nil
+	case attributeLikeWithMapDefaultValue:
+		return a.MapDefaultValue() != nil
+	case attributeLikeWithNumberDefaultValue:
+		return a.NumberDefaultValue() != nil
+	case attributeLikeWithObjectDefaultValue:
+		return a.ObjectDefaultValue() != nil
+	case attributeLikeWithSetDefaultValue:
+		return a.SetDefaultValue() != nil
+	case attributeLikeWithStringDefaultValue:
+		return a.StringDefaultValue() != nil
+	case attributeLikeWithDynamicDefaultValue:
+		return a.DynamicDefaultValue() != nil
+	default:
+		return false
+	}
+}

pkg/pf/internal/schemashim/attr_schema.go

@@ -32,6 +32,8 @@ var _ shim.Schema = (*attrSchema)(nil)
 
 var _ shim.SchemaWithWriteOnly = (*attrSchema)(nil)
 
+var _ shim.SchemaWithHasDefault = (*attrSchema)(nil)
+
 func (s *attrSchema) Type() shim.ValueType {
 	ty := s.attr.GetType()
 	vt, err := convertType(ty)
@@ -63,6 +65,10 @@ func (*attrSchema) DefaultValue() (interface{}, error) {
 	return nil, bridge.ErrSchemaDefaultValue
 }
 
+func (s *attrSchema) HasDefault() bool {
+	return s.attr.HasDefault()
+}
+
 func (s *attrSchema) Description() string {
 	if desc := s.attr.GetMarkdownDescription(); desc != "" {
 		return desc

pkg/pf/tfgen/testdata/TestPFRequiredInputWithDefault.golden

@@ -0,0 +1,96 @@
+{
+    "name": "testprovider",
+    "attribution": "This Pulumi package is based on the [`testprovider` Terraform Provider](https://github.com/terraform-providers/terraform-provider-testprovider).",
+    "meta": {
+        "moduleFormat": "(.*)(?:/[^/]*)"
+    },
+    "language": {
+        "nodejs": {
+            "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-testprovider)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e please consult the source [`terraform-provider-testprovider` repo](https://github.com/terraform-providers/terraform-provider-testprovider/issues).",
+            "compatibility": "tfbridge20",
+            "disableUnionOutputTypes": true
+        },
+        "python": {
+            "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-testprovider)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e please consult the source [`terraform-provider-testprovider` repo](https://github.com/terraform-providers/terraform-provider-testprovider/issues).",
+            "compatibility": "tfbridge20",
+            "pyproject": {}
+        }
+    },
+    "config": {},
+    "provider": {
+        "description": "The provider type for the testprovider package. By default, resources use package-wide configuration\nsettings, however an explicit `Provider` instance may be created and passed during resource\nconstruction to achieve fine-grained programmatic control over provider settings. See the\n[documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.\n",
+        "methods": {
+            "terraformConfig": "pulumi:providers:testprovider/terraformConfig"
+        }
+    },
+    "resources": {
+        "testprovider:index:Res": {
+            "properties": {
+                "a1": {
+                    "type": "string"
+                },
+                "a2": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "a1",
+                "a2"
+            ],
+            "inputProperties": {
+                "a1": {
+                    "type": "string"
+                },
+                "a2": {
+                    "type": "string"
+                }
+            },
+            "requiredInputs": [
+                "a2"
+            ],
+            "stateInputs": {
+                "description": "Input properties used for looking up and filtering Res resources.\n",
+                "properties": {
+                    "a1": {
+                        "type": "string"
+                    },
+                    "a2": {
+                        "type": "string"
+                    }
+                },
+                "type": "object"
+            }
+        }
+    },
+    "functions": {
+        "pulumi:providers:testprovider/terraformConfig": {
+            "description": "This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.",
+            "inputs": {
+                "properties": {
+                    "__self__": {
+                        "type": "ref",
+                        "$ref": "#/resources/pulumi:providers:testprovider"
+                    }
+                },
+                "type": "pulumi:providers:testprovider/terraformConfig",
+                "required": [
+                    "__self__"
+                ]
+            },
+            "outputs": {
+                "properties": {
+                    "result": {
+                        "additionalProperties": {
+                            "$ref": "pulumi.json#/Any"
+                        },
+                        "type": "object"
+                    }
+                },
+                "required": [
+                    "result"
+                ],
+                "type": "object"
+            }
+        }
+    }
+}

pkg/pf/tfgen/tfgen_test.go

@@ -27,6 +27,7 @@ import (
 	pschema "github.com/hashicorp/terraform-plugin-framework/provider/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	rschema "github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringdefault"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hexops/autogold/v2"
@@ -521,3 +522,48 @@ func TestWriteOnlyOmit(t *testing.T) {
 	require.NoError(t, json.Indent(&b, res.ProviderMetadata.PackageSchema, "", "    "))
 	autogold.ExpectFile(t, autogold.Raw(b.String()))
 }
+
+func TestPFRequiredInputWithDefault(t *testing.T) {
+	t.Parallel()
+
+	if runtime.GOOS == "windows" {
+		t.Skipf("Skipping on windows - tests cases need to be made robust to newline handling")
+	}
+
+	schema := rschema.Schema{
+		Attributes: map[string]rschema.Attribute{
+			"id": rschema.StringAttribute{Computed: true},
+			"a1": rschema.StringAttribute{
+				Required: true,
+				Default:  stringdefault.StaticString("default"),
+			},
+			"a2": rschema.StringAttribute{
+				Required: true,
+			},
+		},
+	}
+
+	info := &tfbridge.ResourceInfo{
+		Tok:  "testprovider:index:Res",
+		Docs: &tfbridge.DocInfo{Markdown: []byte{' '}},
+	}
+
+	res, err := GenerateSchema(context.Background(), GenerateSchemaOptions{
+		ProviderInfo: tfbridge.ProviderInfo{
+			Name:             "testprovider",
+			UpstreamRepoPath: ".", // no invalid mappings warnings
+			P: pftfbridge.ShimProvider(&schemaTestProvider{
+				resources: map[string]rschema.Schema{
+					"res": schema,
+				},
+			}),
+			Resources: map[string]*tfbridge.ResourceInfo{
+				"test_res": info,
+			},
+		},
+	})
+	require.NoError(t, err)
+	var b bytes.Buffer
+	require.NoError(t, json.Indent(&b, res.ProviderMetadata.PackageSchema, "", "    "))
+	autogold.ExpectFile(t, autogold.Raw(b.String()))
+}