1 /* 2 Copyright 2021 The Kubernetes Authors. 3 4 Licensed under the Apache License, Version 2.0 (the "License"); 5 you may not use this file except in compliance with the License. 6 You may obtain a copy of the License at 7 8 http://www.apache.org/licenses/LICENSE-2.0 9 10 Unless required by applicable law or agreed to in writing, software 11 distributed under the License is distributed on an "AS IS" BASIS, 12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 See the License for the specific language governing permissions and 14 limitations under the License. 15 */ 16 17 package ktesting 18 19 import ( 20 "context" 21 22 "github.com/go-logr/logr" 23 ) 24 25 // DefaultConfig is the global default logging configuration for a unit 26 // test. It is used by NewTestContext and k8s.io/klogr/testing/init. 27 var DefaultConfig = NewConfig() 28 29 // NewTestContext returns a logger and context for use in a unit test case or 30 // benchmark. The tl parameter can be a testing.T or testing.B pointer that 31 // will receive all log output. Importing k8s.io/klogr/testing/init will add 32 // command line flags that modify the configuration of that log output. 33 func NewTestContext(tl TL) (logr.Logger, context.Context) { 34 logger := NewLogger(tl, DefaultConfig) 35 ctx := logr.NewContext(context.Background(), logger) 36 return logger, ctx 37 38 } 39