Support overriding nested attributes

randomswdev · randomswdev · commit 334f2850a843 · 2024-01-05T17:47:37.000+01:00
diff --git a/internal/explorer/config_explorer.go b/internal/explorer/config_explorer.go
@@ -81,11 +81,18 @@ func (e configExplorer) FindResources() (map[string]Resource, error) {
 			continue
 		}
 
+		parameters, err := extractParameters(e.spec.Paths, resourceConfig.Read.Path)
+		if err != nil {
+			errResult = errors.Join(errResult, fmt.Errorf("failed to extract '%s.delete': %w", name, err))
+			continue
+		}
+
 		resources[name] = Resource{
 			CreateOp:      createOp,
 			ReadOp:        readOp,
 			UpdateOp:      updateOp,
 			DeleteOp:      deleteOp,
+			Parameters:    parameters,
 			SchemaOptions: extractSchemaOptions(resourceConfig.SchemaOptions),
 		}
 	}
@@ -103,8 +110,16 @@ func (e configExplorer) FindDataSources() (map[string]DataSource, error) {
 			errResult = errors.Join(errResult, fmt.Errorf("failed to extract '%s.read': %w", name, err))
 			continue
 		}
+
+		parameters, err := extractParameters(e.spec.Paths, dataSourceConfig.Read.Path)
+		if err != nil {
+			errResult = errors.Join(errResult, fmt.Errorf("failed to extract '%s.delete': %w", name, err))
+			continue
+		}
+
 		dataSources[name] = DataSource{
 			ReadOp:        readOp,
+			Parameters:    parameters,
 			SchemaOptions: extractSchemaOptions(dataSourceConfig.SchemaOptions),
 		}
 	}
@@ -145,6 +160,17 @@ func extractOp(paths *high.Paths, oasLocation *config.OpenApiSpecLocation) (*hig
 	}
 }
 
+func extractParameters(paths *high.Paths, path string) ([]*high.Parameter, error) {
+	// No need to search OAS if not defined
+	if paths.PathItems.GetOrZero(path) == nil {
+		return nil, fmt.Errorf("path '%s' not found in OpenAPI spec", path)
+	}
+
+	pathItem, _ := paths.PathItems.Get(path)
+
+	return pathItem.Parameters, nil
+}
+
 func extractSchemaProxy(document high.Document, componentRef string) (*highbase.SchemaProxy, error) {
 	// find the reference using the root document.Index
 	indexRef := document.Index.FindComponentInRoot(componentRef)
diff --git a/internal/explorer/explorer.go b/internal/explorer/explorer.go
@@ -21,12 +21,14 @@ type Resource struct {
 	ReadOp        *high.Operation
 	UpdateOp      *high.Operation
 	DeleteOp      *high.Operation
+	Parameters    []*high.Parameter
 	SchemaOptions SchemaOptions
 }
 
 // DataSource contains a Read operation and schema options for configuration.
 type DataSource struct {
 	ReadOp        *high.Operation
+	Parameters    []*high.Parameter
 	SchemaOptions SchemaOptions
 }
 
diff --git a/internal/mapper/attrmapper/data_source_attributes.go b/internal/mapper/attrmapper/data_source_attributes.go
@@ -9,6 +9,7 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/explorer"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
+	"github.com/hashicorp/terraform-plugin-codegen-spec/schema"
 )
 
 type DataSourceAttribute interface {
@@ -20,6 +21,7 @@ type DataSourceAttribute interface {
 
 type DataSourceNestedAttribute interface {
 	ApplyNestedOverride([]string, explorer.Override) (DataSourceAttribute, error)
+	NestedMerge([]string, DataSourceAttribute, schema.ComputedOptionalRequired) (DataSourceAttribute, error)
 }
 
 type DataSourceAttributes []DataSourceAttribute
@@ -58,6 +60,46 @@ func (targetSlice DataSourceAttributes) Merge(mergeSlices ...DataSourceAttribute
 	return targetSlice, errResult
 }
 
+func (targetSlice DataSourceAttributes) MergeAttribute(path []string, attribute DataSourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (DataSourceAttributes, error) {
+	var errResult error
+	if len(path) == 0 {
+		return targetSlice, errResult
+	}
+	for i, target := range targetSlice {
+		if target.GetName() == path[0] {
+
+			if len(path) > 1 {
+				nestedTarget, ok := target.(DataSourceNestedAttribute)
+				if !ok {
+					// TODO: error? there is a nested override for an attribute that is not a nested type
+					break
+				}
+
+				// The attribute we need to override is deeper nested, move up
+				nextPath := path[1:]
+
+				overriddenTarget, err := nestedTarget.NestedMerge(nextPath, attribute, intermediateComputability)
+				errResult = errors.Join(errResult, err)
+
+				targetSlice[i] = overriddenTarget
+
+			} else {
+				// No more path to traverse, apply merge, bidirectional
+				overriddenTarget, err := attribute.Merge(target)
+				errResult = errors.Join(errResult, err)
+				overriddenTarget, err = overriddenTarget.Merge(attribute)
+				errResult = errors.Join(errResult, err)
+
+				targetSlice[i] = overriddenTarget
+			}
+
+			break
+		}
+	}
+
+	return targetSlice, errResult
+}
+
 func (attributes DataSourceAttributes) ToSpec() []datasource.Attribute {
 	specAttributes := make([]datasource.Attribute, 0, len(attributes))
 	for _, attribute := range attributes {
diff --git a/internal/mapper/attrmapper/list_nested.go b/internal/mapper/attrmapper/list_nested.go
@@ -9,6 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/provider"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/resource"
+	"github.com/hashicorp/terraform-plugin-codegen-spec/schema"
 )
 
 type ResourceListNestedAttribute struct {
@@ -50,6 +51,16 @@ func (a *ResourceListNestedAttribute) ApplyNestedOverride(path []string, overrid
 	return a, err
 }
 
+func (a *ResourceListNestedAttribute) NestedMerge(path []string, attribute ResourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (ResourceAttribute, error) {
+	var err error
+	a.NestedObject.Attributes, err = a.NestedObject.Attributes.MergeAttribute(path, attribute, intermediateComputability)
+	if err == nil {
+		a.ComputedOptionalRequired = intermediateComputability
+	}
+
+	return a, err
+}
+
 func (a *ResourceListNestedAttribute) ToSpec() resource.Attribute {
 	a.ListNestedAttribute.NestedObject = resource.NestedAttributeObject{
 		Attributes: a.NestedObject.Attributes.ToSpec(),
@@ -100,6 +111,16 @@ func (a *DataSourceListNestedAttribute) ApplyNestedOverride(path []string, overr
 	return a, err
 }
 
+func (a *DataSourceListNestedAttribute) NestedMerge(path []string, attribute DataSourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (DataSourceAttribute, error) {
+	var err error
+	a.NestedObject.Attributes, err = a.NestedObject.Attributes.MergeAttribute(path, attribute, intermediateComputability)
+	if err == nil {
+		a.ComputedOptionalRequired = intermediateComputability
+	}
+
+	return a, err
+}
+
 func (a *DataSourceListNestedAttribute) ToSpec() datasource.Attribute {
 	a.ListNestedAttribute.NestedObject = datasource.NestedAttributeObject{
 		Attributes: a.NestedObject.Attributes.ToSpec(),
diff --git a/internal/mapper/attrmapper/map_nested.go b/internal/mapper/attrmapper/map_nested.go
@@ -9,6 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/provider"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/resource"
+	"github.com/hashicorp/terraform-plugin-codegen-spec/schema"
 )
 
 type ResourceMapNestedAttribute struct {
@@ -50,6 +51,16 @@ func (a *ResourceMapNestedAttribute) ApplyNestedOverride(path []string, override
 	return a, err
 }
 
+func (a *ResourceMapNestedAttribute) NestedMerge(path []string, attribute ResourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (ResourceAttribute, error) {
+	var err error
+	a.NestedObject.Attributes, err = a.NestedObject.Attributes.MergeAttribute(path, attribute, intermediateComputability)
+	if err == nil {
+		a.ComputedOptionalRequired = intermediateComputability
+	}
+
+	return a, err
+}
+
 func (a *ResourceMapNestedAttribute) ToSpec() resource.Attribute {
 	a.MapNestedAttribute.NestedObject = resource.NestedAttributeObject{
 		Attributes: a.NestedObject.Attributes.ToSpec(),
@@ -100,6 +111,16 @@ func (a *DataSourceMapNestedAttribute) ApplyNestedOverride(path []string, overri
 	return a, err
 }
 
+func (a *DataSourceMapNestedAttribute) NestedMerge(path []string, attribute DataSourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (DataSourceAttribute, error) {
+	var err error
+	a.NestedObject.Attributes, err = a.NestedObject.Attributes.MergeAttribute(path, attribute, intermediateComputability)
+	if err == nil {
+		a.ComputedOptionalRequired = intermediateComputability
+	}
+
+	return a, err
+}
+
 func (a *DataSourceMapNestedAttribute) ToSpec() datasource.Attribute {
 	a.MapNestedAttribute.NestedObject = datasource.NestedAttributeObject{
 		Attributes: a.NestedObject.Attributes.ToSpec(),
diff --git a/internal/mapper/attrmapper/resource_attributes.go b/internal/mapper/attrmapper/resource_attributes.go
@@ -9,6 +9,7 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/explorer"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/resource"
+	"github.com/hashicorp/terraform-plugin-codegen-spec/schema"
 )
 
 type ResourceAttribute interface {
@@ -20,6 +21,7 @@ type ResourceAttribute interface {
 
 type ResourceNestedAttribute interface {
 	ApplyNestedOverride([]string, explorer.Override) (ResourceAttribute, error)
+	NestedMerge([]string, ResourceAttribute, schema.ComputedOptionalRequired) (ResourceAttribute, error)
 }
 
 type ResourceAttributes []ResourceAttribute
@@ -58,6 +60,46 @@ func (targetSlice ResourceAttributes) Merge(mergeSlices ...ResourceAttributes) (
 	return targetSlice, errResult
 }
 
+func (targetSlice ResourceAttributes) MergeAttribute(path []string, attribute ResourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (ResourceAttributes, error) {
+	var errResult error
+	if len(path) == 0 {
+		return targetSlice, errResult
+	}
+	for i, target := range targetSlice {
+		if target.GetName() == path[0] {
+
+			if len(path) > 1 {
+				nestedTarget, ok := target.(ResourceNestedAttribute)
+				if !ok {
+					// TODO: error? there is a nested override for an attribute that is not a nested type
+					break
+				}
+
+				// The attribute we need to override is deeper nested, move up
+				nextPath := path[1:]
+
+				overriddenTarget, err := nestedTarget.NestedMerge(nextPath, attribute, intermediateComputability)
+				errResult = errors.Join(errResult, err)
+
+				targetSlice[i] = overriddenTarget
+
+			} else {
+				// No more path to traverse, apply merge, bidirectional
+				overriddenTarget, err := attribute.Merge(target)
+				errResult = errors.Join(errResult, err)
+				overriddenTarget, err = overriddenTarget.Merge(attribute)
+				errResult = errors.Join(errResult, err)
+
+				targetSlice[i] = overriddenTarget
+			}
+
+			break
+		}
+	}
+
+	return targetSlice, errResult
+}
+
 func (attributes ResourceAttributes) ToSpec() []resource.Attribute {
 	specAttributes := make([]resource.Attribute, 0, len(attributes))
 	for _, attribute := range attributes {
diff --git a/internal/mapper/attrmapper/set_nested.go b/internal/mapper/attrmapper/set_nested.go
@@ -9,6 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/provider"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/resource"
+	"github.com/hashicorp/terraform-plugin-codegen-spec/schema"
 )
 
 type ResourceSetNestedAttribute struct {
@@ -50,6 +51,16 @@ func (a *ResourceSetNestedAttribute) ApplyNestedOverride(path []string, override
 	return a, err
 }
 
+func (a *ResourceSetNestedAttribute) NestedMerge(path []string, attribute ResourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (ResourceAttribute, error) {
+	var err error
+	a.NestedObject.Attributes, err = a.NestedObject.Attributes.MergeAttribute(path, attribute, intermediateComputability)
+	if err == nil {
+		a.ComputedOptionalRequired = intermediateComputability
+	}
+
+	return a, err
+}
+
 func (a *ResourceSetNestedAttribute) ToSpec() resource.Attribute {
 	a.SetNestedAttribute.NestedObject = resource.NestedAttributeObject{
 		Attributes: a.NestedObject.Attributes.ToSpec(),
@@ -100,6 +111,16 @@ func (a *DataSourceSetNestedAttribute) ApplyNestedOverride(path []string, overri
 	return a, err
 }
 
+func (a *DataSourceSetNestedAttribute) NestedMerge(path []string, attribute DataSourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (DataSourceAttribute, error) {
+	var err error
+	a.NestedObject.Attributes, err = a.NestedObject.Attributes.MergeAttribute(path, attribute, intermediateComputability)
+	if err == nil {
+		a.ComputedOptionalRequired = intermediateComputability
+	}
+
+	return a, err
+}
+
 func (a *DataSourceSetNestedAttribute) ToSpec() datasource.Attribute {
 	a.SetNestedAttribute.NestedObject = datasource.NestedAttributeObject{
 		Attributes: a.NestedObject.Attributes.ToSpec(),
diff --git a/internal/mapper/attrmapper/single_nested.go b/internal/mapper/attrmapper/single_nested.go
@@ -9,6 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/provider"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/resource"
+	"github.com/hashicorp/terraform-plugin-codegen-spec/schema"
 )
 
 type ResourceSingleNestedAttribute struct {
@@ -50,6 +51,16 @@ func (a *ResourceSingleNestedAttribute) ApplyNestedOverride(path []string, overr
 	return a, err
 }
 
+func (a *ResourceSingleNestedAttribute) NestedMerge(path []string, attribute ResourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (ResourceAttribute, error) {
+	var err error
+	a.Attributes, err = a.Attributes.MergeAttribute(path, attribute, intermediateComputability)
+	if err == nil {
+		a.ComputedOptionalRequired = intermediateComputability
+	}
+
+	return a, err
+}
+
 func (a *ResourceSingleNestedAttribute) ToSpec() resource.Attribute {
 	a.SingleNestedAttribute.Attributes = a.Attributes.ToSpec()
 
@@ -98,6 +109,16 @@ func (a *DataSourceSingleNestedAttribute) ApplyNestedOverride(path []string, ove
 	return a, err
 }
 
+func (a *DataSourceSingleNestedAttribute) NestedMerge(path []string, attribute DataSourceAttribute, intermediateComputability schema.ComputedOptionalRequired) (DataSourceAttribute, error) {
+	var err error
+	a.Attributes, err = a.Attributes.MergeAttribute(path, attribute, intermediateComputability)
+	if err == nil {
+		a.ComputedOptionalRequired = intermediateComputability
+	}
+
+	return a, err
+}
+
 func (a *DataSourceSingleNestedAttribute) ToSpec() datasource.Attribute {
 	a.SingleNestedAttribute.Attributes = a.Attributes.ToSpec()
 
diff --git a/internal/mapper/datasource_mapper.go b/internal/mapper/datasource_mapper.go
diff --git a/internal/mapper/resource_mapper.go b/internal/mapper/resource_mapper.go

Original file line number	Diff line number	Diff line change
`@@ -21,12 +21,14 @@ type Resource struct {`
`21`	`21`	`ReadOp *high.Operation`
`22`	`22`	`UpdateOp *high.Operation`
`23`	`23`	`DeleteOp *high.Operation`
	`24`	`+ Parameters []*high.Parameter`
`24`	`25`	`SchemaOptions SchemaOptions`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`// DataSource contains a Read operation and schema options for configuration.`
`28`	`29`	`type DataSource struct {`
`29`	`30`	`ReadOp *high.Operation`
	`31`	`+ Parameters []*high.Parameter`
`30`	`32`	`SchemaOptions SchemaOptions`
`31`	`33`	`}`
`32`	`34`