From d663b822f1e9efde93691745cc1ca3aa89fd9b64 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:07:15 -0600 Subject: [PATCH 1/3] Fix issue with named parameter spacing --- pkg/ottl/grammar.go | 12 +++++++----- pkg/ottl/lexer_test.go | 3 ++- pkg/ottl/parser_test.go | 18 ++++++++++++++++++ 3 files changed, 27 insertions(+), 6 deletions(-) diff --git a/pkg/ottl/grammar.go b/pkg/ottl/grammar.go index a5b4577ac05c..d2319f3b8621 100644 --- a/pkg/ottl/grammar.go +++ b/pkg/ottl/grammar.go @@ -6,6 +6,7 @@ package ottl // import "github.com/open-telemetry/opentelemetry-collector-contri import ( "encoding/hex" "fmt" + "strings" "github.com/alecthomas/participle/v2/lexer" ) @@ -143,8 +144,9 @@ var compareOpTable = map[string]compareOp{ // Capture is how the parser converts an operator string to a compareOp. func (c *compareOp) Capture(values []string) error { - op, ok := compareOpTable[values[0]] + op, ok := compareOpTable[strings.Join(values, "")] if !ok { + return fmt.Errorf("'%s' is not a valid operator", values[0]) } *c = op @@ -174,7 +176,7 @@ func (c *compareOp) String() string { // comparison represents an optional boolean condition. type comparison struct { Left value `parser:"@@"` - Op compareOp `parser:"@OpComparison"` + Op compareOp `parser:"@(OpComparison | Equal Equal)"` Right value `parser:"@@"` } @@ -218,7 +220,7 @@ type converter struct { } type argument struct { - Name string `parser:"(@(Lowercase(Uppercase | Lowercase)*) Equal)?"` + Name string `parser:"(@(Lowercase(Uppercase | Lowercase)*) Equal (?! Equal))?"` Value value `parser:"@@"` } @@ -434,11 +436,11 @@ func buildLexer() *lexer.StatefulDefinition { {Name: `Float`, Pattern: `[-+]?\d*\.\d+([eE][-+]?\d+)?`}, {Name: `Int`, Pattern: `[-+]?\d+`}, {Name: `String`, Pattern: `"(\\"|[^"])*"`}, - {Name: `Equal`, Pattern: `=[^=]`}, + {Name: `Equal`, Pattern: `=`}, {Name: `OpNot`, Pattern: `\b(not)\b`}, {Name: `OpOr`, Pattern: `\b(or)\b`}, {Name: `OpAnd`, Pattern: `\b(and)\b`}, - {Name: `OpComparison`, Pattern: `==|!=|>=|<=|>|<`}, + {Name: `OpComparison`, Pattern: `!=|>=|<=|>|<`}, {Name: `OpAddSub`, Pattern: `\+|\-`}, {Name: `OpMultDiv`, Pattern: `\/|\*`}, {Name: `Boolean`, Pattern: `\b(true|false)\b`}, diff --git a/pkg/ottl/lexer_test.go b/pkg/ottl/lexer_test.go index c1e32b5c7f25..842e2fa53f71 100644 --- a/pkg/ottl/lexer_test.go +++ b/pkg/ottl/lexer_test.go @@ -38,7 +38,8 @@ func Test_lexer(t *testing.T) { }}, {"basic_equality", "3==4.9", false, []result{ {"Int", "3"}, - {"OpComparison", "=="}, + {"Equal", "="}, + {"Equal", "="}, {"Float", "4.9"}, }}, {"basic_inequality", "3!=4.9", false, []result{ diff --git a/pkg/ottl/parser_test.go b/pkg/ottl/parser_test.go index fd8038b6131e..470957cb2c74 100644 --- a/pkg/ottl/parser_test.go +++ b/pkg/ottl/parser_test.go @@ -1059,6 +1059,24 @@ func Test_parse(t *testing.T) { }, }, }, + { + name: "editor with named arg", + statement: `set(name="foo")`, + expected: &parsedStatement{ + Editor: editor{ + Function: "set", + Arguments: []argument{ + { + Name: "name", + Value: value{ + String: ottltest.Strp("foo"), + }, + }, + }, + }, + WhereClause: nil, + }, + }, } for _, tt := range tests { From 570390a71b7725c4601ec46f166266bb41806b37 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:10:24 -0600 Subject: [PATCH 2/3] add changelog --- .chloggen/ottl-fix-named-param-spacing.yaml | 27 +++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100755 .chloggen/ottl-fix-named-param-spacing.yaml diff --git a/.chloggen/ottl-fix-named-param-spacing.yaml b/.chloggen/ottl-fix-named-param-spacing.yaml new file mode 100755 index 000000000000..fdb35908459c --- /dev/null +++ b/.chloggen/ottl-fix-named-param-spacing.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: bug_fix + +# 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: Fix bug where named parameters needed a space after the equal sign (`=`). + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [28511] + +# (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: [] From 11910fbb4d2cc7487b992627187d6fbee4b31606 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:38:33 -0600 Subject: [PATCH 3/3] Fix solution to not allow "= =" --- pkg/ottl/grammar.go | 12 +++++------- pkg/ottl/lexer_test.go | 3 +-- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/pkg/ottl/grammar.go b/pkg/ottl/grammar.go index d2319f3b8621..e8381292cc13 100644 --- a/pkg/ottl/grammar.go +++ b/pkg/ottl/grammar.go @@ -6,7 +6,6 @@ package ottl // import "github.com/open-telemetry/opentelemetry-collector-contri import ( "encoding/hex" "fmt" - "strings" "github.com/alecthomas/participle/v2/lexer" ) @@ -144,9 +143,8 @@ var compareOpTable = map[string]compareOp{ // Capture is how the parser converts an operator string to a compareOp. func (c *compareOp) Capture(values []string) error { - op, ok := compareOpTable[strings.Join(values, "")] + op, ok := compareOpTable[values[0]] if !ok { - return fmt.Errorf("'%s' is not a valid operator", values[0]) } *c = op @@ -176,7 +174,7 @@ func (c *compareOp) String() string { // comparison represents an optional boolean condition. type comparison struct { Left value `parser:"@@"` - Op compareOp `parser:"@(OpComparison | Equal Equal)"` + Op compareOp `parser:"@OpComparison"` Right value `parser:"@@"` } @@ -220,7 +218,7 @@ type converter struct { } type argument struct { - Name string `parser:"(@(Lowercase(Uppercase | Lowercase)*) Equal (?! Equal))?"` + Name string `parser:"(@(Lowercase(Uppercase | Lowercase)*) Equal)?"` Value value `parser:"@@"` } @@ -436,14 +434,14 @@ func buildLexer() *lexer.StatefulDefinition { {Name: `Float`, Pattern: `[-+]?\d*\.\d+([eE][-+]?\d+)?`}, {Name: `Int`, Pattern: `[-+]?\d+`}, {Name: `String`, Pattern: `"(\\"|[^"])*"`}, - {Name: `Equal`, Pattern: `=`}, {Name: `OpNot`, Pattern: `\b(not)\b`}, {Name: `OpOr`, Pattern: `\b(or)\b`}, {Name: `OpAnd`, Pattern: `\b(and)\b`}, - {Name: `OpComparison`, Pattern: `!=|>=|<=|>|<`}, + {Name: `OpComparison`, Pattern: `==|!=|>=|<=|>|<`}, {Name: `OpAddSub`, Pattern: `\+|\-`}, {Name: `OpMultDiv`, Pattern: `\/|\*`}, {Name: `Boolean`, Pattern: `\b(true|false)\b`}, + {Name: `Equal`, Pattern: `=`}, {Name: `LParen`, Pattern: `\(`}, {Name: `RParen`, Pattern: `\)`}, {Name: `Punct`, Pattern: `[,.\[\]]`}, diff --git a/pkg/ottl/lexer_test.go b/pkg/ottl/lexer_test.go index 842e2fa53f71..c1e32b5c7f25 100644 --- a/pkg/ottl/lexer_test.go +++ b/pkg/ottl/lexer_test.go @@ -38,8 +38,7 @@ func Test_lexer(t *testing.T) { }}, {"basic_equality", "3==4.9", false, []result{ {"Int", "3"}, - {"Equal", "="}, - {"Equal", "="}, + {"OpComparison", "=="}, {"Float", "4.9"}, }}, {"basic_inequality", "3!=4.9", false, []result{