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().
33 lines
1.3 KiB
Go
33 lines
1.3 KiB
Go
/*
|
|
Copyright 2023 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 is a wrapper around k8s.io/klog/v2/ktesting. In contrast
|
|
// to the klog package, this one is opinionated and tailored towards testing
|
|
// Kubernetes.
|
|
//
|
|
// Importing it
|
|
// - adds the -v command line flag
|
|
// - enables better dumping of complex datatypes
|
|
// - sets the default verbosity to 5 (can be changed with [SetDefaultVerbosity])
|
|
//
|
|
// It also adds additional APIs and types for unit and integration tests
|
|
// which are too experimental for klog and/or are unrelated to logging.
|
|
// The ktesting package itself takes care of managing a test context
|
|
// with deadlines, timeouts, cancellation, and some common attributes
|
|
// as first-class members of the API. Sub-packages have additional APIs
|
|
// for propagating values via the context, implemented via [WithValue].
|
|
package ktesting
|