Provide Test Helpers Publicly

[Mordil]

I have my own test helpers for validating logging behavior in my library

after writing tests for #243... the test helpers are much nicer than what I wrote.

It'd be nice if the helpers were made public in a LoggingTestUtils module to be imported in my test targets...

[ktoso]

Rather, we wanted to provide the LogCapture libs, like the one that distributed actors has implemented:

• https://github.com/apple/swift-distributed-actors/blob/main/Sources/DistributedActorsTestKit/LogCapture.swift
• (and same in cluster membership: https://github.com/apple/swift-cluster-membership/blob/main/Tests/SWIMTestKit/LogCapture.swift )

I forgot what that got stuck on, was it you @glbrntt or @fabianfett who was looking into this or am I misremembering?

We provided such for metrics, so we should do the same for log perhaps. For metrics it is: https://github.com/apple/swift-metrics-extras/tree/main/Sources/MetricsTestUtils which also was extracted from distributed actors cluster

[glbrntt]

gRPC does similar. I don't recall looking into making this a feature of swift-log though.

It would be great if we did have this though as it's a useful utility and annoying for folks to have to re-invent it each time they want it.

[tomerd]

+1

[Mordil]

Where are we at with this? Is this something that just needs a PR?

[ktoso]

Just someone needs to do it, yes. If you're interested help here would be welcome.

It'd live in a LoggingTestKit the same as we do for metrics test kit.
You can base the implementation on what the distributed cluster does.

[Mordil]

Awesome. I'll look into creating a submission next week while I take extra time off for the US holiday weekend

[brimworks]

This seems to have languished, so I put together this proposal: #316

If I get the thumbs up, then I'll put together a PR with that implementation. Please provide feedback in the above PR about the approach.

Thanks!

[kukushechkin]

As @samuelmurray pointed out, the package now has a new product InMemoryLogHandler, that allows exploring the recorded entries through a public .entries { get } property.