Documentation
¶
Overview ¶
Package ztest provides low-level helpers for testing log output. These utilities are helpful in zap's own unit tests, but any assertions using them are strongly coupled to a single encoding.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Initialize ¶
func Initialize(factor string) func()
Initialize checks the environment and alters the timeout scale accordingly. It returns a function to undo the scaling.
Types ¶
type Buffer ¶
Buffer is an implementation of zapcore.WriteSyncer that sends all writes to a bytes.Buffer. It has convenience methods to split the accumulated buffer on newlines.
type FailWriter ¶
type FailWriter struct{ Syncer }
FailWriter is a WriteSyncer that always returns an error on writes.
type MockClock ¶ added in v1.20.0
type MockClock struct {
// contains filtered or unexported fields
}
MockClock is a fake source of time. It implements standard time operations, but allows the user to control the passage of time.
Use the [Add] method to progress time.
func NewMockClock ¶ added in v1.20.0
func NewMockClock() *MockClock
NewMockClock builds a new mock clock using the current actual time as the initial time.
func (*MockClock) Add ¶ added in v1.20.0
Add progresses time by the given duration. Other operations waiting for the time to advance will be resolved if they are within range.
Side effects of operations waiting for the time to advance will take effect on a best-effort basis. Avoid racing with operations that have side effects.
Panics if the duration is negative.
func (*MockClock) NewTicker ¶ added in v1.20.0
NewTicker returns a time.Ticker that ticks at the specified frequency.
As with time.NewTicker, the ticker will drop ticks if the receiver is slow, and the channel is never closed.
Calling Stop on the returned ticker is a no-op. The ticker only runs when the clock is advanced.
type ShortWriter ¶
type ShortWriter struct{ Syncer }
ShortWriter is a WriteSyncer whose write method never fails, but nevertheless fails to the last byte of the input.
type Syncer ¶
type Syncer struct {
// contains filtered or unexported fields
}
A Syncer is a spy for the Sync portion of zapcore.WriteSyncer.
Source Files