Logging is an integral part of most of the applications and as such it has to be tested as well. Package zltest provides facilities to test zerolog log messages.

In general zltest.Tester provides methods to test values (or existence) of specific fields in logged messages.

Installation

go get github.com/rzajac/zltest

Examples

func Test_ServiceLogsProperly(t *testing.T) {
	// --- Given ---
    // Crate zerolog test helper.
	tst := zltest.New(t)

    // Configure zerolog and pas tester as a writer.     
	log := zerolog.New(tst).With().Timestamp().Logger()
	
    // Inject log to tested service or package.
    srv := MyService(log)

	// --- When ---
    srv.ExecuteSOmeLogic()

	// --- Then ---

    // Test if log messages were generated properly.
	ent := tst.LastEntry()
	ent.ExpNum("key0", 123)
	ent.ExpMsg("message")
	ent.ExpLevel(zerolog.ErrorLevel)
}

License

BSD-2-Clause