apex

README

apex mocks

Package mocks provides a mock implementation of Apex which can be used to unit test applications using Apex logging.

Download

go get gitlab.com/unboundsoftware/apex-mocks

Usage

Make sure that your application uses log.Interface to be able to pass in a Mock from your tests instead.

To verify what has been logged:

  logger := &apex.Mock{}
  // ... run your actual test using the logger above
  logger.Check(t, tt.wantLogged)

Documentation

Index

• type Mock
  • func New() *Mock
  • func (m *Mock) Check(t testing.TB, wantLogged []string)
  • func (m *Mock) HandleLog(entry *log.Entry) error

Types

type Mock

type Mock struct {
	*sync.RWMutex
	log.Interface
	Logged []string
}

Mock has a Logger for use in unit-testing

func New

func New() *Mock

New instantiates a new Mock and sets the log.Handler to it

func (*Mock) Check

func (m *Mock) Check(t testing.TB, wantLogged []string)

Check verifies that the application has logged the expected strings

func (*Mock) HandleLog

func (m *Mock) HandleLog(entry *log.Entry) error

HandleLog stores the logged entries to be able to check them later