From ded382270735418b075415a56ba99f0f1ac2294f Mon Sep 17 00:00:00 2001 From: Dan Jaglowski Date: Fri, 13 Dec 2024 09:43:42 -0500 Subject: [PATCH] [pkg/ottl] Add support for non-element nodes in GetXML --- .chloggen/get-xml-nonelements.yaml | 27 +++++++++++++++++++++++++ pkg/ottl/ottlfuncs/README.md | 12 +++++++++++ pkg/ottl/ottlfuncs/func_get_xml.go | 12 +++++++++-- pkg/ottl/ottlfuncs/func_get_xml_test.go | 14 ++++++------- 4 files changed, 56 insertions(+), 9 deletions(-) create mode 100644 .chloggen/get-xml-nonelements.yaml diff --git a/.chloggen/get-xml-nonelements.yaml b/.chloggen/get-xml-nonelements.yaml new file mode 100644 index 000000000000..aff6e9c9aab3 --- /dev/null +++ b/.chloggen/get-xml-nonelements.yaml @@ -0,0 +1,27 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: 'enhancement' + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: pkg/ottl + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: GetXML Converter now supports selecting text, CDATA, and attribute (value) content. + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [36821] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: + +# If your change doesn't affect end users or the exported elements of any package, +# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. +# Optional: The change log or logs in which this entry should be included. +# e.g. '[user]' or '[user, api]' +# Include 'user' if the change is relevant to end users. +# Include 'api' if there is a change to a library API. +# Default: '[user]' +change_logs: [] diff --git a/pkg/ottl/ottlfuncs/README.md b/pkg/ottl/ottlfuncs/README.md index 890ceef7d6fe..8a4aec76ca5b 100644 --- a/pkg/ottl/ottlfuncs/README.md +++ b/pkg/ottl/ottlfuncs/README.md @@ -835,6 +835,18 @@ Get all elements in the document with tag "a" that have an attribute "b" with va - `GetXML(body, "//a[@b='c']")` +Get `foo` from `foo` + +- `GetXML(body, "/a/text()")` + +Get `hello` from `` + +- `GetXML(body, "/a/text()")` + +Get `bar` from `` + +- `GetXML(body, "/a/@foo")` + ### Hex `Hex(value)` diff --git a/pkg/ottl/ottlfuncs/func_get_xml.go b/pkg/ottl/ottlfuncs/func_get_xml.go index d5390b62da63..970d4c63d1c5 100644 --- a/pkg/ottl/ottlfuncs/func_get_xml.go +++ b/pkg/ottl/ottlfuncs/func_get_xml.go @@ -52,10 +52,18 @@ func getXML[K any](target ottl.StringGetter[K], xPath string) ottl.ExprFunc[K] { result := &xmlquery.Node{Type: xmlquery.DocumentNode} for _, n := range nodes { - if n.Type != xmlquery.ElementNode { + switch n.Type { + case xmlquery.ElementNode, xmlquery.TextNode, xmlquery.CharDataNode: + xmlquery.AddChild(result, n) + case xmlquery.AttributeNode: + // get the value + xmlquery.AddChild(result, &xmlquery.Node{ + Type: xmlquery.TextNode, + Data: n.InnerText(), + }) + default: continue } - xmlquery.AddChild(result, n) } return result.OutputXML(false), nil } diff --git a/pkg/ottl/ottlfuncs/func_get_xml_test.go b/pkg/ottl/ottlfuncs/func_get_xml_test.go index 26b8bfde5bc9..e9686d3696ad 100644 --- a/pkg/ottl/ottlfuncs/func_get_xml_test.go +++ b/pkg/ottl/ottlfuncs/func_get_xml_test.go @@ -74,22 +74,22 @@ func Test_GetXML(t *testing.T) { want: ``, }, { - name: "ignore attribute selection", + name: "get attribute selection", document: ``, - xPath: "/@foo", - want: ``, + xPath: "/a/@foo", + want: `bar`, }, { - name: "ignore text selection", + name: "get text selection", document: `hello`, xPath: "/a/text()", - want: ``, + want: `hello`, }, { - name: "ignore chardata selection", + name: "get chardata selection", document: ``, xPath: "/a/text()", - want: ``, + want: `hello`, }, } for _, tt := range tests {