1c4d4b2141
In #850 we decided that to make our syntax more similar to k8s style syntax, we will use $() for variable substitution instead of ${}. In a later iteration we may also want to make it so that anything that can be acesssed as a variable is also available as an env var to the running container, but that is TBD. In #1172 we added support for the new syntax, $(), and continued support for ${}, which was released in 0.6. This commit removes support for ${}. Fixes #1170
140 lines
4.7 KiB
Go
140 lines
4.7 KiB
Go
/*
|
|
Copyright 2019 The Tekton Authors
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package v1alpha1
|
|
|
|
import (
|
|
"fmt"
|
|
"regexp"
|
|
"strings"
|
|
|
|
"knative.dev/pkg/apis"
|
|
)
|
|
|
|
const parameterSubstitution = "[_a-zA-Z][_a-zA-Z0-9.-]*"
|
|
|
|
const braceMatchingRegex = "(\\$(\\(%s.(?P<var>%s)\\)))"
|
|
|
|
func ValidateVariable(name, value, prefix, contextPrefix, locationName, path string, vars map[string]struct{}) *apis.FieldError {
|
|
if vs, present := extractVariablesFromString(value, contextPrefix+prefix); present {
|
|
for _, v := range vs {
|
|
if _, ok := vars[v]; !ok {
|
|
return &apis.FieldError{
|
|
Message: fmt.Sprintf("non-existent variable in %q for %s %s", value, locationName, name),
|
|
Paths: []string{path + "." + name},
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Verifies that variables matching the relevant string expressions do not reference any of the names present in vars.
|
|
func ValidateVariableProhibited(name, value, prefix, contextPrefix, locationName, path string, vars map[string]struct{}) *apis.FieldError {
|
|
if vs, present := extractVariablesFromString(value, contextPrefix+prefix); present {
|
|
for _, v := range vs {
|
|
if _, ok := vars[v]; ok {
|
|
return &apis.FieldError{
|
|
Message: fmt.Sprintf("variable type invalid in %q for %s %s", value, locationName, name),
|
|
Paths: []string{path + "." + name},
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Verifies that variables matching the relevant string expressions are completely isolated if present.
|
|
func ValidateVariableIsolated(name, value, prefix, contextPrefix, locationName, path string, vars map[string]struct{}) *apis.FieldError {
|
|
if vs, present := extractVariablesFromString(value, contextPrefix+prefix); present {
|
|
firstMatch, _ := extractExpressionFromString(value, contextPrefix+prefix)
|
|
for _, v := range vs {
|
|
if _, ok := vars[v]; ok {
|
|
if len(value) != len(firstMatch) {
|
|
return &apis.FieldError{
|
|
Message: fmt.Sprintf("variable is not properly isolated in %q for %s %s", value, locationName, name),
|
|
Paths: []string{path + "." + name},
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Extract a the first full string expressions found (e.g "$(input.params.foo)"). Return
|
|
// "" and false if nothing is found.
|
|
func extractExpressionFromString(s, prefix string) (string, bool) {
|
|
pattern := fmt.Sprintf(braceMatchingRegex, prefix, parameterSubstitution)
|
|
re := regexp.MustCompile(pattern)
|
|
match := re.FindStringSubmatch(s)
|
|
if match == nil {
|
|
return "", false
|
|
}
|
|
return match[0], true
|
|
}
|
|
|
|
func extractVariablesFromString(s, prefix string) ([]string, bool) {
|
|
pattern := fmt.Sprintf(braceMatchingRegex, prefix, parameterSubstitution)
|
|
re := regexp.MustCompile(pattern)
|
|
matches := re.FindAllStringSubmatch(s, -1)
|
|
if len(matches) == 0 {
|
|
return []string{}, false
|
|
}
|
|
vars := make([]string, len(matches))
|
|
for i, match := range matches {
|
|
groups := matchGroups(match, re)
|
|
// foo -> foo
|
|
// foo.bar -> foo
|
|
// foo.bar.baz -> foo
|
|
vars[i] = strings.SplitN(groups["var"], ".", 2)[0]
|
|
}
|
|
return vars, true
|
|
}
|
|
|
|
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]
|
|
}
|
|
return groups
|
|
}
|
|
|
|
func ApplyReplacements(in string, replacements map[string]string) string {
|
|
for k, v := range replacements {
|
|
in = strings.Replace(in, fmt.Sprintf("$(%s)", k), v, -1)
|
|
}
|
|
return in
|
|
}
|
|
|
|
// Take an input string, and output an array of strings related to possible arrayReplacements. If there aren't any
|
|
// areas where the input can be split up via arrayReplacements, then just return an array with a single element,
|
|
// which is ApplyReplacements(in, replacements).
|
|
func ApplyArrayReplacements(in string, stringReplacements map[string]string, arrayReplacements map[string][]string) []string {
|
|
for k, v := range arrayReplacements {
|
|
stringToReplace := fmt.Sprintf("$(%s)", k)
|
|
|
|
// If the input string matches a replacement's key (without padding characters), return the corresponding array.
|
|
// Note that the webhook should prevent all instances where this could evaluate to false.
|
|
if (strings.Count(in, stringToReplace) == 1) && len(in) == len(stringToReplace) {
|
|
return v
|
|
}
|
|
}
|
|
|
|
// Otherwise return a size-1 array containing the input string with standard stringReplacements applied.
|
|
return []string{ApplyReplacements(in, stringReplacements)}
|
|
}
|