Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Use full XPaths for config "set" operations #121

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions assets/pango/xml/utils.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package xml

import "bytes"

func StripEntryElement(data []byte) []byte {
if !bytes.HasPrefix(data, []byte("<entry")) || !bytes.HasSuffix(data, []byte("</entry>")) {
return data
}

var startIdx, endIdx int
startIdx = bytes.Index(data, []byte(">"))
endIdx = len(data) - len("</entry>")

return data[startIdx+1 : endIdx]
}
2 changes: 2 additions & 0 deletions pkg/translate/imports.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,12 @@ func RenderImports(templateTypes ...string) (string, error) {
manager.AddSdkImport("github.com/PaloAltoNetworks/pango/version", "")
case "service":
manager.AddStandardImport("context", "")
manager.AddStandardImport("encoding/xml", "")
manager.AddStandardImport("fmt", "")
manager.AddSdkImport("github.com/PaloAltoNetworks/pango/errors", "")
manager.AddSdkImport("github.com/PaloAltoNetworks/pango/util", "")
manager.AddSdkImport("github.com/PaloAltoNetworks/pango/xmlapi", "")
manager.AddSdkImport("github.com/PaloAltoNetworks/pango/xml", "pangoxml")
case "filtering":
manager.AddSdkImport("github.com/PaloAltoNetworks/pango/filtering", "")
case "audit":
Expand Down
25 changes: 20 additions & 5 deletions templates/sdk/service.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,16 @@ return nil, err

{{- if .Entry}}
path, err := loc.XpathWithEntryName(vn, entry.Name)
if err != nil {
return nil, err
}
{{- else}}
path, err := loc.Xpath(vn)
if err != nil {
return nil, err
}
path = path[:len(path)-1]
{{- end}}
if err != nil {
return nil, err
}

{{- if .Entry}}
createSpec, err := specifier(entry)
Expand All @@ -72,10 +76,21 @@ if err != nil {
return nil, err
}

data, err := xml.Marshal(createSpec)
if err != nil {
return nil, err
}

// Optionally remove top entry element from marshalled data to fullfill
// PAN-OS API requirements.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// PAN-OS API requirements.
// PAN-OS API requirements.
// PAN-OS behaviour change: SET operations in the XML API no longer support partial XPath values.

// PAN-OS behaviour change: SET operations in the XML API no longer support
// partial XPath values.
data = pangoxml.StripEntryElement(data)

cmd := &xmlapi.Config{
Action: "set",
Xpath: util.AsXpath(path[:len(path)-1]),
Element: createSpec,
Xpath: util.AsXpath(path),
Element: string(data),
Target: s.client.GetTarget(),
}

Expand Down
Loading