knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/logging/testing/util.go (about)

     1  /*
     2  Copyright 2018 The Knative 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 testing
    18  
    19  import (
    20  	"context"
    21  
    22  	"go.uber.org/zap"
    23  	"go.uber.org/zap/zaptest"
    24  
    25  	"knative.dev/pkg/logging"
    26  )
    27  
    28  // TestLogger gets a logger to use in unit and end to end tests
    29  func TestLogger(t zaptest.TestingT) *zap.SugaredLogger {
    30  	opts := zaptest.WrapOptions(
    31  		zap.AddCaller(),
    32  		zap.Development(),
    33  	)
    34  
    35  	return zaptest.NewLogger(t, opts).Sugar()
    36  }
    37  
    38  // TestContextWithLogger returns a context with a logger to be used in tests
    39  func TestContextWithLogger(t zaptest.TestingT) context.Context {
    40  	return logging.WithLogger(context.Background(), TestLogger(t))
    41  }