fix: fixed marker package attempting to parse undefined markers (#280)

* test: update tests to prove failure It was discovered that this failure only happened to occur on collection markers and not on regular markers. Signed-off-by: Dustin Scott <sdustin@vmware.com> * fix: Fixes #260 added check to ensure marker exists before adding to results Signed-off-by: Dustin Scott <sdustin@vmware.com> * test: fix test to include namespace on namespaced resource Signed-off-by: Dustin Scott <sdustin@vmware.com> * fix: Fixes #260, reversed previous fix and added proper fix Signed-off-by: Dustin Scott <sdustin@vmware.com> * test: added test for kubebuilder marker with semicolon naked delimiter Signed-off-by: Dustin Scott <sdustin@vmware.com>
nukleros · Mar 7, 2022 · 8aadf85 · 8aadf85
1 parent f2daa61
commit 8aadf85
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 2 deletions.
diff --git a/internal/markers/lexer/lexer_test.go b/internal/markers/lexer/lexer_test.go
@@ -383,6 +383,23 @@ func TestLexer(t *testing.T) {
 				{Type: lexer.LexemeEOF, Value: ""},
 			},
 		},
+		{
+			name:  "kubebuilder marker",
+			input: `# +kubebuilder:validation:Enum=aws;azure;vmware`,
+			expected: []lexer.Lexeme{
+				{Type: lexer.LexemeComment, Value: "#"},
+				{Type: lexer.LexemeMarkerStart, Value: "+"},
+				{Type: lexer.LexemeScope, Value: "kubebuilder"},
+				{Type: lexer.LexemeSeparator, Value: ":"},
+				{Type: lexer.LexemeScope, Value: "validation"},
+				{Type: lexer.LexemeSeparator, Value: ":"},
+				{Type: lexer.LexemeArg, Value: "Enum"},
+				{Type: lexer.LexemeArgAssignment, Value: "="},
+				{Type: lexer.LexemeStringLiteral, Value: "aws;azure;vmware"},
+				{Type: lexer.LexemeMarkerEnd, Value: "\n"},
+				{Type: lexer.LexemeEOF, Value: ""},
+			},
+		},
 	}
 
 	focused := false

diff --git a/internal/markers/lexer/state.go b/internal/markers/lexer/state.go
@@ -289,7 +289,7 @@ func lexNakedStringLiteral(l *Lexer, nextState stateFn) (stateFn, bool) {
 	exceptions := []rune{
 		':', '=', ' ', '"', '\'', '`',
 		',', '+', '{', '}', '[', ']',
-		'(', ')', ';', '\n', eof,
+		'(', ')', '\n', eof,
 	}
 
 	if argValue := l.consumeUntil(exceptions...); !argValue {

diff --git a/test/cases/edge-collection/.workloadConfig/ingress/contour-config.yaml b/test/cases/edge-collection/.workloadConfig/ingress/contour-config.yaml
@@ -10,6 +10,21 @@ data:
     anotheroption: another
     justtesting: multistringyaml
 ---
+# +operator-builder:resource:collectionField=provider,value="aws",include
+kind: ConfigMap
+apiVersion: v1
+metadata:
+  name: test-include
+  namespace: ingress-system  # +operator-builder:field:name=namespace,default=ingress-system,type=string
+  labels:
+    # +operator-builder:collection:field:name=provider,type=string,default="aws",description=`
+    # +kubebuilder:validation:Enum=aws;azure;vmware
+    # This test ensures that kubebuilder markers with a semicolon properly work.
+    # See https://github.com/vmware-tanzu-labs/operator-builder/issues/260 for details.`
+    provider: "aws"
+data:
+  test: "data"
+---
 apiVersion: v1
 kind: Secret
 metadata:

diff --git a/test/cases/edge-standalone/.workloadConfig/resources.yaml b/test/cases/edge-standalone/.workloadConfig/resources.yaml
@@ -17,7 +17,11 @@ apiVersion: v1
 metadata:
   name: test-include
   labels:
-    provider: "aws" # +operator-builder:field:name=provider,type=string,default="aws"
+    # +operator-builder:field:name=provider,type=string,default="aws",description=`
+    # +kubebuilder:validation:Enum=aws;azure;vmware
+    # This test ensures that kubebuilder markers with a semicolon properly work.
+    # See https://github.com/vmware-tanzu-labs/operator-builder/issues/260 for details.`
+    provider: "aws"
 data:
   test: "data"
 ---