From 8262c30c977e96d01f7a84b5d1c7f19cced365f5 Mon Sep 17 00:00:00 2001 From: Clayton Coleman Date: Fri, 12 Dec 2014 16:57:25 -0500 Subject: [PATCH] Improve serialization round trip test and add v1beta3 --- hack/test-cmd.sh | 2 +- pkg/api/serialization_test.go | 305 +++++++++++++++++++--------------- pkg/client/client.go | 2 +- 3 files changed, 171 insertions(+), 138 deletions(-) diff --git a/hack/test-cmd.sh b/hack/test-cmd.sh index 61fd70507a1..9f63254b7f9 100755 --- a/hack/test-cmd.sh +++ b/hack/test-cmd.sh @@ -78,7 +78,6 @@ kube::log::status "Starting kube-apiserver" APISERVER_PID=$! kube::util::wait_for_url "http://127.0.0.1:${API_PORT}/healthz" "apiserver: " -kube::util::wait_for_url "http://127.0.0.1:${API_PORT}/api/v1beta1/minions/127.0.0.1" "apiserver(minions): " # Start controller manager kube::log::status "Starting CONTROLLER-MANAGER" @@ -88,6 +87,7 @@ kube::log::status "Starting CONTROLLER-MANAGER" CTLRMGR_PID=$! kube::util::wait_for_url "http://127.0.0.1:${CTLRMGR_PORT}/healthz" "controller-manager: " +kube::util::wait_for_url "http://127.0.0.1:${API_PORT}/api/v1beta1/minions/127.0.0.1" "apiserver(minions): " kube_cmd=( "${KUBE_OUTPUT_HOSTBIN}/kubectl" diff --git a/pkg/api/serialization_test.go b/pkg/api/serialization_test.go index 46330c4e10d..c05d13b5ffe 100644 --- a/pkg/api/serialization_test.go +++ b/pkg/api/serialization_test.go @@ -18,6 +18,7 @@ package api_test import ( "encoding/json" + "flag" "math/rand" "reflect" @@ -30,6 +31,7 @@ import ( "github.com/GoogleCloudPlatform/kubernetes/pkg/api/resource" "github.com/GoogleCloudPlatform/kubernetes/pkg/api/v1beta1" "github.com/GoogleCloudPlatform/kubernetes/pkg/api/v1beta2" + "github.com/GoogleCloudPlatform/kubernetes/pkg/api/v1beta3" "github.com/GoogleCloudPlatform/kubernetes/pkg/runtime" "github.com/GoogleCloudPlatform/kubernetes/pkg/util" @@ -38,188 +40,220 @@ import ( "speter.net/go/exp/math/dec/inf" ) -var fuzzIters = flag.Int("fuzz_iters", 40, "How many fuzzing iterations to do.") +var fuzzIters = flag.Int("fuzz_iters", 20, "How many fuzzing iterations to do.") -// apiObjectFuzzer can randomly populate api objects. -var apiObjectFuzzer = fuzz.New().NilChance(.5).NumElements(1, 1).Funcs( - func(j *runtime.PluginBase, c fuzz.Continue) { - // Do nothing; this struct has only a Kind field and it must stay blank in memory. - }, - func(j *runtime.TypeMeta, c fuzz.Continue) { - // We have to customize the randomization of TypeMetas because their - // APIVersion and Kind must remain blank in memory. - j.APIVersion = "" - j.Kind = "" - }, - func(j *api.TypeMeta, c fuzz.Continue) { - // We have to customize the randomization of TypeMetas because their - // APIVersion and Kind must remain blank in memory. - j.APIVersion = "" - j.Kind = "" - }, - func(j *api.ObjectMeta, c fuzz.Continue) { - j.Name = c.RandString() - j.ResourceVersion = strconv.FormatUint(c.RandUint64(), 10) - j.SelfLink = c.RandString() +// fuzzerFor can randomly populate api objects that are destined for version. +func fuzzerFor(t *testing.T, version string, src rand.Source) *fuzz.Fuzzer { + f := fuzz.New().NilChance(.5).NumElements(1, 1) + if src != nil { + f.RandSource(src) + } + f.Funcs( + func(j *runtime.PluginBase, c fuzz.Continue) { + // Do nothing; this struct has only a Kind field and it must stay blank in memory. + }, + func(j *runtime.TypeMeta, c fuzz.Continue) { + // We have to customize the randomization of TypeMetas because their + // APIVersion and Kind must remain blank in memory. + j.APIVersion = "" + j.Kind = "" + }, + func(j *api.TypeMeta, c fuzz.Continue) { + // We have to customize the randomization of TypeMetas because their + // APIVersion and Kind must remain blank in memory. + j.APIVersion = "" + j.Kind = "" + }, + func(j *api.ObjectMeta, c fuzz.Continue) { + j.Name = c.RandString() + j.ResourceVersion = strconv.FormatUint(c.RandUint64(), 10) + j.SelfLink = c.RandString() - var sec, nsec int64 - c.Fuzz(&sec) - c.Fuzz(&nsec) - j.CreationTimestamp = util.Unix(sec, nsec).Rfc3339Copy() - }, - func(j *api.ListMeta, c fuzz.Continue) { - j.ResourceVersion = strconv.FormatUint(c.RandUint64(), 10) - j.SelfLink = c.RandString() - }, - func(j *api.PodPhase, c fuzz.Continue) { - statuses := []api.PodPhase{api.PodPending, api.PodRunning, api.PodFailed, api.PodUnknown} - *j = statuses[c.Rand.Intn(len(statuses))] - }, - func(j *api.ReplicationControllerSpec, c fuzz.Continue) { - // TemplateRef must be nil for round trip - c.Fuzz(&j.Template) - if j.Template == nil { - // TODO: v1beta1/2 can't round trip a nil template correctly, fix by having v1beta1/2 - // conversion compare converted object to nil via DeepEqual - j.Template = &api.PodTemplateSpec{} - } - j.Template.ObjectMeta = api.ObjectMeta{Labels: j.Template.ObjectMeta.Labels} - j.Template.Spec.NodeSelector = nil - c.Fuzz(&j.Selector) - j.Replicas = int(c.RandUint64()) - }, - func(j *api.ReplicationControllerStatus, c fuzz.Continue) { - // only replicas round trips - j.Replicas = int(c.RandUint64()) - }, - func(j *api.List, c fuzz.Continue) { - c.Fuzz(&j.ListMeta) - c.Fuzz(&j.Items) - if j.Items == nil { - j.Items = []runtime.Object{} - } - }, - func(j *runtime.Object, c fuzz.Continue) { - if c.RandBool() { - *j = &runtime.Unknown{ - TypeMeta: runtime.TypeMeta{Kind: "Something", APIVersion: "unknown"}, - RawJSON: []byte(`{"apiVersion":"unknown","kind":"Something","someKey":"someValue"}`), + var sec, nsec int64 + c.Fuzz(&sec) + c.Fuzz(&nsec) + j.CreationTimestamp = util.Unix(sec, nsec).Rfc3339Copy() + }, + func(j *api.ListMeta, c fuzz.Continue) { + j.ResourceVersion = strconv.FormatUint(c.RandUint64(), 10) + j.SelfLink = c.RandString() + }, + func(j *api.PodPhase, c fuzz.Continue) { + statuses := []api.PodPhase{api.PodPending, api.PodRunning, api.PodFailed, api.PodUnknown} + *j = statuses[c.Rand.Intn(len(statuses))] + }, + func(j *api.ReplicationControllerSpec, c fuzz.Continue) { + // TemplateRef must be nil for round trip + c.Fuzz(&j.Template) + if j.Template == nil { + // TODO: v1beta1/2 can't round trip a nil template correctly, fix by having v1beta1/2 + // conversion compare converted object to nil via DeepEqual + j.Template = &api.PodTemplateSpec{} } - } else { - types := []runtime.Object{&api.Pod{}, &api.ReplicationController{}} - t := types[c.Rand.Intn(len(types))] - c.Fuzz(t) - *j = t - } - }, - func(intstr *util.IntOrString, c fuzz.Continue) { - // util.IntOrString will panic if its kind is set wrong. - if c.RandBool() { - intstr.Kind = util.IntstrInt - intstr.IntVal = int(c.RandUint64()) - intstr.StrVal = "" - } else { - intstr.Kind = util.IntstrString - intstr.IntVal = 0 - intstr.StrVal = c.RandString() - } - }, - func(pb map[docker.Port][]docker.PortBinding, c fuzz.Continue) { - // This is necessary because keys with nil values get omitted. - // TODO: Is this a bug? - pb[docker.Port(c.RandString())] = []docker.PortBinding{ - {c.RandString(), c.RandString()}, - {c.RandString(), c.RandString()}, - } - }, - func(pm map[string]docker.PortMapping, c fuzz.Continue) { - // This is necessary because keys with nil values get omitted. - // TODO: Is this a bug? - pm[c.RandString()] = docker.PortMapping{ - c.RandString(): c.RandString(), - } - }, + j.Template.ObjectMeta = api.ObjectMeta{Labels: j.Template.ObjectMeta.Labels} + j.Template.Spec.NodeSelector = nil + c.Fuzz(&j.Selector) + j.Replicas = int(c.RandUint64()) + }, + func(j *api.ReplicationControllerStatus, c fuzz.Continue) { + // only replicas round trips + j.Replicas = int(c.RandUint64()) + }, + func(j *api.List, c fuzz.Continue) { + c.Fuzz(&j.ListMeta) + c.Fuzz(&j.Items) + if j.Items == nil { + j.Items = []runtime.Object{} + } + }, + func(j *runtime.Object, c fuzz.Continue) { + if c.RandBool() { + *j = &runtime.Unknown{ + TypeMeta: runtime.TypeMeta{Kind: "Something", APIVersion: "unknown"}, + RawJSON: []byte(`{"apiVersion":"unknown","kind":"Something","someKey":"someValue"}`), + } + } else { + types := []runtime.Object{&api.Pod{}, &api.ReplicationController{}} + t := types[c.Rand.Intn(len(types))] + c.Fuzz(t) + *j = t + } + }, + func(intstr *util.IntOrString, c fuzz.Continue) { + // util.IntOrString will panic if its kind is set wrong. + if c.RandBool() { + intstr.Kind = util.IntstrInt + intstr.IntVal = int(c.RandUint64()) + intstr.StrVal = "" + } else { + intstr.Kind = util.IntstrString + intstr.IntVal = 0 + intstr.StrVal = c.RandString() + } + }, + func(pb map[docker.Port][]docker.PortBinding, c fuzz.Continue) { + // This is necessary because keys with nil values get omitted. + // TODO: Is this a bug? + pb[docker.Port(c.RandString())] = []docker.PortBinding{ + {c.RandString(), c.RandString()}, + {c.RandString(), c.RandString()}, + } + }, + func(pm map[string]docker.PortMapping, c fuzz.Continue) { + // This is necessary because keys with nil values get omitted. + // TODO: Is this a bug? + pm[c.RandString()] = docker.PortMapping{ + c.RandString(): c.RandString(), + } + }, - func(q *resource.Quantity, c fuzz.Continue) { - // Real Quantity fuzz testing is done elsewhere; - // this limited subset of functionality survives - // round-tripping to v1beta1/2. - q.Amount = &inf.Dec{} - q.Format = resource.DecimalExponent - //q.Amount.SetScale(inf.Scale(-c.Intn(12))) - q.Amount.SetUnscaled(c.Int63n(1000)) - }, -) + func(q *resource.Quantity, c fuzz.Continue) { + // Real Quantity fuzz testing is done elsewhere; + // this limited subset of functionality survives + // round-tripping to v1beta1/2. + q.Amount = &inf.Dec{} + q.Format = resource.DecimalExponent + //q.Amount.SetScale(inf.Scale(-c.Intn(12))) + q.Amount.SetUnscaled(c.Int63n(1000)) + }, + ) + return f +} -func runTest(t *testing.T, codec runtime.Codec, source runtime.Object) { - name := reflect.TypeOf(source).Elem().Name() - apiObjectFuzzer.Fuzz(source) - j, err := meta.Accessor(source) +func fuzzInternalObject(t *testing.T, forVersion string, item runtime.Object, seed int64) runtime.Object { + fuzzerFor(t, forVersion, rand.NewSource(seed)).Fuzz(item) + + j, err := meta.Accessor(item) if err != nil { - t.Fatalf("Unexpected error %v for %#v", err, source) + t.Fatalf("Unexpected error %v for %#v", err, item) } j.SetKind("") j.SetAPIVersion("") - data, err := codec.Encode(source) + return item +} + +func roundTrip(t *testing.T, codec runtime.Codec, item runtime.Object) { + name := reflect.TypeOf(item).Elem().Name() + data, err := codec.Encode(item) if err != nil { - t.Errorf("%v: %v (%#v)", name, err, source) + t.Errorf("%v: %v (%#v)", name, err, item) return } obj2, err := codec.Decode(data) if err != nil { - t.Errorf("0: %v: %v\nCodec: %v\nData: %s\nSource: %#v", name, err, codec, string(data), source) + t.Errorf("0: %v: %v\nCodec: %v\nData: %s\nSource: %#v", name, err, codec, string(data), item) return } - if !api.Semantic.DeepEqual(source, obj2) { - t.Errorf("1: %v: diff: %v\nCodec: %v\nData: %s\nSource: %#v", name, util.ObjectGoPrintDiff(source, obj2), codec, string(data), source) + if !api.Semantic.DeepEqual(item, obj2) { + t.Errorf("1: %v: diff: %v\nCodec: %v\nData: %s\nSource: %#v\nFinal: %#v", name, util.ObjectGoPrintDiff(item, obj2), codec, string(data), item, obj2) return } - obj3 := reflect.New(reflect.TypeOf(source).Elem()).Interface().(runtime.Object) + obj3 := reflect.New(reflect.TypeOf(item).Elem()).Interface().(runtime.Object) err = codec.DecodeInto(data, obj3) if err != nil { t.Errorf("2: %v: %v", name, err) return } - if !api.Semantic.DeepEqual(source, obj3) { - t.Errorf("3: %v: diff: %v\nCodec: %v", name, util.ObjectDiff(source, obj3), codec) + if !api.Semantic.DeepEqual(item, obj3) { + t.Errorf("3: %v: diff: %v\nCodec: %v", name, util.ObjectDiff(item, obj3), codec) return } } +// roundTripSame verifies the same source object is tested in all API versions. +func roundTripSame(t *testing.T, item runtime.Object) { + seed := rand.Int63() + fuzzInternalObject(t, "", item, seed) + roundTrip(t, v1beta1.Codec, item) + roundTrip(t, v1beta2.Codec, item) + fuzzInternalObject(t, "v1beta3", item, seed) + roundTrip(t, v1beta3.Codec, item) +} + +func roundTripAll(t *testing.T, item runtime.Object) { + seed := rand.Int63() + roundTrip(t, v1beta1.Codec, fuzzInternalObject(t, "v1beta1", item, seed)) + roundTrip(t, v1beta2.Codec, fuzzInternalObject(t, "v1beta2", item, seed)) + roundTrip(t, v1beta3.Codec, fuzzInternalObject(t, "v1beta3", item, seed)) +} + // For debugging problems func TestSpecificKind(t *testing.T) { api.Scheme.Log(t) + defer api.Scheme.Log(nil) + kind := "PodList" item, err := api.Scheme.New("", kind) if err != nil { t.Errorf("Couldn't make a %v? %v", kind, err) return } - runTest(t, v1beta1.Codec, item) - runTest(t, v1beta2.Codec, item) - api.Scheme.Log(nil) + roundTripSame(t, item) } func TestList(t *testing.T) { api.Scheme.Log(t) + defer api.Scheme.Log(nil) + kind := "List" item, err := api.Scheme.New("", kind) if err != nil { t.Errorf("Couldn't make a %v? %v", kind, err) return } - runTest(t, v1beta1.Codec, item) - runTest(t, v1beta2.Codec, item) - api.Scheme.Log(nil) + roundTripSame(t, item) } -var nonRoundTrippableTypes = util.NewStringSet("ContainerManifest") +var nonRoundTrippableTypes = util.NewStringSet("ContainerManifest", "ContainerManifestList") var nonInternalRoundTrippableTypes = util.NewStringSet("List") func TestRoundTripTypes(t *testing.T) { + // api.Scheme.Log(t) + // defer api.Scheme.Log(nil) + for kind := range api.Scheme.KnownTypes("") { if nonRoundTrippableTypes.Has(kind) { continue @@ -233,10 +267,9 @@ func TestRoundTripTypes(t *testing.T) { if _, err := meta.Accessor(item); err != nil { t.Fatalf("%q is not a TypeMeta and cannot be tested - add it to nonRoundTrippableTypes: %v", kind, err) } - runTest(t, v1beta1.Codec, item) - runTest(t, v1beta2.Codec, item) + roundTripSame(t, item) if !nonInternalRoundTrippableTypes.Has(kind) { - runTest(t, api.Codec, item) + roundTrip(t, api.Codec, fuzzInternalObject(t, "", item, rand.Int63())) } } } @@ -281,7 +314,7 @@ const benchmarkSeed = 100 func BenchmarkEncode(b *testing.B) { pod := api.Pod{} - apiObjectFuzzer.RandSource(rand.NewSource(benchmarkSeed)) + apiObjectFuzzer := fuzzerFor(nil, "", rand.NewSource(benchmarkSeed)) apiObjectFuzzer.Fuzz(&pod) for i := 0; i < b.N; i++ { latest.Codec.Encode(&pod) @@ -291,7 +324,7 @@ func BenchmarkEncode(b *testing.B) { // BenchmarkEncodeJSON provides a baseline for regular JSON encode performance func BenchmarkEncodeJSON(b *testing.B) { pod := api.Pod{} - apiObjectFuzzer.RandSource(rand.NewSource(benchmarkSeed)) + apiObjectFuzzer := fuzzerFor(nil, "", rand.NewSource(benchmarkSeed)) apiObjectFuzzer.Fuzz(&pod) for i := 0; i < b.N; i++ { json.Marshal(&pod) @@ -300,7 +333,7 @@ func BenchmarkEncodeJSON(b *testing.B) { func BenchmarkDecode(b *testing.B) { pod := api.Pod{} - apiObjectFuzzer.RandSource(rand.NewSource(benchmarkSeed)) + apiObjectFuzzer := fuzzerFor(nil, "", rand.NewSource(benchmarkSeed)) apiObjectFuzzer.Fuzz(&pod) data, _ := latest.Codec.Encode(&pod) for i := 0; i < b.N; i++ { @@ -310,7 +343,7 @@ func BenchmarkDecode(b *testing.B) { func BenchmarkDecodeInto(b *testing.B) { pod := api.Pod{} - apiObjectFuzzer.RandSource(rand.NewSource(benchmarkSeed)) + apiObjectFuzzer := fuzzerFor(nil, "", rand.NewSource(benchmarkSeed)) apiObjectFuzzer.Fuzz(&pod) data, _ := latest.Codec.Encode(&pod) for i := 0; i < b.N; i++ { @@ -322,7 +355,7 @@ func BenchmarkDecodeInto(b *testing.B) { // BenchmarkDecodeJSON provides a baseline for regular JSON decode performance func BenchmarkDecodeJSON(b *testing.B) { pod := api.Pod{} - apiObjectFuzzer.RandSource(rand.NewSource(benchmarkSeed)) + apiObjectFuzzer := fuzzerFor(nil, "", rand.NewSource(benchmarkSeed)) apiObjectFuzzer.Fuzz(&pod) data, _ := latest.Codec.Encode(&pod) for i := 0; i < b.N; i++ { diff --git a/pkg/client/client.go b/pkg/client/client.go index 84adb91592b..8a92fc6ce3f 100644 --- a/pkg/client/client.go +++ b/pkg/client/client.go @@ -40,7 +40,7 @@ type Interface interface { } func (c *Client) ReplicationControllers(namespace string) ReplicationControllerInterface { - return newReplicationControllers(c, namespace, c.preV1Beta3) + return newReplicationControllers(c, namespace) } func (c *Client) Nodes() NodeInterface {