Safer formatting of Xunit assertion messages #7446
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
milang
force-pushed
the
safer-message-format
branch
from
a141a33 to
208c05e
Compare
|
Thanks @milang , I was about to create a PR but I saw that you had already done one. |
This is a racy spec - there's a bunch of timing-sensitive ones in the Akka.Streams test suite that have this problem. Issue is not caused by your PR |
I'll need to re-run this and see what's going on here - test didn't get "reported" as failed by AzDo for some reason, but I could find this in the logs. |
I removed serialization from |
Let's go ahead and keep it just because I don't know what the secondary effects are of removing it |
milang
force-pushed
the
safer-message-format
branch
from
f213199 to
e93440b
Compare
I restored the |
|
Thank you @milang ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #7442
Changes
This pull request updates
Akka.TestKit.XUnit2to format assertion messages withstring.Formatonly when formatting arguments are specified, otherwise it uses format string as-is. For more background/motivation, please see akkadotnet/Akka.TestKit.NUnit#159.Additionally, this PR adds a new project,
src/contrib/testkits/Akka.TestKit.Xunit2.Tests. This project contains tests that verify formatting behavior.This PR also refactors the existing
AkkaEqualExceptionclass. Instead of deferring assertion message creation/formatting untilMessageproperty call (as originally implemented), the updated code builds the message at the time exception instance is created, and stores the value in base class'Messageproperty. This allows us to remove_format+_argsfields and theMessageproperty override, simplifying the class.Please note that I also fixed the
protected AkkaEqualException(SerializationInfo info, StreamingContext context)deserialization constructor that was implemented incorrectly + markedAkkaEqualExceptionas[Serializable]+ added a testAkkaEqualExceptionSpec.Constructor_deserializes_messageto verify the serialization/deserialization roundtrip preserves the most important part of the exception instance,Message. I personally recommend removing the constructor altogether, as the base classXunitExceptiondoes not implement deserialization constructor at all, plus the binary formatter is obsolete as of .NET 8+ (Microsoft announcement).Important
@Aaronontheweb please let me know if you would like me to remove the constructor as part of this PR.
Checklist
For significant changes, please ensure that the following have been completed (delete if not relevant):