mirror of https://github.com/docker/cli.git
Allow custom pattern when extracting variable…
… as it is possible to do it when interpolating. It also fixes when there is 2 variables on the same *value* (in the composefile, on the same line) Finaly, renaming the default, used in cli, pattern to `defaultPattern` to not be shadowed unintentionally. Signed-off-by: Vincent Demeester <vincent@sbr.pm>
This commit is contained in:
parent
4fbb009d39
commit
4c87725c35
|
@ -14,7 +14,7 @@ var patternString = fmt.Sprintf(
|
|||
delimiter, delimiter, substitution, substitution,
|
||||
)
|
||||
|
||||
var pattern = regexp.MustCompile(patternString)
|
||||
var defaultPattern = regexp.MustCompile(patternString)
|
||||
|
||||
// DefaultSubstituteFuncs contains the default SubstitueFunc used by the docker cli
|
||||
var DefaultSubstituteFuncs = []SubstituteFunc{
|
||||
|
@ -51,7 +51,7 @@ func SubstituteWith(template string, mapping Mapping, pattern *regexp.Regexp, su
|
|||
var err error
|
||||
result := pattern.ReplaceAllStringFunc(template, func(substring string) string {
|
||||
matches := pattern.FindStringSubmatch(substring)
|
||||
groups := matchGroups(matches)
|
||||
groups := matchGroups(matches, pattern)
|
||||
if escaped := groups["escaped"]; escaped != "" {
|
||||
return escaped
|
||||
}
|
||||
|
@ -90,26 +90,31 @@ func SubstituteWith(template string, mapping Mapping, pattern *regexp.Regexp, su
|
|||
|
||||
// Substitute variables in the string with their values
|
||||
func Substitute(template string, mapping Mapping) (string, error) {
|
||||
return SubstituteWith(template, mapping, pattern, DefaultSubstituteFuncs...)
|
||||
return SubstituteWith(template, mapping, defaultPattern, DefaultSubstituteFuncs...)
|
||||
}
|
||||
|
||||
// ExtractVariables returns a map of all the variables defined in the specified
|
||||
// composefile (dict representation) and their default value if any.
|
||||
func ExtractVariables(configDict map[string]interface{}) map[string]string {
|
||||
return recurseExtract(configDict)
|
||||
func ExtractVariables(configDict map[string]interface{}, pattern *regexp.Regexp) map[string]string {
|
||||
if pattern == nil {
|
||||
pattern = defaultPattern
|
||||
}
|
||||
return recurseExtract(configDict, pattern)
|
||||
}
|
||||
|
||||
func recurseExtract(value interface{}) map[string]string {
|
||||
func recurseExtract(value interface{}, pattern *regexp.Regexp) map[string]string {
|
||||
m := map[string]string{}
|
||||
|
||||
switch value := value.(type) {
|
||||
case string:
|
||||
if v, is := extractVariable(value); is {
|
||||
if values, is := extractVariable(value, pattern); is {
|
||||
for _, v := range values {
|
||||
m[v.name] = v.value
|
||||
}
|
||||
}
|
||||
case map[string]interface{}:
|
||||
for _, elem := range value {
|
||||
submap := recurseExtract(elem)
|
||||
submap := recurseExtract(elem, pattern)
|
||||
for key, value := range submap {
|
||||
m[key] = value
|
||||
}
|
||||
|
@ -117,11 +122,13 @@ func recurseExtract(value interface{}) map[string]string {
|
|||
|
||||
case []interface{}:
|
||||
for _, elem := range value {
|
||||
if v, is := extractVariable(elem); is {
|
||||
if values, is := extractVariable(elem, pattern); is {
|
||||
for _, v := range values {
|
||||
m[v.name] = v.value
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return m
|
||||
}
|
||||
|
@ -131,18 +138,20 @@ type extractedValue struct {
|
|||
value string
|
||||
}
|
||||
|
||||
func extractVariable(value interface{}) (extractedValue, bool) {
|
||||
func extractVariable(value interface{}, pattern *regexp.Regexp) ([]extractedValue, bool) {
|
||||
sValue, ok := value.(string)
|
||||
if !ok {
|
||||
return extractedValue{}, false
|
||||
return []extractedValue{}, false
|
||||
}
|
||||
matches := pattern.FindStringSubmatch(sValue)
|
||||
matches := pattern.FindAllStringSubmatch(sValue, -1)
|
||||
if len(matches) == 0 {
|
||||
return extractedValue{}, false
|
||||
return []extractedValue{}, false
|
||||
}
|
||||
groups := matchGroups(matches)
|
||||
values := []extractedValue{}
|
||||
for _, match := range matches {
|
||||
groups := matchGroups(match, pattern)
|
||||
if escaped := groups["escaped"]; escaped != "" {
|
||||
return extractedValue{}, false
|
||||
continue
|
||||
}
|
||||
val := groups["named"]
|
||||
if val == "" {
|
||||
|
@ -160,7 +169,9 @@ func extractVariable(value interface{}) (extractedValue, bool) {
|
|||
case strings.Contains(val, "-"):
|
||||
name, defaultValue = partition(val, "-")
|
||||
}
|
||||
return extractedValue{name: name, value: defaultValue}, true
|
||||
values = append(values, extractedValue{name: name, value: defaultValue})
|
||||
}
|
||||
return values, len(values) > 0
|
||||
}
|
||||
|
||||
// Soft default (fall back if unset or empty)
|
||||
|
@ -207,7 +218,7 @@ func withRequired(substitution string, mapping Mapping, sep string, valid func(s
|
|||
return value, true, nil
|
||||
}
|
||||
|
||||
func matchGroups(matches []string) map[string]string {
|
||||
func matchGroups(matches []string, pattern *regexp.Regexp) map[string]string {
|
||||
groups := make(map[string]string)
|
||||
for i, name := range pattern.SubexpNames()[1:] {
|
||||
groups[name] = matches[i+1]
|
||||
|
|
|
@ -161,15 +161,15 @@ func TestSubstituteWithCustomFunc(t *testing.T) {
|
|||
return value, true, nil
|
||||
}
|
||||
|
||||
result, err := SubstituteWith("ok ${FOO}", defaultMapping, pattern, errIsMissing)
|
||||
result, err := SubstituteWith("ok ${FOO}", defaultMapping, defaultPattern, errIsMissing)
|
||||
assert.NilError(t, err)
|
||||
assert.Check(t, is.Equal("ok first", result))
|
||||
|
||||
result, err = SubstituteWith("ok ${BAR}", defaultMapping, pattern, errIsMissing)
|
||||
result, err = SubstituteWith("ok ${BAR}", defaultMapping, defaultPattern, errIsMissing)
|
||||
assert.NilError(t, err)
|
||||
assert.Check(t, is.Equal("ok ", result))
|
||||
|
||||
_, err = SubstituteWith("ok ${NOTHERE}", defaultMapping, pattern, errIsMissing)
|
||||
_, err = SubstituteWith("ok ${NOTHERE}", defaultMapping, defaultPattern, errIsMissing)
|
||||
assert.Check(t, is.ErrorContains(err, "required variable"))
|
||||
}
|
||||
|
||||
|
@ -245,6 +245,7 @@ func TestExtractVariables(t *testing.T) {
|
|||
},
|
||||
"baz": []interface{}{
|
||||
"foo",
|
||||
"$docker:${project:-cli}",
|
||||
"$toto",
|
||||
},
|
||||
},
|
||||
|
@ -252,11 +253,13 @@ func TestExtractVariables(t *testing.T) {
|
|||
"bar": "foo",
|
||||
"fruit": "banana",
|
||||
"toto": "",
|
||||
"docker": "",
|
||||
"project": "cli",
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tc := range testCases {
|
||||
actual := ExtractVariables(tc.dict)
|
||||
actual := ExtractVariables(tc.dict, defaultPattern)
|
||||
assert.Check(t, is.DeepEqual(actual, tc.expected))
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue