Repository navigation
Custom panic messages in snapbox #223
Description
std::assert_eq supports providing a custom panic message in a third argument (optionally followed by further parameters for the message arguments). pretty_assertions and similar-asserts both provide assert_eq! macros that are compatible.
snapbox however currently appears to hard-code it's panic message:
I think custom panic messages are a nice way to provide more context to a test failure, so I think it would be great if snapbox supported them.
Activity
feat(snapbox)!: Support custom panic messages
feat(snapbox)!: Support custom panic messages
epage commentedon Aug 18, 2023
Yeah, I've recently gotten requests for this from others. When creating
snapbox, I overlooked this becauseAssert, meaning the macros don't get as much attentionThe main care about I had was then handled with
track_caller.If we move forward with this, I would expect we'd try to match the new assert format that is coming out soon, where relevant.
My main concern is what the API should look like for something like this.
Assertis a first class citizen in the API and should be able to be reused across calls (something which the current solution in #224 does not handle). I also don't like creating a bunch of variations of functions for different use cases. Maybe smaller builders off ofAssert?not-my-profile commentedon Aug 18, 2023
Do you have a link for or more context about that?
epage commentedon Aug 19, 2023
rust-lang/rust#111071
feat(assert): Add `assert_data_eq!`
feat(assert): Add `assert_data_eq!`
feat(assert): Add `assert_data_eq!`