Adjust Required and Default attributes to ComputedOptional (#42)

Reference: #38

This implements the typical provider development behavior of allowing a default value on an API required value to make its configuration optional. It is unclear if provider developers will need to adjust this behavior, but that can be sorted out in the future. Any API-intended behaviors that must be preserved will be surfaced via additional properties in the code generation specification to prevent conflating them with Terraform-intended behaviors.

Author: bflad

DESIGN.md

@@ -150,7 +150,7 @@ For the provider, all fields in the provided JSON schema (`provider.schema_ref`)
 If not required, then the field will be mapped as [Optional](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/schemas#optional).
 
 #### Resources
-For resources, all fields, in the `Create` operation `requestBody` OAS schema, marked as [required](https://json-schema.org/understanding-json-schema/reference/object.html#required-properties) will be mapped as a [Required](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/schemas#required) attribute.
+For resources, all fields, in the `Create` operation `requestBody` OAS schema, marked as [required](https://json-schema.org/understanding-json-schema/reference/object.html#required-properties) will be mapped as a [Required](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/schemas#required) attribute. If [default](https://json-schema.org/draft/2020-12/json-schema-validation.html#name-default) is also specified, it will be mapped as [Computed](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/schemas#computed) and [Optional](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/schemas#optional) instead.
 
 If not required, or if the field is in a different schema than the `Create` operation `requestbody`, then the field will be mapped as [Computed](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/schemas#computed) and [Optional](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/schemas#optional).
 

internal/cmd/testdata/scaleway/generated_framework_ir.json

@@ -2456,7 +2456,7 @@
 					{
 						"name": "arch",
 						"string": {
-							"computed_optional_required": "required",
+							"computed_optional_required": "computed_optional",
 							"default": {
 								"static": "x86_64"
 							},

internal/mapper/oas/bool.go

@@ -24,6 +24,10 @@ func (s *OASSchema) BuildBoolResource(name string, computability schema.Computed
 		staticDefault, ok := s.Schema.Default.(bool)
 
 		if ok {
+			if computability == schema.Required {
+				result.Bool.ComputedOptionalRequired = schema.ComputedOptional
+			}
+
 			result.Bool.Default = &schema.BoolDefault{
 				Static: &staticDefault,
 			}

internal/mapper/oas/bool_test.go

@@ -57,7 +57,8 @@ func TestBuildBoolResource(t *testing.T) {
 		},
 		"boolean attributes default": {
 			schema: &base.Schema{
-				Type: []string{"object"},
+				Type:     []string{"object"},
+				Required: []string{"bool_prop_required_default_true"},
 				Properties: map[string]*base.SchemaProxy{
 					"bool_prop_default_false": base.CreateSchemaProxy(&base.Schema{
 						Type:    []string{"boolean"},
@@ -67,6 +68,10 @@ func TestBuildBoolResource(t *testing.T) {
 						Type:    []string{"boolean"},
 						Default: true,
 					}),
+					"bool_prop_required_default_true": base.CreateSchemaProxy(&base.Schema{
+						Type:    []string{"boolean"},
+						Default: true,
+					}),
 				},
 			},
 			expectedAttributes: &[]resource.Attribute{
@@ -88,6 +93,16 @@ func TestBuildBoolResource(t *testing.T) {
 						},
 					},
 				},
+				{
+					Name: "bool_prop_required_default_true",
+					Bool: &resource.BoolAttribute{
+						// Intentionally not required due to default
+						ComputedOptionalRequired: schema.ComputedOptional,
+						Default: &schema.BoolDefault{
+							Static: pointer(true),
+						},
+					},
+				},
 			},
 		},
 		"boolean attributes deprecated": {

internal/mapper/oas/integer.go

@@ -25,6 +25,10 @@ func (s *OASSchema) BuildIntegerResource(name string, computability schema.Compu
 		staticDefault, ok := s.Schema.Default.(int64)
 
 		if ok {
+			if computability == schema.Required {
+				result.Int64.ComputedOptionalRequired = schema.ComputedOptional
+			}
+
 			result.Int64.Default = &schema.Int64Default{
 				Static: &staticDefault,
 			}

internal/mapper/oas/integer_test.go

@@ -58,7 +58,8 @@ func TestBuildIntegerResource(t *testing.T) {
 		},
 		"int64 attributes default": {
 			schema: &base.Schema{
-				Type: []string{"object"},
+				Type:     []string{"object"},
+				Required: []string{"int64_prop_required_default_non_zero"},
 				Properties: map[string]*base.SchemaProxy{
 					"int64_prop_default_non_zero": base.CreateSchemaProxy(&base.Schema{
 						Type:    []string{"integer"},
@@ -68,6 +69,10 @@ func TestBuildIntegerResource(t *testing.T) {
 						Type:    []string{"integer"},
 						Default: int64(0),
 					}),
+					"int64_prop_required_default_non_zero": base.CreateSchemaProxy(&base.Schema{
+						Type:    []string{"integer"},
+						Default: int64(123),
+					}),
 				},
 			},
 			expectedAttributes: &[]resource.Attribute{
@@ -89,6 +94,16 @@ func TestBuildIntegerResource(t *testing.T) {
 						},
 					},
 				},
+				{
+					Name: "int64_prop_required_default_non_zero",
+					Int64: &resource.Int64Attribute{
+						// Intentionally not required due to default
+						ComputedOptionalRequired: schema.ComputedOptional,
+						Default: &schema.Int64Default{
+							Static: pointer(int64(123)),
+						},
+					},
+				},
 			},
 		},
 		"int64 attributes deprecated": {

internal/mapper/oas/number.go

@@ -28,6 +28,10 @@ func (s *OASSchema) BuildNumberResource(name string, computability schema.Comput
 			staticDefault, ok := s.Schema.Default.(float64)
 
 			if ok {
+				if computability == schema.Required {
+					result.Float64.ComputedOptionalRequired = schema.ComputedOptional
+				}
+
 				result.Float64.Default = &schema.Float64Default{
 					Static: &staticDefault,
 				}

internal/mapper/oas/number_test.go

@@ -84,7 +84,8 @@ func TestBuildNumberResource(t *testing.T) {
 		},
 		"float64 attributes default": {
 			schema: &base.Schema{
-				Type: []string{"object"},
+				Type:     []string{"object"},
+				Required: []string{"float64_prop_required_default_non_zero"},
 				Properties: map[string]*base.SchemaProxy{
 					"float64_prop_default_non_zero": base.CreateSchemaProxy(&base.Schema{
 						Type:    []string{"number"},
@@ -96,6 +97,11 @@ func TestBuildNumberResource(t *testing.T) {
 						Format:  "double",
 						Default: float64(0.0),
 					}),
+					"float64_prop_required_default_non_zero": base.CreateSchemaProxy(&base.Schema{
+						Type:    []string{"number"},
+						Format:  "double",
+						Default: float64(123.45),
+					}),
 				},
 			},
 			expectedAttributes: &[]resource.Attribute{
@@ -117,6 +123,16 @@ func TestBuildNumberResource(t *testing.T) {
 						},
 					},
 				},
+				{
+					Name: "float64_prop_required_default_non_zero",
+					Float64: &resource.Float64Attribute{
+						// Intentionally not required due to default
+						ComputedOptionalRequired: schema.ComputedOptional,
+						Default: &schema.Float64Default{
+							Static: pointer(float64(123.45)),
+						},
+					},
+				},
 			},
 		},
 		"float64 attributes deprecated": {

internal/mapper/oas/string.go

@@ -26,6 +26,10 @@ func (s *OASSchema) BuildStringResource(name string, computability schema.Comput
 		staticDefault, ok := s.Schema.Default.(string)
 
 		if ok {
+			if computability == schema.Required {
+				result.String.ComputedOptionalRequired = schema.ComputedOptional
+			}
+
 			result.String.Default = &schema.StringDefault{
 				Static: &staticDefault,
 			}

internal/mapper/oas/string_test.go

@@ -60,7 +60,8 @@ func TestBuildStringResource(t *testing.T) {
 		},
 		"string attributes default": {
 			schema: &base.Schema{
-				Type: []string{"object"},
+				Type:     []string{"object"},
+				Required: []string{"string_prop_required_default_non_empty"},
 				Properties: map[string]*base.SchemaProxy{
 					"string_prop_default_empty": base.CreateSchemaProxy(&base.Schema{
 						Type:    []string{"string"},
@@ -72,6 +73,11 @@ func TestBuildStringResource(t *testing.T) {
 						Format:  "double",
 						Default: "test value",
 					}),
+					"string_prop_required_default_non_empty": base.CreateSchemaProxy(&base.Schema{
+						Type:    []string{"string"},
+						Format:  "double",
+						Default: "test value",
+					}),
 				},
 			},
 			expectedAttributes: &[]resource.Attribute{
@@ -93,6 +99,16 @@ func TestBuildStringResource(t *testing.T) {
 						},
 					},
 				},
+				{
+					Name: "string_prop_required_default_non_empty",
+					String: &resource.StringAttribute{
+						// Intentionally not required due to default
+						ComputedOptionalRequired: schema.ComputedOptional,
+						Default: &schema.StringDefault{
+							Static: pointer("test value"),
+						},
+					},
+				},
 			},
 		},
 		"string attributes deprecated": {