What is the reason for ERROR controller-runtime.source failed to get informer from cache error appear on envtest cluster?

[hellt]

Hi all,
Could you please help me figure out why I see below-mentioned informer errors when I launch my controller_test.go suite?

Begin Captured GinkgoWriter Output >>
    STEP: Creating the Namespace to perform the tests 03/13/23 22:39:37.233
    1.6787435772335277e+09      INFO    Stopping and waiting for non leader election runnables
    1.6787435772335474e+09      INFO    Stopping and waiting for leader election runnables
    1.6787435772335675e+09      INFO    Starting server {"path": "/metrics", "kind": "metrics", "addr": "[::]:8080"}
    1.6787435772336721e+09      INFO    Starting EventSource    {"controller": "srlinux", "controllerGroup": "kne.srlinux.dev", "controllerKind": "Srlinux", "source": "kind source: *v1.Srlinux"}
    1.6787435772337315e+09      INFO    Starting EventSource    {"controller": "srlinux", "controllerGroup": "kne.srlinux.dev", "controllerKind": "Srlinux", "source": "kind source: *v1.Pod"}
    1.678743577233737e+09       INFO    Starting Controller     {"controller": "srlinux", "controllerGroup": "kne.srlinux.dev", "controllerKind": "Srlinux"}
    1.6787435772337453e+09      INFO    Starting workers        {"controller": "srlinux", "controllerGroup": "kne.srlinux.dev", "controllerKind": "Srlinux", "worker count": 1}
    1.6787435772337728e+09      INFO    Shutdown signal received, waiting for all workers to finish     {"controller": "srlinux", "controllerGroup": "kne.srlinux.dev", "controllerKind": "Srlinux"}
    1.6787435772337801e+09      INFO    All workers finished    {"controller": "srlinux", "controllerGroup": "kne.srlinux.dev", "controllerKind": "Srlinux"}
    1.678743577233788e+09       INFO    Stopping and waiting for caches
    1.6787435772338114e+09      INFO    Stopping and waiting for webhooks
    1.6787435772338176e+09      INFO    Wait completed, proceeding to shutdown the manager
    1.67874357723389e+09        ERROR   controller-runtime.source       failed to get informer from cache       {"error": "Timeout: failed waiting for *v1.Srlinux Informer to sync"}
    sigs.k8s.io/controller-runtime/pkg/source.(*Kind).Start.func1.1
        /root/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.13.1/pkg/source/source.go:144
    k8s.io/apimachinery/pkg/util/wait.runConditionWithCrashProtectionWithContext
        /root/go/pkg/mod/k8s.io/apimachinery@v0.25.6/pkg/util/wait/wait.go:235
    k8s.io/apimachinery/pkg/util/wait.poll
        /root/go/pkg/mod/k8s.io/apimachinery@v0.25.6/pkg/util/wait/wait.go:582
    k8s.io/apimachinery/pkg/util/wait.PollImmediateUntilWithContext
        /root/go/pkg/mod/k8s.io/apimachinery@v0.25.6/pkg/util/wait/wait.go:547
    sigs.k8s.io/controller-runtime/pkg/source.(*Kind).Start.func1
        /root/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.13.1/pkg/source/source.go:132
    1.6787435772339833e+09      ERROR   controller-runtime.source       failed to get informer from cache       {"error": "Timeout: failed waiting for *v1.Pod Informer to sync"}
    sigs.k8s.io/controller-runtime/pkg/source.(*Kind).Start.func1.1
        /root/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.13.1/pkg/source/source.go:144
    k8s.io/apimachinery/pkg/util/wait.runConditionWithCrashProtectionWithContext
        /root/go/pkg/mod/k8s.io/apimachinery@v0.25.6/pkg/util/wait/wait.go:235
    k8s.io/apimachinery/pkg/util/wait.poll
        /root/go/pkg/mod/k8s.io/apimachinery@v0.25.6/pkg/util/wait/wait.go:582
    k8s.io/apimachinery/pkg/util/wait.PollImmediateUntilWithContext
        /root/go/pkg/mod/k8s.io/apimachinery@v0.25.6/pkg/util/wait/wait.go:547
    sigs.k8s.io/controller-runtime/pkg/source.(*Kind).Start.func1
        /root/go/pkg/mod/sigs.k8s.io/controller-runtime@v0.13.1/pkg/source/source.go:132

My suite_test.go follows the book examples:

package controllers

import (
	"context"
	"path/filepath"
	"testing"

	ctrl "sigs.k8s.io/controller-runtime"

	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"

	"k8s.io/client-go/kubernetes/scheme"
	"k8s.io/client-go/rest"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/envtest"
	logf "sigs.k8s.io/controller-runtime/pkg/log"
	"sigs.k8s.io/controller-runtime/pkg/log/zap"

	srlinuxv1 "github.com/srl-labs/srl-controller/api/v1"
	//+kubebuilder:scaffold:imports
)

// These tests use Ginkgo (BDD-style Go testing framework). Refer to
// http://onsi.github.io/ginkgo/ to learn more about Ginkgo.

var (
	cfg       *rest.Config
	k8sClient client.Client
	testEnv   *envtest.Environment
)

func TestAPIs(t *testing.T) {
	RegisterFailHandler(Fail)

	RunSpecs(t, "Controller Suite")
}

var _ = BeforeSuite(func() {
	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))

	ctx, cancel := context.WithCancel(context.TODO())
	defer cancel()

	By("bootstrapping test environment")
	testEnv = &envtest.Environment{
		CRDDirectoryPaths:     []string{filepath.Join("..", "config", "crd", "bases")},
		ErrorIfCRDPathMissing: true,
	}

	var err error
	// cfg is defined in this file globally.
	cfg, err = testEnv.Start()
	Expect(err).NotTo(HaveOccurred())
	Expect(cfg).NotTo(BeNil())

	err = srlinuxv1.AddToScheme(scheme.Scheme)
	Expect(err).NotTo(HaveOccurred())

	//+kubebuilder:scaffold:scheme

	k8sClient, err = client.New(cfg, client.Options{Scheme: scheme.Scheme})
	Expect(err).NotTo(HaveOccurred())
	Expect(k8sClient).NotTo(BeNil())

	k8sManager, err := ctrl.NewManager(cfg, ctrl.Options{
		Scheme: scheme.Scheme,
	})
	Expect(err).ToNot(HaveOccurred())

	err = (&SrlinuxReconciler{
		Client: k8sManager.GetClient(),
		Scheme: k8sManager.GetScheme(),
	}).SetupWithManager(k8sManager)
	Expect(err).ToNot(HaveOccurred())

	go func() {
		defer GinkgoRecover()
		err = k8sManager.Start(ctx)
		Expect(err).ToNot(HaveOccurred(), "failed to run manager")
	}()
})

var _ = AfterSuite(func() {
	By("tearing down the test environment")
	err := testEnv.Stop()
	Expect(err).NotTo(HaveOccurred())
})

I am running with the following versions:

k8s.io/api v0.25.6
	k8s.io/apimachinery v0.25.6
	k8s.io/client-go v0.25.6
	k8s.io/utils v0.0.0-20221128185143-99ec85e7a448
	sigs.k8s.io/controller-runtime v0.13.1

[hellt]

Sorry, error on my side,
the defer cancel() was called in BeforeSuite, though it should've been called in AfterSuite()

[camilamacedo86]

Closing since it is answered.