github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2026-07-18 13:57:38 +00:00
Code Issues Projects Releases Wiki Activity

e2e framework: avoid memory overhead of ginkgo.GinkgoT

Browse Source 
It turned out that ginkgo.GinkgoT() wasn't as cheap as it should have been (fix
coming in Ginkgo 2.27.5). When instantiated once for each framework.Framework
instance during init by all workers at the same time, the resulting spike in
overall memory usage within the container caused OOM killing of workers in Prow
jobs like ci-kubernetes-e2e-gci-gce with very tight memory limits.

Even with the upcoming fix in Ginkgo it makes sense to set the TB field only
while it really is needed, i.e. while a test runs. This is conceptually similar
to setting and unsetting the test namespace. It may help to flush out incorrect
usage of TB outside of tests.
This commit is contained in:
Patrick Ohly
2026-01-12 20:13:37 +01:00
parent 0d64cbff49
commit db36339d03
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
test/e2e/framework/framework.go
View File

@@ -99,11 +99,12 @@ var (
// struct.
//
// A framework instance implements ktesting.TB and thus can be passed as
// first parameter to [github.com/stretchr/testify/assert]. There are
// just two caveats:
// first parameter to [github.com/stretchr/testify/assert].
// There are just two caveats:
// - Error and Errorf abort the currently running test.
// - The implementation is only usable while a test runs,
// not while defining tests.
// - This only works while a test runs, not while defining tests.
// Incorrect tests may panic. The same applies to using ginkgo.Fail
// outside of tests.
type Framework struct {
ktesting.TB
@@ -178,7 +179,13 @@ var _ ktesting.ContextTB = &Framework{}
// an interim solution. It's cleaner to rewrite that code to accept
// a [ktesting.TContext].
func (f *Framework) TContext(ctx context.Context) ktesting.TContext {
tCtx := ktesting.InitCtx(ctx, f)
if f.TB == nil {
// Test setup typically has no context, so this is unlikely to be reached.
// A sufficiently determined developer might pass in context.Background(),
// so let's be explicit anyway.
panic("TContext may only be used while a test runs.")
}
tCtx := ktesting.InitCtx(ctx, f /* intentionally using f here and not f.TB because f overrides some methods */)
tCtx = tCtx.WithClients(f.clientConfig, f.restMapper, f.ClientSet, f.DynamicClient, apiextensions.NewForConfigOrDie(f.clientConfig))
tCtx = tCtx.WithNamespace(f.Namespace.Name)
tCtx = ensureLogger(tCtx)
@@ -280,7 +287,7 @@ func NewDefaultFramework(baseName string) *Framework {
// NewFramework creates a test framework.
func NewFramework(baseName string, options Options, client clientset.Interface) *Framework {
f := &Framework{
TB: ginkgo.GinkgoT(),
// TB initially not set yet. It may only be used while tests run.
BaseName: baseName,
Options: options,
ClientSet: client,
@@ -300,6 +307,8 @@ func NewFramework(baseName string, options Options, client clientset.Interface)
// BeforeEach gets a client and makes a namespace.
func (f *Framework) BeforeEach(ctx context.Context) {
f.TB = ginkgo.GinkgoT()
// DeferCleanup, in contrast to AfterEach, triggers execution in
// first-in-last-out order. This ensures that the framework instance
// remains valid as long as possible.
@@ -484,6 +493,7 @@ func (f *Framework) AfterEach(ctx context.Context) {
f.clientConfig = nil
f.ClientSet = nil
f.namespacesToDelete = nil
f.TB = nil
// if we had errors deleting, report them now.
if len(nsDeletionErrors) != 0 {