github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-24 12:15:52 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #105702 from liggitt/json-strict-test

Browse Source 
JSON decoder fixup
This commit is contained in:
Kubernetes Prow Robot 2021-10-15 15:45:48 -07:00 committed by GitHub
commit 3f40906dd8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 169 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
staging/src/k8s.io/apimachinery/pkg/apis/meta/v1/unstructured/helpers.go
View File

@ -382,7 +382,7 @@ func (unstructuredJSONScheme) Identifier() runtime.Identifier {
func (s unstructuredJSONScheme) decode(data []byte) (runtime.Object, error) {
type detector struct {
Items gojson.RawMessage
Items gojson.RawMessage `json:"items"`
}
var det detector
if err := json.Unmarshal(data, &det); err != nil {
@ -425,7 +425,7 @@ func (unstructuredJSONScheme) decodeToUnstructured(data []byte, unstruct *Unstru
func (s unstructuredJSONScheme) decodeToList(data []byte, list *UnstructuredList) error {
type decodeList struct {
Items []gojson.RawMessage
Items []gojson.RawMessage `json:"items"`
}
var dList decodeList

215
staging/src/k8s.io/apimachinery/pkg/runtime/serializer/json/json_test.go
View File

@ -22,6 +22,7 @@ import (
"strings"
"testing"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/runtime/serializer/json"
@ -30,11 +31,12 @@ import (
)
type testDecodable struct {
metav1.TypeMeta `json:",inline"`
Other string
Value int `json:"value"`
Spec DecodableSpec `json:"spec"`
Interface interface{} `json:"interface"`
gvk schema.GroupVersionKind
}
// DecodableSpec has 15 fields. json-iterator treats struct with more than 10
@ -57,9 +59,6 @@ type DecodableSpec struct {
O int `json:"o"`
}
func (d *testDecodable) GetObjectKind() schema.ObjectKind { return d }
func (d *testDecodable) SetGroupVersionKind(gvk schema.GroupVersionKind) { d.gvk = gvk }
func (d *testDecodable) GroupVersionKind() schema.GroupVersionKind { return d.gvk }
func (d *testDecodable) DeepCopyObject() runtime.Object {
if d == nil {
return nil
@ -74,7 +73,39 @@ func (d *testDecodable) DeepCopyInto(out *testDecodable) {
out.Value = d.Value
out.Spec = d.Spec
out.Interface = d.Interface
out.gvk = d.gvk
return
}
type testDecodeCoercion struct {
metav1.TypeMeta `json:",inline"`
Bool bool `json:"bool"`
Int int `json:"int"`
Int32 int `json:"int32"`
Int64 int `json:"int64"`
Float32 float32 `json:"float32"`
Float64 float64 `json:"float64"`
String string `json:"string"`
Struct testDecodable `json:"struct"`
Array []string `json:"array"`
Map map[string]string `json:"map"`
}
func (d *testDecodeCoercion) DeepCopyObject() runtime.Object {
if d == nil {
return nil
}
out := new(testDecodeCoercion)
d.DeepCopyInto(out)
return out
}
func (d *testDecodeCoercion) DeepCopyInto(out *testDecodeCoercion) {
*out = *d
return
}
@ -121,7 +152,7 @@ func TestDecode(t *testing.T) {
data: []byte(`{"apiVersion":"blah"}`),
defaultGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
creater: &mockCreater{obj: &testDecodable{}},
expectedObject: &testDecodable{},
expectedObject: &testDecodable{TypeMeta: metav1.TypeMeta{APIVersion: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "", Version: "blah"},
},
// group without version is defaulted
@ -129,7 +160,7 @@ func TestDecode(t *testing.T) {
data: []byte(`{"apiVersion":"other/"}`),
defaultGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
creater: &mockCreater{obj: &testDecodable{}},
expectedObject: &testDecodable{},
expectedObject: &testDecodable{TypeMeta: metav1.TypeMeta{APIVersion: "other/"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
},
// group version, kind is defaulted
@ -137,7 +168,7 @@ func TestDecode(t *testing.T) {
data: []byte(`{"apiVersion":"other1/blah1"}`),
defaultGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
creater: &mockCreater{obj: &testDecodable{}},
expectedObject: &testDecodable{},
expectedObject: &testDecodable{TypeMeta: metav1.TypeMeta{APIVersion: "other1/blah1"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other1", Version: "blah1"},
},
// gvk all provided then not defaulted at all
@ -145,17 +176,17 @@ func TestDecode(t *testing.T) {
data: []byte(`{"kind":"Test","apiVersion":"other/blah"}`),
defaultGVK: &schema.GroupVersionKind{Kind: "Test1", Group: "other1", Version: "blah1"},
creater: &mockCreater{obj: &testDecodable{}},
expectedObject: &testDecodable{},
expectedObject: &testDecodable{TypeMeta: metav1.TypeMeta{APIVersion: "other/blah", Kind: "Test"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
},
//gvk defaulting if kind not provided in data and defaultGVK use into's kind
{
data: []byte(`{"apiVersion":"b1/c1"}`),
into: &testDecodable{gvk: schema.GroupVersionKind{Kind: "a3", Group: "b1", Version: "c1"}},
into: &testDecodable{TypeMeta: metav1.TypeMeta{Kind: "a3", APIVersion: "b1/c1"}},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "a3", Group: "b1", Version: "c1"}},
defaultGVK: nil,
creater: &mockCreater{obj: &testDecodable{}},
expectedObject: &testDecodable{gvk: schema.GroupVersionKind{Kind: "a3", Group: "b1", Version: "c1"}},
expectedObject: &testDecodable{TypeMeta: metav1.TypeMeta{Kind: "a3", APIVersion: "b1/c1"}},
expectedGVK: &schema.GroupVersionKind{Kind: "a3", Group: "b1", Version: "c1"},
},
@ -199,8 +230,9 @@ func TestDecode(t *testing.T) {
typer: &mockTyper{err: runtime.NewNotRegisteredErrForKind("mock", schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"})},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodable{
Other: "test",
Value: 1,
TypeMeta: metav1.TypeMeta{APIVersion: "other/blah", Kind: "Test"},
Other: "test",
Value: 1,
},
},
// registered types get defaulted by the into object kind
@ -243,7 +275,8 @@ func TestDecode(t *testing.T) {
typer: &mockTyper{err: runtime.NewNotRegisteredErrForKind("mock", schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"})},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodable{
Other: "test",
TypeMeta: metav1.TypeMeta{APIVersion: "other/blah", Kind: "Test"},
Other: "test",
},
},
// Unmarshalling is case-sensitive for big struct.
@ -254,7 +287,8 @@ func TestDecode(t *testing.T) {
typer: &mockTyper{err: runtime.NewNotRegisteredErrForKind("mock", schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"})},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodable{
Spec: DecodableSpec{A: 1, H: 3},
TypeMeta: metav1.TypeMeta{APIVersion: "other/blah", Kind: "Test"},
Spec: DecodableSpec{A: 1, H: 3},
},
},
// Unknown fields should return an error from the strict JSON deserializer.
@ -275,7 +309,7 @@ func TestDecode(t *testing.T) {
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
errFn: func(err error) bool {
return strings.Contains(err.Error(), "found unknown field")
return strings.Contains(err.Error(), "found unknown field: unknown")
},
yaml: true,
strict: true,
@ -287,7 +321,7 @@ func TestDecode(t *testing.T) {
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
errFn: func(err error) bool {
return strings.Contains(err.Error(), "already set in map")
return strings.Contains(err.Error(), `"value" already set in map`)
},
strict: true,
},
@ -299,33 +333,7 @@ func TestDecode(t *testing.T) {
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
errFn: func(err error) bool {
return strings.Contains(err.Error(), "already set in map")
},
yaml: true,
strict: true,
},
// Strict JSON decode should fail for untagged fields.
{
data: []byte(`{"kind":"Test","apiVersion":"other/blah","value":1,"Other":"test"}`),
into: &testDecodable{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
errFn: func(err error) bool {
return strings.Contains(err.Error(), "found unknown field")
},
strict: true,
},
// Strict YAML decode should fail for untagged fields.
{
data: []byte("kind: Test\n" +
"apiVersion: other/blah\n" +
"value: 1\n" +
"Other: test\n"),
into: &testDecodable{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
errFn: func(err error) bool {
return strings.Contains(err.Error(), "found unknown field")
return strings.Contains(err.Error(), `"value" already set in map`)
},
yaml: true,
strict: true,
@ -337,8 +345,9 @@ func TestDecode(t *testing.T) {
typer: &mockTyper{err: runtime.NewNotRegisteredErrForKind("mock", schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"})},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodable{
Other: "test",
Value: 1,
TypeMeta: metav1.TypeMeta{APIVersion: "other/blah", Kind: "Test"},
Other: "test",
Value: 1,
},
strict: true,
},
@ -352,8 +361,9 @@ func TestDecode(t *testing.T) {
typer: &mockTyper{err: runtime.NewNotRegisteredErrForKind("mock", schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"})},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodable{
Other: "test",
Value: 1,
TypeMeta: metav1.TypeMeta{APIVersion: "other/blah", Kind: "Test"},
Other: "test",
Value: 1,
},
yaml: true,
strict: true,
@ -381,6 +391,115 @@ func TestDecode(t *testing.T) {
yaml: true,
strict: true,
},
// coerce from null
{
data: []byte(`{"bool":null,"int":null,"int32":null,"int64":null,"float32":null,"float64":null,"string":null,"array":null,"map":null,"struct":null}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{},
strict: true,
},
{
data: []byte(`{"bool":null,"int":null,"int32":null,"int64":null,"float32":null,"float64":null,"string":null,"array":null,"map":null,"struct":null}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{},
yaml: true,
strict: true,
},
// coerce from string
{
data: []byte(`{"string":""}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{},
strict: true,
},
{
data: []byte(`{"string":""}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{},
yaml: true,
strict: true,
},
// coerce from array
{
data: []byte(`{"array":[]}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{Array: []string{}},
strict: true,
},
{
data: []byte(`{"array":[]}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{Array: []string{}},
yaml: true,
strict: true,
},
// coerce from map
{
data: []byte(`{"map":{},"struct":{}}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{Map: map[string]string{}},
strict: true,
},
{
data: []byte(`{"map":{},"struct":{}}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{Map: map[string]string{}},
yaml: true,
strict: true,
},
// coerce from int
{
data: []byte(`{"int":1,"int32":1,"int64":1,"float32":1,"float64":1}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{Int: 1, Int32: 1, Int64: 1, Float32: 1, Float64: 1},
strict: true,
},
{
data: []byte(`{"int":1,"int32":1,"int64":1,"float32":1,"float64":1}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{Int: 1, Int32: 1, Int64: 1, Float32: 1, Float64: 1},
yaml: true,
strict: true,
},
// coerce from float
{
data: []byte(`{"float32":1.0,"float64":1.0}`),
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{Float32: 1, Float64: 1},
strict: true,
},
{
data: []byte(`{"int":1.0,"int32":1.0,"int64":1.0,"float32":1.0,"float64":1.0}`), // floating point gets dropped in yaml -> json step
into: &testDecodeCoercion{},
typer: &mockTyper{gvk: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"}},
expectedGVK: &schema.GroupVersionKind{Kind: "Test", Group: "other", Version: "blah"},
expectedObject: &testDecodeCoercion{Int: 1, Int32: 1, Int64: 1, Float32: 1, Float64: 1},
yaml: true,
strict: true,
},
}
for i, test := range testCases {