Documentation
¶
Overview ¶
Package stubs provides test doubles for tests.
This file contains LoggerStub which can be used in both unit and integration tests. Unlike ports.go, this file has no build tag to ensure availability in all test contexts.
Index ¶
- type LoggerStub
- func (l *LoggerStub) Debug(args ...any)
- func (l *LoggerStub) Debugf(format string, args ...any)
- func (l *LoggerStub) Debugln(args ...any)
- func (l *LoggerStub) Error(args ...any)
- func (l *LoggerStub) ErrorCount() int
- func (l *LoggerStub) Errorf(format string, args ...any)
- func (l *LoggerStub) Errorln(args ...any)
- func (l *LoggerStub) Fatal(args ...any)
- func (l *LoggerStub) Fatalf(format string, args ...any)
- func (l *LoggerStub) Fatalln(args ...any)
- func (l *LoggerStub) HasError(substring string) bool
- func (l *LoggerStub) HasInfo(substring string) bool
- func (l *LoggerStub) HasWarning(substring string) bool
- func (l *LoggerStub) Info(args ...any)
- func (l *LoggerStub) InfoCount() int
- func (l *LoggerStub) Infof(format string, args ...any)
- func (l *LoggerStub) Infoln(args ...any)
- func (l *LoggerStub) Reset()
- func (l *LoggerStub) Sync() error
- func (l *LoggerStub) Warn(args ...any)
- func (l *LoggerStub) Warnf(format string, args ...any)
- func (l *LoggerStub) WarningCount() int
- func (l *LoggerStub) Warnln(args ...any)
- func (l *LoggerStub) WithDefaultMessageTemplate(message string) libLog.Logger
- func (l *LoggerStub) WithFields(fields ...any) libLog.Logger
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LoggerStub ¶
type LoggerStub struct {
Infos []string
Warnings []string
Errors []string
Debugs []string
Fatals []string
}
LoggerStub captures log messages for verification in tests.
Use when you need to verify specific log messages were emitted (e.g., deprecation warnings). For tests that don't need to verify log output, prefer using the real logger:
logger := libZap.InitializeLogger()
Example usage:
func TestFunction_LogsDeprecationWarning(t *testing.T) {
logger := &stubs.LoggerStub{}
result := FunctionUnderTest(logger)
assert.True(t, logger.HasWarning("DEPRECATED"))
assert.Equal(t, 1, logger.WarningCount())
}
func (*LoggerStub) Debugf ¶
func (l *LoggerStub) Debugf(format string, args ...any)
Debugf captures formatted debug messages.
func (*LoggerStub) Debugln ¶
func (l *LoggerStub) Debugln(args ...any)
Debugln captures debug messages with newline.
func (*LoggerStub) ErrorCount ¶
func (l *LoggerStub) ErrorCount() int
ErrorCount returns the number of captured errors.
func (*LoggerStub) Errorf ¶
func (l *LoggerStub) Errorf(format string, args ...any)
Errorf captures formatted error messages.
func (*LoggerStub) Errorln ¶
func (l *LoggerStub) Errorln(args ...any)
Errorln captures error messages with newline.
func (*LoggerStub) Fatal ¶
func (l *LoggerStub) Fatal(args ...any)
Fatal captures fatal messages (does NOT exit - safe for tests).
func (*LoggerStub) Fatalf ¶
func (l *LoggerStub) Fatalf(format string, args ...any)
Fatalf captures formatted fatal messages (does NOT exit - safe for tests).
func (*LoggerStub) Fatalln ¶
func (l *LoggerStub) Fatalln(args ...any)
Fatalln captures fatal messages with newline (does NOT exit - safe for tests).
func (*LoggerStub) HasError ¶
func (l *LoggerStub) HasError(substring string) bool
HasError checks if any captured error contains the given substring.
func (*LoggerStub) HasInfo ¶
func (l *LoggerStub) HasInfo(substring string) bool
HasInfo checks if any captured info contains the given substring.
func (*LoggerStub) HasWarning ¶
func (l *LoggerStub) HasWarning(substring string) bool
HasWarning checks if any captured warning contains the given substring.
func (*LoggerStub) InfoCount ¶
func (l *LoggerStub) InfoCount() int
InfoCount returns the number of captured info messages.
func (*LoggerStub) Infof ¶
func (l *LoggerStub) Infof(format string, args ...any)
Infof captures formatted info messages.
func (*LoggerStub) Infoln ¶
func (l *LoggerStub) Infoln(args ...any)
Infoln captures info messages with newline.
func (*LoggerStub) Warnf ¶
func (l *LoggerStub) Warnf(format string, args ...any)
Warnf captures formatted warning messages.
func (*LoggerStub) WarningCount ¶
func (l *LoggerStub) WarningCount() int
WarningCount returns the number of captured warnings.
func (*LoggerStub) Warnln ¶
func (l *LoggerStub) Warnln(args ...any)
Warnln captures warning messages with newline.
func (*LoggerStub) WithDefaultMessageTemplate ¶
func (l *LoggerStub) WithDefaultMessageTemplate(message string) libLog.Logger
WithDefaultMessageTemplate returns self (no-op for stub).
func (*LoggerStub) WithFields ¶
func (l *LoggerStub) WithFields(fields ...any) libLog.Logger
WithFields returns self (no-op for stub).
Source Files