Assertions in scaffolded suite_test.go BeforeSuite are not caught

[armsnyder]

What broke? What's expected?

This code at the bottom of a scaffolded BeforeSuite function in controllers/suite_test.go has a bug:

go func() {
	err = k8sManager.Start(ctrl.SetupSignalHandler())
	Expect(err).ToNot(HaveOccurred())
}()

Ginkgo does not work in new goroutines without adding a defer GinkgoRecover() line. When this assertion fails you get this error:

panic: 
Your test failed.
Ginkgo panics to prevent subsequent assertions from running.
Normally Ginkgo rescues this panic so you shouldn't see it.

But, if you make an assertion in a goroutine, Ginkgo can't capture the panic.
To circumvent this, you should call

        defer GinkgoRecover()

at the top of the goroutine that caused this panic.

As a result the error message cannot be inspected.

Reproducing this issue

No response

KubeBuilder (CLI) Version

Version: main.version{KubeBuilderVersion:"3.1.0", KubernetesVendor:"unknown", GitCommit:"92e0349ca7334a0a8e5e499da4fb077eb524e94a", BuildDate:"2021-05-29T05:57:53+01:00", GoOs:"darwin", GoArch:"amd64"}

PROJECT version

3

Plugin versions

layout:
- go.kubebuilder.io/v3

Other versions

No response

Extra Labels

No response

[armsnyder]

Seems to have been resolved by #2302, but there are still a couple places missing a defer GinkgoRecover() call. I'm getting a PR ready.