Merge pull request #136921 from dims/dump-from-utils

Move dump package from apimachinery to k8s.io/utils Kubernetes-commit: 5b63a8c68e8e4d417ab3758c7a80118c2db27ac9
Merge pull request #135395 from pohly/apimachinery-wait-for-cache-sync
2026-02-15 00:07:52 +08:00 · 2026-02-12 21:25:53 +00:00 · 2026-02-11 09:19:44 +00:00 · 2026-02-10 22:08:40 +00:00 · 2026-02-10 15:20:41 -05:00 · 2026-02-10 00:34:08 +00:00
4 changed files with 93 additions and 42 deletions
--- a/go.mod
+++ b/go.mod
@@ -8,14 +8,14 @@ godebug default=go1.25

 require (
 	golang.org/x/time v0.14.0
-	k8s.io/api v0.0.0-20260205193817-6f99b47a2bbd
-	k8s.io/apimachinery v0.0.0-20260205233455-f12546b4989d
-	k8s.io/client-go v0.0.0-20260206035242-67ce5196123a
-	k8s.io/code-generator v0.0.0-20260206040502-0f34ff6ed017
+	k8s.io/api v0.0.0-20260212204713-44213e038791
+	k8s.io/apimachinery v0.0.0-20260212204335-aed281c35483
+	k8s.io/client-go v0.0.0-20260212205228-7aaede787267
+	k8s.io/code-generator v0.0.0-20260212210152-c9a3346aa756
 	k8s.io/klog/v2 v2.130.1
 	k8s.io/kube-openapi v0.0.0-20260127142750-a19766b6e2d4
-	k8s.io/utils v0.0.0-20260108192941-914a6e750570
-	sigs.k8s.io/structured-merge-diff/v6 v6.3.1
+	k8s.io/utils v0.0.0-20260210185600-b8788abfbbc2
+	sigs.k8s.io/structured-merge-diff/v6 v6.3.2
 )

 require (
--- a/go.sum
+++ b/go.sum
@@ -115,27 +115,27 @@ gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-k8s.io/api v0.0.0-20260205193817-6f99b47a2bbd h1:tgzQul+6n5AQYpFcrhpV9fn7dLVlLG7J+7GkXPe8LOg=
-k8s.io/api v0.0.0-20260205193817-6f99b47a2bbd/go.mod h1:GZUpeSi8zsYiS/GDA9jMt0/+n6PAFNj8Z/eK2Rd/IvQ=
-k8s.io/apimachinery v0.0.0-20260205233455-f12546b4989d h1:bxuu4ynFTom/p7dq3+D7rcM500tuOXgMoEY7OqtmboE=
-k8s.io/apimachinery v0.0.0-20260205233455-f12546b4989d/go.mod h1:hQkG060WLAG1TIkYsu5lj3tb6YdNpKe5Zrr2UPGg+/k=
-k8s.io/client-go v0.0.0-20260206035242-67ce5196123a h1:auN2L5YlnujjNGN4fRrWZdEbXbCwdNM+C3yH7NFov3s=
-k8s.io/client-go v0.0.0-20260206035242-67ce5196123a/go.mod h1:hsICy6wbUdtAQzzHyhNbTFeOKp9Uzdt5AYPPFwF+ucQ=
-k8s.io/code-generator v0.0.0-20260206040502-0f34ff6ed017 h1:dQ/S71ndt9MkU9hpmBueo9pNLxCit1LHWlCtFGDJmM4=
-k8s.io/code-generator v0.0.0-20260206040502-0f34ff6ed017/go.mod h1:KP4dpswTGq3absCF0P5pjfVrV/FEwgyhgo4pPaBsrxI=
+k8s.io/api v0.0.0-20260212204713-44213e038791 h1:EmU9p9/78PfLzMIiBR7jLGrBDWQadw9sP0N0cwxhPWw=
+k8s.io/api v0.0.0-20260212204713-44213e038791/go.mod h1:lqM03fgO3Hxw6VR9c5bLCKvc1v/PIcun8qcqYrhZJeU=
+k8s.io/apimachinery v0.0.0-20260212204335-aed281c35483 h1:t6T/l7vW88+5v57Tp3Vnwg9WYfPaydspTn+V3YNGCP0=
+k8s.io/apimachinery v0.0.0-20260212204335-aed281c35483/go.mod h1:7mgr/dli8ofwAbcIQXetFVX1fbOYsOYojq3AUbybVmQ=
+k8s.io/client-go v0.0.0-20260212205228-7aaede787267 h1:aGYlF0Fs64sW91eYl5fkcjpmufNMWpVjczBJKwsWBe0=
+k8s.io/client-go v0.0.0-20260212205228-7aaede787267/go.mod h1:1O9M9BLxIBTUHXSOdPux8rk9Iw0qtGJvWp1Y80EX9c8=
+k8s.io/code-generator v0.0.0-20260212210152-c9a3346aa756 h1:O0MAofdXy+S56W1Gp9fFQSn/5//zVAdQTmWiUQa9rLM=
+k8s.io/code-generator v0.0.0-20260212210152-c9a3346aa756/go.mod h1:G8ZQHj4mTDmCxTF7/RjqEJxGg0O6KxuCJ8+EygZuzK0=
 k8s.io/gengo/v2 v2.0.0-20250922181213-ec3ebc5fd46b h1:gMplByicHV/TJBizHd9aVEsTYoJBnnUAT5MHlTkbjhQ=
 k8s.io/gengo/v2 v2.0.0-20250922181213-ec3ebc5fd46b/go.mod h1:CgujABENc3KuTrcsdpGmrrASjtQsWCT7R99mEV4U/fM=
 k8s.io/klog/v2 v2.130.1 h1:n9Xl7H1Xvksem4KFG4PYbdQCQxqc/tTUyrgXaOhHSzk=
 k8s.io/klog/v2 v2.130.1/go.mod h1:3Jpz1GvMt720eyJH1ckRHK1EDfpxISzJ7I9OYgaDtPE=
 k8s.io/kube-openapi v0.0.0-20260127142750-a19766b6e2d4 h1:HhDfevmPS+OalTjQRKbTHppRIz01AWi8s45TMXStgYY=
 k8s.io/kube-openapi v0.0.0-20260127142750-a19766b6e2d4/go.mod h1:kdmbQkyfwUagLfXIad1y2TdrjPFWp2Q89B3qkRwf/pQ=
-k8s.io/utils v0.0.0-20260108192941-914a6e750570 h1:JT4W8lsdrGENg9W+YwwdLJxklIuKWdRm+BC+xt33FOY=
-k8s.io/utils v0.0.0-20260108192941-914a6e750570/go.mod h1:xDxuJ0whA3d0I4mf/C4ppKHxXynQ+fxnkmQH0vTHnuk=
+k8s.io/utils v0.0.0-20260210185600-b8788abfbbc2 h1:AZYQSJemyQB5eRxqcPky+/7EdBj0xi3g0ZcxxJ7vbWU=
+k8s.io/utils v0.0.0-20260210185600-b8788abfbbc2/go.mod h1:xDxuJ0whA3d0I4mf/C4ppKHxXynQ+fxnkmQH0vTHnuk=
 sigs.k8s.io/json v0.0.0-20250730193827-2d320260d730 h1:IpInykpT6ceI+QxKBbEflcR5EXP7sU1kvOlxwZh5txg=
 sigs.k8s.io/json v0.0.0-20250730193827-2d320260d730/go.mod h1:mdzfpAEoE6DHQEN0uh9ZbOCuHbLK5wOm7dK4ctXE9Tg=
 sigs.k8s.io/randfill v1.0.0 h1:JfjMILfT8A6RbawdsK2JXGBR5AQVfd+9TbzrlneTyrU=
 sigs.k8s.io/randfill v1.0.0/go.mod h1:XeLlZ/jmk4i1HRopwe7/aU3H5n1zNUcX6TM94b3QxOY=
-sigs.k8s.io/structured-merge-diff/v6 v6.3.1 h1:JrhdFMqOd/+3ByqlP2I45kTOZmTRLBUm5pvRjeheg7E=
-sigs.k8s.io/structured-merge-diff/v6 v6.3.1/go.mod h1:M3W8sfWvn2HhQDIbGWj3S099YozAsymCo/wrT5ohRUE=
+sigs.k8s.io/structured-merge-diff/v6 v6.3.2 h1:kwVWMx5yS1CrnFWA/2QHyRVJ8jM6dBA80uLmm0wJkk8=
+sigs.k8s.io/structured-merge-diff/v6 v6.3.2/go.mod h1:M3W8sfWvn2HhQDIbGWj3S099YozAsymCo/wrT5ohRUE=
 sigs.k8s.io/yaml v1.6.0 h1:G8fkbMSAFqgEFgh4b1wmtzDnioxFCUgTZhlbj5P9QYs=
 sigs.k8s.io/yaml v1.6.0/go.mod h1:796bPqUfzR/0jLAl6XjHl3Ck7MiyVv8dbTdyT3/pMf4=
--- a/pkg/generated/clientset/versioned/fake/clientset_generated.go
+++ b/pkg/generated/clientset/versioned/fake/clientset_generated.go
@@ -35,10 +35,6 @@ import (
 // It's backed by a very simple object tracker that processes creates, updates and deletions as-is,
 // without applying any field management, validations and/or defaults. It shouldn't be considered a replacement
 // for a real clientset and is mostly useful in simple unit tests.
-//
-// Deprecated: NewClientset replaces this with support for field management, which significantly improves
-// server side apply testing. NewClientset is only available when apply configurations are generated (e.g.
-// via --with-applyconfig).
 func NewSimpleClientset(objects ...runtime.Object) *Clientset {
 	o := testing.NewObjectTracker(scheme, codecs.UniversalDecoder())
 	for _, obj := range objects {
@@ -99,6 +95,10 @@ func (c *Clientset) IsWatchListSemanticsUnSupported() bool {
 // It's backed by a very simple object tracker that processes creates, updates and deletions as-is,
 // without applying any validations and/or defaults. It shouldn't be considered a replacement
 // for a real clientset and is mostly useful in simple unit tests.
+//
+// Compared to NewSimpleClientset, the Clientset returned here supports field tracking and thus
+// server-side apply. Beware though that support in that for CRDs is missing
+// (https://github.com/kubernetes/kubernetes/issues/126850).
 func NewClientset(objects ...runtime.Object) *Clientset {
 	o := testing.NewFieldManagedObjectTracker(
 		scheme,
--- a/pkg/generated/informers/externalversions/factory.go
+++ b/pkg/generated/informers/externalversions/factory.go
@@ -19,6 +19,7 @@ limitations under the License.
 package externalversions

 import (
+	context "context"
 	reflect "reflect"
 	sync "sync"
 	time "time"
@@ -26,6 +27,7 @@ import (
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	runtime "k8s.io/apimachinery/pkg/runtime"
 	schema "k8s.io/apimachinery/pkg/runtime/schema"
+	wait "k8s.io/apimachinery/pkg/util/wait"
 	cache "k8s.io/client-go/tools/cache"
 	versioned "k8s.io/sample-controller/pkg/generated/clientset/versioned"
 	internalinterfaces "k8s.io/sample-controller/pkg/generated/informers/externalversions/internalinterfaces"
@@ -139,6 +141,10 @@ func NewSharedInformerFactoryWithOptions(client versioned.Interface, defaultResy
 }

 func (f *sharedInformerFactory) Start(stopCh <-chan struct{}) {
+	f.StartWithContext(wait.ContextForChannel(stopCh))
+}
+
+func (f *sharedInformerFactory) StartWithContext(ctx context.Context) {
 	f.lock.Lock()
 	defer f.lock.Unlock()

@@ -148,15 +154,9 @@ func (f *sharedInformerFactory) Start(stopCh <-chan struct{}) {

 	for informerType, informer := range f.informers {
 		if !f.startedInformers[informerType] {
-			f.wg.Add(1)
-			// We need a new variable in each loop iteration,
-			// otherwise the goroutine would use the loop variable
-			// and that keeps changing.
-			informer := informer
-			go func() {
-				defer f.wg.Done()
-				informer.Run(stopCh)
-			}()
+			f.wg.Go(func() {
+				informer.RunWithContext(ctx)
+			})
 			f.startedInformers[informerType] = true
 		}
 	}
@@ -173,6 +173,11 @@ func (f *sharedInformerFactory) Shutdown() {
 }

 func (f *sharedInformerFactory) WaitForCacheSync(stopCh <-chan struct{}) map[reflect.Type]bool {
+	result := f.WaitForCacheSyncWithContext(wait.ContextForChannel(stopCh))
+	return result.Synced
+}
+
+func (f *sharedInformerFactory) WaitForCacheSyncWithContext(ctx context.Context) cache.SyncResult {
 	informers := func() map[reflect.Type]cache.SharedIndexInformer {
 		f.lock.Lock()
 		defer f.lock.Unlock()
@@ -186,10 +191,31 @@ func (f *sharedInformerFactory) WaitForCacheSync(stopCh <-chan struct{}) map[ref
 		return informers
 	}()

-	res := map[reflect.Type]bool{}
-	for informType, informer := range informers {
-		res[informType] = cache.WaitForCacheSync(stopCh, informer.HasSynced)
+	// Wait for informers to sync, without polling.
+	cacheSyncs := make([]cache.DoneChecker, 0, len(informers))
+	for _, informer := range informers {
+		cacheSyncs = append(cacheSyncs, informer.HasSyncedChecker())
 	}
+	cache.WaitFor(ctx, "" /* no logging */, cacheSyncs...)
+
+	res := cache.SyncResult{
+		Synced: make(map[reflect.Type]bool, len(informers)),
+	}
+	failed := false
+	for informType, informer := range informers {
+		hasSynced := informer.HasSynced()
+		if !hasSynced {
+			failed = true
+		}
+		res.Synced[informType] = hasSynced
+	}
+	if failed {
+		// context.Cause is more informative than ctx.Err().
+		// This must be non-nil, otherwise WaitFor wouldn't have stopped
+		// prematurely.
+		res.Err = context.Cause(ctx)
+	}
+
 	return res
 }

@@ -228,27 +254,46 @@ func (f *sharedInformerFactory) InformerFor(obj runtime.Object, newFunc internal
 //	defer factory.WaitForStop()    // Returns immediately if nothing was started.
 //	genericInformer := factory.ForResource(resource)
 //	typedInformer := factory.SomeAPIGroup().V1().SomeType()
-//	factory.Start(ctx.Done())          // Start processing these informers.
-//	synced := factory.WaitForCacheSync(ctx.Done())
-//	for v, ok := range synced {
-//	    if !ok {
-//	        fmt.Fprintf(os.Stderr, "caches failed to sync: %v", v)
-//	        return
-//	    }
+//	handle, err := typeInformer.Informer().AddEventHandler(...)
+//	if err != nil {
+//	    return fmt.Errorf("register event handler: %v", err)
+//	}
+//	defer typeInformer.Informer().RemoveEventHandler(handle) // Avoids leaking goroutines.
+//	factory.StartWithContext(ctx)                            // Start processing these informers.
+//	synced := factory.WaitForCacheSyncWithContext(ctx)
+//	if err := synced.AsError(); err != nil {
+//	    return err
+//	}
+//	for v := range synced {
+//	    // Only if desired log some information similar to this.
+//	    fmt.Fprintf(os.Stdout, "cache synced: %s", v)
+//	}
+//
+//	// Also make sure that all of the initial cache events have been delivered.
+//	if !WaitFor(ctx, "event handler sync", handle.HasSyncedChecker()) {
+//	    // Must have failed because of context.
+//	    return fmt.Errorf("sync event handler: %w", context.Cause(ctx))
 //	}
 //
 //	// Creating informers can also be created after Start, but then
 //	// Start must be called again:
 //	anotherGenericInformer := factory.ForResource(resource)
-//	factory.Start(ctx.Done())
+//	factory.StartWithContext(ctx)
 type SharedInformerFactory interface {
 	internalinterfaces.SharedInformerFactory

 	// Start initializes all requested informers. They are handled in goroutines
 	// which run until the stop channel gets closed.
 	// Warning: Start does not block. When run in a go-routine, it will race with a later WaitForCacheSync.
+	//
+	// Contextual logging: StartWithContext should be used instead of Start in code which supports contextual logging.
 	Start(stopCh <-chan struct{})

+	// StartWithContext initializes all requested informers. They are handled in goroutines
+	// which run until the context gets canceled.
+	// Warning: StartWithContext does not block. When run in a go-routine, it will race with a later WaitForCacheSync.
+	StartWithContext(ctx context.Context)
+
 	// Shutdown marks a factory as shutting down. At that point no new
 	// informers can be started anymore and Start will return without
 	// doing anything.
@@ -263,8 +308,14 @@ type SharedInformerFactory interface {

 	// WaitForCacheSync blocks until all started informers' caches were synced
 	// or the stop channel gets closed.
+	//
+	// Contextual logging: WaitForCacheSync should be used instead of WaitForCacheSync in code which supports contextual logging. It also returns a more useful result.
 	WaitForCacheSync(stopCh <-chan struct{}) map[reflect.Type]bool

+	// WaitForCacheSyncWithContext blocks until all started informers' caches were synced
+	// or the context gets canceled.
+	WaitForCacheSyncWithContext(ctx context.Context) cache.SyncResult
+
 	// ForResource gives generic access to a shared informer of the matching type.
 	ForResource(resource schema.GroupVersionResource) (GenericInformer, error)
Author	SHA1	Message	Date
Kubernetes Publisher	4cfc7ddd3e	Merge pull request #136921 from dims/dump-from-utils Move dump package from apimachinery to k8s.io/utils Kubernetes-commit: 5b63a8c68e8e4d417ab3758c7a80118c2db27ac9	2026-02-12 21:25:53 +00:00
Kubernetes Publisher	100f3ac540	Merge pull request #135395 from pohly/apimachinery-wait-for-cache-sync apimachinery + client-go + device taint eviction unit test: context-aware Start/WaitFor, waiting through channels Kubernetes-commit: eb09a3c23e3c3905c89e996fcec2c02ba8c4bb0e	2026-02-11 09:19:44 +00:00
Kubernetes Publisher	b5e36fedcd	Merge pull request #136826 from alvaroaleman/bumpv0.32 Bump structured merge diff to v6.3.2 Kubernetes-commit: 65f09e605cb206b2e5fcff4d69a4ae8acf62dbc3	2026-02-10 22:08:40 +00:00
Davanum Srinivas	b9a13d422d	Move dump package from apimachinery to k8s.io/utils Replace all imports of k8s.io/apimachinery/pkg/util/dump with k8s.io/utils/dump across the repo. The apimachinery dump package now contains deprecated wrapper functions that delegate to k8s.io/utils/dump for backwards compatibility. Signed-off-by: Davanum Srinivas <davanum@gmail.com> Kubernetes-commit: 550cc8645bedcc8b187e0ebeb52ead29d5631a32	2026-02-10 15:20:41 -05:00
Kubernetes Publisher	8202729143	Merge pull request #136455 from pohly/client-go-simpleclient-undeprecation fake client-go: un-deprecate NewSimpleClientset Kubernetes-commit: 09e1c9fe0ec3d3a61fa71c43610b42e1e3f53612	2026-02-10 00:34:08 +00:00
Alvaro Aleman	31c1b60160	Bump structured merge diff to v6.3.2 Diff: https://github.com/kubernetes-sigs/structured-merge-diff/compare/v6.3.1...v6.3.2 It's just one change that prevents a NPD when an embedded pointer to a struct is encountered. Kubernetes-commit: f59cfe60ef2063e2383ebef416f9da05196903d6	2026-02-07 13:49:48 -05:00
Patrick Ohly	2ee58e6c15	fake client-go: un-deprecate NewSimpleClientset NewSimpleClientset was marked as deprecated when NewClientset was introduced. This has caused some confusion: - Not all packages have NewClientset (https://github.com/kubernetes/kubernetes/issues/135980). - Tests that work with NewSimpleClientset fail when switched to NewClientset (https://github.com/kubernetes/kubernetes/issues/136327) because of missing CRD support (https://github.com/kubernetes/kubernetes/issues/126850). It doesn't seem burdensome to keep NewSimpleClientset around forever. Some unit tests may even prefer to use it when they don't need server-side apply (less overhead). Therefore there is no need to deprecate it. This avoids churn in the eco system because contributors no longer create PRs "because the linter complains about the usage of a deprecated function". Kubernetes-commit: e80da21868059f789c90105a00481fa8cef169e1	2026-01-23 11:20:40 +01:00
Patrick Ohly	6c1a55459d	client-go informers: context-aware Start + WaitForCacheSync Passing a context to StartWithContext enables context-aware reflector logging. This is the main remaining source of log spam (output to stderr instead of per-test logger) in controller unit tests. WaitForCacheSynceWithContext takes advantage of the new cache.WaitFor + NamedHasSynced functionality to finish "immediately" (= no virtual time passed) in a synctest bubble. While at it, the return type gets improved so that a failure is easier to handle. Kubernetes-commit: 5ff323de791df88880f6e065f5de4b445e5c90ed	2025-11-21 16:23:44 +01:00