Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add Imply() to BooleanAssertions #2074

Merged
merged 20 commits into from Jan 3, 2023
Merged

Add Imply() to BooleanAssertions #2074

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
7918ef1
Add `Imply()` to `BooleanAssertions`
IT-VBFK Dec 28, 2022
70dd569
Approve API
IT-VBFK Dec 28, 2022
4a2d67c
Add release notes
IT-VBFK Dec 28, 2022
c2a2344
Update the docs
IT-VBFK Dec 28, 2022
7c66a67
Fix possible `NullReferenceException`
IT-VBFK Dec 28, 2022
fa65a54
Test the because arguments
IT-VBFK Dec 28, 2022
694bd37
Add missing xml comments
IT-VBFK Dec 28, 2022
ade5b60
Fix test names and variable names
IT-VBFK Dec 28, 2022
0e82b92
Accept API changes
IT-VBFK Dec 28, 2022
7657c93
Using `CallerArgumentExpression`
IT-VBFK Dec 28, 2022
aa4ccbf
Accept API changes
IT-VBFK Dec 28, 2022
16f335f
Mention the `CallerArgumentExpression` in the docs
IT-VBFK Dec 28, 2022
1dbf235
Name the operands for the implication correctly
IT-VBFK Dec 29, 2022
97ccf12
Accept API changes
IT-VBFK Dec 29, 2022
3b134c9
Add documentation about necessity of the caller argument expression
IT-VBFK Dec 30, 2022
5c1a4f6
Remove `CallerArgumentExpression`
IT-VBFK Dec 30, 2022
c2ccbcc
Update Src/FluentAssertions/Primitives/BooleanAssertions.cs
IT-VBFK Jan 2, 2023
c2a49ef
Minor typo fixes
IT-VBFK Jan 2, 2023
6d09735
Switch from `MemberData` to `InlineData`
IT-VBFK Jan 3, 2023
3f340f5
Update Tests/FluentAssertions.Specs/Primitives/BooleanAssertionSpecs.cs
IT-VBFK Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions Src/FluentAssertions/Primitives/BooleanAssertions.cs
View file
Open in desktop
Expand Up @@ -118,6 +118,16 @@ public AndConstraint<TAssertions> NotBe(bool unexpected, string because = "", pa
return new AndConstraint<TAssertions>((TAssertions)this);
}

public AndConstraint<TAssertions> Imply(bool expectation, string because = "", params object[] becauseArgs)
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved
{
Execute.Assertion
.ForCondition(!Subject.Value || expectation)
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved
.BecauseOf(because, becauseArgs)
.FailWith("Expected {context:boolean} ({0}) to imply {1} ({2}){reason}, but it did not.", Subject, nameof(expectation), expectation);
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved

return new AndConstraint<TAssertions>((TAssertions)this);
}

/// <inheritdoc/>
public override bool Equals(object obj) =>
throw new NotSupportedException("Equals is not part of Fluent Assertions. Did you mean Be() instead?");
Expand Down
1 change: 1 addition & 0 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt
View file
Open in desktop
Expand Up @@ -1816,6 +1816,7 @@ namespace FluentAssertions.Primitives
public FluentAssertions.AndConstraint<TAssertions> BeFalse(string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> BeTrue(string because = "", params object[] becauseArgs) { }
public override bool Equals(object obj) { }
public FluentAssertions.AndConstraint<TAssertions> Imply(bool expectation, string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> NotBe(bool unexpected, string because = "", params object[] becauseArgs) { }
}
public class DateTimeAssertions : FluentAssertions.Primitives.DateTimeAssertions<FluentAssertions.Primitives.DateTimeAssertions>
Expand Down
1 change: 1 addition & 0 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/net6.0.verified.txt
View file
Open in desktop
Expand Up @@ -1841,6 +1841,7 @@ namespace FluentAssertions.Primitives
public FluentAssertions.AndConstraint<TAssertions> BeFalse(string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> BeTrue(string because = "", params object[] becauseArgs) { }
public override bool Equals(object obj) { }
public FluentAssertions.AndConstraint<TAssertions> Imply(bool expectation, string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> NotBe(bool unexpected, string because = "", params object[] becauseArgs) { }
}
public class DateOnlyAssertions : FluentAssertions.Primitives.DateOnlyAssertions<FluentAssertions.Primitives.DateOnlyAssertions>
Expand Down
1 change: 1 addition & 0 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt
View file
Open in desktop
Expand Up @@ -1816,6 +1816,7 @@ namespace FluentAssertions.Primitives
public FluentAssertions.AndConstraint<TAssertions> BeFalse(string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> BeTrue(string because = "", params object[] becauseArgs) { }
public override bool Equals(object obj) { }
public FluentAssertions.AndConstraint<TAssertions> Imply(bool expectation, string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> NotBe(bool unexpected, string because = "", params object[] becauseArgs) { }
}
public class DateTimeAssertions : FluentAssertions.Primitives.DateTimeAssertions<FluentAssertions.Primitives.DateTimeAssertions>
Expand Down
1 change: 1 addition & 0 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt
View file
Open in desktop
Expand Up @@ -1816,6 +1816,7 @@ namespace FluentAssertions.Primitives
public FluentAssertions.AndConstraint<TAssertions> BeFalse(string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> BeTrue(string because = "", params object[] becauseArgs) { }
public override bool Equals(object obj) { }
public FluentAssertions.AndConstraint<TAssertions> Imply(bool expectation, string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> NotBe(bool unexpected, string because = "", params object[] becauseArgs) { }
}
public class DateTimeAssertions : FluentAssertions.Primitives.DateTimeAssertions<FluentAssertions.Primitives.DateTimeAssertions>
Expand Down
1 change: 1 addition & 0 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt
View file
Open in desktop
Expand Up @@ -1767,6 +1767,7 @@ namespace FluentAssertions.Primitives
public FluentAssertions.AndConstraint<TAssertions> BeFalse(string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> BeTrue(string because = "", params object[] becauseArgs) { }
public override bool Equals(object obj) { }
public FluentAssertions.AndConstraint<TAssertions> Imply(bool expectation, string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> NotBe(bool unexpected, string because = "", params object[] becauseArgs) { }
}
public class DateTimeAssertions : FluentAssertions.Primitives.DateTimeAssertions<FluentAssertions.Primitives.DateTimeAssertions>
Expand Down
1 change: 1 addition & 0 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt
View file
Open in desktop
Expand Up @@ -1816,6 +1816,7 @@ namespace FluentAssertions.Primitives
public FluentAssertions.AndConstraint<TAssertions> BeFalse(string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> BeTrue(string because = "", params object[] becauseArgs) { }
public override bool Equals(object obj) { }
public FluentAssertions.AndConstraint<TAssertions> Imply(bool expectation, string because = "", params object[] becauseArgs) { }
public FluentAssertions.AndConstraint<TAssertions> NotBe(bool unexpected, string because = "", params object[] becauseArgs) { }
}
public class DateTimeAssertions : FluentAssertions.Primitives.DateTimeAssertions<FluentAssertions.Primitives.DateTimeAssertions>
Expand Down
313 changes: 180 additions & 133 deletions Tests/FluentAssertions.Specs/Primitives/BooleanAssertionSpecs.cs
View file
Open in desktop
Expand Up @@ -6,151 +6,198 @@ namespace FluentAssertions.Specs.Primitives;

public class BooleanAssertionSpecs
{
[Fact]
public void Should_succeed_when_asserting_boolean_value_true_is_true()
public class BeTrue
{
// Arrange
bool boolean = true;

// Act / Assert
boolean.Should().BeTrue();
}

[Fact]
public void Should_fail_when_asserting_boolean_value_false_is_true()
{
// Arrange
bool boolean = false;

// Act
Action action = () => boolean.Should().BeTrue();

// Assert
action.Should().Throw<XunitException>();
[Fact]
public void Should_succeed_when_asserting_boolean_value_true_is_true()
{
// Arrange
bool boolean = true;

// Act / Assert
boolean.Should().BeTrue();
}

[Fact]
public void Should_fail_when_asserting_boolean_value_false_is_true()
{
// Arrange
bool boolean = false;

// Act
Action action = () => boolean.Should().BeTrue();

// Assert
action.Should().Throw<XunitException>();
}

[Fact]
public void Should_fail_with_descriptive_message_when_asserting_boolean_value_false_is_true()
{
// Act
Action action = () =>
false.Should().BeTrue("because we want to test the failure {0}", "message");

// Assert
action
.Should().Throw<XunitException>()
.WithMessage("Expected boolean to be true because we want to test the failure message, but found False.");
}
}

[Fact]
public void Should_fail_with_descriptive_message_when_asserting_boolean_value_false_is_true()
public class BeFalse
{
// Act
Action action = () =>
false.Should().BeTrue("because we want to test the failure {0}", "message");

// Assert
action
.Should().Throw<XunitException>()
.WithMessage("Expected boolean to be true because we want to test the failure message, but found False.");
[Fact]
public void Should_succeed_when_asserting_boolean_value_false_is_false()
{
// Act
Action action = () =>
false.Should().BeFalse();

// Assert
action.Should().NotThrow();
}

[Fact]
public void Should_fail_when_asserting_boolean_value_true_is_false()
{
// Act
Action action = () =>
true.Should().BeFalse();

// Assert
action.Should().Throw<XunitException>();
}

[Fact]
public void Should_fail_with_descriptive_message_when_asserting_boolean_value_true_is_false()
{
// Act
Action action = () =>
true.Should().BeFalse("we want to test the failure {0}", "message");

// Assert
action.Should().Throw<XunitException>()
.WithMessage("Expected boolean to be false because we want to test the failure message, but found True.");
}
}

[Fact]
public void Should_succeed_when_asserting_boolean_value_false_is_false()
public class Be
{
// Act
Action action = () =>
false.Should().BeFalse();

// Assert
action.Should().NotThrow();
[Fact]
public void Should_succeed_when_asserting_boolean_value_to_be_equal_to_the_same_value()
{
// Act
Action action = () =>
false.Should().Be(false);

// Assert
action.Should().NotThrow();
}

[Fact]
public void Should_fail_when_asserting_boolean_value_to_be_equal_to_a_different_value()
{
// Act
Action action = () =>
false.Should().Be(true);

// Assert
action.Should().Throw<XunitException>();
}

[Fact]
public void Should_fail_with_descriptive_message_when_asserting_boolean_value_to_be_equal_to_a_different_value()
{
// Act
Action action = () =>
false.Should().Be(true, "because we want to test the failure {0}", "message");

// Assert
action.Should().Throw<XunitException>()
.WithMessage("*Expected*boolean*True*because we want to test the failure message, but found False.*");
}
}

[Fact]
public void Should_fail_when_asserting_boolean_value_true_is_false()
public class NotBe
{
// Act
Action action = () =>
true.Should().BeFalse();

// Assert
action.Should().Throw<XunitException>();
[Fact]
public void Should_succeed_when_asserting_boolean_value_not_to_be_equal_to_the_same_value()
{
// Act
Action action = () =>
true.Should().NotBe(false);

// Assert
action.Should().NotThrow();
}

[Fact]
public void Should_fail_when_asserting_boolean_value_not_to_be_equal_to_a_different_value()
{
// Act
Action action = () =>
true.Should().NotBe(true);

// Assert
action.Should().Throw<XunitException>();
}

[Fact]
public void Should_fail_with_descriptive_message_when_asserting_boolean_value_not_to_be_equal_to_a_different_value()
{
// Act
Action action = () =>
true.Should().NotBe(true, "because we want to test the failure {0}", "message");

// Assert
action.Should().Throw<XunitException>()
.WithMessage("*Expected*boolean*True*because we want to test the failure message, but found True.*");
}

[Fact]
public void Should_throw_a_helpful_error_when_accidentally_using_equals()
{
// Act
Action action = () => true.Should().Equals(true);

// Assert
action.Should().Throw<NotSupportedException>().WithMessage("Equals is not part of Fluent Assertions. Did you mean Be() instead?");
}
}

[Fact]
public void Should_fail_with_descriptive_message_when_asserting_boolean_value_true_is_false()
public class Imply
{
// Act
Action action = () =>
true.Should().BeFalse("we want to test the failure {0}", "message");

// Assert
action.Should().Throw<XunitException>()
.WithMessage("Expected boolean to be false because we want to test the failure message, but found True.");
}

[Fact]
public void Should_succeed_when_asserting_boolean_value_to_be_equal_to_the_same_value()
{
// Act
Action action = () =>
false.Should().Be(false);

// Assert
action.Should().NotThrow();
}

[Fact]
public void Should_fail_when_asserting_boolean_value_to_be_equal_to_a_different_value()
{
// Act
Action action = () =>
false.Should().Be(true);

// Assert
action.Should().Throw<XunitException>();
}

[Fact]
public void Should_fail_with_descriptive_message_when_asserting_boolean_value_to_be_equal_to_a_different_value()
{
// Act
Action action = () =>
false.Should().Be(true, "because we want to test the failure {0}", "message");

// Assert
action.Should().Throw<XunitException>()
.WithMessage("*Expected*boolean*True*because we want to test the failure message, but found False.*");
}

[Fact]
public void Should_succeed_when_asserting_boolean_value_not_to_be_equal_to_the_same_value()
{
// Act
Action action = () =>
true.Should().NotBe(false);

// Assert
action.Should().NotThrow();
}

[Fact]
public void Should_fail_when_asserting_boolean_value_not_to_be_equal_to_a_different_value()
{
// Act
Action action = () =>
true.Should().NotBe(true);

// Assert
action.Should().Throw<XunitException>();
}

[Fact]
public void Should_fail_with_descriptive_message_when_asserting_boolean_value_not_to_be_equal_to_a_different_value()
{
// Act
Action action = () =>
true.Should().NotBe(true, "because we want to test the failure {0}", "message");

// Assert
action.Should().Throw<XunitException>()
.WithMessage("*Expected*boolean*True*because we want to test the failure message, but found True.*");
}

[Fact]
public void Should_throw_a_helpful_error_when_accidentally_using_equals()
{
// Act
Action action = () => true.Should().Equals(true);

// Assert
action.Should().Throw<NotSupportedException>().WithMessage("Equals is not part of Fluent Assertions. Did you mean Be() instead?");
public static TheoryData<bool, bool> PassingImplications => new()
{
{ false, false },
{ false, true },
{ true, true }
};

public static TheoryData<bool, bool> NonPassingImplications => new()
{
{ true, false }
};

[Theory]
[MemberData(nameof(PassingImplications), MemberType = typeof(BooleanAssertionSpecs.Imply))]
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved
public void A_implies_B(bool a, bool b)
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved
{
// Act / Assert
a.Should().Imply(b);
}

[Theory]
[MemberData(nameof(NonPassingImplications), MemberType = typeof(BooleanAssertionSpecs.Imply))]
public void A_does_not_imply_B(bool a, bool b)
{
// Act
Action act = () => a.Should().Imply(b);
IT-VBFK marked this conversation as resolved.
Show resolved Hide resolved

// Assert
act.Should().Throw<XunitException>()
.WithMessage("Expected*to imply*but it did not*");
}
}
}