Feat/schema overrides

internal/config/parse.go

@@ -82,6 +82,10 @@ type AttributeOptions struct {
 type Override struct {
 	// Description overrides the description that was mapped/merged from the OpenAPI specification.
 	Description string `yaml:"description"`
+	// Schema overrides the schema that was mapped/merged from the OpenAPI specification.
+	Schema SchemaOptions `yaml:"schema"`
+	// A power tool to perform any arbitrary override of or insertion - not validated against OpenAPI spec.
+	CustomOverrides map[string]string `yaml:"custom_overrides"`
 }
 
 // ParseConfig takes in a byte array (of YAML), unmarshals into a Config struct, and validates the result

internal/explorer/config_explorer.go

@@ -198,20 +198,22 @@ func extractSchemaProxy(document high.Document, componentRef string) (*highbase.
 	return highbase.CreateSchemaProxy(highSchema), nil
 }
 
-func extractSchemaOptions(cfgSchemaOpts config.SchemaOptions) SchemaOptions {
-	return SchemaOptions{
+func extractSchemaOptions(cfgSchemaOpts config.SchemaOptions) config.SchemaOptions {
+	return config.SchemaOptions{
 		Ignores: cfgSchemaOpts.Ignores,
-		AttributeOptions: AttributeOptions{
+		AttributeOptions: config.AttributeOptions{
 			Aliases:   cfgSchemaOpts.AttributeOptions.Aliases,
 			Overrides: extractOverrides(cfgSchemaOpts.AttributeOptions.Overrides),
 		},
 	}
 }
 
-func extractOverrides(cfgOverrides map[string]config.Override) map[string]Override {
-	overrides := make(map[string]Override, len(cfgOverrides))
+func extractOverrides(cfgOverrides map[string]config.Override) map[string]config.Override {
+	overrides := make(map[string]config.Override, len(cfgOverrides))
 	for key, cfgOverride := range cfgOverrides {
-		overrides[key] = Override{Description: cfgOverride.Description}
+		overrides[key] = config.Override{Description: cfgOverride.Description}
+		overrides[key] = config.Override{CustomOverrides: cfgOverride.CustomOverrides}
+		overrides[key] = config.Override{Schema: cfgOverride.Schema}
 	}
 
 	return overrides

internal/explorer/config_explorer_test.go

@@ -92,9 +92,9 @@ func Test_ConfigExplorer_FindResources(t *testing.T) {
 						Description: "delete op here",
 						OperationId: "delete_resource",
 					},
-					SchemaOptions: explorer.SchemaOptions{
-						AttributeOptions: explorer.AttributeOptions{
-							Overrides: map[string]explorer.Override{},
+					SchemaOptions: config.SchemaOptions{
+						AttributeOptions: config.AttributeOptions{
+							Overrides: map[string]config.Override{},
 						},
 					},
 				},
@@ -165,9 +165,9 @@ func Test_ConfigExplorer_FindResources(t *testing.T) {
 						Description: "delete op here",
 						OperationId: "delete_resource",
 					},
-					SchemaOptions: explorer.SchemaOptions{
-						AttributeOptions: explorer.AttributeOptions{
-							Overrides: map[string]explorer.Override{},
+					SchemaOptions: config.SchemaOptions{
+						AttributeOptions: config.AttributeOptions{
+							Overrides: map[string]config.Override{},
 						},
 					},
 				},
@@ -302,13 +302,13 @@ func Test_ConfigExplorer_FindResources(t *testing.T) {
 						Description: "read op here",
 						OperationId: "read_resource",
 					},
-					SchemaOptions: explorer.SchemaOptions{
+					SchemaOptions: config.SchemaOptions{
 						Ignores: []string{"ignore1.abc", "ignore2.def"},
-						AttributeOptions: explorer.AttributeOptions{
+						AttributeOptions: config.AttributeOptions{
 							Aliases: map[string]string{
 								"otherId": "id",
 							},
-							Overrides: map[string]explorer.Override{
+							Overrides: map[string]config.Override{
 								"test": {
 									Description: "test description for override",
 								},
@@ -382,9 +382,9 @@ func Test_ConfigExplorer_FindDataSources(t *testing.T) {
 						Description: "read op here",
 						OperationId: "read_resource",
 					},
-					SchemaOptions: explorer.SchemaOptions{
-						AttributeOptions: explorer.AttributeOptions{
-							Overrides: map[string]explorer.Override{},
+					SchemaOptions: config.SchemaOptions{
+						AttributeOptions: config.AttributeOptions{
+							Overrides: map[string]config.Override{},
 						},
 					},
 				},
@@ -415,9 +415,9 @@ func Test_ConfigExplorer_FindDataSources(t *testing.T) {
 						Description: "read op here",
 						OperationId: "read_resource",
 					},
-					SchemaOptions: explorer.SchemaOptions{
-						AttributeOptions: explorer.AttributeOptions{
-							Overrides: map[string]explorer.Override{},
+					SchemaOptions: config.SchemaOptions{
+						AttributeOptions: config.AttributeOptions{
+							Overrides: map[string]config.Override{},
 						},
 					},
 				},
@@ -496,13 +496,13 @@ func Test_ConfigExplorer_FindDataSources(t *testing.T) {
 						Description: "read op here",
 						OperationId: "read_resource",
 					},
-					SchemaOptions: explorer.SchemaOptions{
+					SchemaOptions: config.SchemaOptions{
 						Ignores: []string{"ignore1.abc", "ignore2.def"},
-						AttributeOptions: explorer.AttributeOptions{
+						AttributeOptions: config.AttributeOptions{
 							Aliases: map[string]string{
 								"otherId": "id",
 							},
-							Overrides: map[string]explorer.Override{
+							Overrides: map[string]config.Override{
 								"test": {
 									Description: "test description for override",
 								},

internal/explorer/explorer.go

@@ -4,7 +4,9 @@
 package explorer
 
 import (
+	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/config"
 	"github.com/pb33f/libopenapi/datamodel/high/base"
+
 	high "github.com/pb33f/libopenapi/datamodel/high/v3"
 )
 
@@ -22,14 +24,14 @@ type Resource struct {
 	UpdateOp         *high.Operation
 	DeleteOp         *high.Operation
 	CommonParameters []*high.Parameter
-	SchemaOptions    SchemaOptions
+	SchemaOptions    config.SchemaOptions
 }
 
 // DataSource contains a Read operation and schema options for configuration.
 type DataSource struct {
 	ReadOp           *high.Operation
 	CommonParameters []*high.Parameter
-	SchemaOptions    SchemaOptions
+	SchemaOptions    config.SchemaOptions
 }
 
 // Provider contains a name and a schema.
@@ -38,17 +40,3 @@ type Provider struct {
 	SchemaProxy *base.SchemaProxy
 	Ignores     []string
 }
-
-type SchemaOptions struct {
-	Ignores          []string
-	AttributeOptions AttributeOptions
-}
-
-type AttributeOptions struct {
-	Aliases   map[string]string
-	Overrides map[string]Override
-}
-
-type Override struct {
-	Description string
-}

internal/mapper/attrmapper/bool.go

@@ -4,7 +4,7 @@
 package attrmapper
 
 import (
-	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/explorer"
+	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/config"
 	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/mapper/util"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/provider"
@@ -31,7 +31,7 @@ func (a *ResourceBoolAttribute) Merge(mergeAttribute ResourceAttribute) (Resourc
 	return a, nil
 }
 
-func (a *ResourceBoolAttribute) ApplyOverride(override explorer.Override) (ResourceAttribute, error) {
+func (a *ResourceBoolAttribute) ApplyOverride(override config.Override) (ResourceAttribute, error) {
 	a.Description = &override.Description
 
 	return a, nil
@@ -64,7 +64,7 @@ func (a *DataSourceBoolAttribute) Merge(mergeAttribute DataSourceAttribute) (Dat
 	return a, nil
 }
 
-func (a *DataSourceBoolAttribute) ApplyOverride(override explorer.Override) (DataSourceAttribute, error) {
+func (a *DataSourceBoolAttribute) ApplyOverride(override config.Override) (DataSourceAttribute, error) {
 	a.Description = &override.Description
 
 	return a, nil

internal/mapper/attrmapper/bool_test.go

@@ -7,7 +7,7 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
-	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/explorer"
+	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/config"
 	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/mapper/attrmapper"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/resource"
@@ -131,7 +131,7 @@ func TestResourceBoolAttribute_ApplyOverride(t *testing.T) {
 
 	testCases := map[string]struct {
 		attribute         attrmapper.ResourceBoolAttribute
-		override          explorer.Override
+		override          config.Override
 		expectedAttribute attrmapper.ResourceAttribute
 	}{
 		"override description": {
@@ -142,7 +142,7 @@ func TestResourceBoolAttribute_ApplyOverride(t *testing.T) {
 					Description:              pointer("old description"),
 				},
 			},
-			override: explorer.Override{
+			override: config.Override{
 				Description: "new description",
 			},
 			expectedAttribute: &attrmapper.ResourceBoolAttribute{
@@ -285,7 +285,7 @@ func TestDataSourceBoolAttribute_ApplyOverride(t *testing.T) {
 
 	testCases := map[string]struct {
 		attribute         attrmapper.DataSourceBoolAttribute
-		override          explorer.Override
+		override          config.Override
 		expectedAttribute attrmapper.DataSourceAttribute
 	}{
 		"override description": {
@@ -296,7 +296,7 @@ func TestDataSourceBoolAttribute_ApplyOverride(t *testing.T) {
 					Description:              pointer("old description"),
 				},
 			},
-			override: explorer.Override{
+			override: config.Override{
 				Description: "new description",
 			},
 			expectedAttribute: &attrmapper.DataSourceBoolAttribute{

internal/mapper/attrmapper/data_source_attributes.go

@@ -7,19 +7,19 @@ import (
 	"errors"
 	"strings"
 
-	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/explorer"
+	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/config"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 )
 
 type DataSourceAttribute interface {
 	GetName() string
 	Merge(DataSourceAttribute) (DataSourceAttribute, error)
-	ApplyOverride(explorer.Override) (DataSourceAttribute, error)
+	ApplyOverride(config.Override) (DataSourceAttribute, error)
 	ToSpec() datasource.Attribute
 }
 
 type DataSourceNestedAttribute interface {
-	ApplyNestedOverride([]string, explorer.Override) (DataSourceAttribute, error)
+	ApplyNestedOverride([]string, config.Override) (DataSourceAttribute, error)
 }
 
 type DataSourceAttributes []DataSourceAttribute
@@ -67,7 +67,7 @@ func (attributes DataSourceAttributes) ToSpec() []datasource.Attribute {
 	return specAttributes
 }
 
-func (attributes DataSourceAttributes) ApplyOverrides(overrideMap map[string]explorer.Override) (DataSourceAttributes, error) {
+func (attributes DataSourceAttributes) ApplyOverrides(overrideMap map[string]config.Override) (DataSourceAttributes, error) {
 	var errResult error
 	for key, override := range overrideMap {
 		var err error
@@ -78,7 +78,7 @@ func (attributes DataSourceAttributes) ApplyOverrides(overrideMap map[string]exp
 	return attributes, errResult
 }
 
-func (attributes DataSourceAttributes) ApplyOverride(path []string, override explorer.Override) (DataSourceAttributes, error) {
+func (attributes DataSourceAttributes) ApplyOverride(path []string, override config.Override) (DataSourceAttributes, error) {
 	var errResult error
 	if len(path) == 0 {
 		return attributes, errResult

internal/mapper/attrmapper/data_source_attributes_test.go

@@ -7,7 +7,7 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
-	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/explorer"
+	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/config"
 	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/mapper/attrmapper"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/schema"
@@ -204,13 +204,13 @@ func TestDataSourceAttributes_ApplyOverrides(t *testing.T) {
 	t.Parallel()
 
 	testCases := map[string]struct {
-		overrides          map[string]explorer.Override
+		overrides          map[string]config.Override
 		attributes         attrmapper.DataSourceAttributes
 		expectedAttributes attrmapper.DataSourceAttributes
 	}{
 		// TODO: this may eventually return an error, but for now just returns without modification
 		"no matching overrides": {
-			overrides: map[string]explorer.Override{
+			overrides: map[string]config.Override{
 				"": {
 					Description: "new description",
 				},
@@ -241,7 +241,7 @@ func TestDataSourceAttributes_ApplyOverrides(t *testing.T) {
 			},
 		},
 		"matching overrides": {
-			overrides: map[string]explorer.Override{
+			overrides: map[string]config.Override{
 				"string_attribute": {
 					Description: "new string description",
 				},
@@ -283,7 +283,7 @@ func TestDataSourceAttributes_ApplyOverrides(t *testing.T) {
 			},
 		},
 		"matching nested overrides": {
-			overrides: map[string]explorer.Override{
+			overrides: map[string]config.Override{
 				"single_nested": {
 					Description: "new description",
 				},

internal/mapper/attrmapper/float64.go

@@ -4,7 +4,7 @@
 package attrmapper
 
 import (
-	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/explorer"
+	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/config"
 	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/mapper/util"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/provider"
@@ -31,7 +31,7 @@ func (a *ResourceFloat64Attribute) Merge(mergeAttribute ResourceAttribute) (Reso
 	return a, nil
 }
 
-func (a *ResourceFloat64Attribute) ApplyOverride(override explorer.Override) (ResourceAttribute, error) {
+func (a *ResourceFloat64Attribute) ApplyOverride(override config.Override) (ResourceAttribute, error) {
 	a.Description = &override.Description
 
 	return a, nil
@@ -64,7 +64,7 @@ func (a *DataSourceFloat64Attribute) Merge(mergeAttribute DataSourceAttribute) (
 	return a, nil
 }
 
-func (a *DataSourceFloat64Attribute) ApplyOverride(override explorer.Override) (DataSourceAttribute, error) {
+func (a *DataSourceFloat64Attribute) ApplyOverride(override config.Override) (DataSourceAttribute, error) {
 	a.Description = &override.Description
 
 	return a, nil

internal/mapper/attrmapper/float64_test.go

@@ -7,7 +7,7 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
-	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/explorer"
+	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/config"
 	"github.com/hashicorp/terraform-plugin-codegen-openapi/internal/mapper/attrmapper"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/datasource"
 	"github.com/hashicorp/terraform-plugin-codegen-spec/resource"
@@ -131,7 +131,7 @@ func TestResourceFloat64Attribute_ApplyOverride(t *testing.T) {
 
 	testCases := map[string]struct {
 		attribute         attrmapper.ResourceFloat64Attribute
-		override          explorer.Override
+		override          config.Override
 		expectedAttribute attrmapper.ResourceAttribute
 	}{
 		"override description": {
@@ -142,7 +142,7 @@ func TestResourceFloat64Attribute_ApplyOverride(t *testing.T) {
 					Description:              pointer("old description"),
 				},
 			},
-			override: explorer.Override{
+			override: config.Override{
 				Description: "new description",
 			},
 			expectedAttribute: &attrmapper.ResourceFloat64Attribute{
@@ -285,7 +285,7 @@ func TestDataSourceFloat64Attribute_ApplyOverride(t *testing.T) {
 
 	testCases := map[string]struct {
 		attribute         attrmapper.DataSourceFloat64Attribute
-		override          explorer.Override
+		override          config.Override
 		expectedAttribute attrmapper.DataSourceAttribute
 	}{
 		"override description": {
@@ -296,7 +296,7 @@ func TestDataSourceFloat64Attribute_ApplyOverride(t *testing.T) {
 					Description:              pointer("old description"),
 				},
 			},
-			override: explorer.Override{
+			override: config.Override{
 				Description: "new description",
 			},
 			expectedAttribute: &attrmapper.DataSourceFloat64Attribute{