Add ClusterWithContext

Signed-off-by: Nelo-T. Wallus <n.wallus@sap.com>

Author: ntnn

pkg/internal/clientgen/clientset.go

@@ -58,7 +58,7 @@ import (
 	"github.com/kcp-dev/logicalcluster/v3"
 
 	client "{{.singleClusterClientPackagePath}}"
-	
+
 	"k8s.io/client-go/discovery"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/util/flowcontrol"
@@ -91,7 +91,7 @@ func (c *ClusterClientset) Discovery() discovery.DiscoveryInterface {
 }
 
 {{range .groups}}
-// {{.GroupGoName}}{{.Version}} retrieves the {{.GroupGoName}}{{.Version}}ClusterClient.  
+// {{.GroupGoName}}{{.Version}} retrieves the {{.GroupGoName}}{{.Version}}ClusterClient.
 func (c *ClusterClientset) {{.GroupGoName}}{{.Version}}() {{.GoPackageAlias}}.{{.GroupGoName}}{{.Version}}ClusterInterface {
 	return c.{{.GroupGoNameLower}}{{.Version}}
 }
@@ -106,7 +106,7 @@ func (c *ClusterClientset) Cluster(clusterPath logicalcluster.Path) client.Inter
 }
 
 // NewForConfig creates a new ClusterClientset for the given config.
-// If config's RateLimiter is not set and QPS and Burst are acceptable, 
+// If config's RateLimiter is not set and QPS and Burst are acceptable,
 // NewForConfig will generate a rate-limiter in configShallowCopy.
 // NewForConfig is equivalent to NewForConfigAndClient(c, httpClient),
 // where httpClient was generated with rest.HTTPClientFor(c).

pkg/internal/informergen/factory.go

@@ -82,7 +82,7 @@ import (
 	"k8s.io/client-go/tools/cache"
 
 	clientset "{{.clientsetPackagePath}}"
-	{{if not .useUpstreamInterfaces -}}	
+	{{if not .useUpstreamInterfaces -}}
 	scopedclientset "{{.singleClusterClientPackagePath}}"
 	{{end -}}
 	{{if .useUpstreamInterfaces -}}
@@ -265,7 +265,7 @@ func (f *sharedInformerFactory) InformerFor(obj runtime.Object, newFunc internal
 type ScopedDynamicSharedInformerFactory interface {
 	// ForResource gives generic access to a shared informer of the matching type.
 	ForResource(resource schema.GroupVersionResource) ({{if .useUpstreamInterfaces}}upstreaminformers.{{end}}GenericInformer, error)
-	
+
 	// Start initializes all requested informers. They are handled in goroutines
 	// which run until the stop channel gets closed.
 	Start(stopCh <-chan struct{})
@@ -353,7 +353,7 @@ func (f *scopedDynamicSharedInformerFactory) ForResource(resource schema.GroupVe
 	if err != nil {
 		return nil, err
 	}
-	return clusterInformer.Cluster(f.clusterName), nil 
+	return clusterInformer.Cluster(f.clusterName), nil
 }
 
 func (f *scopedDynamicSharedInformerFactory) Start(stopCh <-chan struct{}) {

pkg/internal/informergen/generic.go

@@ -63,6 +63,7 @@ var genericInformer = `
 package informers
 
 import (
+	"context"
 	"fmt"
 
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -81,6 +82,7 @@ import (
 
 type GenericClusterInformer interface {
 	Cluster(logicalcluster.Name) {{if .useUpstreamInterfaces}}upstreaminformers.{{end}}GenericInformer
+	ClusterWithContext(context.Context, logicalcluster.Name) {{if .useUpstreamInterfaces}}upstreaminformers.{{end}}GenericInformer
 	Informer() kcpcache.ScopeableSharedIndexInformer
 	Lister() kcpcache.GenericClusterLister
 }
@@ -115,6 +117,15 @@ func (f *genericClusterInformer) Cluster(clusterName logicalcluster.Name) {{if .
 	}
 }
 
+// ClusterWithContext scopes to a GenericInformer and unregisters all
+// handles registered through it once the provided context is canceled.
+func (f *genericClusterInformer) ClusterWithContext(ctx context.Context, clusterName logicalcluster.Name) {{if .useUpstreamInterfaces}}upstreaminformers.{{end}}GenericInformer {
+	return &genericInformer{
+		informer: f.Informer().ClusterWithContext(ctx, clusterName),
+		lister:   f.Lister().ByCluster(clusterName),
+	}
+}
+
 type genericInformer struct {
 	informer cache.SharedIndexInformer
 	lister   cache.GenericLister

pkg/internal/informergen/informer.go

@@ -108,7 +108,7 @@ import (
 	{{end -}}
 
 	clientset "{{.clientsetPackagePath}}"
-	{{if not .useUpstreamInterfaces -}}	
+	{{if not .useUpstreamInterfaces -}}
 	scopedclientset "{{.singleClusterClientPackagePath}}"
 	{{end -}}
 
@@ -119,6 +119,7 @@ import (
 // {{.kind.Plural}}.
 type {{.kind}}ClusterInformer interface {
 	Cluster(logicalcluster.Name) {{if .useUpstreamInterfaces}}upstream{{.group.GoPackageAlias}}informers.{{end}}{{.kind}}Informer
+	ClusterWithContext(context.Context, logicalcluster.Name) {{if .useUpstreamInterfaces}}upstream{{.group.GoPackageAlias}}informers.{{end}}{{.kind}}Informer
 	Informer() kcpcache.ScopeableSharedIndexInformer
 	Lister() {{.group.GoPackageAlias}}listers.{{.kind}}ClusterLister
 }
@@ -164,7 +165,7 @@ func (f *{{.kind.String|lowerFirst}}ClusterInformer) defaultInformer(client clie
 	return NewFiltered{{.kind}}ClusterInformer(client, resyncPeriod, cache.Indexers{
 			kcpcache.ClusterIndexName: kcpcache.ClusterIndexFunc,
 			{{if .kind.IsNamespaced}}kcpcache.ClusterAndNamespaceIndexName: kcpcache.ClusterAndNamespaceIndexFunc,{{end -}}
-		}, 
+		},
 		f.tweakListOptions,
 	)
 }
@@ -193,6 +194,13 @@ func (f *{{.kind.String|lowerFirst}}ClusterInformer) Cluster(clusterName logical
 	}
 }
 
+func (f *{{.kind.String|lowerFirst}}ClusterInformer) ClusterWithContext(ctx context.Context, clusterName logicalcluster.Name) {{if .useUpstreamInterfaces}}upstream{{.group.GoPackageAlias}}informers.{{end}}{{.kind}}Informer {
+	return &{{.kind.String|lowerFirst}}Informer{
+		informer: f.Informer().ClusterWithContext(ctx, clusterName),
+		lister:   f.Lister().Cluster(clusterName),
+	}
+}
+
 type {{.kind.String|lowerFirst}}Informer struct {
 	informer cache.SharedIndexInformer
 	lister {{if .useUpstreamInterfaces}}upstream{{end}}{{.group.GoPackageAlias}}listers.{{.kind.String}}Lister

pkg/internal/listergen/lister.go

@@ -46,9 +46,9 @@ var lister = `
 package {{.group.Version.PackageName}}
 
 import (
-	kcpcache "github.com/kcp-dev/apimachinery/v2/pkg/cache"	
+	kcpcache "github.com/kcp-dev/apimachinery/v2/pkg/cache"
 	"github.com/kcp-dev/logicalcluster/v3"
-	
+
 	"k8s.io/client-go/tools/cache"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/api/errors"