HttpClientTestExtensions/src/Ardalis.HttpClientTestExtensions/HttpResponseMessageExtensionMethods.cs at main · ardalis/HttpClientTestExtensions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
usingSystem.Net;
usingSystem.Net.Http;
usingSystem.Threading.Tasks;
usingXunit.Abstractions;

namespaceArdalis.HttpClientTestExtensions;

publicstaticclassHttpResponseMessageExtensionMethods
{
/// <summary>
/// Ensures a response has a status code 404 Not Found
/// </summary>
/// <param name="response"></param>
/// <return></return>
[AssertionMethod]
publicstaticvoidEnsureNotFound(thisHttpResponseMessageresponse)
{
response.Ensure(HttpStatusCode.NotFound);
}

/// <summary>
/// Ensures a response has a status code 405 Method Not Allowed
/// </summary>
/// <param name="response"></param>
/// <return></return>
[AssertionMethod]
publicstaticvoidEnsureMethodNotAllowed(thisHttpResponseMessageresponse)
{
response.Ensure(HttpStatusCode.MethodNotAllowed);
}

/// <summary>
/// Ensures a response has a status code 204 No Content
/// </summary>
/// <param name="response"></param>
/// <return></return>
[AssertionMethod]
publicstaticvoidEnsureNoContent(thisHttpResponseMessageresponse)
{
response.Ensure(HttpStatusCode.NoContent);
}

/// <summary>
/// Ensures a response has a status code 302 Redirect
/// </summary>
/// <param name="response"></param>
/// <param name="redirectUri">The expected redirect URI</param>
/// <param name="output">Optional; used to provide details to standard output.</param>
/// <return></return>
[AssertionMethod]
publicstaticvoidEnsureRedirect(
thisHttpResponseMessageresponse,
stringredirectUri,
ITestOutputHelperoutput=null)
{
response.Ensure(HttpStatusCode.Redirect);
output?.WriteLine($"Ensuring redirect to {redirectUri}");
if(response.Headers.Location.ToString()!=redirectUri)
{
thrownewHttpRequestException($"Expected redirect to {redirectUri} but received {response.Headers.Location}");
}
}

/// <summary>
/// Ensures a response has a status code 400 Bad Request
/// </summary>
/// <param name="response"></param>
/// <return></return>
[AssertionMethod]
publicstaticvoidEnsureBadRequest(thisHttpResponseMessageresponse)
{
response.Ensure(HttpStatusCode.BadRequest);
}

/// <summary>
/// Ensures a response has a status code 401 Unauthorized
/// </summary>
/// <param name="response"></param>
/// <return></return>
[AssertionMethod]
publicstaticvoidEnsureUnauthorized(thisHttpResponseMessageresponse)
{
response.Ensure(HttpStatusCode.Unauthorized);
}

/// <summary>
/// Ensures a response has a status code 403 Forbidden
/// </summary>
/// <param name="response"></param>
/// <return></return>
[AssertionMethod]
publicstaticvoidEnsureForbidden(thisHttpResponseMessageresponse)
{
response.Ensure(HttpStatusCode.Forbidden);
}

/// <summary>
/// Ensures a response contains a substring
/// </summary>
/// <param name="response"></param>
/// <param name="substring">The substring to look for</param>
/// <param name="output">Optional; used to provide details to standard output.</param>
/// <return>The response string</return>
[AssertionMethod]
publicstaticasyncTask<string>EnsureContainsAsync(
thisHttpResponseMessageresponse,
stringsubstring,
ITestOutputHelperoutput=null)
{
varresponseString=awaitresponse.Content.ReadAsStringAsync();
output?.WriteLine($"Ensuring substring \"{substring}\" in response \"{responseString}\"");
if(!responseString.Contains(substring))
{
thrownewHttpRequestException($"Expected substring \"{substring}\" not found in response \"{responseString}\"");
};

returnresponseString;
}

/// <summary>
/// Ensures a response has a given status code
/// </summary>
/// <param name="response"></param>
/// <param name="expected">The status code to expect</param>
/// <return></return>
[AssertionMethod]
publicstaticvoidEnsure(thisHttpResponseMessageresponse,HttpStatusCodeexpected)
{
if(response.StatusCode!=expected)
{
ThrowHelper(expected,response.StatusCode);
}
}

privatestaticHttpRequestExceptionThrowHelper(HttpStatusCodeexpectedStatusCode,HttpStatusCodeactualStatusCode)
{
thrownewHttpRequestException($"Expected {expectedStatusCode.ToString("D")}{expectedStatusCode.ToString("G")} but was {actualStatusCode.ToString("D")}{actualStatusCode.ToString("G")}");
}
}