feat: Replace hand-written specs with autogenerated specs

assets/terraform/test/resource_ethernet_interface_test.go

@@ -105,7 +105,7 @@ func makePanosEthernetInterface_Layer3(label string) string {
             {
               advertise = {
                 enable         = true
-                valid_lifetime = "10000"
+                valid_lifetime = "1000000"
               },
               name                = "::1",
               enable_on_interface = true

assets/terraform/test/resource_nat_policy_test.go

@@ -252,6 +252,7 @@ resource "panos_nat_policy" "{{ .ResourceName }}" {
   rules = [
     for index, name in var.rule_names: {
       name = name
+
       source_zones = ["any"]
       source_addresses = ["any"]
       destination_zone = ["external"]

assets/terraform/test/resource_virtual_router_test.go

@@ -153,7 +153,7 @@ func makePanosVirtualRouterConfig(label string) string {
             {
               advertise = {
                 enable         = true
-                valid_lifetime = "10000"
+                valid_lifetime = "1000000"
               },
               name                = "::1",
               enable_on_interface = true

pkg/commands/codegen/codegen.go

@@ -123,7 +123,7 @@ func (c *Command) Execute() error {
 				case properties.TerraformResourceCustom:
 					resourceTyp = properties.ResourceCustom
 				case properties.TerraformResourceConfig:
-					panic("missing implementation for config type resources")
+					resourceTyp = properties.ResourceConfig
 				}
 
 				terraformGenerator := generate.NewCreator(config.Output.TerraformProvider, c.templatePath, spec)

pkg/generate/generator.go

@@ -2,6 +2,7 @@
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"go/format"
 	"io"
@@ -59,7 +60,7 @@
 // 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) ([]string, []string, map[string]properties.TerraformProviderSpecMetadata, error) {
 	var name string
 	switch typ {
 	case properties.ResourceUuidPlural:
 		name = fmt.Sprintf("%s_%s", spec.TerraformProviderConfig.Suffix, spec.TerraformProviderConfig.PluralName)
 	case properties.ResourceEntryPlural:
@@ -95,7 +96,7 @@
 	case properties.ResourceEntryPlural:
 		name = spec.TerraformProviderConfig.PluralSuffix
 		filePath = c.createTerraformProviderFilePath(name)
-	case properties.ResourceEntry, properties.ResourceUuid, properties.ResourceCustom:
+	case properties.ResourceEntry, properties.ResourceUuid, properties.ResourceCustom, properties.ResourceConfig:
 		filePath = c.createTerraformProviderFilePath(spec.TerraformProviderConfig.Suffix)
 	}
 
@@ -140,8 +141,9 @@
 		}
 		formattedBuf := bytes.NewBuffer(formattedCode)
 
-		if writeErr := c.createAndWriteFile(filePath, formattedBuf); writeErr != nil {
-			return fmt.Errorf("error creating and writing to file %s: %w", filePath, err)
+		writeErr := c.createAndWriteFile(filePath, formattedBuf)
+		if writeErr != nil {
+			return errors.Join(err, writeErr)
 		}
 	}
 	return err
@@ -151,8 +153,8 @@
 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)
+		log.Printf("failed to format provided content: %s", filePath)
+		formattedCode = []byte(content)
 	}
 	formattedBuf := bytes.NewBuffer(formattedCode)
 

pkg/properties/normalized.go

@@ -3,6 +3,7 @@ package properties
 import (
 	"fmt"
 	"io/fs"
+	"log"
 	"path/filepath"
 	"runtime"
 	"strings"
@@ -174,11 +175,13 @@ type SpecParam struct {
 }
 
 type SpecParamTerraformProviderConfig struct {
-	Name      string `json:"name" yaml:"name"`
-	Type      string `json:"type" yaml:"type"`
-	Private   bool   `json:"ignored" yaml:"private"`
-	Sensitive bool   `json:"sensitive" yaml:"sensitive"`
-	Computed  bool   `json:"computed" yaml:"computed"`
+	Name         string `json:"name" yaml:"name"`
+	Type         string `json:"type" yaml:"type"`
+	Private      bool   `json:"ignored" yaml:"private"`
+	Sensitive    bool   `json:"sensitive" yaml:"sensitive"`
+	Computed     bool   `json:"computed" yaml:"computed"`
+	Required     *bool  `json:"required" yaml:"required"`
+	VariantCheck string `json:"variant_check" yaml:"variant_check"`
 }
 
 type SpecParamLength struct {
@@ -221,6 +224,14 @@ func (o *SpecParam) NameVariant() *NameVariant {
 	return o.Name
 }
 
+func (o *SpecParam) FinalRequired() bool {
+	if o.TerraformProviderConfig != nil && o.TerraformProviderConfig.Required != nil {
+		return *o.TerraformProviderConfig.Required
+	}
+
+	return o.Required
+}
+
 func hasChildEncryptedResources(param *SpecParam) bool {
 	if param.Hashing != nil {
 		return true
@@ -404,6 +415,8 @@ func schemaParameterToSpecParameter(schemaSpec *parameter.Parameter) (*SpecParam
 			if err != nil {
 				return nil, err
 			}
+		} else if spec.Items.Type == "enum" {
+			itemsSpec.Type = "string"
 		} else {
 			itemsSpec.Type = spec.Items.Type
 		}
@@ -459,12 +472,15 @@ func schemaParameterToSpecParameter(schemaSpec *parameter.Parameter) (*SpecParam
 	if schemaSpec.CodegenOverrides != nil {
 		sensitive = schemaSpec.CodegenOverrides.Terraform.Sensitive
 		terraformProviderConfig = &SpecParamTerraformProviderConfig{
-			Name:      schemaSpec.CodegenOverrides.Terraform.Name,
-			Type:      schemaSpec.CodegenOverrides.Terraform.Type,
-			Private:   schemaSpec.CodegenOverrides.Terraform.Private,
-			Sensitive: schemaSpec.CodegenOverrides.Terraform.Sensitive,
-			Computed:  schemaSpec.CodegenOverrides.Terraform.Computed,
+			Name:         schemaSpec.CodegenOverrides.Terraform.Name,
+			Type:         schemaSpec.CodegenOverrides.Terraform.Type,
+			Private:      schemaSpec.CodegenOverrides.Terraform.Private,
+			Sensitive:    schemaSpec.CodegenOverrides.Terraform.Sensitive,
+			Computed:     schemaSpec.CodegenOverrides.Terraform.Computed,
+			Required:     schemaSpec.CodegenOverrides.Terraform.Required,
+			VariantCheck: string(schemaSpec.CodegenOverrides.Terraform.VariantCheck),
 		}
+		log.Printf("terraformProviderConfig: %s VariantCheck: '%s'\n", schemaSpec.Name, terraformProviderConfig.VariantCheck)
 	}
 	specParameter := &SpecParam{
 		Description:             schemaSpec.Description,

pkg/properties/normalized_test.go

@@ -20,7 +20,7 @@ func TestUnmarshallAddressSpecFile(t *testing.T) {
 
 	// then
 	assert.NotNilf(t, yamlParsedData, "Unmarshalled data cannot be nil")
-	assert.Equal(t, "Address", yamlParsedData.Name, "Unmarshalled data should contain `name`")
+	assert.Equal(t, "address", yamlParsedData.Name, "Unmarshalled data should contain `name`")
 	assert.NotNilf(t, yamlParsedData.TerraformProviderConfig.Suffix, "Unmarshalled data should contain `suffix`")
 	assert.NotNilf(t, yamlParsedData.GoSdkPath, "Unmarshalled data should contain `go_sdk_path`")
 	assert.NotNilf(t, yamlParsedData.XpathSuffix, "Unmarshalled data should contain `xpath_suffix`")

pkg/properties/provider_file.go

@@ -38,7 +38,7 @@ type TerraformNameProvider struct {
 func NewTerraformNameProvider(spec *Normalization, resourceTyp ResourceType) *TerraformNameProvider {
 	var tfName string
 	switch resourceTyp {
-	case ResourceEntry, ResourceCustom:
+	case ResourceEntry, ResourceCustom, ResourceConfig:
 		tfName = spec.TerraformProviderConfig.Suffix
 	case ResourceEntryPlural:
 		tfName = spec.TerraformProviderConfig.PluralSuffix

pkg/properties/resourcetype.go

@@ -3,11 +3,12 @@ package properties
 type ResourceType int
 
 const (
-	ResourceEntry       ResourceType = iota
-	ResourceCustom      ResourceType = iota
-	ResourceEntryPlural ResourceType = iota
-	ResourceUuid        ResourceType = iota
-	ResourceUuidPlural  ResourceType = iota
+	ResourceEntry ResourceType = iota
+	ResourceCustom
+	ResourceConfig
+	ResourceEntryPlural
+	ResourceUuid
+	ResourceUuidPlural
 )
 
 type SchemaType int

pkg/schema/parameter/parameter.go

@@ -42,12 +42,21 @@ type EnumSpecValue struct {
 	Const string `yaml:"const"`
 }
 
+type VariantCheckType string
+
+const (
+	VariantCheckConflictsWith VariantCheckType = "ConflictsWith"
+	VariantCheckExactlyOneOf  VariantCheckType = "ExactlyOneOf"
+)
+
 type CodegenOverridesTerraform struct {
-	Name      string `yaml:"name"`
-	Type      string `yaml:"type"`
-	Private   bool   `yaml:"private"`
-	Sensitive bool   `yaml:"sensitive"`
-	Computed  bool   `yaml:"computed"`
+	Name         string           `yaml:"name"`
+	Type         string           `yaml:"type"`
+	Private      bool             `yaml:"private"`
+	Sensitive    bool             `yaml:"sensitive"`
+	Computed     bool             `yaml:"computed"`
+	Required     *bool            `yaml:"required"`
+	VariantCheck VariantCheckType `yaml:"variant_check"`
 }
 
 type CodegenOverrides struct {
@@ -133,7 +142,7 @@ func (p *Parameter) UnmarshalYAML(n *yaml.Node) error {
 		p.Spec = new(EnumSpec)
 	case "nil":
 		p.Spec = new(NilSpec)
-	case "string", "bool", "int64":
+	case "string", "bool", "int64", "float64":
 		p.Spec = new(SimpleSpec)
 	default:
 		return errors.NewSchemaError(fmt.Sprintf("unsupported parameter type: '%s'", p.Type))

pkg/translate/assignments.go

@@ -133,24 +133,27 @@ func defineNestedObject(parent []*properties.SpecParam, param, parentParam *prop
 	}
 }
 
-func startIfBlockForParamNotNil(parent []*properties.SpecParam, param *properties.SpecParam, parentParam *properties.SpecParam, builder *strings.Builder) {
-	if len(parent) == 2 && parent[0].Type == "list" && parent[0].Items.Type == "entry" {
+func startIfBlockForParamNotNil(parents []*properties.SpecParam, param *properties.SpecParam, parentParam *properties.SpecParam, builder *strings.Builder) {
+	grandparent := parents[0]
+
+	if grandparent != param && grandparent.Type == "list" && grandparent.Items.Type == "entry" {
 		if isParamName(param) {
 			builder.WriteString(fmt.Sprintf("if o%s != \"\" {\n",
-				renderNestedVariableName(parent, true, true, false)))
+				renderNestedVariableName(parents, true, true, false)))
 		} else {
 			builder.WriteString(fmt.Sprintf("if o%s != nil {\n",
-				renderNestedVariableName(parent, true, true, false)))
+				renderNestedVariableName(parents, true, true, false)))
 		}
 	} else {
 		if isParamName(param) {
 			builder.WriteString(fmt.Sprintf("if o%s != \"\" {\n",
-				renderNestedVariableName(parent, true, true, true)))
+				renderNestedVariableName(parents, true, true, true)))
 		} else {
 			builder.WriteString(fmt.Sprintf("if o%s != nil {\n",
-				renderNestedVariableName(parent, true, true, true)))
+				renderNestedVariableName(parents, true, true, true)))
 		}
 	}
+
 }
 
 func finishNestedObjectIfBlock(parent []*properties.SpecParam, param *properties.SpecParam, builder *strings.Builder) {
@@ -193,8 +196,8 @@ func declareRootOfNestedObject(parent []*properties.SpecParam, builder *strings.
 
 func assignEmptyStructForNestedObject(parent []*properties.SpecParam, builder *strings.Builder, param *properties.SpecParam, objectType, version, prefix, suffix string) {
 	if isParamListAndProfileTypeIsExtendedEntry(param) {
-		createListAndLoopForNestedEntry(parent, builder, prefix, suffix, version)
-		miscForUnknownXmlWithExtendedEntry(parent, builder, suffix)
+		createListAndLoopForNestedEntry(parent, param, builder, prefix, suffix, version)
+		miscForUnknownXmlWithExtendedEntry(parent, objectType, builder, suffix)
 	} else {
 		createStructForParamWithSpec(parent, builder, prefix, suffix, version)
 		miscForUnknownXmlWithSpec(parent, builder, suffix, objectType)
@@ -209,7 +212,7 @@ func createStructForParamWithSpec(parent []*properties.SpecParam, builder *strin
 		CreateGoSuffixFromVersion(version)))
 }
 
-func createListAndLoopForNestedEntry(parent []*properties.SpecParam, builder *strings.Builder, prefix string, suffix string, version string) {
+func createListAndLoopForNestedEntry(parent []*properties.SpecParam, param *properties.SpecParam, builder *strings.Builder, prefix string, suffix string, version string) {
 	if len(parent) == 1 && parent[0].Type == "list" && parent[0].Items.Type == "entry" {
 		builder.WriteString(fmt.Sprintf("nested%sCol = []%s%s%s%s{}\n",
 			renderNestedVariableName(parent, true, true, false), prefix,
@@ -222,9 +225,14 @@ func createListAndLoopForNestedEntry(parent []*properties.SpecParam, builder *st
 			CreateGoSuffixFromVersion(version)))
 	}
 
-	builder.WriteString(fmt.Sprintf("for _, o%s := range o%s {\n",
+	startFromDot := true
+	if len(parent) == 2 && parent[0].Type == "list" && parent[0].Items.Type == "entry" {
+		startFromDot = false
+	}
+
+	builder.WriteString(fmt.Sprintf("for _, o%s := range o%s { \n",
 		renderNestedVariableName(parent, false, false, false),
-		renderNestedVariableName(parent, true, true, true)))
+		renderNestedVariableName(parent, true, true, startFromDot)))
 	builder.WriteString(fmt.Sprintf("nested%s := %s%s%s%s{}\n",
 		renderNestedVariableName(parent, false, false, false),
 		prefix, renderNestedVariableName(parent, false, false, false), suffix,
@@ -240,16 +248,21 @@ func miscForUnknownXmlWithSpec(parent []*properties.SpecParam, builder *strings.
 			renderNestedVariableName(parent, false, false, false),
 		))
 	} else {
+		startsWithDot := true
+		if parent[0].Type == "list" && parent[0].Items.Type == "entry" {
+			startsWithDot = false
+		}
+
 		builder.WriteString(fmt.Sprintf("if o%s.Misc != nil {\n",
-			renderNestedVariableName(parent, true, true, true)))
+			renderNestedVariableName(parent, true, true, startsWithDot)))
 		builder.WriteString(fmt.Sprintf("%s.Misc[\"%s\"] = o%s.Misc\n",
 			objectType, renderNestedVariableName(parent, false, false, false),
-			renderNestedVariableName(parent, true, true, true),
+			renderNestedVariableName(parent, true, true, startsWithDot),
 		))
 	}
 }
 
-func miscForUnknownXmlWithExtendedEntry(parent []*properties.SpecParam, builder *strings.Builder, suffix string) {
+func miscForUnknownXmlWithExtendedEntry(parent []*properties.SpecParam, objectType string, builder *strings.Builder, suffix string) {
 	if suffix == "Xml" {
 		builder.WriteString(fmt.Sprintf("if _, ok := o.Misc[\"%s\"]; ok {\n",
 			renderNestedVariableName(parent, false, false, false)))
@@ -260,7 +273,8 @@ func miscForUnknownXmlWithExtendedEntry(parent []*properties.SpecParam, builder
 	} else {
 		builder.WriteString(fmt.Sprintf("if o%s.Misc != nil {\n",
 			renderNestedVariableName(parent, false, false, false)))
-		builder.WriteString(fmt.Sprintf("entry.Misc[\"%s\"] = o%s.Misc\n",
+		builder.WriteString(fmt.Sprintf("%s.Misc[\"%s\"] = o%s.Misc\n",
+			objectType,
 			renderNestedVariableName(parent, false, false, false),
 			renderNestedVariableName(parent, false, false, false),
 		))
@@ -270,7 +284,7 @@ func miscForUnknownXmlWithExtendedEntry(parent []*properties.SpecParam, builder
 var _ = log.Printf
 
 func assignValueForNestedObject(parent []*properties.SpecParam, builder *strings.Builder, param, parentParam *properties.SpecParam) {
-	if len(parent) == 2 && parent[0].Type == "list" && parent[0].Items.Type == "entry" {
+	if parent[0] != param && parent[0].Type == "list" && parent[0].Items.Type == "entry" {
 		builder.WriteString(fmt.Sprintf("nested%s = o%s\n",
 			renderNestedVariableName(parent, true, true, false),
 			renderNestedVariableName(parent, true, true, false)))
@@ -282,8 +296,9 @@ func assignValueForNestedObject(parent []*properties.SpecParam, builder *strings
 }
 
 func assignFunctionForNestedObject(parent []*properties.SpecParam, functionName, additionalArguments string, builder *strings.Builder, param, parentParam *properties.SpecParam) {
+
 	var startWithDot bool
-	if len(parent) == 2 && parent[0].Type == "list" && parent[0].Items.Type == "entry" {
+	if parent[0] != param && parent[0].Type == "list" && parent[0].Items.Type == "entry" {
 		startWithDot = false
 	} else {
 		startWithDot = true

pkg/translate/funcs.go

@@ -46,6 +46,8 @@ func specMatchFunctionName(parent []string, param *properties.SpecParam) string
 		return "util.IntsMatch"
 	} else if param.Type == "int64" {
 		return "util.Ints64Match"
+	} else if param.Type == "float64" {
+		return "util.FloatsMatch"
 	} else {
 		return fmt.Sprintf("match%s%s", strings.Join(parent, ""), param.Name.CamelCase)
 	}

pkg/translate/structs.go

@@ -43,6 +43,9 @@ func checkNestedSpecs(parent []string, spec *properties.Spec, nestedSpecs map[st
 	}
 	for _, param := range spec.OneOf {
 		updateNestedSpecs(append(parent, param.Name.CamelCase), param, nestedSpecs)
+		if len(param.Profiles) > 0 && param.Profiles[0].Type == "entry" && param.Items != nil && param.Items.Type == "entry" {
+			addNameAsParamForNestedSpec(append(parent, param.Name.CamelCase), nestedSpecs)
+		}
 	}
 }
 

pkg/translate/structs_test.go

@@ -17,7 +17,7 @@ func TestLocationType(t *testing.T) {
 	// given
 	yamlParsedData, _ := properties.ParseSpec([]byte(sampleSpec))
 
-	locationKeys := []string{"device_group", "shared"}
+	locationKeys := []string{"device-group", "shared"}
 	locations := yamlParsedData.Locations
 	var locationTypes []string
 
@@ -66,7 +66,7 @@ func TestOmitEmpty(t *testing.T) {
 
 	// given
 	yamlParsedData, _ := properties.ParseSpec([]byte(sampleSpec))
-	locationKeys := []string{"device_group", "shared"}
+	locationKeys := []string{"device-group", "shared"}
 	locations := yamlParsedData.Locations
 	var omitEmptyLocations []string