parser: bug fixes (#102)

* parser: remove unnecessary type convertions
* parser: properly pass number and boolean values
* parser: set values if they don't exist
This commit is contained in:
Matthew Penner 2021-08-24 16:05:02 -07:00 committed by GitHub
parent a0a54749d7
commit d4a8f25cc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 38 deletions

View File

@ -48,19 +48,19 @@ func readFileBytes(path string) ([]byte, error) {
} }
// Gets the value of a key based on the value type defined. // Gets the value of a key based on the value type defined.
func (cfr *ConfigurationFileReplacement) getKeyValue(value []byte) interface{} { func (cfr *ConfigurationFileReplacement) getKeyValue(value string) interface{} {
if cfr.ReplaceWith.Type() == jsonparser.Boolean { if cfr.ReplaceWith.Type() == jsonparser.Boolean {
v, _ := strconv.ParseBool(string(value)) v, _ := strconv.ParseBool(value)
return v return v
} }
// Try to parse into an int, if this fails just ignore the error and continue // Try to parse into an int, if this fails just ignore the error and continue
// through, returning the string. // through, returning the string.
if v, err := strconv.Atoi(string(value)); err == nil { if v, err := strconv.Atoi(value); err == nil {
return v return v
} }
return string(value) return value
} }
// Iterate over an unstructured JSON/YAML/etc. interface and set all of the required // Iterate over an unstructured JSON/YAML/etc. interface and set all of the required
@ -97,22 +97,21 @@ func (f *ConfigurationFile) IterateOverJson(data []byte) (*gabs.Container, error
// If the child is a null value, nothing will happen. Seems reasonable as of the // If the child is a null value, nothing will happen. Seems reasonable as of the
// time this code is being written. // time this code is being written.
for _, child := range parsed.Path(strings.Trim(parts[0], ".")).Children() { for _, child := range parsed.Path(strings.Trim(parts[0], ".")).Children() {
if err := v.SetAtPathway(child, strings.Trim(parts[1], "."), []byte(value)); err != nil { if err := v.SetAtPathway(child, strings.Trim(parts[1], "."), value); err != nil {
if errors.Is(err, gabs.ErrNotFound) { if errors.Is(err, gabs.ErrNotFound) {
continue continue
} }
return nil, errors.WithMessage(err, "failed to set config value of array child") return nil, errors.WithMessage(err, "failed to set config value of array child")
} }
} }
} else {
if err = v.SetAtPathway(parsed, v.Match, []byte(value)); err != nil {
if errors.Is(err, gabs.ErrNotFound) {
continue continue
} }
return nil, errors.WithMessage(err, "unable to set config value at pathway: "+v.Match) if err := v.SetAtPathway(parsed, v.Match, value); err != nil {
if errors.Is(err, gabs.ErrNotFound) {
continue
} }
return nil, errors.WithMessage(err, "unable to set config value at pathway: "+v.Match)
} }
} }
@ -132,13 +131,10 @@ func setValueAtPath(c *gabs.Container, path string, value interface{}) error {
var err error var err error
matches := checkForArrayElement.FindStringSubmatch(path) matches := checkForArrayElement.FindStringSubmatch(path)
if len(matches) < 3 {
// Only update the value if the pathway actually exists in the configuration, otherwise
// do nothing.
if c.ExistsP(path) {
_, err = c.SetP(value, path)
}
// Check if we are **NOT** updating an array element.
if len(matches) < 3 {
_, err = c.SetP(value, path)
return err return err
} }
@ -196,32 +192,34 @@ func setValueAtPath(c *gabs.Container, path string, value interface{}) error {
// Sets the value at a specific pathway, but checks if we were looking for a specific // Sets the value at a specific pathway, but checks if we were looking for a specific
// value or not before doing it. // value or not before doing it.
func (cfr *ConfigurationFileReplacement) SetAtPathway(c *gabs.Container, path string, value []byte) error { func (cfr *ConfigurationFileReplacement) SetAtPathway(c *gabs.Container, path string, value string) error {
if cfr.IfValue == "" { if cfr.IfValue == "" {
return setValueAtPath(c, path, cfr.getKeyValue(value)) return setValueAtPath(c, path, cfr.getKeyValue(value))
} }
// If this is a regex based matching, we need to get a little more creative since // Check if we are replacing instead of overwriting.
// we're only going to replacing part of the string, and not the whole thing. if strings.HasPrefix(cfr.IfValue, "regex:") {
if c.ExistsP(path) && strings.HasPrefix(cfr.IfValue, "regex:") { // Doing a regex replacement requires an existing value.
// We're doing some regex here. // TODO: Do we try passing an empty string to the regex?
if c.ExistsP(path) {
return gabs.ErrNotFound
}
r, err := regexp.Compile(strings.TrimPrefix(cfr.IfValue, "regex:")) r, err := regexp.Compile(strings.TrimPrefix(cfr.IfValue, "regex:"))
if err != nil { if err != nil {
log.WithFields(log.Fields{"if_value": strings.TrimPrefix(cfr.IfValue, "regex:"), "error": err}). log.WithFields(log.Fields{"if_value": strings.TrimPrefix(cfr.IfValue, "regex:"), "error": err}).
Warn("configuration if_value using invalid regexp, cannot perform replacement") Warn("configuration if_value using invalid regexp, cannot perform replacement")
return nil return nil
} }
// If the path exists and there is a regex match, go ahead and attempt the replacement v := strings.Trim(c.Path(path).String(), "\"")
// using the value we got from the key. This will only replace the one match.
v := strings.Trim(string(c.Path(path).Bytes()), "\"")
if r.Match([]byte(v)) { if r.Match([]byte(v)) {
return setValueAtPath(c, path, r.ReplaceAllString(v, string(value))) return setValueAtPath(c, path, r.ReplaceAllString(v, value))
}
return nil
} }
return nil if c.ExistsP(path) && !bytes.Equal(c.Bytes(), []byte(cfr.IfValue)) {
} else if !c.ExistsP(path) || (c.ExistsP(path) && !bytes.Equal(c.Bytes(), []byte(cfr.IfValue))) {
return nil return nil
} }

View File

@ -57,17 +57,22 @@ func (cv *ReplaceValue) Type() jsonparser.ValueType {
// handle casting the UTF-8 sequence into the expected value, switching something // handle casting the UTF-8 sequence into the expected value, switching something
// like "\u00a7Foo" into "§Foo". // like "\u00a7Foo" into "§Foo".
func (cv *ReplaceValue) String() string { func (cv *ReplaceValue) String() string {
if cv.Type() != jsonparser.String { switch cv.Type() {
if cv.Type() == jsonparser.Null { case jsonparser.String:
return "<nil>"
}
return "<invalid>"
}
str, err := jsonparser.ParseString(cv.value) str, err := jsonparser.ParseString(cv.value)
if err != nil { if err != nil {
panic(errors.Wrap(err, "parser: could not parse value")) panic(errors.Wrap(err, "parser: could not parse value"))
} }
return str return str
case jsonparser.Null:
return "<nil>"
case jsonparser.Boolean:
return string(cv.value)
case jsonparser.Number:
return string(cv.value)
default:
return "<invalid>"
}
} }
type ConfigurationParser string type ConfigurationParser string