Rewrite SDK codegen for structures, normalizers and specifiers

Author: kklimonda-cl

assets/pango/example/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"encoding/xml"
 	"fmt"
 	"log"
 
@@ -1038,21 +1037,6 @@ func checkService(c *pango.Client, ctx context.Context) {
 		return
 	}
 
-	readDescription := ""
-	if serviceReply.Description != nil {
-		readDescription = *serviceReply.Description
-	}
-
-	keys := make([]string, 0, len(serviceReply.Misc))
-	xmls := make([]string, 0, len(serviceReply.Misc))
-	for key := range serviceReply.Misc {
-		keys = append(keys, key)
-		data, _ := xml.Marshal(serviceReply.Misc[key])
-		xmls = append(xmls, string(data))
-	}
-	log.Printf("Service '%s=%s, description: %s misc XML: %s, misc keys: %s' read",
-		serviceReply.Name, *serviceReply.Protocol.Tcp.Port, readDescription, xmls, keys)
-
 	// SERVICE - UPDATE 3
 	serviceReply.Description = util.String("some text changed now")
 
@@ -1061,21 +1045,6 @@ func checkService(c *pango.Client, ctx context.Context) {
 		log.Printf("Failed to update object: %s", err)
 		return
 	}
-
-	readDescription = ""
-	if serviceReply.Description != nil {
-		readDescription = *serviceReply.Description
-	}
-
-	keys = make([]string, 0, len(serviceReply.Misc))
-	xmls = make([]string, 0, len(serviceReply.Misc))
-	for key := range serviceReply.Misc {
-		keys = append(keys, key)
-		data, _ := xml.Marshal(serviceReply.Misc[key])
-		xmls = append(xmls, string(data))
-	}
-	log.Printf("Service '%s=%s, description: %s misc XML: %s, misc keys: %s' update",
-		serviceReply.Name, *serviceReply.Protocol.Tcp.Port, readDescription, xmls, keys)
 }
 
 func checkNtp(c *pango.Client, ctx context.Context) {

pkg/generate/generator.go

@@ -256,11 +256,9 @@ func (c *Creator) parseTemplate(templateName string) (*template.Template, error)
 		"packageName":               translate.PackageName,
 		"locationType":              translate.LocationType,
 		"specParamType":             translate.SpecParamType,
-		"xmlParamType":              translate.XmlParamType,
 		"xmlName":                   translate.XmlName,
+		"xmlParamType":              translate.XmlParamType,
 		"xmlTag":                    translate.XmlTag,
-		"specifyEntryAssignment":    translate.SpecifyEntryAssignmentTmpl,
-		"normalizeAssignment":       translate.NormalizeAssignmentTmpl,
 		"specMatchesFunction":       translate.SpecMatchesFunction,
 		"nestedSpecMatchesFunction": translate.NestedSpecMatchesFunction,
 		"omitEmpty":                 translate.OmitEmpty,
@@ -272,10 +270,24 @@ func (c *Creator) parseTemplate(templateName string) (*template.Template, error)
 			return a - b
 		},
 		"generateEntryXpath": translate.GenerateEntryXpath,
-		"nestedSpecs":        translate.NestedSpecs,
-		"RenderEntryXmlStructs": func(spec *properties.Normalization) (string, error) {
+		"RenderApiStructs": func(spec *properties.Normalization) (string, error) {
+			return translate.RenderEntryApiStructs(spec)
+		},
+		"RenderXmlStructs": func(spec *properties.Normalization) (string, error) {
 			return translate.RenderEntryXmlStructs(spec)
 		},
+		"RenderXmlContainerNormalizers": func(spec *properties.Normalization) (string, error) {
+			return translate.RenderXmlContainerNormalizers(spec)
+		},
+		"RenderXmlContainerSpecifiers": func(spec *properties.Normalization) (string, error) {
+			return translate.RenderXmlContainerSpecifiers(spec)
+		},
+		"RenderToXmlMarshallers": func(spec *properties.Normalization) (string, error) {
+			return translate.RenderToXmlMarshalers(spec)
+		},
+		"RenderSpecMatchers": func(spec *properties.Normalization) (string, error) {
+			return translate.RenderSpecMatchers(spec)
+		},
 		"createGoSuffixFromVersion": translate.CreateGoSuffixFromVersionTmpl,
 		"paramSupportedInVersion":   translate.ParamSupportedInVersionTmpl,
 		"xmlPathSuffixes":           translate.XmlPathSuffixes,

pkg/properties/namevariant.go

@@ -0,0 +1,48 @@
+package properties
+
+import (
+	"strings"
+
+	"github.com/paloaltonetworks/pan-os-codegen/pkg/naming"
+)
+
+type NameVariant struct {
+	Original       string
+	Underscore     string
+	CamelCase      string
+	LowerCamelCase string
+}
+
+func NewNameVariant(name string) *NameVariant {
+	return &NameVariant{
+		Original:       name,
+		Underscore:     naming.Underscore("", name, ""),
+		CamelCase:      naming.CamelCase("", name, "", true),
+		LowerCamelCase: naming.CamelCase("", name, "", false),
+	}
+}
+
+func (o NameVariant) Components() []string {
+	return strings.Split(o.Original, "-")
+}
+
+func (o NameVariant) IsEmpty() bool {
+	return o.Original == ""
+}
+
+func (o NameVariant) WithSuffix(suffix *NameVariant) *NameVariant {
+	if o.Original == "" {
+		return NewNameVariant(suffix.Original)
+	} else {
+		return NewNameVariant(o.Original + "-" + suffix.Original)
+	}
+}
+
+func (o NameVariant) WithLiteralSuffix(suffix string) *NameVariant {
+	return &NameVariant{
+		Original:       o.Original + suffix,
+		CamelCase:      o.CamelCase + suffix,
+		LowerCamelCase: o.LowerCamelCase + suffix,
+		Underscore:     o.Underscore + suffix,
+	}
+}

pkg/properties/namevariant_test.go

@@ -0,0 +1,22 @@
+package properties_test
+
+import (
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
+)
+
+var _ = Describe("NameVariant", func() {
+	Context("When creating name variant from empty string", func() {
+		It("should return empty string for all variants", func() {
+			variant := properties.NewNameVariant("")
+			Expect(variant).To(Equal(&properties.NameVariant{
+				Original:       "",
+				LowerCamelCase: "",
+				CamelCase:      "",
+				Underscore:     "",
+			}))
+		})
+	})
+})

pkg/properties/normalized.go

@@ -11,7 +11,6 @@ import (
 	"strings"
 
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/content"
-	"github.com/paloaltonetworks/pan-os-codegen/pkg/naming"
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/schema/object"
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/schema/parameter"
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/schema/validator"
@@ -85,26 +84,6 @@ type TerraformProviderConfig struct {
 	PluralDescription     string                     `json:"plural_description" yaml:"plural_description"`
 }
 
-type NameVariant struct {
-	Original       string
-	Underscore     string
-	CamelCase      string
-	LowerCamelCase string
-}
-
-func NewNameVariant(name string) *NameVariant {
-	return &NameVariant{
-		Original:       name,
-		Underscore:     naming.Underscore("", name, ""),
-		CamelCase:      naming.CamelCase("", name, "", true),
-		LowerCamelCase: naming.CamelCase("", name, "", false),
-	}
-}
-
-func (o *NameVariant) Components() []string {
-	return strings.Split(o.Original, "-")
-}
-
 type Location struct {
 	Name        *NameVariant
 	SpecOrder   int

pkg/properties/properties_suite_test.go

@@ -0,0 +1,18 @@
+package properties_test
+
+import (
+	"log/slog"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestMovement(t *testing.T) {
+	handler := slog.NewTextHandler(GinkgoWriter, &slog.HandlerOptions{
+		Level: slog.LevelDebug,
+	})
+	slog.SetDefault(slog.New(handler))
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Properties Suite")
+}