support escaping comas in tags

Author: RomanBednar

pkg/common/utils.go

@@ -17,6 +17,7 @@ limitations under the License.
 package common
 
 import (
+	"bytes"
 	"context"
 	"errors"
 	"fmt"
@@ -78,6 +79,8 @@ const (
 	// Full or partial URL of the zone resource, in the format:
 	//   projects/{project}/zones/{zone}
 	zoneURIPattern = "projects/[^/]+/zones/([^/]+)$"
+
+	escapeRune = '\\'
 )
 
 var (
@@ -280,7 +283,7 @@ func ConvertLabelsStringToMap(labels string) (map[string]string, error) {
 // See https://cloud.google.com/resource-manager/docs/tags/tags-overview,
 // https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing for details
 func ConvertTagsStringToMap(tags string) (map[string]string, error) {
-	const tagsDelimiter = ","
+	const tagsDelimiter = ','
 	const tagsParentIDKeyValueDelimiter = "/"
 
 	tagsMap := make(map[string]string)
@@ -311,7 +314,7 @@ func ConvertTagsStringToMap(tags string) (map[string]string, error) {
 	}
 
 	checkTagParentIDKey := sets.String{}
-	parentIDkeyValueStrings := strings.Split(tags, tagsDelimiter)
+	parentIDkeyValueStrings := splitWithEscape(tags, tagsDelimiter, escapeRune)
 	for _, parentIDkeyValueString := range parentIDkeyValueStrings {
 		parentIDKeyValue := strings.Split(parentIDkeyValueString, tagsParentIDKeyValueDelimiter)
 

pkg/common/utils_test.go

@@ -618,6 +618,41 @@ func TestConvertTagsStringToMap(t *testing.T) {
 				expectedOutput: nil,
 				expectedError:  true,
 			},
+			{
+				name: "tag value contains escaped delimiters",
+				tags: "parent1/key1/value\\,with\\,comas,parent2/key2/value3",
+				expectedOutput: map[string]string{
+					"parent1/key1": "value,with,comas",
+					"parent2/key2": "value3",
+				},
+				expectedError: false,
+			},
+			{
+				name: "tag value contains unescaped comas",
+				tags: "parent1/key1/value,with,comas,parent2/key2/value3",
+				expectedOutput: map[string]string{
+					"parent1/key1": "value,with,comas",
+					"parent2/key2": "value3",
+				},
+				expectedError: true,
+			},
+			{
+				name: "tag value contains escapes for non delimiter characters",
+				tags: "p\\arent1/key1/value1,parent2/key2/value2",
+				expectedOutput: map[string]string{
+					"parent1/key1": "value1",
+					"parent2/key2": "value2",
+				},
+				expectedError: false,
+			},
+			{
+				name: "tag value contains a sequence of escape characters",
+				tags: "parent1/key1/\\\\value\\",
+				expectedOutput: map[string]string{
+					"parent1/key1": "value",
+				},
+				expectedError: false,
+			},
 		}
 
 		for _, tc := range testCases {
@@ -756,6 +791,11 @@ func TestConvertTagsStringToMap(t *testing.T) {
 				tags:          "parent/k/Special@value[10]{20}(30)-example",
 				expectedError: false,
 			},
+			{
+				name:          "tag value may contain escaped comas",
+				tags:          "parent/k/v\\,v",
+				expectedError: false,
+			},
 		}
 
 		for _, tc := range testCases {