From 36b612aeb260c284d92a596f5cf406e311e625ee Mon Sep 17 00:00:00 2001 From: Dennis Doomen Date: Sat, 1 Jan 2022 13:52:08 +0100 Subject: [PATCH 01/25] Update releases.md --- docs/_pages/releases.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/_pages/releases.md b/docs/_pages/releases.md index b7846665a0..efad6be024 100644 --- a/docs/_pages/releases.md +++ b/docs/_pages/releases.md @@ -9,6 +9,12 @@ sidebar: ## Unreleased +### What's New + +### Fixes + +## 6.3.0 + ### What's New * Adding `ThatAreAsync()` and `ThatAreNotAsync()` for filtering in method assertions - [#1725](https://github.com/fluentassertions/fluentassertions/pull/1725) * Adding `ThatAreVirtual()` and `ThatAreNotVirtual()` for filtering in method assertions - [#1744](https://github.com/fluentassertions/fluentassertions/pull/1744) From 50d1f00c6e76b1eee0b8aa044176861f9891fbe6 Mon Sep 17 00:00:00 2001 From: Dennis Doomen Date: Sat, 1 Jan 2022 13:53:08 +0100 Subject: [PATCH 02/25] Update index.html --- docs/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.html b/docs/index.html index c5349dcddc..5f556393ca 100644 --- a/docs/index.html +++ b/docs/index.html @@ -6,7 +6,7 @@ overlay_color: "#373737" overlay_filter: "0.7" overlay_image: "/assets/images/fluent_assertions_large_horizontal.svg" - cta_label: "v6 is out NOW!" + cta_label: "Happy 2022! And don't forget to grab 6.3..." cta_url: "https://www.continuousimprover.com/2021/08/fluent-assertions-v6" caption: "Logo by [**IUserName**](https://github.com/IUsername) and icons by [**Zlatko Najdenovski**](https://www.flaticon.com/authors/zlatko-najdenovski) from [Flaticon](https://www.flaticon.com/) " From 885f873973a638f4ce9a35a46f150175a64d015f Mon Sep 17 00:00:00 2001 From: chvollm <37902729+chvollm@users.noreply.github.com> Date: Thu, 6 Jan 2022 14:21:36 +0100 Subject: [PATCH 03/25] Adds ThatAreStatic and ThatAreNotStatic to method-level Reflection assertions (#1740) --- .../Types/MethodInfoSelector.cs | 20 ++++++++++- .../FluentAssertions/net47.verified.txt | 2 ++ .../netcoreapp2.1.verified.txt | 2 ++ .../netcoreapp3.0.verified.txt | 2 ++ .../netstandard2.0.verified.txt | 2 ++ .../netstandard2.1.verified.txt | 2 ++ .../Types/MethodInfoSelectorSpecs.cs | 35 +++++++++++++++++++ docs/_pages/releases.md | 3 +- 8 files changed, 66 insertions(+), 2 deletions(-) diff --git a/Src/FluentAssertions/Types/MethodInfoSelector.cs b/Src/FluentAssertions/Types/MethodInfoSelector.cs index e3ba8ca102..f800d0d656 100644 --- a/Src/FluentAssertions/Types/MethodInfoSelector.cs +++ b/Src/FluentAssertions/Types/MethodInfoSelector.cs @@ -35,7 +35,7 @@ public MethodInfoSelector(IEnumerable types) Guard.ThrowIfArgumentContainsNull(types, nameof(types)); selectedMethods = types.SelectMany(t => t - .GetMethods(BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic) + .GetMethods(BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic) .Where(method => !HasSpecialName(method))); } @@ -151,6 +151,24 @@ public MethodInfoSelector ThatAreNotAsync() return this; } + ///

+ /// Only return methods that are static. + ///

+ public MethodInfoSelector ThatAreStatic() + { + selectedMethods = selectedMethods.Where(method => method.IsStatic); + return this; + } + + ///

+ /// Only return methods that are not static. + ///

+ public MethodInfoSelector ThatAreNotStatic() + { + selectedMethods = selectedMethods.Where(method => !method.IsStatic); + return this; + } + ///

/// Only return methods that are virtual. ///

diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt index ee73949aa0..0f7328406c 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt @@ -2363,7 +2363,9 @@ namespace FluentAssertions.Types where TAttribute : System.Attribute { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotDecoratedWithOrInherit() where TAttribute : System.Attribute { } + public FluentAssertions.Types.MethodInfoSelector ThatAreNotStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotVirtual() { } + public FluentAssertions.Types.MethodInfoSelector ThatAreStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreVirtual() { } public FluentAssertions.Types.MethodInfoSelector ThatDoNotReturn() { } public FluentAssertions.Types.MethodInfoSelector ThatReturn() { } diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt index d5b927c7d6..8427581cf0 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt @@ -2365,7 +2365,9 @@ namespace FluentAssertions.Types where TAttribute : System.Attribute { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotDecoratedWithOrInherit() where TAttribute : System.Attribute { } + public FluentAssertions.Types.MethodInfoSelector ThatAreNotStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotVirtual() { } + public FluentAssertions.Types.MethodInfoSelector ThatAreStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreVirtual() { } public FluentAssertions.Types.MethodInfoSelector ThatDoNotReturn() { } public FluentAssertions.Types.MethodInfoSelector ThatReturn() { } diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt index 62d7b60d9a..d0c715644a 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt @@ -2365,7 +2365,9 @@ namespace FluentAssertions.Types where TAttribute : System.Attribute { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotDecoratedWithOrInherit() where TAttribute : System.Attribute { } + public FluentAssertions.Types.MethodInfoSelector ThatAreNotStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotVirtual() { } + public FluentAssertions.Types.MethodInfoSelector ThatAreStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreVirtual() { } public FluentAssertions.Types.MethodInfoSelector ThatDoNotReturn() { } public FluentAssertions.Types.MethodInfoSelector ThatReturn() { } diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt index 45c197d938..9b13b251b7 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt @@ -2316,7 +2316,9 @@ namespace FluentAssertions.Types where TAttribute : System.Attribute { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotDecoratedWithOrInherit() where TAttribute : System.Attribute { } + public FluentAssertions.Types.MethodInfoSelector ThatAreNotStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotVirtual() { } + public FluentAssertions.Types.MethodInfoSelector ThatAreStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreVirtual() { } public FluentAssertions.Types.MethodInfoSelector ThatDoNotReturn() { } public FluentAssertions.Types.MethodInfoSelector ThatReturn() { } diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt index 49ebf2d8c8..ea94174c5a 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt @@ -2365,7 +2365,9 @@ namespace FluentAssertions.Types where TAttribute : System.Attribute { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotDecoratedWithOrInherit() where TAttribute : System.Attribute { } + public FluentAssertions.Types.MethodInfoSelector ThatAreNotStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreNotVirtual() { } + public FluentAssertions.Types.MethodInfoSelector ThatAreStatic() { } public FluentAssertions.Types.MethodInfoSelector ThatAreVirtual() { } public FluentAssertions.Types.MethodInfoSelector ThatDoNotReturn() { } public FluentAssertions.Types.MethodInfoSelector ThatReturn() { } diff --git a/Tests/FluentAssertions.Specs/Types/MethodInfoSelectorSpecs.cs b/Tests/FluentAssertions.Specs/Types/MethodInfoSelectorSpecs.cs index f32f2c9911..e56e41f242 100644 --- a/Tests/FluentAssertions.Specs/Types/MethodInfoSelectorSpecs.cs +++ b/Tests/FluentAssertions.Specs/Types/MethodInfoSelectorSpecs.cs @@ -332,6 +332,34 @@ public void When_selecting_methods_that_are_not_virtual_it_should_only_return_th .And.NotContain(m => m.Name == "PublicVirtualVoidMethodWithAttribute") .And.NotContain(m => m.Name == "ProtectedVirtualVoidMethodWithAttribute"); } + + [Fact] + public void When_selecting_methods_that_are_static_it_should_only_return_the_applicable_methods() + { + // Arrange + Type type = typeof(TestClassForMethodSelectorWithStaticAndNonStaticMethod); + + // Act + MethodInfo[] methods = type.Methods().ThatAreStatic().ToArray(); + + // Assert + methods.Should().ContainSingle() + .Which.Name.Should().Be("PublicStaticMethod"); + } + + [Fact] + public void When_selecting_methods_that_are_not_static_it_should_only_return_the_applicable_methods() + { + // Arrange + Type type = typeof(TestClassForMethodSelectorWithStaticAndNonStaticMethod); + + // Act + MethodInfo[] methods = type.Methods().ThatAreNotStatic().ToArray(); + + // Assert + methods.Should().ContainSingle() + .Which.Name.Should().Be("PublicNonStaticMethod"); + } [Fact] public void When_selecting_methods_not_decorated_with_or_inheriting_a_noninheritable_attribute_it_should_only_return_the_applicable_methods() @@ -435,6 +463,13 @@ internal class TestClassForMethodSelectorWithAsyncAndNonAsyncMethod public Task PublicNonAsyncMethod() => Task.CompletedTask; } + internal class TestClassForMethodSelectorWithStaticAndNonStaticMethod + { + public static void PublicStaticMethod() { } + + public void PublicNonStaticMethod() { } + } + internal class TestClassForMethodReturnTypesSelector { public void SomeMethod() { } diff --git a/docs/_pages/releases.md b/docs/_pages/releases.md index efad6be024..be1359083f 100644 --- a/docs/_pages/releases.md +++ b/docs/_pages/releases.md @@ -18,10 +18,11 @@ sidebar: ### What's New * Adding `ThatAreAsync()` and `ThatAreNotAsync()` for filtering in method assertions - [#1725](https://github.com/fluentassertions/fluentassertions/pull/1725) * Adding `ThatAreVirtual()` and `ThatAreNotVirtual()` for filtering in method assertions - [#1744](https://github.com/fluentassertions/fluentassertions/pull/1744) +* Adding `ThatAreStatic()` and `ThatAreNotStatic()` for filtering in method assertions - [#1740](https://github.com/fluentassertions/fluentassertions/pull/1740) * Adding collection content to assertion messages for `HaveCountGreaterThan()`, `HaveCountGreaterThanOrEqualTo()`, `HaveCountLessThan()` and `HaveCountLessThanOrEqualTo()` - [#1760](https://github.com/fluentassertions/fluentassertions/pull/1760) - ### Fixes * Prevent multiple enumeration of `IEnumerable`s in parameter-less `ContainSingle()` - [#1753](https://github.com/fluentassertions/fluentassertions/pull/1753) +* Querying methods on classes, e.g. `typeof(MyController).Methods()`, now also includes static methods - [#1740](https://github.com/fluentassertions/fluentassertions/pull/1740) * Change `HaveCount()` assertion message order to state expected and actual collection count before dumping its content` - [#1760](https://github.com/fluentassertions/fluentassertions/pull/1760) * `CompleteWithinAsync` did not take initial sync computation into account when measuring execution time - [1762](https://github.com/fluentassertions/fluentassertions/pull/1762). From 648428eb66e92eb767dff27f6002ca0950c5c600 Mon Sep 17 00:00:00 2001 From: Dennis Doomen Date: Fri, 7 Jan 2022 11:43:35 +0100 Subject: [PATCH 04/25] Fixup of the release notes --- docs/_pages/releases.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_pages/releases.md b/docs/_pages/releases.md index be1359083f..eb5b94e687 100644 --- a/docs/_pages/releases.md +++ b/docs/_pages/releases.md @@ -10,19 +10,19 @@ sidebar: ## Unreleased ### What's New +* Adding `ThatAreStatic()` and `ThatAreNotStatic()` for filtering in method assertions - [#1740](https://github.com/fluentassertions/fluentassertions/pull/1740) ### Fixes +* Querying methods on classes, e.g. `typeof(MyController).Methods()`, now also includes static methods - [#1740](https://github.com/fluentassertions/fluentassertions/pull/1740) ## 6.3.0 ### What's New * Adding `ThatAreAsync()` and `ThatAreNotAsync()` for filtering in method assertions - [#1725](https://github.com/fluentassertions/fluentassertions/pull/1725) * Adding `ThatAreVirtual()` and `ThatAreNotVirtual()` for filtering in method assertions - [#1744](https://github.com/fluentassertions/fluentassertions/pull/1744) -* Adding `ThatAreStatic()` and `ThatAreNotStatic()` for filtering in method assertions - [#1740](https://github.com/fluentassertions/fluentassertions/pull/1740) * Adding collection content to assertion messages for `HaveCountGreaterThan()`, `HaveCountGreaterThanOrEqualTo()`, `HaveCountLessThan()` and `HaveCountLessThanOrEqualTo()` - [#1760](https://github.com/fluentassertions/fluentassertions/pull/1760) ### Fixes * Prevent multiple enumeration of `IEnumerable`s in parameter-less `ContainSingle()` - [#1753](https://github.com/fluentassertions/fluentassertions/pull/1753) -* Querying methods on classes, e.g. `typeof(MyController).Methods()`, now also includes static methods - [#1740](https://github.com/fluentassertions/fluentassertions/pull/1740) * Change `HaveCount()` assertion message order to state expected and actual collection count before dumping its content` - [#1760](https://github.com/fluentassertions/fluentassertions/pull/1760) * `CompleteWithinAsync` did not take initial sync computation into account when measuring execution time - [1762](https://github.com/fluentassertions/fluentassertions/pull/1762). From 208638d4d56fe4127e10fc035fe2defb7bbed956 Mon Sep 17 00:00:00 2001 From: MEmanuelsson Date: Fri, 7 Jan 2022 16:51:53 +0100 Subject: [PATCH 05/25] Trailing slash results in 404 page (#1767) Noticed that when going to https://fluentassertions.com/introduction/ I get a 404-page in response. If I remove the trailing slash it works. I guess the best solution is to make it work with and without trailing slash but this is at least one way of making the Issue template not pointing to a 404-page. --- ISSUE_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 6c9fc5255c..b4449db0ce 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -3,7 +3,7 @@ * Tried upgrading to newest version of Fluent Assertions, to see if your issue has already been resolved and released? * Checked existing open *and* closed [issues](https://github.com/fluentassertions/fluentassertions/issues?utf8=%E2%9C%93&q=is%3Aissue), to see if the issue has already been reported? * Tried reproducing your problem in a new isolated project? -* Read the [documentation](https://fluentassertions.com/introduction/)? +* Read the [documentation](https://fluentassertions.com/introduction)? * Considered if this is a general question and not a bug?. For general questions please use [StackOverflow](https://stackoverflow.com/questions/tagged/fluent-assertions?mixed=1). ### Description @@ -43,4 +43,4 @@ result.Should().Be('M'); ### Additional Information -Any additional information, configuration or data that might be necessary to reproduce the issue. \ No newline at end of file +Any additional information, configuration or data that might be necessary to reproduce the issue. From c7fe3e6eb438d9cecba5d24e270d4f31a61f2faf Mon Sep 17 00:00:00 2001 From: mu88 <4560672+mu88@users.noreply.github.com> Date: Mon, 10 Jan 2022 10:20:03 +0100 Subject: [PATCH 06/25] Introduce assertions for StatusCode of HttpResponseMessage (#1737) --- Src/FluentAssertions/AssertionExtensions.cs | 11 + Src/FluentAssertions/FluentAssertions.csproj | 1 + .../HttpResponseMessageAssertions.cs | 234 +++++++++++++++ .../FluentAssertions/net47.verified.txt | 17 ++ .../netcoreapp2.1.verified.txt | 17 ++ .../netcoreapp3.0.verified.txt | 17 ++ .../netstandard2.0.verified.txt | 17 ++ .../netstandard2.1.verified.txt | 17 ++ Tests/Benchmarks/Benchmarks.csproj | 2 +- .../HttpResponseMessageAssertionSpecs.cs | 271 ++++++++++++++++++ docs/_data/navigation.yml | 2 + docs/_pages/httpresponsemessages.md | 28 ++ docs/_pages/releases.md | 1 + 13 files changed, 634 insertions(+), 1 deletion(-) create mode 100644 Src/FluentAssertions/Primitives/HttpResponseMessageAssertions.cs create mode 100644 Tests/FluentAssertions.Specs/Primitives/HttpResponseMessageAssertionSpecs.cs create mode 100644 docs/_pages/httpresponsemessages.md diff --git a/Src/FluentAssertions/AssertionExtensions.cs b/Src/FluentAssertions/AssertionExtensions.cs index 9eb3e85dfc..4940cffe48 100644 --- a/Src/FluentAssertions/AssertionExtensions.cs +++ b/Src/FluentAssertions/AssertionExtensions.cs @@ -5,6 +5,7 @@ using System.Diagnostics; using System.IO; using System.Linq.Expressions; +using System.Net.Http; using System.Reflection; using System.Threading.Tasks; using System.Xml.Linq; @@ -302,6 +303,16 @@ public static NullableBooleanAssertions Should(this bool? actualValue) return new NullableBooleanAssertions(actualValue); } + ///

+ /// Returns an object that can be used to assert the + /// current . + ///

+ [Pure] + public static HttpResponseMessageAssertions Should(this HttpResponseMessage actualValue) + { + return new HttpResponseMessageAssertions(actualValue); + } + ///

/// Returns an object that can be used to assert the /// current . diff --git a/Src/FluentAssertions/FluentAssertions.csproj b/Src/FluentAssertions/FluentAssertions.csproj index 2204810ff1..330b2da149 100644 --- a/Src/FluentAssertions/FluentAssertions.csproj +++ b/Src/FluentAssertions/FluentAssertions.csproj @@ -75,6 +75,7 @@ + diff --git a/Src/FluentAssertions/Primitives/HttpResponseMessageAssertions.cs b/Src/FluentAssertions/Primitives/HttpResponseMessageAssertions.cs new file mode 100644 index 0000000000..45010cb0ce --- /dev/null +++ b/Src/FluentAssertions/Primitives/HttpResponseMessageAssertions.cs @@ -0,0 +1,234 @@ +using System.Diagnostics; +using System.Net; +using System.Net.Http; +using FluentAssertions.Execution; + +namespace FluentAssertions.Primitives +{ + ///

+ /// Contains a number of methods to assert that a is in the expected state. + ///

+ [DebuggerNonUserCode] + public class HttpResponseMessageAssertions : HttpResponseMessageAssertions + { + public HttpResponseMessageAssertions(HttpResponseMessage value) + : base(value) + { + } + } + + ///

+ /// Contains a number of methods to assert that a is in the expected state. + ///

+ [DebuggerNonUserCode] + public class HttpResponseMessageAssertions : ObjectAssertions + where TAssertions : HttpResponseMessageAssertions + { + protected HttpResponseMessageAssertions(HttpResponseMessage value) + : base(value) + { + } + + ///

+ /// Asserts that the is successful (2xx). + ///

+ /// + /// A formatted phrase as is supported by explaining why the assertion + /// is needed. If the phrase does not start with the word because, it is prepended automatically. + /// + /// + /// Zero or more objects to format using the placeholders in . + /// + public AndConstraint BeSuccessful(string because = "", params object[] becauseArgs) + { + var success = Execute.Assertion + .ForCondition(Subject is not null) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be successful (2xx){reason}, but HttpResponseMessage was ."); + + if (success) + { + Execute.Assertion + .ForCondition(Subject!.IsSuccessStatusCode) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be successful (2xx){reason}, but found {0}.", Subject.StatusCode); + } + + return new AndConstraint((TAssertions)this); + } + + ///

+ /// Asserts that the is redirection (3xx). + ///

+ /// + /// A formatted phrase as is supported by explaining why the assertion + /// is needed. If the phrase does not start with the word because, it is prepended automatically. + /// + /// + /// Zero or more objects to format using the placeholders in . + /// + public AndConstraint BeRedirection(string because = "", params object[] becauseArgs) + { + var success = Execute.Assertion + .ForCondition(Subject is not null) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be redirection (3xx){reason}, but HttpResponseMessage was ."); + + if (success) + { + Execute.Assertion + .ForCondition((int)Subject!.StatusCode is >= 300 and <= 399) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be redirection (3xx){reason}, but found {0}.", Subject.StatusCode); + } + + return new AndConstraint((TAssertions)this); + } + + ///

+ /// Asserts that the is either client (4xx) or server error (5xx). + ///

+ /// + /// A formatted phrase as is supported by explaining why the assertion + /// is needed. If the phrase does not start with the word because, it is prepended automatically. + /// + /// + /// Zero or more objects to format using the placeholders in . + /// + public AndConstraint HaveError(string because = "", params object[] becauseArgs) + { + var success = Execute.Assertion + .ForCondition(Subject is not null) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be an error{reason}, but HttpResponseMessage was ."); + + if (success) + { + Execute.Assertion + .ForCondition(IsClientError() || IsServerError()) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be an error{reason}, but found {0}.", Subject.StatusCode); + } + + return new AndConstraint((TAssertions)this); + } + + ///

+ /// Asserts that the is client error (4xx). + ///

+ /// + /// A formatted phrase as is supported by explaining why the assertion + /// is needed. If the phrase does not start with the word because, it is prepended automatically. + /// + /// + /// Zero or more objects to format using the placeholders in . + /// + public AndConstraint HaveClientError(string because = "", params object[] becauseArgs) + { + var success = Execute.Assertion + .ForCondition(Subject is not null) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be client error (4xx){reason}, but HttpResponseMessage was ."); + + if (success) + { + Execute.Assertion + .ForCondition(IsClientError()) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be client error (4xx){reason}, but found {0}.", Subject.StatusCode); + } + + return new AndConstraint((TAssertions)this); + } + + ///

+ /// Asserts that the is server error (5xx). + ///

+ /// + /// A formatted phrase as is supported by explaining why the assertion + /// is needed. If the phrase does not start with the word because, it is prepended automatically. + /// + /// + /// Zero or more objects to format using the placeholders in . + /// + public AndConstraint HaveServerError(string because = "", params object[] becauseArgs) + { + var success = Execute.Assertion + .ForCondition(Subject is not null) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be server error (5xx){reason}, but HttpResponseMessage was ."); + + if (success) + { + Execute.Assertion + .ForCondition(IsServerError()) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be server error (5xx){reason}, but found {0}.", Subject.StatusCode); + } + + return new AndConstraint((TAssertions)this); + } + + ///

+ /// Asserts that the is equal to the specified value. + ///

+ /// The expected value + /// + /// A formatted phrase as is supported by explaining why the assertion + /// is needed. If the phrase does not start with the word because, it is prepended automatically. + /// + /// + /// Zero or more objects to format using the placeholders in . + /// + public AndConstraint HaveStatusCode(HttpStatusCode expected, string because = "", params object[] becauseArgs) + { + var success = Execute.Assertion + .ForCondition(Subject is not null) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be {0}{reason}, but HttpResponseMessage was .", expected); + + if (success) + { + Execute.Assertion + .ForCondition(Subject!.StatusCode == expected) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode to be {0}{reason}, but found {1}.", expected, Subject.StatusCode); + } + + return new AndConstraint((TAssertions)this); + } + + ///

+ /// Asserts that the is not equal to the specified value. + ///

+ /// The unexpected value + /// + /// A formatted phrase as is supported by explaining why the assertion + /// is needed. If the phrase does not start with the word because, it is prepended automatically. + /// + /// + /// Zero or more objects to format using the placeholders in . + /// + public AndConstraint NotHaveStatusCode(HttpStatusCode unexpected, string because = "", params object[] becauseArgs) + { + var success = Execute.Assertion + .ForCondition(Subject is not null) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode not to be {0}{reason}, but HttpResponseMessage was .", unexpected); + + if (success) + { + Execute.Assertion + .ForCondition(Subject!.StatusCode != unexpected) + .BecauseOf(because, becauseArgs) + .FailWith("Expected HttpStatusCode not to be {0}{reason}, but found {1}.", unexpected, Subject.StatusCode); + } + + return new AndConstraint((TAssertions)this); + } + + private bool IsServerError() => (int)Subject.StatusCode is >= 500 and <= 599; + + private bool IsClientError() => (int)Subject.StatusCode is >= 400 and <= 499; + } +} diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt index 0f7328406c..8f749545dd 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt @@ -66,6 +66,7 @@ namespace FluentAssertions public static FluentAssertions.Primitives.NullableGuidAssertions Should(this System.Guid? actualValue) { } public static FluentAssertions.Streams.BufferedStreamAssertions Should(this System.IO.BufferedStream actualValue) { } public static FluentAssertions.Streams.StreamAssertions Should(this System.IO.Stream actualValue) { } + public static FluentAssertions.Primitives.HttpResponseMessageAssertions Should(this System.Net.Http.HttpResponseMessage actualValue) { } public static FluentAssertions.Reflection.AssemblyAssertions Should(this System.Reflection.Assembly assembly) { } public static FluentAssertions.Types.ConstructorInfoAssertions Should(this System.Reflection.ConstructorInfo constructorInfo) { } public static FluentAssertions.Types.MethodInfoAssertions Should(this System.Reflection.MethodInfo methodInfo) { } @@ -1909,6 +1910,22 @@ namespace FluentAssertions.Primitives public FluentAssertions.AndConstraint NotBe(string unexpected, string because = "", params object[] becauseArgs) { } public FluentAssertions.AndConstraint NotBeEmpty(string because = "", params object[] becauseArgs) { } } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + public HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.ObjectAssertions + where TAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + protected HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + public FluentAssertions.AndConstraint BeRedirection(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint BeSuccessful(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveClientError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveServerError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveStatusCode(System.Net.HttpStatusCode expected, string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint NotHaveStatusCode(System.Net.HttpStatusCode unexpected, string because = "", params object[] becauseArgs) { } + } public class NullableBooleanAssertions : FluentAssertions.Primitives.NullableBooleanAssertions { public NullableBooleanAssertions(bool? value) { } diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt index 8427581cf0..74366f32aa 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp2.1.verified.txt @@ -66,6 +66,7 @@ namespace FluentAssertions public static FluentAssertions.Primitives.NullableGuidAssertions Should(this System.Guid? actualValue) { } public static FluentAssertions.Streams.BufferedStreamAssertions Should(this System.IO.BufferedStream actualValue) { } public static FluentAssertions.Streams.StreamAssertions Should(this System.IO.Stream actualValue) { } + public static FluentAssertions.Primitives.HttpResponseMessageAssertions Should(this System.Net.Http.HttpResponseMessage actualValue) { } public static FluentAssertions.Reflection.AssemblyAssertions Should(this System.Reflection.Assembly assembly) { } public static FluentAssertions.Types.ConstructorInfoAssertions Should(this System.Reflection.ConstructorInfo constructorInfo) { } public static FluentAssertions.Types.MethodInfoAssertions Should(this System.Reflection.MethodInfo methodInfo) { } @@ -1909,6 +1910,22 @@ namespace FluentAssertions.Primitives public FluentAssertions.AndConstraint NotBe(string unexpected, string because = "", params object[] becauseArgs) { } public FluentAssertions.AndConstraint NotBeEmpty(string because = "", params object[] becauseArgs) { } } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + public HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.ObjectAssertions + where TAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + protected HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + public FluentAssertions.AndConstraint BeRedirection(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint BeSuccessful(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveClientError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveServerError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveStatusCode(System.Net.HttpStatusCode expected, string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint NotHaveStatusCode(System.Net.HttpStatusCode unexpected, string because = "", params object[] becauseArgs) { } + } public class NullableBooleanAssertions : FluentAssertions.Primitives.NullableBooleanAssertions { public NullableBooleanAssertions(bool? value) { } diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt index d0c715644a..742058b3f4 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netcoreapp3.0.verified.txt @@ -66,6 +66,7 @@ namespace FluentAssertions public static FluentAssertions.Primitives.NullableGuidAssertions Should(this System.Guid? actualValue) { } public static FluentAssertions.Streams.BufferedStreamAssertions Should(this System.IO.BufferedStream actualValue) { } public static FluentAssertions.Streams.StreamAssertions Should(this System.IO.Stream actualValue) { } + public static FluentAssertions.Primitives.HttpResponseMessageAssertions Should(this System.Net.Http.HttpResponseMessage actualValue) { } public static FluentAssertions.Reflection.AssemblyAssertions Should(this System.Reflection.Assembly assembly) { } public static FluentAssertions.Types.ConstructorInfoAssertions Should(this System.Reflection.ConstructorInfo constructorInfo) { } public static FluentAssertions.Types.MethodInfoAssertions Should(this System.Reflection.MethodInfo methodInfo) { } @@ -1909,6 +1910,22 @@ namespace FluentAssertions.Primitives public FluentAssertions.AndConstraint NotBe(string unexpected, string because = "", params object[] becauseArgs) { } public FluentAssertions.AndConstraint NotBeEmpty(string because = "", params object[] becauseArgs) { } } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + public HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.ObjectAssertions + where TAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + protected HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + public FluentAssertions.AndConstraint BeRedirection(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint BeSuccessful(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveClientError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveServerError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveStatusCode(System.Net.HttpStatusCode expected, string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint NotHaveStatusCode(System.Net.HttpStatusCode unexpected, string because = "", params object[] becauseArgs) { } + } public class NullableBooleanAssertions : FluentAssertions.Primitives.NullableBooleanAssertions { public NullableBooleanAssertions(bool? value) { } diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt index 9b13b251b7..9a7e925e43 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt @@ -65,6 +65,7 @@ namespace FluentAssertions public static FluentAssertions.Primitives.NullableGuidAssertions Should(this System.Guid? actualValue) { } public static FluentAssertions.Streams.BufferedStreamAssertions Should(this System.IO.BufferedStream actualValue) { } public static FluentAssertions.Streams.StreamAssertions Should(this System.IO.Stream actualValue) { } + public static FluentAssertions.Primitives.HttpResponseMessageAssertions Should(this System.Net.Http.HttpResponseMessage actualValue) { } public static FluentAssertions.Reflection.AssemblyAssertions Should(this System.Reflection.Assembly assembly) { } public static FluentAssertions.Types.ConstructorInfoAssertions Should(this System.Reflection.ConstructorInfo constructorInfo) { } public static FluentAssertions.Types.MethodInfoAssertions Should(this System.Reflection.MethodInfo methodInfo) { } @@ -1862,6 +1863,22 @@ namespace FluentAssertions.Primitives public FluentAssertions.AndConstraint NotBe(string unexpected, string because = "", params object[] becauseArgs) { } public FluentAssertions.AndConstraint NotBeEmpty(string because = "", params object[] becauseArgs) { } } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + public HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.ObjectAssertions + where TAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + protected HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + public FluentAssertions.AndConstraint BeRedirection(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint BeSuccessful(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveClientError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveServerError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveStatusCode(System.Net.HttpStatusCode expected, string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint NotHaveStatusCode(System.Net.HttpStatusCode unexpected, string because = "", params object[] becauseArgs) { } + } public class NullableBooleanAssertions : FluentAssertions.Primitives.NullableBooleanAssertions { public NullableBooleanAssertions(bool? value) { } diff --git a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt index ea94174c5a..27d7e7a226 100644 --- a/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt +++ b/Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt @@ -66,6 +66,7 @@ namespace FluentAssertions public static FluentAssertions.Primitives.NullableGuidAssertions Should(this System.Guid? actualValue) { } public static FluentAssertions.Streams.BufferedStreamAssertions Should(this System.IO.BufferedStream actualValue) { } public static FluentAssertions.Streams.StreamAssertions Should(this System.IO.Stream actualValue) { } + public static FluentAssertions.Primitives.HttpResponseMessageAssertions Should(this System.Net.Http.HttpResponseMessage actualValue) { } public static FluentAssertions.Reflection.AssemblyAssertions Should(this System.Reflection.Assembly assembly) { } public static FluentAssertions.Types.ConstructorInfoAssertions Should(this System.Reflection.ConstructorInfo constructorInfo) { } public static FluentAssertions.Types.MethodInfoAssertions Should(this System.Reflection.MethodInfo methodInfo) { } @@ -1909,6 +1910,22 @@ namespace FluentAssertions.Primitives public FluentAssertions.AndConstraint NotBe(string unexpected, string because = "", params object[] becauseArgs) { } public FluentAssertions.AndConstraint NotBeEmpty(string because = "", params object[] becauseArgs) { } } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + public HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + } + public class HttpResponseMessageAssertions : FluentAssertions.Primitives.ObjectAssertions + where TAssertions : FluentAssertions.Primitives.HttpResponseMessageAssertions + { + protected HttpResponseMessageAssertions(System.Net.Http.HttpResponseMessage value) { } + public FluentAssertions.AndConstraint BeRedirection(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint BeSuccessful(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveClientError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveServerError(string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint HaveStatusCode(System.Net.HttpStatusCode expected, string because = "", params object[] becauseArgs) { } + public FluentAssertions.AndConstraint NotHaveStatusCode(System.Net.HttpStatusCode unexpected, string because = "", params object[] becauseArgs) { } + } public class NullableBooleanAssertions : FluentAssertions.Primitives.NullableBooleanAssertions { public NullableBooleanAssertions(bool? value) { } diff --git a/Tests/Benchmarks/Benchmarks.csproj b/Tests/Benchmarks/Benchmarks.csproj index 51b8040720..3e61198905 100644 --- a/Tests/Benchmarks/Benchmarks.csproj +++ b/Tests/Benchmarks/Benchmarks.csproj @@ -17,4 +17,4 @@ - \ No newline at end of file + diff --git a/Tests/FluentAssertions.Specs/Primitives/HttpResponseMessageAssertionSpecs.cs b/Tests/FluentAssertions.Specs/Primitives/HttpResponseMessageAssertionSpecs.cs new file mode 100644 index 0000000000..d0513cacc7 --- /dev/null +++ b/Tests/FluentAssertions.Specs/Primitives/HttpResponseMessageAssertionSpecs.cs @@ -0,0 +1,271 @@ +using System; +using System.Net; +using System.Net.Http; +using Xunit; +using Xunit.Sdk; + +namespace FluentAssertions.Specs.Primitives +{ + public class HttpResponseMessageAssertionSpecs + { + [Theory] + [InlineData(HttpStatusCode.OK)] + [InlineData(HttpStatusCode.Accepted)] + public void Should_succeed_when_status_code_is_successful(HttpStatusCode statusCodeOfResponse) + { + // Arrange + var testee = new HttpResponseMessage(statusCodeOfResponse); + + // Act / Assert + testee.Should().BeSuccessful(); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_status_code_error_is_successful() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.Gone).Should() + .BeSuccessful("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be successful (2xx) because we want to test the failure message, but found HttpStatusCode.Gone {value: 410}."); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_asserting_success_but_response_is_null() + { + // Arrange + Action action = () => + ((HttpResponseMessage)null).Should().BeSuccessful("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be successful (2xx) because we want to test the failure message, but HttpResponseMessage was ."); + } + + [Theory] + [InlineData(HttpStatusCode.Moved)] + public void Should_succeed_when_status_code_is_redirect(HttpStatusCode statusCodeOfResponse) + { + // Arrange + var testee = new HttpResponseMessage(statusCodeOfResponse); + + // Act / Assert + testee.Should().BeRedirection(); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_status_code_error_is_redirection() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.Gone).Should() + .BeRedirection("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be redirection (3xx) because we want to test the failure message, but found HttpStatusCode.Gone {value: 410}."); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_asserting_redirect_but_response_is_null() + { + // Arrange + Action action = () => + ((HttpResponseMessage)null).Should().BeRedirection("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be redirection (3xx) because we want to test the failure message, but HttpResponseMessage was ."); + } + + [Theory] + [InlineData(HttpStatusCode.Gone)] + [InlineData(HttpStatusCode.BadRequest)] + public void Should_succeed_when_status_code_is_client_error(HttpStatusCode statusCodeOfResponse) + { + // Arrange + var testee = new HttpResponseMessage(statusCodeOfResponse); + + // Act / Assert + testee.Should().HaveClientError(); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_status_code_success_is_client_error() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.OK).Should() + .HaveClientError("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be client error (4xx) because we want to test the failure message, but found HttpStatusCode.OK {value: 200}."); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_asserting_client_error_but_response_is_null() + { + // Arrange + Action action = () => + ((HttpResponseMessage)null).Should().HaveClientError("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be client error (4xx) because we want to test the failure message, but HttpResponseMessage was ."); + } + + [Theory] + [InlineData(HttpStatusCode.InternalServerError)] + public void Should_succeed_when_status_code_is_server_error(HttpStatusCode statusCodeOfResponse) + { + // Arrange + var testee = new HttpResponseMessage(statusCodeOfResponse); + + // Act / Assert + testee.Should().HaveServerError(); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_status_code_success_is_server_error() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.OK).Should() + .HaveServerError("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be server error (5xx) because we want to test the failure message, but found HttpStatusCode.OK {value: 200}."); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_asserting_server_error_but_response_is_null() + { + // Arrange + Action action = () => + ((HttpResponseMessage)null).Should().HaveServerError("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be server error (5xx) because we want to test the failure message, but HttpResponseMessage was ."); + } + + [Theory] + [InlineData(HttpStatusCode.BadRequest)] + [InlineData(HttpStatusCode.InternalServerError)] + public void Should_succeed_when_status_code_is_error(HttpStatusCode statusCodeOfResponse) + { + // Arrange + var testee = new HttpResponseMessage(statusCodeOfResponse); + + // Act / Assert + testee.Should().HaveError(); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_status_code_success_is_error() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.OK).Should() + .HaveError("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be an error because we want to test the failure message, but found HttpStatusCode.OK {value: 200}."); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_asserting_error_but_response_is_null() + { + // Arrange + Action action = () => + ((HttpResponseMessage)null).Should().HaveError("because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be an error because we want to test the failure message, but HttpResponseMessage was ."); + } + + [Fact] + public void Should_succeed_when_status_code_to_be_equal_to_the_same_value() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.OK).Should().HaveStatusCode(HttpStatusCode.OK); + + // Act / Assert + action.Should().NotThrow(); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_status_code_value_to_be_equal_to_a_different_value() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.OK).Should().HaveStatusCode(HttpStatusCode.Gone, + "because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be HttpStatusCode.Gone {value: 410} because we want to test the failure message, but found HttpStatusCode.OK {value: 200}.*"); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_asserting_certain_status_code_but_response_is_null() + { + // Arrange + Action action = () => ((HttpResponseMessage)null).Should() + .HaveStatusCode(HttpStatusCode.Gone, "because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode to be HttpStatusCode.Gone {value: 410} because we want to test the failure message, but HttpResponseMessage was ."); + } + + [Fact] + public void Should_succeed_when_status_code_value_not_to_be_equal_to_the_same_value() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.OK).Should().NotHaveStatusCode(HttpStatusCode.Gone); + + // Act / Assert + action.Should().NotThrow(); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_status_code_value_not_to_be_equal_to_a_different_value() + { + // Arrange + Action action = () => new HttpResponseMessage(HttpStatusCode.OK).Should().NotHaveStatusCode(HttpStatusCode.OK, + "because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode not to be HttpStatusCode.OK {value: 200} because we want to test the failure message, but found HttpStatusCode.OK {value: 200}.*"); + } + + [Fact] + public void Should_fail_with_descriptive_message_when_asserting_against_certain_status_code_but_response_is_null() + { + // Arrange + Action action = () => ((HttpResponseMessage)null).Should() + .NotHaveStatusCode(HttpStatusCode.Gone, "because we want to test the failure {0}", "message"); + + // Act / Assert + action.Should().Throw() + .WithMessage( + "Expected HttpStatusCode not to be HttpStatusCode.Gone {value: 410} because we want to test the failure message, but HttpResponseMessage was ."); + } + } +} diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 51c26a1224..0ec09d306d 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -73,6 +73,8 @@ sidebar: url: /xml - title: Execution Time url: /executiontime + - title: HTTP response messages + url: /httpresponsemessages - title: Extensibility url: /extensibility diff --git a/docs/_pages/httpresponsemessages.md b/docs/_pages/httpresponsemessages.md new file mode 100644 index 0000000000..96575c1087 --- /dev/null +++ b/docs/_pages/httpresponsemessages.md @@ -0,0 +1,28 @@ +--- +title: HttpResponseMessages +permalink: /httpresponsemessages/ +layout: single +classes: wide +sidebar: +nav: "sidebar" +--- + +```csharp +var successfulResponse = new HttpResponseMessage(HttpStatusCode.OK); +successfulResponse.Should().BeSuccessful("it's set to OK"); // (HttpStatusCode = 2xx) + +var redirectResponse = new HttpResponseMessage(HttpStatusCode.Moved); +redirectResponse.Should().BeRedirection("it's set to Moved"); // (HttpStatusCode = 3xx) + +var clientErrorResponse = new HttpResponseMessage(HttpStatusCode.BadRequest); +clientErrorResponse.Should().HaveClientError("it's set to BadRequest"); // (HttpStatusCode = 4xx) +clientErrorResponse.Should().HaveError("it's set to BadRequest"); // (HttpStatusCode = 4xx or 5xx) + +var serverErrorResponse = new HttpResponseMessage(HttpStatusCode.InternalServerError); +serverErrorResponse.Should().HaveServerError("it's set to InternalServerError"); // (HttpStatusCode = 5xx) +serverErrorResponse.Should().HaveError("it's set to InternalServerError"); // (HttpStatusCode = 4xx or 5xx) + +var anotherResponse = new HttpResponseMessage(HttpStatusCode.Moved); +anotherResponse.Should().HaveStatusCode(HttpStatusCode.Moved); +anotherResponse.Should().NotHaveStatusCode(HttpStatusCode.OK); +``` diff --git a/docs/_pages/releases.md b/docs/_pages/releases.md index eb5b94e687..094c140bc6 100644 --- a/docs/_pages/releases.md +++ b/docs/_pages/releases.md @@ -11,6 +11,7 @@ sidebar: ### What's New * Adding `ThatAreStatic()` and `ThatAreNotStatic()` for filtering in method assertions - [#1740](https://github.com/fluentassertions/fluentassertions/pull/1740) +* Adding new assertions for the `HttpStatusCode` of an `HttpResponseMessage` - [#1737](https://github.com/fluentassertions/fluentassertions/pull/1737) ### Fixes * Querying methods on classes, e.g. `typeof(MyController).Methods()`, now also includes static methods - [#1740](https://github.com/fluentassertions/fluentassertions/pull/1740) From 305b36ade4787fbf3afd100e810d57443a912c41 Mon Sep 17 00:00:00 2001 From: Leandro Muller Date: Mon, 10 Jan 2022 14:51:33 -0300 Subject: [PATCH 07/25] `ContainItemsAssignableTo` Now Expects At Least One Item Assignable to `T` (#1765) --- .../GenericCollectionAssertions.cs | 33 ++++------- Src/FluentAssertions/Common/Configuration.cs | 2 +- .../Execution/GivenSelector.cs | 2 +- ...AssertionSpecs.ContainItemsAssignableTo.cs | 58 +++++++------------ docs/_pages/releases.md | 1 + 5 files changed, 34 insertions(+), 62 deletions(-) diff --git a/Src/FluentAssertions/Collections/GenericCollectionAssertions.cs b/Src/FluentAssertions/Collections/GenericCollectionAssertions.cs index ff75c7090d..54a10c802c 100644 --- a/Src/FluentAssertions/Collections/GenericCollectionAssertions.cs +++ b/Src/FluentAssertions/Collections/GenericCollectionAssertions.cs @@ -946,7 +946,7 @@ public AndConstraint ContainInOrder(IEnumerable expected, string } ///

- /// Asserts that the current collection only contains items that are assignable to the type . + /// Asserts that the current collection contains at least one element that is assignable to the type . ///

/// /// A formatted phrase as is supported by explaining why the assertion @@ -957,29 +957,18 @@ public AndConstraint ContainInOrder(IEnumerable expected, string /// public AndConstraint ContainItemsAssignableTo(string because = "", params object[] becauseArgs) { - bool success = Execute.Assertion + Execute.Assertion .BecauseOf(because, becauseArgs) + .WithExpectation("Expected {context:collection} to contain at least one element assignable to type {0}{reason}, ", + typeof(TExpectation).FullName) .ForCondition(Subject is not null) - .FailWith("Expected {context:collection} to contain element assignable to type {0}{reason}, but found .", - typeof(TExpectation)); - - if (success) - { - int index = 0; - foreach (T item in Subject) - { - if (item is not TExpectation) - { - Execute.Assertion - .BecauseOf(because, becauseArgs) - .FailWith( - "Expected {context:collection} to contain only items of type {0}{reason}" + - ", but item {1} at index {2} is of type {3}.", typeof(TExpectation), item, index, item.GetType()); - } - - ++index; - } - } + .FailWith("but found .") + .Then + .Given(() => Subject.ConvertOrCastToCollection()) + .ForCondition(subject => subject.Any(x => typeof(TExpectation).IsAssignableFrom(GetType(x)))) + .FailWith("but found {0}.", subject => subject.Select(x => GetType(x))) + .Then + .ClearExpectation(); return new AndConstraint((TAssertions)this); } diff --git a/Src/FluentAssertions/Common/Configuration.cs b/Src/FluentAssertions/Common/Configuration.cs index a59e40be46..d46724dd7e 100644 --- a/Src/FluentAssertions/Common/Configuration.cs +++ b/Src/FluentAssertions/Common/Configuration.cs @@ -76,7 +76,7 @@ private ValueFormatterDetectionMode DetermineFormatterDetectionMode() ///

/// Gets or sets the assembly name to scan for custom value formatters in case - /// is set to . + /// is set to . ///

public string ValueFormatterAssembly { diff --git a/Src/FluentAssertions/Execution/GivenSelector.cs b/Src/FluentAssertions/Execution/GivenSelector.cs index 395e2aeb12..58d46f2647 100644 --- a/Src/FluentAssertions/Execution/GivenSelector.cs +++ b/Src/FluentAssertions/Execution/GivenSelector.cs @@ -49,7 +49,7 @@ public GivenSelector ForCondition(Func predicate) /// The will not be invoked if the prior assertion failed, /// nor will throw any exceptions. /// - /// + /// public GivenSelector Given(Func selector) { Guard.ThrowIfArgumentIsNull(selector, nameof(selector)); diff --git a/Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.ContainItemsAssignableTo.cs b/Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.ContainItemsAssignableTo.cs index 524608e968..43f3518c2a 100644 --- a/Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.ContainItemsAssignableTo.cs +++ b/Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.ContainItemsAssignableTo.cs @@ -24,7 +24,7 @@ public void Should_succeed_when_asserting_collection_with_all_items_of_same_type } [Fact] - public void Should_fail_when_asserting_collection_with_items_of_different_types_only_contains_item_of_one_type() + public void Should_succeed_when_asserting_collection_with_items_of_different_types_contains_item_of_expected_type() { // Arrange var collection = new List