From 48994c1518982143de81ccec555f6b947f8d8d8f Mon Sep 17 00:00:00 2001 From: Joe Julian Date: Tue, 14 Dec 2021 17:11:54 -0800 Subject: [PATCH 1/2] add test to dry-run for unwanted generated values [kep 576, dry run](https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/576-dry-run/README.md#generated-values), states: ``` The UID and the generated name would have a different value in a dry-run and non-dry-run creation. These values will be left empty when performing a dry-run. ``` and ``` ResourceVersion will also be left empty on creation ``` This tests ensures this behavior. --- test/integration/dryrun/dryrun_test.go | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/test/integration/dryrun/dryrun_test.go b/test/integration/dryrun/dryrun_test.go index aa6138a7892..95897b90e70 100644 --- a/test/integration/dryrun/dryrun_test.go +++ b/test/integration/dryrun/dryrun_test.go @@ -46,16 +46,33 @@ var kindAllowList = sets.NewString() // namespace used for all tests, do not change this const testNamespace = "dryrunnamespace" +func DryRunCreateWithGenerateNameTest(t *testing.T, rsc dynamic.ResourceInterface, obj *unstructured.Unstructured, gvResource schema.GroupVersionResource) { + // Create a new object with generateName + gnObj := obj.DeepCopy() + gnObj.SetGenerateName(obj.GetName() + "-") + gnObj.SetName("") + DryRunCreateTest(t, rsc, gnObj, gvResource) +} + func DryRunCreateTest(t *testing.T, rsc dynamic.ResourceInterface, obj *unstructured.Unstructured, gvResource schema.GroupVersionResource) { createdObj, err := rsc.Create(context.TODO(), obj, metav1.CreateOptions{DryRun: []string{metav1.DryRunAll}}) if err != nil { - t.Fatalf("failed to dry-run create stub for %s: %#v", gvResource, err) + t.Fatalf("failed to dry-run create stub for %s: %#v: %v", gvResource, err, obj) } if obj.GroupVersionKind() != createdObj.GroupVersionKind() { t.Fatalf("created object doesn't have the same gvk as original object: got %v, expected %v", createdObj.GroupVersionKind(), obj.GroupVersionKind()) } + if createdObj.GetUID() != "" { + t.Fatalf("created object shouldn't have a uid: %v", createdObj) + } + if createdObj.GetResourceVersion() != "" { + t.Fatalf("created object shouldn't have a resource version: %v", createdObj) + } + if obj.GetGenerateName() != "" && createdObj.GetName() != "" { + t.Fatalf("created object's name should be an empty string if using GenerateName: %v", createdObj) + } if _, err := rsc.Get(context.TODO(), obj.GetName(), metav1.GetOptions{}); !apierrors.IsNotFound(err) { t.Fatalf("object shouldn't exist: %v", err) @@ -282,6 +299,7 @@ func TestDryRun(t *testing.T) { name := obj.GetName() DryRunCreateTest(t, rsc, obj, gvResource) + DryRunCreateWithGenerateNameTest(t, rsc, obj, gvResource) if _, err := rsc.Create(context.TODO(), obj, metav1.CreateOptions{}); err != nil { t.Fatalf("failed to create stub for %s: %#v", gvResource, err) From 60c1d58d02c7374645c00281dda3fd656264e1c5 Mon Sep 17 00:00:00 2001 From: Joe Julian Date: Thu, 16 Dec 2021 12:44:02 -0800 Subject: [PATCH 2/2] remove unwanted values returned from dry-run Remove the uid and the resourceVersion from dry-run results per kep 576 https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/576-dry-run/README.md#generated-values --- .../pkg/registry/generic/registry/store.go | 5 +++ .../apiserver/pkg/util/dryrun/dryrun.go | 34 +++++++++++++++++++ test/integration/dryrun/dryrun_test.go | 14 ++++++-- 3 files changed, 50 insertions(+), 3 deletions(-) diff --git a/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store.go b/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store.go index eb15cf5fc82..ca29106f678 100644 --- a/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store.go +++ b/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store.go @@ -433,6 +433,11 @@ func (e *Store) Create(ctx context.Context, obj runtime.Object, createValidation if e.Decorator != nil { e.Decorator(out) } + if dryrun.IsDryRun(options.DryRun) { + if err := dryrun.ResetMetadata(obj, out); err != nil { + return nil, err + } + } return out, nil } diff --git a/staging/src/k8s.io/apiserver/pkg/util/dryrun/dryrun.go b/staging/src/k8s.io/apiserver/pkg/util/dryrun/dryrun.go index 3e28c293453..f94542b65da 100644 --- a/staging/src/k8s.io/apiserver/pkg/util/dryrun/dryrun.go +++ b/staging/src/k8s.io/apiserver/pkg/util/dryrun/dryrun.go @@ -16,7 +16,41 @@ limitations under the License. package dryrun +import ( + "k8s.io/apimachinery/pkg/api/errors" + "k8s.io/apimachinery/pkg/api/meta" + "k8s.io/apimachinery/pkg/runtime" +) + // IsDryRun returns true if the DryRun flag is an actual dry-run. func IsDryRun(flag []string) bool { return len(flag) > 0 } + +// ResetMetadata resets metadata fields that are not allowed to be set by dry-run. +func ResetMetadata(originalObj, newObj runtime.Object) error { + originalObjMeta, err := meta.Accessor(originalObj) + if err != nil { + return errors.NewInternalError(err) + } + newObjMeta, err := meta.Accessor(newObj) + if err != nil { + return errors.NewInternalError(err) + } + // If a resource is created with dry-run enabled where generateName is set, the + // store will set the name to the generated name. We need to reset the name and restore + // the generateName metadata fields in order for the returned object to match the intent + // of the original template. + if originalObjMeta.GetGenerateName() != "" { + newObjMeta.SetName("") + } + newObjMeta.SetGenerateName(originalObjMeta.GetGenerateName()) + // If UID is set in the dry-run output then that output cannot be used to create a resource. Reset + // the UID to allow the output to be used to create resources. + newObjMeta.SetUID("") + // If the resourceVersion is set in the dry-run output then that output cannot be used to create + // a resource. Reset the resourceVersion to allow the output to be used to create resources. + newObjMeta.SetResourceVersion("") + + return nil +} diff --git a/test/integration/dryrun/dryrun_test.go b/test/integration/dryrun/dryrun_test.go index 95897b90e70..6f002c791aa 100644 --- a/test/integration/dryrun/dryrun_test.go +++ b/test/integration/dryrun/dryrun_test.go @@ -18,6 +18,7 @@ package dryrun import ( "context" + "strings" "testing" v1 "k8s.io/api/core/v1" @@ -47,7 +48,11 @@ var kindAllowList = sets.NewString() const testNamespace = "dryrunnamespace" func DryRunCreateWithGenerateNameTest(t *testing.T, rsc dynamic.ResourceInterface, obj *unstructured.Unstructured, gvResource schema.GroupVersionResource) { - // Create a new object with generateName + // special resources with dots in the name cannot use generateName + if strings.Contains(obj.GetName(), ".") { + return + } + // Create a new object with generateName to ensure we don't taint the original object gnObj := obj.DeepCopy() gnObj.SetGenerateName(obj.GetName() + "-") gnObj.SetName("") @@ -74,8 +79,11 @@ func DryRunCreateTest(t *testing.T, rsc dynamic.ResourceInterface, obj *unstruct t.Fatalf("created object's name should be an empty string if using GenerateName: %v", createdObj) } - if _, err := rsc.Get(context.TODO(), obj.GetName(), metav1.GetOptions{}); !apierrors.IsNotFound(err) { - t.Fatalf("object shouldn't exist: %v", err) + // we won't have a generated name here, so we won't check for this case + if obj.GetGenerateName() == "" { + if _, err := rsc.Get(context.TODO(), obj.GetName(), metav1.GetOptions{}); !apierrors.IsNotFound(err) { + t.Fatalf("object shouldn't exist: %v, %v", obj, err) + } } }