feat: Add full rendering for terraform resources and data sources

assets/terraform/internal/provider/tfid.go

@@ -31,7 +31,7 @@ func NewTfidDataSource() datasource.DataSource {
 }
 
 type tfidDataSource struct {
-	client *pango.XmlApiClient
+	client *pango.Client
 }
 
 type tfidDsModel struct {
@@ -105,7 +105,7 @@ func (d *tfidDataSource) Configure(_ context.Context, req datasource.ConfigureRe
 		return
 	}
 
-	d.client = req.ProviderData.(*pango.XmlApiClient)
+	d.client = req.ProviderData.(*pango.Client)
 }
 
 func (d *tfidDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {

cmd/codegen/config.yaml

@@ -72,6 +72,10 @@ terraform_provider_config:
       env_name: "PANOS_HEADERS"
       optional: true
       type: map
+      items:
+        type: string
+        length:
+          max: 60
     skip_verify_certificate:
       description: "(For https protocol) Skip verifying the HTTPS certificate."
       env_name: "PANOS_SKIP_VERIFY_CERTIFICATE"

cmd/codegen/main.go

@@ -71,4 +71,6 @@ func main() {
 		// Execute Terraform
 		runCommand(ctx, properties.CommandTypeTerraform, cfg.ConfigFile)
 	}
+
+	log.Println("Generation complete.")
 }

go.mod

@@ -2,6 +2,7 @@ module github.com/paloaltonetworks/pan-os-codegen
 
 require (
 	github.com/stretchr/testify v1.9.0
+	golang.org/x/text v0.16.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 

go.sum

@@ -4,6 +4,8 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4=
+golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

pkg/commands/codegen/codegen.go

@@ -10,6 +10,13 @@ import (
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 )
 
+type CommandType string
+
+const (
+	CommandTypeSDK       CommandType = "sdk"
+	CommandTypeTerraform CommandType = "terraform"
+)
+
 type Command struct {
 	ctx          context.Context
 	args         []string
@@ -42,7 +49,7 @@ func (c *Command) Setup() error {
 	if c.specs == nil {
 		c.specs, err = properties.GetNormalizations()
 		if err != nil {
-			return fmt.Errorf("error getting normalizations: %w", err)
+			return fmt.Errorf("error getting normalizations: %s", err)
 		}
 	}
 	return nil
@@ -58,12 +65,12 @@ func (c *Command) Execute() error {
 
 	content, err := load.File(configPath)
 	if err != nil {
-		return fmt.Errorf("error loading %s: %w", configPath, err)
+		return fmt.Errorf("error loading %s - %s", configPath, err)
 	}
 
 	config, err := properties.ParseConfig(content)
 	if err != nil {
-		return fmt.Errorf("error parsing %s: %w", configPath, err)
+		return fmt.Errorf("error parsing %s - %s", configPath, err)
 	}
 	var resourceList []string
 	var dataSourceList []string
@@ -72,16 +79,16 @@ func (c *Command) Execute() error {
 		log.Printf("Parsing %s...\n", specPath)
 		content, err := load.File(specPath)
 		if err != nil {
-			return fmt.Errorf("error loading %s: %w", specPath, err)
+			return fmt.Errorf("error loading %s - %s", specPath, err)
 		}
 
 		spec, err := properties.ParseSpec(content)
 		if err != nil {
-			return fmt.Errorf("error parsing %s: %w", specPath, err)
+			return fmt.Errorf("error parsing %s - %s", specPath, err)
 		}
 
 		if err = spec.Sanity(); err != nil {
-			return fmt.Errorf("%s sanity failed: %w", specPath, err)
+			return fmt.Errorf("%s sanity failed: %s", specPath, err)
 		}
 
 		if c.commandType == properties.CommandTypeTerraform {
@@ -90,7 +97,7 @@ func (c *Command) Execute() error {
 			terraformGenerator := generate.NewCreator(config.Output.TerraformProvider, c.templatePath, spec)
 			err = terraformGenerator.RenderTerraformProviderFile(newProviderObject, spec)
 			if err != nil {
-				return fmt.Errorf("error generating Terraform provider: %w", err)
+				return fmt.Errorf("error rendering Terraform provider file for %s - %s", specPath, err)
 			}
 
 			resourceList = append(resourceList, newProviderObject.Resources...)
@@ -99,7 +106,7 @@ func (c *Command) Execute() error {
 		} else if c.commandType == properties.CommandTypeSDK {
 			generator := generate.NewCreator(config.Output.GoSdk, c.templatePath, spec)
 			if err = generator.RenderTemplate(); err != nil {
-				return fmt.Errorf("error rendering %s: %w", specPath, err)
+				return fmt.Errorf("error rendering %s - %s", specPath, err)
 			}
 		}
 
@@ -116,16 +123,13 @@ func (c *Command) Execute() error {
 		terraformGenerator := generate.NewCreator(config.Output.TerraformProvider, c.templatePath, providerSpec)
 		err = terraformGenerator.RenderTerraformProvider(newProviderObject, providerSpec, config.TerraformProviderConfig)
 		if err != nil {
-			return err
+			return fmt.Errorf("error generating terraform code: %w", err)
 		}
+		log.Printf("Generated Terraform resources: %s\n Generated dataSources: %s", resourceList, dataSourceList)
 	}
 
 	if err = generate.CopyAssets(config, c.commandType); err != nil {
 		return fmt.Errorf("error copying assets %w", err)
 	}
-
-	log.Println("Generation complete.")
-
-	log.Printf("Generated resources: %s\n Generated dataSources: %s", resourceList, dataSourceList)
 	return nil
 }

pkg/generate/generator.go

@@ -3,6 +3,7 @@ package generate
 import (
 	"bytes"
 	"fmt"
+	"go/format"
 	"io"
 	"log"
 	"os"
@@ -22,7 +23,7 @@ type Creator struct {
 	Spec         *properties.Normalization
 }
 
-// NewCreator initialize Creator instance.
+// NewCreator initializes a Creator instance.
 func NewCreator(goOutputDir, templatesDir string, spec *properties.Normalization) *Creator {
 	return &Creator{
 		GoOutputDir:  goOutputDir,
@@ -31,7 +32,7 @@ func NewCreator(goOutputDir, templatesDir string, spec *properties.Normalization
 	}
 }
 
-// RenderTemplate loop through all templates, parse them and render content, which is saved to output file.
+// RenderTemplate loops through all templates, parses them, and renders content, which is saved to the output file.
 func (c *Creator) RenderTemplate() error {
 	log.Println("Start rendering templates")
 
@@ -48,28 +49,14 @@ func (c *Creator) RenderTemplate() error {
 			return fmt.Errorf("error creating directories for %s: %w", filePath, err)
 		}
 
-		tmpl, err := c.parseTemplate(templateName)
-		if err != nil {
-			return fmt.Errorf("error parsing template %s: %w", templateName, err)
-		}
-
-		var data bytes.Buffer
-		if err := tmpl.Execute(&data, c.Spec); err != nil {
-			return fmt.Errorf("error executing template %s: %w", templateName, err)
-		}
-		// If from template no data was rendered (e.g. for DNS spec entry should not be created),
-		// then we don't need to create empty file (e.g. `entry.go`) with no content
-		if data.Len() > 0 {
-			if err := c.createAndWriteFile(filePath, &data); err != nil {
-				return fmt.Errorf("error creating and writing to file %s: %w", filePath, err)
-			}
+		if err := c.processTemplate(templateName, filePath); err != nil {
+			return err
 		}
 	}
 	return nil
 }
 
 // RenderTerraformProviderFile generates a Go file for a Terraform provider based on the provided TerraformProviderFile and Normalization arguments.
-// It calls terraform.GenerateTerraformResource() passing the Normalization specification and the TerraformProviderFile.
 func (c *Creator) RenderTerraformProviderFile(terraformProvider *properties.TerraformProviderFile, spec *properties.Normalization) error {
 	tfp := terraform_provider.GenerateTerraformProvider{}
 
@@ -81,42 +68,72 @@ func (c *Creator) RenderTerraformProviderFile(terraformProvider *properties.Terr
 		return err
 	}
 
-	if err := tfp.GenerateTerraformProviderFile(spec, terraformProvider); err != nil {
+	if err := tfp.GenerateCommonCode(spec, terraformProvider); err != nil {
 		return err
 	}
-	filePath := c.createTerraformProviderFilePath(spec.TerraformProviderConfig.Suffix)
 
-	content := bytes.NewBufferString(terraformProvider.Code.String())
-	if err := c.createFileAndWriteContent(filePath, content); err != nil {
+	if err := tfp.GenerateTerraformProviderFile(spec, terraformProvider); err != nil {
 		return err
 	}
+	filePath := c.createTerraformProviderFilePath(spec.TerraformProviderConfig.Suffix)
 
-	return nil
+	return c.writeFormattedContentToFile(filePath, terraformProvider.Code.String())
 }
 
+// RenderTerraformProvider generates and writes a Terraform provider file.
 func (c *Creator) RenderTerraformProvider(terraformProvider *properties.TerraformProviderFile, spec *properties.Normalization, providerConfig properties.TerraformProvider) error {
 	tfp := terraform_provider.GenerateTerraformProvider{}
 	if err := tfp.GenerateTerraformProvider(terraformProvider, spec, providerConfig); err != nil {
 		return err
 	}
 	filePath := c.createTerraformProviderFilePath(spec.Name)
 
-	content := bytes.NewBufferString(terraformProvider.Code.String())
-	if err := c.createFileAndWriteContent(filePath, content); err != nil {
-		return err
+	return c.writeFormattedContentToFile(filePath, terraformProvider.Code.String())
+}
+
+// processTemplate processes a single template and writes the rendered content to a file.
+func (c *Creator) processTemplate(templateName, filePath string) error {
+	tmpl, err := c.parseTemplate(templateName)
+	if err != nil {
+		return fmt.Errorf("error parsing template %s: %w", templateName, err)
+	}
+
+	var data bytes.Buffer
+	if err := tmpl.Execute(&data, c.Spec); err != nil {
+		return fmt.Errorf("error executing template %s: %w", templateName, err)
+	}
+
+	// If no data was rendered from the template, skip creating an empty file.
+	dataLength := len(bytes.TrimSpace(data.Bytes()))
+	if dataLength > 0 {
+		formattedCode, err := format.Source(data.Bytes())
+		if err != nil {
+			return fmt.Errorf("error formatting code %w", err)
+		}
+		formattedBuf := bytes.NewBuffer(formattedCode)
+
+		if err := c.createAndWriteFile(filePath, formattedBuf); err != nil {
+			return fmt.Errorf("error creating and writing to file %s: %w", filePath, err)
+		}
 	}
 	return nil
 }
 
-// createTerraformProviderFilePath returns a file path for a Terraform provider based on the provided suffix.
-func (c *Creator) createTerraformProviderFilePath(terraformProviderFileName string) string {
-	terraformProviderFileNameSuffix := "_object"
-
-	if terraformProviderFileName == "provider" {
-		terraformProviderFileNameSuffix = ""
+// writeFormattedContentToFile formats the content and writes it to a file.
+func (c *Creator) writeFormattedContentToFile(filePath, content string) error {
+	formattedCode, err := format.Source([]byte(content))
+	if err != nil {
+		log.Printf("provided content: %s", content)
+		return fmt.Errorf("error formatting code: %w", err)
 	}
+	formattedBuf := bytes.NewBuffer(formattedCode)
 
-	fileName := fmt.Sprintf("%s%s.go", terraformProviderFileName, terraformProviderFileNameSuffix)
+	return c.createFileAndWriteContent(filePath, formattedBuf)
+}
+
+// createTerraformProviderFilePath returns a file path for a Terraform provider based on the provided suffix.
+func (c *Creator) createTerraformProviderFilePath(terraformProviderFileName string) string {
+	fileName := fmt.Sprintf("%s.go", terraformProviderFileName)
 	return filepath.Join(c.GoOutputDir, "internal/provider", fileName)
 }
 
@@ -138,18 +155,20 @@ func (c *Creator) createAndWriteFile(filePath string, content *bytes.Buffer) err
 	if err != nil {
 		return err
 	}
-	defer outputFile.Close()
+	defer func(outputFile *os.File) {
+		_ = outputFile.Close()
+	}(outputFile)
 
 	return writeContentToFile(content, outputFile)
 }
 
-// createFullFilePath returns a full path for output file generated from template passed as argument to function.
+// createFullFilePath returns a full path for the output file generated from the template passed as an argument.
 func (c *Creator) createFullFilePath(templateName string) string {
 	fileBaseName := strings.TrimSuffix(templateName, filepath.Ext(templateName))
 	return filepath.Join(c.GoOutputDir, filepath.Join(c.Spec.GoSdkPath...), fmt.Sprintf("%s.go", fileBaseName))
 }
 
-// listOfTemplates return list of templates defined in TemplatesDir.
+// listOfTemplates returns a list of templates defined in TemplatesDir.
 func (c *Creator) listOfTemplates() ([]string, error) {
 	var files []string
 	err := filepath.WalkDir(c.TemplatesDir, func(path string, entry os.DirEntry, err error) error {
@@ -170,13 +189,13 @@ func (c *Creator) listOfTemplates() ([]string, error) {
 	return files, nil
 }
 
-// makeAllDirs creates all required directories, which are in the file path.
+// makeAllDirs creates all required directories in the file path.
 func (c *Creator) makeAllDirs(filePath string) error {
 	dirPath := filepath.Dir(filePath)
 	return os.MkdirAll(dirPath, os.ModePerm)
 }
 
-// createFile just create a file and return it.
+// createFile creates a file and returns it.
 func (c *Creator) createFile(filePath string) (*os.File, error) {
 	outputFile, err := os.Create(filePath)
 	if err != nil {
@@ -193,7 +212,7 @@ func writeContentToFile(content *bytes.Buffer, file *os.File) error {
 	return nil
 }
 
-// parseTemplate parse template passed as argument and with function map defined below.
+// parseTemplate parses the template passed as an argument with the function map defined below.
 func (c *Creator) parseTemplate(templateName string) (*template.Template, error) {
 	templatePath := filepath.Join(c.TemplatesDir, templateName)
 	funcMap := template.FuncMap{