fix trailing comment parse in properties (#2371)

Author: lucix-aws

.changelog/db2095be68314e47882d4a8881cc72ff.json

@@ -0,0 +1,8 @@
+{
+    "id": "db2095be-6831-4e47-882d-4a8881cc72ff",
+    "type": "bugfix",
+    "description": "Fix recognition of trailing comments in shared config properties. # or ; separators that aren't preceded by whitespace at the end of a property value should be considered part of it.",
+    "modules": [
+        "internal/ini"
+    ]
+}

internal/ini/parse.go

@@ -82,7 +82,7 @@ func (p *parser) handleSubProperty(tok *lineTokenSubProperty) {
 		// "promote" this to a normal property.
 		p.handleProperty(&lineTokenProperty{
 			Key:   tok.Key,
-			Value: strings.TrimSpace(trimComment(tok.Value)),
+			Value: strings.TrimSpace(trimPropertyComment(tok.Value)),
 		})
 		return
 	}

internal/ini/strings.go

@@ -1,11 +1,21 @@
 package ini
 
-import "strings"
+import (
+	"strings"
+)
 
-func trimComment(v string) string {
-	rest, _, _ := strings.Cut(v, "#")
-	rest, _, _ = strings.Cut(rest, ";")
-	return rest
+func trimProfileComment(s string) string {
+	r, _, _ := strings.Cut(s, "#")
+	r, _, _ = strings.Cut(r, ";")
+	return r
+}
+
+func trimPropertyComment(s string) string {
+	r, _, _ := strings.Cut(s, " #")
+	r, _, _ = strings.Cut(r, " ;")
+	r, _, _ = strings.Cut(r, "\t#")
+	r, _, _ = strings.Cut(r, "\t;")
+	return r
 }
 
 // assumes no surrounding comment

internal/ini/testdata/valid/comments

@@ -0,0 +1,16 @@
+[profile comments];comment
+a = foo#notcomment
+b = foo;notcomment
+c = foo#
+d = foo;
+e = foo bar 	 # comment
+f = foo 	 bar ; comment
+g = foo		# comment
+h = foo		; comment
+i = # comment
+j = ; comment
+k = foo # ; comment
+l = foo ; # comment
+m = foo		
+n = foo #
+o = foo ;

internal/ini/testdata/valid/comments_expected

@@ -0,0 +1,19 @@
+{
+	"profile comments": {
+		"a": "foo#notcomment",
+		"b": "foo;notcomment",
+		"c": "foo#",
+		"d": "foo;",
+		"e": "foo bar",
+		"f": "foo \t bar",
+		"g": "foo",
+		"h": "foo",
+		"i": "",
+		"j": "",
+		"k": "foo",
+		"l": "foo",
+		"m": "foo",
+		"n": "foo",
+		"o": "foo"
+	}
+}

internal/ini/tokenize.go

@@ -30,7 +30,7 @@ func isLineComment(line string) bool {
 }
 
 func asProfile(line string) *lineTokenProfile { // " [ type name ] ; comment"
-	trimmed := strings.TrimSpace(trimComment(line)) // "[ type name ]"
+	trimmed := strings.TrimSpace(trimProfileComment(line)) // "[ type name ]"
 	if !isBracketed(trimmed) {
 		return nil
 	}
@@ -48,7 +48,8 @@ func asProperty(line string) *lineTokenProperty {
 		return nil
 	}
 
-	trimmed := strings.TrimRight(trimComment(line), " \t")
+	trimmed := trimPropertyComment(line)
+	trimmed = strings.TrimRight(trimmed, " \t")
 	k, v, ok := splitProperty(trimmed)
 	if !ok {
 		return nil