Commit e776cdc2 authored by Sam Ghods's avatar Sam Ghods

Upgrade ghodss/yaml, fixes #2763

parent 3a201e5e
...@@ -64,7 +64,7 @@ ...@@ -64,7 +64,7 @@
}, },
{ {
"ImportPath": "github.com/ghodss/yaml", "ImportPath": "github.com/ghodss/yaml",
"Rev": "a4ad25344bbdf7fec4f4675f866b0091fb00e00e" "Rev": "4fb5c728a37b361a1e971a3bb3d785fcc96b6ef5"
}, },
{ {
"ImportPath": "github.com/golang/glog", "ImportPath": "github.com/golang/glog",
......
...@@ -19,3 +19,32 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER ...@@ -19,3 +19,32 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
Copyright (c) 2012 The Go Authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package yaml package yaml
import ( import (
"bytes"
"encoding/json" "encoding/json"
"fmt" "fmt"
"reflect" "reflect"
...@@ -27,7 +28,8 @@ func Marshal(o interface{}) ([]byte, error) { ...@@ -27,7 +28,8 @@ func Marshal(o interface{}) ([]byte, error) {
// Converts YAML to JSON then uses JSON to unmarshal into an object. // Converts YAML to JSON then uses JSON to unmarshal into an object.
func Unmarshal(y []byte, o interface{}) error { func Unmarshal(y []byte, o interface{}) error {
j, err := YAMLToJSON(y) vo := reflect.ValueOf(o)
j, err := yamlToJSON(y, &vo)
if err != nil { if err != nil {
return fmt.Errorf("error converting YAML to JSON: %v", err) return fmt.Errorf("error converting YAML to JSON: %v", err)
} }
...@@ -64,6 +66,10 @@ func JSONToYAML(j []byte) ([]byte, error) { ...@@ -64,6 +66,10 @@ func JSONToYAML(j []byte) ([]byte, error) {
// not use the !!binary tag in your YAML. This will ensure the original base64 // not use the !!binary tag in your YAML. This will ensure the original base64
// encoded data makes it all the way through to the JSON. // encoded data makes it all the way through to the JSON.
func YAMLToJSON(y []byte) ([]byte, error) { func YAMLToJSON(y []byte) ([]byte, error) {
return yamlToJSON(y, nil)
}
func yamlToJSON(y []byte, jsonTarget *reflect.Value) ([]byte, error) {
// Convert the YAML to an object. // Convert the YAML to an object.
var yamlObj interface{} var yamlObj interface{}
err := yaml.Unmarshal(y, &yamlObj) err := yaml.Unmarshal(y, &yamlObj)
...@@ -75,7 +81,7 @@ func YAMLToJSON(y []byte) ([]byte, error) { ...@@ -75,7 +81,7 @@ func YAMLToJSON(y []byte) ([]byte, error) {
// can have non-string keys in YAML). So, convert the YAML-compatible object // can have non-string keys in YAML). So, convert the YAML-compatible object
// to a JSON-compatible object, failing with an error if irrecoverable // to a JSON-compatible object, failing with an error if irrecoverable
// incompatibilties happen along the way. // incompatibilties happen along the way.
jsonObj, err := convertToJSONableObject(yamlObj) jsonObj, err := convertToJSONableObject(yamlObj, jsonTarget)
if err != nil { if err != nil {
return nil, err return nil, err
} }
...@@ -84,8 +90,30 @@ func YAMLToJSON(y []byte) ([]byte, error) { ...@@ -84,8 +90,30 @@ func YAMLToJSON(y []byte) ([]byte, error) {
return json.Marshal(jsonObj) return json.Marshal(jsonObj)
} }
func convertToJSONableObject(yamlObj interface{}) (interface{}, error) { func convertToJSONableObject(yamlObj interface{}, jsonTarget *reflect.Value) (interface{}, error) {
var err error var err error
// Resolve jsonTarget to a concrete value (i.e. not a pointer or an
// interface). We pass decodingNull as false because we're not actually
// decoding into the value, we're just checking if the ultimate target is a
// string.
if jsonTarget != nil {
ju, tu, pv := indirect(*jsonTarget, false)
// We have a JSON or Text Umarshaler at this level, so we can't be trying
// to decode into a string.
if ju != nil || tu != nil {
jsonTarget = nil
} else {
jsonTarget = &pv
}
}
// If yamlObj is a number, check if jsonTarget is a string - if so, coerce.
// Else return normal.
// If yamlObj is a map or array, find the field that each key is
// unmarshaling to, and when you recurse pass the reflect.Value for that
// field back into this function.
switch typedYAMLObj := yamlObj.(type) { switch typedYAMLObj := yamlObj.(type) {
case map[interface{}]interface{}: case map[interface{}]interface{}:
// JSON does not support arbitrary keys in a map, so we must convert // JSON does not support arbitrary keys in a map, so we must convert
...@@ -127,7 +155,40 @@ func convertToJSONableObject(yamlObj interface{}) (interface{}, error) { ...@@ -127,7 +155,40 @@ func convertToJSONableObject(yamlObj interface{}) (interface{}, error) {
reflect.TypeOf(k), k, v) reflect.TypeOf(k), k, v)
} }
strMap[keyString], err = convertToJSONableObject(v) // If jsonTarget is a struct (which it really should be), find the
// field it's going to map to. If it's not a struct, just pass nil
// - JSON conversion will error for us if it's a real issue.
if jsonTarget != nil {
t := *jsonTarget
if t.Kind() == reflect.Struct {
keyBytes := []byte(keyString)
// Find the field that the JSON library would use.
var f *field
fields := cachedTypeFields(t.Type())
for i := range fields {
ff := &fields[i]
if bytes.Equal(ff.nameBytes, keyBytes) {
f = ff
break
}
// Do case-insensitive comparison.
if f == nil && ff.equalFold(ff.nameBytes, keyBytes) {
f = ff
}
}
if f != nil {
// Find the reflect.Value of the most preferential
// struct field.
jtf := t.Field(f.index[0])
strMap[keyString], err = convertToJSONableObject(v, &jtf)
if err != nil {
return nil, err
}
continue
}
}
}
strMap[keyString], err = convertToJSONableObject(v, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
...@@ -135,16 +196,53 @@ func convertToJSONableObject(yamlObj interface{}) (interface{}, error) { ...@@ -135,16 +196,53 @@ func convertToJSONableObject(yamlObj interface{}) (interface{}, error) {
return strMap, nil return strMap, nil
case []interface{}: case []interface{}:
// We need to recurse into arrays in case there are any // We need to recurse into arrays in case there are any
// map[interface{}]interface{}'s inside. // map[interface{}]interface{}'s inside and to convert any
// numbers to strings.
// If jsonTarget is a slice (which it really should be), find the
// thing it's going to map to. If it's not a slice, just pass nil
// - JSON conversion will error for us if it's a real issue.
var jsonSliceElemValue *reflect.Value
if jsonTarget != nil {
t := *jsonTarget
if t.Kind() == reflect.Slice {
// By default slices point to nil, but we need a reflect.Value
// pointing to a value of the slice type, so we create one here.
ev := reflect.Indirect(reflect.New(t.Type().Elem()))
jsonSliceElemValue = &ev
}
}
// Make and use a new array.
arr := make([]interface{}, len(typedYAMLObj)) arr := make([]interface{}, len(typedYAMLObj))
for i, v := range typedYAMLObj { for i, v := range typedYAMLObj {
arr[i], err = convertToJSONableObject(v) arr[i], err = convertToJSONableObject(v, jsonSliceElemValue)
if err != nil { if err != nil {
return nil, err return nil, err
} }
} }
return arr, nil return arr, nil
default: default:
// If the target type is a string and the YAML type is a number,
// convert the YAML type to a string.
if jsonTarget != nil && (*jsonTarget).Kind() == reflect.String {
// Based on my reading of go-yaml, it may return int, int64,
// float64, or uint64.
var s string
switch num := typedYAMLObj.(type) {
case int:
s = strconv.FormatInt(int64(num), 10)
case int64:
s = strconv.FormatInt(num, 10)
case float64:
s = strconv.FormatFloat(num, 'g', -1, 32)
case uint64:
s = strconv.FormatUint(num, 10)
}
if len(s) > 0 {
yamlObj = interface{}(s)
}
}
return yamlObj, nil return yamlObj, nil
} }
......
package yaml package yaml
import ( import (
"fmt"
"reflect" "reflect"
"testing" "testing"
) )
type MarshalTest struct { type MarshalTest struct {
A int A string
} }
func TestMarshalYAML(t *testing.T) { func TestMarshal(t *testing.T) {
s := MarshalTest{1} s := MarshalTest{"a"}
e := []byte("A: 1\n") e := []byte("A: a\n")
y, err := Marshal(s) y, err := Marshal(s)
if err != nil { if err != nil {
...@@ -21,16 +20,50 @@ func TestMarshalYAML(t *testing.T) { ...@@ -21,16 +20,50 @@ func TestMarshalYAML(t *testing.T) {
if !reflect.DeepEqual(y, e) { if !reflect.DeepEqual(y, e) {
t.Errorf("marshal YAML was unsuccessful, expected: %#v, got: %#v", t.Errorf("marshal YAML was unsuccessful, expected: %#v, got: %#v",
string(y), string(e)) string(e), string(y))
} }
} }
type UnmarshalString struct {
A string
}
type UnmarshalNestedString struct {
A NestedString
}
type NestedString struct {
A string
}
type UnmarshalSlice struct {
A []NestedSlice
}
type NestedSlice struct {
B string
C *string
}
func TestUnmarshal(t *testing.T) { func TestUnmarshal(t *testing.T) {
y := []byte(`a: 1`) y := []byte("a: 1")
s := MarshalTest{} s1 := UnmarshalString{}
e := MarshalTest{1} e1 := UnmarshalString{"1"}
unmarshal(t, y, &s1, &e1)
y = []byte("a:\n a: 1")
s2 := UnmarshalNestedString{}
e2 := UnmarshalNestedString{NestedString{"1"}}
unmarshal(t, y, &s2, &e2)
y = []byte("a:\n - b: abc\n c: def\n - b: 123\n c: 456\n")
s3 := UnmarshalSlice{}
e3 := UnmarshalSlice{[]NestedSlice{NestedSlice{"abc", strPtr("def")}, NestedSlice{"123", strPtr("456")}}}
unmarshal(t, y, &s3, &e3)
}
err := Unmarshal(y, &s) func unmarshal(t *testing.T, y []byte, s, e interface{}) {
err := Unmarshal(y, s)
if err != nil { if err != nil {
t.Errorf("error unmarshaling YAML: %v", err) t.Errorf("error unmarshaling YAML: %v", err)
} }
...@@ -170,7 +203,7 @@ func runCases(t *testing.T, runType RunType, cases []Case) { ...@@ -170,7 +203,7 @@ func runCases(t *testing.T, runType RunType, cases []Case) {
for _, c := range cases { for _, c := range cases {
// Convert the string. // Convert the string.
fmt.Printf("converting %s\n", c.input) t.Logf("converting %s\n", c.input)
output, err := f([]byte(c.input)) output, err := f([]byte(c.input))
if err != nil { if err != nil {
t.Errorf("Failed to convert %s, input: `%s`, err: %v", msg, c.input, err) t.Errorf("Failed to convert %s, input: `%s`, err: %v", msg, c.input, err)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment