63aa261583
The new TContext interface combines a normal context and the testing interface, then adds some helper methods. The context gets canceled when the test is done, but that can also be requested earlier via Cancel. The intended usage is to pass a single `tCtx ktesting.TContext` parameter around in all helper functions that get called by a unit or integration test. Logging is also more useful: Log[f] and Fatal[f] output is prefixed with "[FATAL] ERROR: " to make it stand out more from regular log output. If this approach turns out to be useful, it could be extended further (for example, with a per-test timeout) and might get moved to a staging repository to enable usage of it in other staging repositories. To allow other implementations besides testing.T and testing.B, a custom ktesting.TB interface gets defined with the methods expected from the actual implementation. One such implementation can be ginkgo.GinkgoT().
102 lines
3.0 KiB
Go
102 lines
3.0 KiB
Go
/*
|
|
Copyright 2024 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package ktesting
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"k8s.io/klog/v2"
|
|
)
|
|
|
|
// WithStep creates a context where a prefix is added to all errors and log
|
|
// messages, similar to how errors are wrapped. This can be nested, leaving a
|
|
// trail of "bread crumbs" that help figure out where in a test some problem
|
|
// occurred or why some log output gets written:
|
|
//
|
|
// ERROR: bake cake: set heat for baking: oven not found
|
|
//
|
|
// The string should describe the operation that is about to happen ("starting
|
|
// the controller", "list items") or what is being operated on ("HTTP server").
|
|
// Multiple different prefixes get concatenated with a colon.
|
|
func WithStep(tCtx TContext, what string) TContext {
|
|
sCtx := &stepContext{
|
|
TContext: tCtx,
|
|
what: what,
|
|
}
|
|
return WithLogger(sCtx, klog.LoggerWithName(sCtx.Logger(), what))
|
|
}
|
|
|
|
type stepContext struct {
|
|
TContext
|
|
what string
|
|
}
|
|
|
|
func (sCtx *stepContext) Log(args ...any) {
|
|
sCtx.Helper()
|
|
sCtx.TContext.Log(sCtx.what + ": " + strings.TrimSpace(fmt.Sprintln(args...)))
|
|
}
|
|
|
|
func (sCtx *stepContext) Logf(format string, args ...any) {
|
|
sCtx.Helper()
|
|
sCtx.TContext.Log(sCtx.what + ": " + strings.TrimSpace(fmt.Sprintf(format, args...)))
|
|
}
|
|
|
|
func (sCtx *stepContext) Error(args ...any) {
|
|
sCtx.Helper()
|
|
sCtx.TContext.Error(sCtx.what + ": " + strings.TrimSpace(fmt.Sprintln(args...)))
|
|
}
|
|
|
|
func (sCtx *stepContext) Errorf(format string, args ...any) {
|
|
sCtx.Helper()
|
|
sCtx.TContext.Error(sCtx.what + ": " + strings.TrimSpace(fmt.Sprintf(format, args...)))
|
|
}
|
|
|
|
func (sCtx *stepContext) Fatal(args ...any) {
|
|
sCtx.Helper()
|
|
sCtx.TContext.Fatal(sCtx.what + ": " + strings.TrimSpace(fmt.Sprintln(args...)))
|
|
}
|
|
|
|
func (sCtx *stepContext) Fatalf(format string, args ...any) {
|
|
sCtx.Helper()
|
|
sCtx.TContext.Fatal(sCtx.what + ": " + strings.TrimSpace(fmt.Sprintf(format, args...)))
|
|
}
|
|
|
|
// Value intercepts a search for the special
|
|
func (sCtx *stepContext) Value(key any) any {
|
|
if s, ok := key.(string); ok && s == ginkgoSpecContextKey {
|
|
if reporter, ok := sCtx.TContext.Value(key).(ginkgoReporter); ok {
|
|
return ginkgoReporter(&stepReporter{reporter: reporter, what: sCtx.what})
|
|
}
|
|
}
|
|
return sCtx.TContext.Value(key)
|
|
}
|
|
|
|
type stepReporter struct {
|
|
reporter ginkgoReporter
|
|
what string
|
|
}
|
|
|
|
var _ ginkgoReporter = &stepReporter{}
|
|
|
|
func (s *stepReporter) AttachProgressReporter(reporter func() string) func() {
|
|
return s.reporter.AttachProgressReporter(func() string {
|
|
report := reporter()
|
|
return s.what + ": " + report
|
|
})
|
|
}
|