Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce assertions for StatusCode of HttpResponseMessage (#1737)
- Loading branch information
Showing
13 changed files
with
634 additions
and
1 deletion.
There are no files selected for viewing
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
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
234 changes: 234 additions & 0 deletions
234
Src/FluentAssertions/Primitives/HttpResponseMessageAssertions.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,234 @@ | ||
| using System.Diagnostics; | ||
| using System.Net; | ||
| using System.Net.Http; | ||
| using FluentAssertions.Execution; | ||
|
|
||
| namespace FluentAssertions.Primitives | ||
| { | ||
| /// <summary> | ||
| /// Contains a number of methods to assert that a <see cref="HttpResponseMessage"/> is in the expected state. | ||
| /// </summary> | ||
| [DebuggerNonUserCode] | ||
| public class HttpResponseMessageAssertions : HttpResponseMessageAssertions<HttpResponseMessageAssertions> | ||
| { | ||
| public HttpResponseMessageAssertions(HttpResponseMessage value) | ||
| : base(value) | ||
| { | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Contains a number of methods to assert that a <see cref="HttpResponseMessage" /> is in the expected state. | ||
| /// </summary> | ||
| [DebuggerNonUserCode] | ||
| public class HttpResponseMessageAssertions<TAssertions> : ObjectAssertions<HttpResponseMessage, TAssertions> | ||
| where TAssertions : HttpResponseMessageAssertions<TAssertions> | ||
| { | ||
| protected HttpResponseMessageAssertions(HttpResponseMessage value) | ||
| : base(value) | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Asserts that the <see cref="HttpStatusCode"/> is successful (2xx). | ||
| /// </summary> | ||
| /// <param name="because"> | ||
| /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion | ||
| /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically. | ||
| /// </param> | ||
| /// <param name="becauseArgs"> | ||
| /// Zero or more objects to format using the placeholders in <paramref name="because" />. | ||
| /// </param> | ||
| public AndConstraint<TAssertions> 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 <null>."); | ||
|
|
||
| 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>((TAssertions)this); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Asserts that the <see cref="HttpStatusCode"/> is redirection (3xx). | ||
| /// </summary> | ||
| /// <param name="because"> | ||
| /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion | ||
| /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically. | ||
| /// </param> | ||
| /// <param name="becauseArgs"> | ||
| /// Zero or more objects to format using the placeholders in <paramref name="because" />. | ||
| /// </param> | ||
| public AndConstraint<TAssertions> 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 <null>."); | ||
|
|
||
| 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>((TAssertions)this); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Asserts that the <see cref="HttpStatusCode"/> is either client (4xx) or server error (5xx). | ||
| /// </summary> | ||
| /// <param name="because"> | ||
| /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion | ||
| /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically. | ||
| /// </param> | ||
| /// <param name="becauseArgs"> | ||
| /// Zero or more objects to format using the placeholders in <paramref name="because" />. | ||
| /// </param> | ||
| public AndConstraint<TAssertions> 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 <null>."); | ||
|
|
||
| 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>((TAssertions)this); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Asserts that the <see cref="HttpStatusCode"/> is client error (4xx). | ||
| /// </summary> | ||
| /// <param name="because"> | ||
| /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion | ||
| /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically. | ||
| /// </param> | ||
| /// <param name="becauseArgs"> | ||
| /// Zero or more objects to format using the placeholders in <paramref name="because" />. | ||
| /// </param> | ||
| public AndConstraint<TAssertions> 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 <null>."); | ||
|
|
||
| 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>((TAssertions)this); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Asserts that the <see cref="HttpStatusCode"/> is server error (5xx). | ||
| /// </summary> | ||
| /// <param name="because"> | ||
| /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion | ||
| /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically. | ||
| /// </param> | ||
| /// <param name="becauseArgs"> | ||
| /// Zero or more objects to format using the placeholders in <paramref name="because" />. | ||
| /// </param> | ||
| public AndConstraint<TAssertions> 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 <null>."); | ||
|
|
||
| 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>((TAssertions)this); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Asserts that the <see cref="HttpStatusCode"/> is equal to the specified <paramref name="expected"/> value. | ||
| /// </summary> | ||
| /// <param name="expected">The expected value</param> | ||
| /// <param name="because"> | ||
| /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion | ||
| /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically. | ||
| /// </param> | ||
| /// <param name="becauseArgs"> | ||
| /// Zero or more objects to format using the placeholders in <paramref name="because" />. | ||
| /// </param> | ||
| public AndConstraint<TAssertions> 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 <null>.", 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>((TAssertions)this); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Asserts that the <see cref="HttpStatusCode"/> is not equal to the specified <paramref name="unexpected"/> value. | ||
| /// </summary> | ||
| /// <param name="unexpected">The unexpected value</param> | ||
| /// <param name="because"> | ||
| /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion | ||
| /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically. | ||
| /// </param> | ||
| /// <param name="becauseArgs"> | ||
| /// Zero or more objects to format using the placeholders in <paramref name="because"/>. | ||
| /// </param> | ||
| public AndConstraint<TAssertions> 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 <null>.", 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>((TAssertions)this); | ||
| } | ||
|
|
||
| private bool IsServerError() => (int)Subject.StatusCode is >= 500 and <= 599; | ||
|
|
||
| private bool IsClientError() => (int)Subject.StatusCode is >= 400 and <= 499; | ||
| } | ||
| } |
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
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
Oops, something went wrong.