mirror of
https://github.com/kubernetes/kubernetes.git
synced 2026-02-15 08:47:59 -05:00
11dcfc6c15
Manually pairing Being with End is too error prone to be useful. It had the
advantage of keeping variables created between them visible to the following
code, but that doesn't justify using those calls.
By using a callback we can achieve a few things:
- Code using it automatically shadows the parent tCtx, thus enforcing
that within a code block the tCtx with step is used consistently.
- The code block is clearly delineated with curly braces.
- When the code block ends, the unmodified parent tCtx is automatically
in scope again.
Downsides:
- Extra boilerplate for the anonymous function.
Python's `with tCtx.Step(...) as tCtx: ` would be nicer.
As an approximation of that `for tCtx := range tCtx.Step(...)` was
tried with `Step` returning an iterator, but that wasn't very idiomatic.
- Variables created inside the code block are not visible outside of it.
(cherry picked from commit 047682908d)
89 lines
2.7 KiB
Go
89 lines
2.7 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
|
|
|
|
// Deprecated: use tCtx.WithStep instead
|
|
func WithStep(tCtx TContext, step string) TContext {
|
|
return tCtx.WithStep(step)
|
|
}
|
|
|
|
// 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 (tc *TC) WithStep(step string) *TC {
|
|
tc = tc.clone()
|
|
tc.steps += step + ": "
|
|
return tc
|
|
}
|
|
|
|
// Deprecated: use tCtx.Step instead
|
|
func Step(tCtx TContext, step string, cb func(tCtx TContext)) {
|
|
tCtx.Helper()
|
|
tCtx.Step(step, cb)
|
|
}
|
|
|
|
// Step is useful when the context with the step information is
|
|
// used more than once:
|
|
//
|
|
// ktesting.Step(tCtx, "step 1", func(tCtx ktesting.TContext) {
|
|
// tCtx.Log(...)
|
|
// if (... ) {
|
|
// tCtx.Failf(...)
|
|
// }
|
|
// )}
|
|
//
|
|
// Inside the callback, the tCtx variable is the one where the step
|
|
// has been added. This avoids the need to introduce multiple different
|
|
// context variables and risk of using the wrong one.
|
|
func (tc *TC) Step(step string, cb func(tCtx TContext)) {
|
|
tc.Helper()
|
|
cb(WithStep(tc, step))
|
|
}
|
|
|
|
// Value intercepts a search for the special "GINKGO_SPEC_CONTEXT" and
|
|
// wraps the underlying reporter so that the steps are visible in the report.
|
|
func (tc *TC) Value(key any) any {
|
|
if tc.steps != "" {
|
|
if s, ok := key.(string); ok && s == ginkgoSpecContextKey {
|
|
if reporter, ok := tc.Context.Value(key).(ginkgoReporter); ok {
|
|
return ginkgoReporter(&stepReporter{reporter: reporter, steps: tc.steps})
|
|
}
|
|
}
|
|
}
|
|
return tc.Context.Value(key)
|
|
}
|
|
|
|
type stepReporter struct {
|
|
reporter ginkgoReporter
|
|
steps string
|
|
}
|
|
|
|
var _ ginkgoReporter = &stepReporter{}
|
|
|
|
func (s *stepReporter) AttachProgressReporter(reporter func() string) func() {
|
|
return s.reporter.AttachProgressReporter(func() string {
|
|
report := reporter()
|
|
return s.steps + report
|
|
})
|
|
}
|