increase_level_test.go

Documentation: go.uber.org/zap

     1  // Copyright (c) 2020 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package zap
    22  
    23  import (
    24  	"bytes"
    25  	"testing"
    26  
    27  	"github.com/stretchr/testify/assert"
    28  	"go.uber.org/zap/zapcore"
    29  	"go.uber.org/zap/zaptest/observer"
    30  )
    31  
    32  func newLoggedEntry(level zapcore.Level, msg string, fields ...zapcore.Field) observer.LoggedEntry {
    33  	if len(fields) == 0 {
    34  		fields = []zapcore.Field{}
    35  	}
    36  	return observer.LoggedEntry{
    37  		Entry:   zapcore.Entry{Level: level, Message: msg},
    38  		Context: fields,
    39  	}
    40  }
    41  
    42  func TestIncreaseLevelTryDecrease(t *testing.T) {
    43  	errorOut := &bytes.Buffer{}
    44  	opts := []Option{
    45  		ErrorOutput(zapcore.AddSync(errorOut)),
    46  	}
    47  	withLogger(t, WarnLevel, opts, func(logger *Logger, logs *observer.ObservedLogs) {
    48  		logger.Warn("original warn log")
    49  
    50  		debugLogger := logger.WithOptions(IncreaseLevel(DebugLevel))
    51  		debugLogger.Debug("ignored debug log")
    52  		debugLogger.Warn("increase level warn log")
    53  		debugLogger.Error("increase level error log")
    54  
    55  		assert.Equal(t, []observer.LoggedEntry{
    56  			newLoggedEntry(WarnLevel, "original warn log"),
    57  			newLoggedEntry(WarnLevel, "increase level warn log"),
    58  			newLoggedEntry(ErrorLevel, "increase level error log"),
    59  		}, logs.AllUntimed(), "unexpected logs")
    60  		assert.Equal(t,
    61  			"failed to IncreaseLevel: invalid increase level, as level \"info\" is allowed by increased level, but not by existing core\n",
    62  			errorOut.String(),
    63  			"unexpected error output",
    64  		)
    65  	})
    66  }
    67  
    68  func TestIncreaseLevel(t *testing.T) {
    69  	errorOut := &bytes.Buffer{}
    70  	opts := []Option{
    71  		ErrorOutput(zapcore.AddSync(errorOut)),
    72  	}
    73  	withLogger(t, WarnLevel, opts, func(logger *Logger, logs *observer.ObservedLogs) {
    74  		logger.Warn("original warn log")
    75  
    76  		errorLogger := logger.WithOptions(IncreaseLevel(ErrorLevel))
    77  		errorLogger.Debug("ignored debug log")
    78  		errorLogger.Warn("ignored warn log")
    79  		errorLogger.Error("increase level error log")
    80  
    81  		withFields := errorLogger.With(String("k", "v"))
    82  		withFields.Debug("ignored debug log with fields")
    83  		withFields.Warn("ignored warn log with fields")
    84  		withFields.Error("increase level error log with fields")
    85  
    86  		assert.Equal(t, []observer.LoggedEntry{
    87  			newLoggedEntry(WarnLevel, "original warn log"),
    88  			newLoggedEntry(ErrorLevel, "increase level error log"),
    89  			newLoggedEntry(ErrorLevel, "increase level error log with fields", String("k", "v")),
    90  		}, logs.AllUntimed(), "unexpected logs")
    91  
    92  		assert.Empty(t, errorOut.String(), "expect no error output")
    93  	})
    94  }
    95
View as plain text