better manager API

Author: cirisked

internal/informer/manager.go

@@ -17,6 +17,10 @@ import (
 	"github.com/castai/cluster-controller/internal/metrics"
 )
 
+const (
+	defaultCacheSyncTimeout = 30 * time.Second
+)
+
 // Manager manages the global SharedInformerFactory and provides
 // access to specific informers and listers.
 type Manager struct {
@@ -32,12 +36,22 @@ type Manager struct {
 	mu         sync.RWMutex
 }
 
-// NewManager creates a new Manager with the given clientset, resync period, and cache sync timeout.
+// Option is a functional option for configuring the Manager.
+type Option func(*Manager)
+
+// WithCacheSyncTimeout sets the timeout for waiting for informer caches to sync.
+func WithCacheSyncTimeout(timeout time.Duration) Option {
+	return func(m *Manager) {
+		m.cacheSyncTimeout = timeout
+	}
+}
+
+// NewManager creates a new Manager with the given clientset and resync period.
 func NewManager(
 	log logrus.FieldLogger,
 	clientset kubernetes.Interface,
 	resyncPeriod time.Duration,
-	cacheSyncTimeout time.Duration,
+	opts ...Option,
 ) *Manager {
 	factory := informers.NewSharedInformerFactory(clientset, resyncPeriod)
 
@@ -51,13 +65,19 @@ func NewManager(
 		lister:   factory.Core().V1().Pods().Lister(),
 	}
 
-	return &Manager{
+	m := &Manager{
 		log:              log,
 		factory:          factory,
-		cacheSyncTimeout: cacheSyncTimeout,
+		cacheSyncTimeout: defaultCacheSyncTimeout,
 		nodes:            nodes,
 		pods:             pods,
 	}
+
+	for _, opt := range opts {
+		opt(m)
+	}
+
+	return m
 }
 
 // Start starts the informer factory and waits for all caches to sync.

internal/informer/manager_test.go

@@ -19,7 +19,7 @@ func TestNewManager(t *testing.T) {
 	log := logrus.New()
 	clientset := fake.NewClientset()
 
-	manager := NewManager(log, clientset, time.Hour, 5*time.Second)
+	manager := NewManager(log, clientset, time.Hour)
 
 	require.NotNil(t, manager)
 	require.NotNil(t, manager.GetFactory())
@@ -44,7 +44,7 @@ func TestManager_Start_Success(t *testing.T) {
 	}
 
 	clientset := fake.NewClientset(node, pod)
-	manager := NewManager(log, clientset, 0, 5*time.Second)
+	manager := NewManager(log, clientset, 0)
 
 	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 	defer cancel()
@@ -70,7 +70,7 @@ func TestManager_Start_AlreadyStarted(t *testing.T) {
 	log.SetLevel(logrus.ErrorLevel)
 
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, 0, 5*time.Second)
+	manager := NewManager(log, clientset, 0)
 
 	ctx := context.Background()
 
@@ -90,7 +90,7 @@ func TestManager_Start_ContextCanceled(t *testing.T) {
 	log.SetLevel(logrus.ErrorLevel)
 
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, 0, 5*time.Second)
+	manager := NewManager(log, clientset, 0)
 
 	ctx, cancel := context.WithCancel(context.Background())
 	cancel()
@@ -108,7 +108,7 @@ func TestManager_Stop(t *testing.T) {
 	log.SetLevel(logrus.ErrorLevel)
 
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, 0, 5*time.Second)
+	manager := NewManager(log, clientset, 0)
 
 	manager.Stop()
 	require.False(t, manager.IsStarted())
@@ -138,7 +138,7 @@ func TestManager_CacheUpdates(t *testing.T) {
 	}
 
 	clientset := fake.NewClientset(node)
-	manager := NewManager(log, clientset, 0, 5*time.Second)
+	manager := NewManager(log, clientset, 0)
 
 	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 	defer cancel()

internal/informer/node_informer_test.go

@@ -14,7 +14,7 @@ func TestNodeInformer_Informer(t *testing.T) {
 
 	log := logrus.New()
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, time.Hour, 5*time.Second)
+	manager := NewManager(log, clientset, time.Hour)
 
 	informer := manager.nodes.Informer()
 	require.NotNil(t, informer)
@@ -25,7 +25,7 @@ func TestNodeInformer_Lister(t *testing.T) {
 
 	log := logrus.New()
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, time.Hour, 5*time.Second)
+	manager := NewManager(log, clientset, time.Hour)
 
 	lister := manager.nodes.Lister()
 	require.NotNil(t, lister)
@@ -36,7 +36,7 @@ func TestNodeInformer_HasSynced(t *testing.T) {
 
 	log := logrus.New()
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, time.Hour, 5*time.Second)
+	manager := NewManager(log, clientset, time.Hour)
 
 	require.False(t, manager.nodes.HasSynced())
 }

internal/informer/pod_informer_test.go

@@ -14,7 +14,7 @@ func TestPodInformer_Informer(t *testing.T) {
 
 	log := logrus.New()
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, time.Hour, 5*time.Second)
+	manager := NewManager(log, clientset, time.Hour)
 
 	informer := manager.pods.Informer()
 	require.NotNil(t, informer)
@@ -25,7 +25,7 @@ func TestPodInformer_Lister(t *testing.T) {
 
 	log := logrus.New()
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, time.Hour, 5*time.Second)
+	manager := NewManager(log, clientset, time.Hour)
 
 	lister := manager.pods.Lister()
 	require.NotNil(t, lister)
@@ -36,7 +36,7 @@ func TestPodInformer_HasSynced(t *testing.T) {
 
 	log := logrus.New()
 	clientset := fake.NewClientset()
-	manager := NewManager(log, clientset, time.Hour, 5*time.Second)
+	manager := NewManager(log, clientset, time.Hour)
 
 	require.False(t, manager.pods.HasSynced())
 }