Verbose testing logger

[basgys]

The Mock clock outputs this log line for every call to Now(), which can become really verbose in tests:

m.tb.Logf("Mock Clock - %s call, matched %d traps", c, len(traps))

Source

Would it be possible to let the caller decide if those logs are desirable?

Unfortunately, we cannot decorate testing.TB due to the private() function, so there aren't convenient options to block them to my knowledge.

[basgys]

Possible solution:

type Logger interface {
	Log(args ...any)
	Logf(format string, args ...any)
}

type noOp struct {}

func (n noOp) Log(args ...any) {}
func (n noOp) Logf(format string, args ...any) {}

clock := quartz.NewMock(t)
clock.SetLogger(noOp{})

NewMock would use the instance of testing.TB as the default logger, but would also expose a SetLogger method to override it.

[spikecurtis]

I like it! Or maybe clock := quartz.NewMock(t).WithLogger(quartz.NoOpLogger{})

Any insterest in sending a PR?

[basgys]

I like it! Or maybe clock := quartz.NewMock(t).WithLogger(quartz.NoOpLogger{})

That is also an option. A 3rd solution could be to use the functional options pattern if you have a preference for setting the options during the initialisation only.

clock := quartz.NewMock(t, quartz.WithLogger(quartz.NoOpLogger))

Which would look like:

type Logger interface {
	Log(args ...any)
	Logf(format string, args ...any)
}

type MockOption func(*Mock)

func WithLogger(l Logger) MockOption {
	return func(m *Mock) {
		m.logger = l
	}
}

func NewMock(tb testing.TB, opts ...MockOption) *Mock {
	cur, err := time.Parse(time.RFC3339, "2024-01-01T00:00:00Z")
	if err != nil {
		panic(err)
	}
	m := &Mock{
		tb:  tb,
		logger: tb, // default logger
		cur: cur,
	}
	for _, opt := range opts {
		opt(m)
	}
	tb.Cleanup(func() {
		m.mu.Lock()
		defer m.mu.Unlock()
		m.testOver = true
		m.logger.Logf("Mock Clock - test cleanup; will no longer log clock events")
	})
	return m
}

Any insterest in sending a PR?

Yes, absolutely! Let me know which option you prefer and I can prepare a PR.

[spikecurtis]

The library already uses method-chaining ("Fluent" API) in other places, so I'd like to keep things consistent with clock := quartz.NewMock(t).WithLogger(quartz.NoOpLogger{}). It also reduces the number of times you have to include the package name quartz when you specify multiple options.

I don't mind if it gets set after initialization; just make sure to hold the lock while modifying.

[basgys]

@spikecurtis I prepared a PR here: #21

Let me know what you think.