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.

      func Sleep

      func Sleep(base time.Duration)

        Sleep scales the sleep duration by $TEST_TIMEOUT_SCALE.

        func Timeout

        func Timeout(base time.Duration) time.Duration

          Timeout scales the provided duration by $TEST_TIMEOUT_SCALE.

          Types

          type Buffer

          type Buffer struct {
          	bytes.Buffer
          	Syncer
          }

            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.

            func (*Buffer) Lines

            func (b *Buffer) Lines() []string

              Lines returns the current buffer contents, split on newlines.

              func (*Buffer) Stripped

              func (b *Buffer) Stripped() string

                Stripped returns the current buffer contents with the last trailing newline stripped.

                type Discarder

                type Discarder struct{ Syncer }

                  A Discarder sends all writes to ioutil.Discard.

                  func (*Discarder) Write

                  func (d *Discarder) Write(b []byte) (int, error)

                    Write implements io.Writer.

                    type FailWriter

                    type FailWriter struct{ Syncer }

                      FailWriter is a WriteSyncer that always returns an error on writes.

                      func (FailWriter) Write

                      func (w FailWriter) Write(b []byte) (int, error)

                        Write implements io.Writer.

                        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.

                          func (ShortWriter) Write

                          func (w ShortWriter) Write(b []byte) (int, error)

                            Write implements io.Writer.

                            type Syncer

                            type Syncer struct {
                            	// contains filtered or unexported fields
                            }

                              A Syncer is a spy for the Sync portion of zapcore.WriteSyncer.

                              func (*Syncer) Called

                              func (s *Syncer) Called() bool

                                Called reports whether the Sync method was called.

                                func (*Syncer) SetError

                                func (s *Syncer) SetError(err error)

                                  SetError sets the error that the Sync method will return.

                                  func (*Syncer) Sync

                                  func (s *Syncer) Sync() error

                                    Sync records that it was called, then returns the user-supplied error (if any).