feat(codegen): Add support for terraform lists/queries

Author: kklimonda-cl

pkg/commands/codegen/codegen.go

@@ -75,7 +75,6 @@ func (c *Command) Execute() error {
 	var resourceList []string
 	var dataSourceList []string
 	var ephemeralResourceList []string
-	var actionsList []string
 	specMetadata := make(map[string]properties.TerraformProviderSpecMetadata)
 
 	for _, specPath := range c.specs {
@@ -129,17 +128,16 @@ func (c *Command) Execute() error {
 				}
 
 				terraformGenerator := generate.NewCreator(config.Output.TerraformProvider, c.templatePath, spec)
-				data, err := terraformGenerator.RenderTerraformProviderFile(spec, resourceTyp)
+				dataSources, resources, ephemeralResources, partialNames, err := terraformGenerator.RenderTerraformProviderFile(spec, resourceTyp)
 				if err != nil {
 					return fmt.Errorf("error rendering Terraform provider file for %s - %s", specPath, err)
 				}
 
-				resourceList = append(resourceList, data.Resources...)
-				dataSourceList = append(dataSourceList, data.DataSources...)
-				ephemeralResourceList = append(ephemeralResourceList, data.EphemeralResources...)
-				actionsList = append(actionsList, data.Actions...)
+				resourceList = append(resourceList, resources...)
+				dataSourceList = append(dataSourceList, dataSources...)
+				ephemeralResourceList = append(ephemeralResourceList, ephemeralResources...)
 
-				for k, v := range data.SpecMetadata {
+				for k, v := range partialNames {
 					specMetadata[k] = v
 				}
 
@@ -159,17 +157,16 @@ func (c *Command) Execute() error {
 				}
 
 				terraformGenerator := generate.NewCreator(config.Output.TerraformProvider, c.templatePath, spec)
-				data, err := terraformGenerator.RenderTerraformProviderFile(spec, resourceTyp)
+				dataSources, resources, ephemeralResources, partialNames, err := terraformGenerator.RenderTerraformProviderFile(spec, resourceTyp)
 				if err != nil {
 					return fmt.Errorf("error rendering Terraform provider file for %s - %s", specPath, err)
 				}
 
-				resourceList = append(resourceList, data.Resources...)
-				dataSourceList = append(dataSourceList, data.DataSources...)
-				ephemeralResourceList = append(ephemeralResourceList, data.EphemeralResources...)
-				actionsList = append(actionsList, data.Actions...)
+				resourceList = append(resourceList, resources...)
+				dataSourceList = append(dataSourceList, dataSources...)
+				ephemeralResourceList = append(ephemeralResourceList, ephemeralResources...)
 
-				for k, v := range data.SpecMetadata {
+				for k, v := range partialNames {
 					specMetadata[k] = v
 				}
 			}
@@ -190,7 +187,6 @@ func (c *Command) Execute() error {
 		newProviderObject.DataSources = append(newProviderObject.DataSources, dataSourceList...)
 		newProviderObject.Resources = append(newProviderObject.Resources, resourceList...)
 		newProviderObject.EphemeralResources = append(newProviderObject.EphemeralResources, ephemeralResourceList...)
-		newProviderObject.Actions = append(newProviderObject.Actions, actionsList...)
 		newProviderObject.SpecMetadata = specMetadata
 
 		terraformGenerator := generate.NewCreator(config.Output.TerraformProvider, c.templatePath, providerSpec)

pkg/generate/generator.go

@@ -58,16 +58,8 @@ func (c *Creator) RenderTemplate() error {
 	return nil
 }
 
-type TerraformProviderFileData struct {
-	EphemeralResources []string
-	Resources          []string
-	DataSources        []string
-	Actions            []string
-	SpecMetadata       map[string]properties.TerraformProviderSpecMetadata
-}
-
 // RenderTerraformProviderFile generates a Go file for a Terraform provider based on the provided TerraformProviderFile and Normalization arguments.
-func (c *Creator) RenderTerraformProviderFile(spec *properties.Normalization, typ properties.ResourceType) (*TerraformProviderFileData, error) {
+func (c *Creator) RenderTerraformProviderFile(spec *properties.Normalization, typ properties.ResourceType) ([]string, []string, []string, map[string]properties.TerraformProviderSpecMetadata, error) {
 	var name string
 	switch typ {
 	case properties.ResourceUuidPlural:
@@ -83,25 +75,19 @@ func (c *Creator) RenderTerraformProviderFile(spec *properties.Normalization, ty
 	tfp := terraform_provider.GenerateTerraformProvider{}
 
 	if err := tfp.GenerateTerraformDataSource(typ, spec, terraformProvider); err != nil {
-		return nil, err
+		return nil, nil, nil, nil, err
 	}
 
 	if err := tfp.GenerateTerraformResource(typ, spec, terraformProvider); err != nil {
-		return nil, err
-	}
-
-	if spec.TerraformProviderConfig.Action {
-		if err := tfp.GenerateTerraformAction(spec, terraformProvider); err != nil {
-			return nil, err
-		}
+		return nil, nil, nil, nil, err
 	}
 
 	if err := tfp.GenerateCommonCode(typ, spec, terraformProvider); err != nil {
-		return nil, err
+		return nil, nil, nil, nil, err
 	}
 
 	if err := tfp.GenerateTerraformProviderFile(typ, spec, terraformProvider); err != nil {
-		return nil, err
+		return nil, nil, nil, nil, err
 	}
 
 	var filePath string
@@ -117,17 +103,10 @@ func (c *Creator) RenderTerraformProviderFile(spec *properties.Normalization, ty
 	}
 
 	if err := c.writeFormattedContentToFile(filePath, terraformProvider.Code.String()); err != nil {
-		return nil, err
+		return nil, nil, nil, nil, err
 	}
 
-	data := &TerraformProviderFileData{
-		Resources:          terraformProvider.Resources,
-		DataSources:        terraformProvider.DataSources,
-		EphemeralResources: terraformProvider.EphemeralResources,
-		Actions:            terraformProvider.Actions,
-		SpecMetadata:       terraformProvider.SpecMetadata,
-	}
-	return data, nil
+	return terraformProvider.DataSources, terraformProvider.Resources, terraformProvider.EphemeralResources, terraformProvider.SpecMetadata, nil
 }
 
 // RenderTerraformProvider generates and writes a Terraform provider file.
@@ -224,8 +203,6 @@ func (c *Creator) createFullFilePath(templateName string) string {
 }
 
 // listOfTemplates returns a list of templates defined in TemplatesDir.
-// Excludes templates in the "partials" subdirectory as those are meant to be
-// called from within other templates, not processed independently.
 func (c *Creator) listOfTemplates() ([]string, error) {
 	var files []string
 	err := filepath.WalkDir(c.TemplatesDir, func(path string, entry os.DirEntry, err error) error {

pkg/properties/normalized.go

@@ -65,6 +65,7 @@ type TerraformProviderConfig struct {
 	Action                bool                       `json:"action" yaml:"action"`
 	CustomValidation      bool                       `json:"custom_validation" yaml:"custom_validation"`
 	SkipResource          bool                       `json:"skip_resource" yaml:"skip_resource"`
+	SkipListResource      *bool                      `json:"skip_list_resource", yaml:"skip_list_resource"`
 	SkipDatasource        bool                       `json:"skip_datasource" yaml:"skip_datasource"`
 	SkipDatasourceListing bool                       `json:"skip_datasource_listing" yaml:"skip_datasource_listing"`
 	ResourceType          TerraformResourceType      `json:"resource_type" yaml:"resource_type"`
@@ -702,6 +703,7 @@ func schemaToSpec(object object.Object) (*Normalization, error) {
 			Action:                object.TerraformConfig.Action,
 			CustomValidation:      object.TerraformConfig.CustomValidation,
 			SkipResource:          object.TerraformConfig.SkipResource,
+			SkipListResource:      object.TerraformConfig.SkipListResource,
 			SkipDatasource:        object.TerraformConfig.SkipDatasource,
 			SkipDatasourceListing: object.TerraformConfig.SkipdatasourceListing,
 			ResourceType:          TerraformResourceType(object.TerraformConfig.ResourceType),

pkg/properties/provider_file.go

@@ -68,6 +68,10 @@ func (o TerraformNameProvider) IdentityModelStructName() string {
 	return fmt.Sprintf("%sIdentityModel", o.ResourceStructName)
 }
 
+func (o TerraformNameProvider) ListResourceStructName() string {
+	return fmt.Sprintf("%sListResource", o.StructName)
+}
+
 type TerraformSpecFlags uint
 
 const (
@@ -91,6 +95,7 @@ type TerraformProviderFile struct {
 	DataSources        []string
 	Resources          []string
 	EphemeralResources []string
+	ListResources      []string
 	Actions            []string
 	SpecMetadata       map[string]TerraformProviderSpecMetadata
 	Code               *strings.Builder

pkg/properties/resourcetype.go

@@ -16,8 +16,10 @@ type SchemaType string
 const (
 	SchemaResource          SchemaType = "resource"
 	SchemaEphemeralResource SchemaType = "ephemeral-resource"
+	SchemaListResource      SchemaType = "list-resource"
 	SchemaAction            SchemaType = "action"
 	SchemaDataSource        SchemaType = "datasource"
 	SchemaCommon            SchemaType = "common"
 	SchemaProvider          SchemaType = "provider"
+	SchemaCustom            SchemaType = "custom"
 )

pkg/schema/object/object.go

@@ -43,6 +43,7 @@ type TerraformConfig struct {
 	SkipResource          bool                       `yaml:"skip_resource"`
 	SkipDatasource        bool                       `yaml:"skip_datasource"`
 	SkipdatasourceListing bool                       `yaml:"skip_datasource_listing"`
+	SkipListResource      *bool                      `yaml:"skip_list_resource"`
 	ResourceType          TerraformResourceType      `yaml:"resource_type"`
 	XmlNode               *string                    `yaml:"xml_node"`
 	CustomFunctions       map[string]bool            `yaml:"custom_functions"`

pkg/translate/terraform_provider/crud_operations.go

@@ -35,7 +35,7 @@ func ResourceCreateFunction(resourceTyp properties.ResourceType, names *NameProv
 			return RendeCreateUpdateMovementRequired(state, entries)
 		},
 		"RenderLocationsStateToPango": func(source string, dest string) (string, error) {
-			return RenderLocationsStateToPango(names, paramSpec, source, dest)
+			return RenderLocationsStateToPango(names, paramSpec, source, dest, "resp.Diagnostics")
 		},
 	}
 
@@ -151,7 +151,7 @@ func DataSourceReadFunction(resourceTyp properties.ResourceType, names *NameProv
 			return RenderLocationsPangoToState(names, paramSpec, source, dest)
 		},
 		"RenderLocationsStateToPango": func(source string, dest string) (string, error) {
-			return RenderLocationsStateToPango(names, paramSpec, source, dest)
+			return RenderLocationsStateToPango(names, paramSpec, source, dest, "resp.Diagnostics")
 		},
 	}
 
@@ -219,7 +219,7 @@ func ResourceReadFunction(resourceTyp properties.ResourceType, names *NameProvid
 			return RenderLocationsPangoToState(names, paramSpec, source, dest)
 		},
 		"RenderLocationsStateToPango": func(source string, dest string) (string, error) {
-			return RenderLocationsStateToPango(names, paramSpec, source, dest)
+			return RenderLocationsStateToPango(names, paramSpec, source, dest, "resp.Diagnostics")
 		},
 	}
 
@@ -281,7 +281,7 @@ func ResourceUpdateFunction(resourceTyp properties.ResourceType, names *NameProv
 			return RendeCreateUpdateMovementRequired(state, entries)
 		},
 		"RenderLocationsStateToPango": func(source string, dest string) (string, error) {
-			return RenderLocationsStateToPango(names, paramSpec, source, dest)
+			return RenderLocationsStateToPango(names, paramSpec, source, dest, "resp.Diagnostics")
 		},
 		"RenderLocationsPangoToState": func(source string, dest string) (string, error) {
 			return RenderLocationsPangoToState(names, paramSpec, source, dest)
@@ -345,7 +345,7 @@ func ResourceDeleteFunction(resourceTyp properties.ResourceType, names *NameProv
 			return RenderImportLocationAssignment(names, paramSpec, source, dest)
 		},
 		"RenderLocationsStateToPango": func(source string, dest string) (string, error) {
-			return RenderLocationsStateToPango(names, paramSpec, source, dest)
+			return RenderLocationsStateToPango(names, paramSpec, source, dest, "resp.Diagnostics")
 		},
 	}
 

pkg/translate/terraform_provider/entity_generators.go

@@ -91,6 +91,15 @@ func (g *GenerateTerraformProvider) GenerateTerraformResource(resourceTyp proper
 		"RenderXpathComponentsGetter": func() (string, error) {
 			return RenderXpathComponentsGetter(names.ResourceStructName, spec)
 		},
+		"RenderMainStruct": func() (string, error) {
+			return RenderMainStruct(resourceTyp, schemaTyp, names, spec)
+		},
+		"RenderConfigureFunc": func() (string, error) {
+			return RenderConfigureFunc(resourceTyp, schemaTyp, names, spec)
+		},
+		"RenderModelStructs": func() (string, error) {
+			return RenderModelStructs(resourceTyp, schemaTyp, names, spec)
+		},
 		"ResourceCreateFunction": func(structName string, serviceName string) (string, error) {
 			return ResourceCreateFunction(resourceTyp, names, serviceName, spec, terraformProvider, names.PackageName)
 		},
@@ -265,6 +274,37 @@ func (g *GenerateTerraformProvider) GenerateTerraformResource(resourceTyp proper
 	return nil
 }
 
+// GenerateTerraformListResource generates a Terraform list resource template.
+func (o *GenerateTerraformProvider) GenerateTerraformListResource(resourceTyp properties.ResourceType, spec *properties.Normalization, provider *properties.TerraformProviderFile) error {
+	provider.ImportManager.AddHashicorpImport("github.com/hashicorp/terraform-plugin-framework/list", "")
+	provider.ImportManager.AddHashicorpImport("github.com/hashicorp/terraform-plugin-framework/list/schema", "listschema")
+
+	names := NewNameProvider(spec, resourceTyp)
+
+	funcMap := template.FuncMap{
+		"structName": func() string { return names.StructName },
+		"metaName":   func() string { return names.MetaName },
+
+		"RenderModelStructs": func() (string, error) {
+			return RenderModelStructs(resourceTyp, properties.SchemaListResource, names, spec)
+		},
+		"RenderMainStruct": func() (string, error) {
+			return RenderMainStruct(resourceTyp, properties.SchemaListResource, names, spec)
+		},
+		"RenderConfigureFunc": func() (string, error) {
+			return RenderConfigureFunc(resourceTyp, properties.SchemaListResource, names, spec)
+		},
+		"RenderSchema": func() (string, error) {
+			return RenderSchema(resourceTyp, properties.SchemaListResource, names, spec, provider.ImportManager)
+		},
+		"RenderListFunc": func() (string, error) {
+			return RenderListFunc(resourceTyp, properties.SchemaListResource, names, spec, provider.ImportManager)
+		},
+	}
+
+	return o.generateTerraformEntityTemplate(resourceTyp, properties.SchemaListResource, names, spec, provider, "resource/list_resource.tmpl", funcMap)
+}
+
 // GenerateTerraformAction generates a Terraform action template.
 func (o *GenerateTerraformProvider) GenerateTerraformAction(spec *properties.Normalization, provider *properties.TerraformProviderFile) error {
 	provider.ImportManager.AddStandardImport("context", "")
@@ -288,7 +328,7 @@ func (o *GenerateTerraformProvider) GenerateTerraformAction(spec *properties.Nor
 		"metaName":            func() string { return names.MetaName },
 		"HasCustomValidation": func() bool { return spec.TerraformProviderConfig.CustomValidation },
 
-		"RenderStructs": func() (string, error) { return RenderStructs(resourceTyp, properties.SchemaAction, names, spec) },
+		"RenderModelStructs": func() (string, error) { return RenderModelStructs(resourceTyp, properties.SchemaAction, names, spec) },
 		"RenderSchema": func() (string, error) {
 			return RenderSchema(resourceTyp, properties.SchemaAction, names, spec, provider.ImportManager)
 		},
@@ -387,6 +427,15 @@ func (g *GenerateTerraformProvider) GenerateTerraformDataSource(resourceTyp prop
 			"RenderDataSourceSchema": func() (string, error) {
 				return RenderDataSourceSchema(resourceTyp, names, spec, terraformProvider.ImportManager)
 			},
+			"RenderMainStruct": func() (string, error) {
+				return RenderMainStruct(resourceTyp, properties.SchemaDataSource, names, spec)
+			},
+			"RenderConfigureFunc": func() (string, error) {
+				return RenderConfigureFunc(resourceTyp, properties.SchemaDataSource, names, spec)
+			},
+			"RenderModelStructs": func() (string, error) {
+				return RenderModelStructs(resourceTyp, properties.SchemaDataSource, names, spec)
+			},
 		}
 		err := g.generateTerraformEntityTemplate(resourceTyp, properties.SchemaDataSource, names, spec, terraformProvider, "datasource/datasource.tmpl", funcMap)
 		if err != nil {