-
-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add WithMessageContaining for delegates
#679
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
31 changes: 31 additions & 0 deletions
31
Source/aweXpect/That/Delegates/ThatDelegateThrows.WithMessageContaining.cs
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| using System; | ||
| using aweXpect.Core; | ||
| using aweXpect.Delegates; | ||
| using aweXpect.Options; | ||
| using aweXpect.Results; | ||
|
|
||
| namespace aweXpect; | ||
|
|
||
| public static partial class ThatDelegateThrows | ||
| { | ||
| /// <summary> | ||
| /// Verifies that the thrown exception has a message that contains the <paramref name="expected" /> pattern. | ||
| /// </summary> | ||
| public static StringEqualityResult<TException, ThatDelegateThrows<TException>> WithMessageContaining<TException>( | ||
| this ThatDelegateThrows<TException> source, | ||
| string? expected) | ||
| where TException : Exception? | ||
| { | ||
| StringEqualityOptions options = new(); | ||
| return new StringEqualityResult<TException, ThatDelegateThrows<TException>>( | ||
| source.ExpectationBuilder.AddConstraint((it, grammars) | ||
| => new ThatException.HasMessageContainingConstraint( | ||
| source.ExpectationBuilder, | ||
| it, | ||
| grammars | ExpectationGrammars.Active | ExpectationGrammars.Nested, | ||
| expected, | ||
| options)), | ||
| source, | ||
| options); | ||
| } | ||
| } |
This file contains hidden or 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
99 changes: 99 additions & 0 deletions
99
Source/aweXpect/That/Exceptions/ThatException.HasMessageContaining.cs
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| using System; | ||
| using aweXpect.Core; | ||
| using aweXpect.Core.Constraints; | ||
| using aweXpect.Helpers; | ||
| using aweXpect.Options; | ||
| using aweXpect.Results; | ||
|
|
||
| namespace aweXpect; | ||
|
|
||
| public static partial class ThatException | ||
| { | ||
| /// <summary> | ||
| /// Verifies that the actual exception has a message containing the <paramref name="expected" /> pattern. | ||
| /// </summary> | ||
| public static StringEqualityTypeResult<Exception?, IThat<Exception?>> HasMessageContaining( | ||
| this IThat<Exception?> source, | ||
| string? expected) | ||
| { | ||
| StringEqualityOptions options = new(); | ||
| return new StringEqualityTypeResult<Exception?, IThat<Exception?>>( | ||
| source.Get().ExpectationBuilder.AddConstraint((expectationBuilder, it, grammars) | ||
| => new HasMessageContainingConstraint( | ||
| expectationBuilder, it, grammars, expected, options)), | ||
| source, | ||
| options); | ||
| } | ||
|
|
||
| internal class HasMessageContainingConstraint( | ||
| ExpectationBuilder expectationBuilder, | ||
| string it, | ||
| ExpectationGrammars grammars, | ||
| string? expected, | ||
| StringEqualityOptions options) | ||
| : ConstraintResult.WithValue<Exception?>(grammars), | ||
| IValueConstraint<Exception?> | ||
| { | ||
| public ConstraintResult IsMetBy(Exception? actual) | ||
| { | ||
| Actual = actual; | ||
| options.AsWildcard(); | ||
| Outcome = expected is null || options.AreConsideredEqual(actual?.Message, $"*{expected}*") | ||
| ? Outcome.Success | ||
| : Outcome.Failure; | ||
| if (Outcome == Outcome.Failure) | ||
| { | ||
| expectationBuilder.UpdateContexts(contexts => contexts | ||
| .Add(new ResultContext("Message", actual?.Message))); | ||
| } | ||
|
|
||
| return this; | ||
| } | ||
|
|
||
| protected override void AppendNormalExpectation(StringBuilder stringBuilder, string? indentation = null) | ||
| { | ||
| ExpectationGrammars equalityGrammars = Grammars; | ||
| if (Grammars.HasFlag(ExpectationGrammars.Active)) | ||
| { | ||
| stringBuilder.Append("with Message containing "); | ||
| equalityGrammars &= ~ExpectationGrammars.Active; | ||
| } | ||
| else if (Grammars.HasFlag(ExpectationGrammars.Nested)) | ||
| { | ||
| stringBuilder.Append("Message contains "); | ||
| } | ||
| else | ||
| { | ||
| stringBuilder.Append("contains Message "); | ||
| } | ||
|
|
||
| stringBuilder.Append(options.GetExpectation(expected, equalityGrammars)); | ||
| } | ||
|
|
||
| protected override void AppendNormalResult(StringBuilder stringBuilder, string? indentation = null) | ||
|
vbreuss marked this conversation as resolved.
|
||
| => stringBuilder.Append(options.GetExtendedFailure(it, Grammars, Actual?.Message, expected)); | ||
|
|
||
| protected override void AppendNegatedExpectation(StringBuilder stringBuilder, string? indentation = null) | ||
|
vbreuss marked this conversation as resolved.
|
||
| { | ||
| ExpectationGrammars equalityGrammars = Grammars; | ||
| if (Grammars.HasFlag(ExpectationGrammars.Active)) | ||
| { | ||
| stringBuilder.Append("with Message containing "); | ||
| equalityGrammars &= ~ExpectationGrammars.Active; | ||
| } | ||
| else if (Grammars.HasFlag(ExpectationGrammars.Nested)) | ||
| { | ||
| stringBuilder.Append("Message contains "); | ||
| } | ||
| else | ||
| { | ||
| stringBuilder.Append("contains Message "); | ||
| } | ||
|
|
||
| stringBuilder.Append(options.GetExpectation(expected, equalityGrammars)); | ||
| } | ||
|
|
||
| protected override void AppendNegatedResult(StringBuilder stringBuilder, string? indentation = null) | ||
|
vbreuss marked this conversation as resolved.
|
||
| => AppendNormalResult(stringBuilder, indentation); | ||
| } | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
176 changes: 176 additions & 0 deletions
176
Tests/aweXpect.Tests/Delegates/ThatDelegate.ThrowsException.WithMessageContainingTests.cs
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| namespace aweXpect.Tests; | ||
|
|
||
| public sealed partial class ThatDelegate | ||
| { | ||
| public sealed partial class ThrowsException | ||
| { | ||
| public sealed class WithMessageContainingTests | ||
| { | ||
| [Fact] | ||
| public async Task CanCompareCaseInsensitive() | ||
| { | ||
| string message = "_FOO_BAR"; | ||
| Exception exception = | ||
| new OuterException(message, new CustomException()); | ||
| void Delegate() => throw exception; | ||
|
|
||
| async Task Act() | ||
| => await That(Delegate).ThrowsException() | ||
| .WithMessageContaining("foo").IgnoringCase(); | ||
|
|
||
| await That(Act).DoesNotThrow(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task CanUseWildcardCheck() | ||
| { | ||
| string message = "_foo-BAR"; | ||
| Exception exception = | ||
| new OuterException(message, new CustomException()); | ||
| void Delegate() => throw exception; | ||
|
|
||
| async Task Act() | ||
| => await That(Delegate).ThrowsException() | ||
| .WithMessageContaining("f?o-"); | ||
|
|
||
| await That(Act).DoesNotThrow(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task ShouldCompareCaseSensitive() | ||
| { | ||
| string message = "FOO"; | ||
| Exception exception = | ||
| new OuterException(message, new CustomException()); | ||
| void Delegate() => throw exception; | ||
|
|
||
| async Task Act() | ||
| => await That(Delegate).ThrowsException() | ||
| .WithMessageContaining("foo"); | ||
|
|
||
| await That(Act).Throws<XunitException>() | ||
| .WithMessage(""" | ||
| Expected that Delegate | ||
| throws an exception with Message containing matching "foo", | ||
| but it did not match: | ||
| ↓ (actual) | ||
| "FOO" | ||
| "foo" | ||
| ↑ (wildcard pattern) | ||
|
|
||
| Message: | ||
| FOO | ||
| """); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task ShouldIgnorePrecedingText() | ||
| { | ||
| string message = "some text before foo"; | ||
| Exception exception = | ||
| new OuterException(message, new CustomException()); | ||
| void Delegate() => throw exception; | ||
|
|
||
| async Task Act() | ||
| => await That(Delegate).ThrowsException() | ||
| .WithMessageContaining("foo"); | ||
|
|
||
| await That(Act).DoesNotThrow(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task ShouldIgnoreSucceedingText() | ||
| { | ||
| string message = "foo and some other text"; | ||
| Exception exception = | ||
| new OuterException(message, new CustomException()); | ||
| void Delegate() => throw exception; | ||
|
|
||
| async Task Act() | ||
| => await That(Delegate).ThrowsException() | ||
| .WithMessageContaining("foo"); | ||
|
|
||
| await That(Act).DoesNotThrow(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task ShouldIncludeExceptionType() | ||
| { | ||
| string message = "FOO"; | ||
| Exception exception = new CustomException(message); | ||
| void Delegate() => throw exception; | ||
|
|
||
| async Task Act() | ||
| => await That(Delegate).Throws<CustomException>() | ||
| .WithMessageContaining("foo"); | ||
|
|
||
| await That(Act).Throws<XunitException>() | ||
| .WithMessage(""" | ||
| Expected that Delegate | ||
| throws a ThatDelegate.CustomException with Message containing matching "foo", | ||
| but it did not match: | ||
| ↓ (actual) | ||
| "FOO" | ||
| "foo" | ||
| ↑ (wildcard pattern) | ||
|
|
||
| Message: | ||
| FOO | ||
| """); | ||
| } | ||
|
|
||
| [Theory] | ||
| [AutoData] | ||
| public async Task WhenAwaited_ShouldReturnThrownException(string message) | ||
| { | ||
| Exception exception = | ||
| new OuterException(message, new CustomException()); | ||
| void Delegate() => throw exception; | ||
|
|
||
| Exception result = await That(Delegate) | ||
| .ThrowsException().WithMessageContaining(message); | ||
|
|
||
| await That(result).IsSameAs(exception); | ||
| } | ||
|
|
||
| [Theory] | ||
| [AutoData] | ||
| public async Task WhenExpectedIsNull_ShouldSucceed(string message) | ||
| { | ||
| Exception exception = new(message); | ||
| void Delegate() => throw exception; | ||
|
|
||
| async Task Act() | ||
| => await That(Delegate).ThrowsException() | ||
| .WithMessageContaining(null); | ||
|
|
||
| await That(Act).DoesNotThrow(); | ||
| } | ||
|
|
||
| [Fact] | ||
| public async Task WhenMessagesAreDifferent_ShouldFail() | ||
| { | ||
| string actual = "expected actual text"; | ||
| string expected = "expected other text"; | ||
| Action action = () => throw new CustomException(actual); | ||
|
|
||
| async Task Act() | ||
| => await That(action).ThrowsException().WithMessageContaining(expected); | ||
|
|
||
| await That(Act).Throws<XunitException>() | ||
| .WithMessage(""" | ||
| Expected that action | ||
| throws an exception with Message containing matching "expected other text", | ||
| but it did not match: | ||
| ↓ (actual) | ||
| "expected actual text" | ||
| "expected other text" | ||
| ↑ (wildcard pattern) | ||
|
|
||
| Message: | ||
| expected actual text | ||
| """); | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.