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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
"""Define tests for the client."""
import logging
from time import time
from typing import Any
from unittest.mock import Mock
import aiohttp
import pytest
from aresponses import ResponsesMockServer
from aioridwell import async_get_client
from aioridwell.errors import InvalidCredentialsError, RequestError
from .common import generate_jwt
@pytest.mark.asyncio
async def test_dashboard_url(
authenticated_ridwell_api_server: ResponsesMockServer,
) -> None:
"""Test getting the dashboard URL for a user.
Args:
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
"""
async with authenticated_ridwell_api_server:
client = await async_get_client("user", "password")
url = client.get_dashboard_url()
assert url == "https://www.ridwell.com/users/userId1/dashboard"
@pytest.mark.asyncio
async def test_expired_token_successful(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
authentication_response: dict[str, Any],
caplog: Mock,
token_expired_response: dict[str, Any],
) -> None:
"""Test that getting a new access token successfully retries the request.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
authentication_response: An API response payload.
caplog: A mocked logging utility.
token_expired_response: An API response payload.
"""
caplog.set_level(logging.INFO)
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
token_expired_response, status=200
),
)
# Simulate a JWT that's generated at some point in the future from the original
# one:
authentication_response["data"]["createAuthentication"][
"authenticationToken"
] = generate_jwt(issued_at=round(time()) + 1000)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
authentication_response, status=200
),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response({}, status=200),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client(
"user",
"password",
session=session,
# We set this parameter low so that this test doesn't take longer than
# necessary:
request_retry_delay=0,
)
# Perform a fake request that has an expired token:
await client.async_request()
assert any(
"Token failed; refreshing and trying again" in e.message
for e in caplog.records
)
# Verify that the token actually changed between retries:
request_history = authenticated_ridwell_api_server.history
token_1 = request_history[1].request.headers["Authorization"]
token_2 = request_history[3].request.headers["Authorization"]
assert token_1 != token_2
aresponses.assert_plan_strictly_followed()
@pytest.mark.asyncio
async def test_expired_token_failure(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
authentication_response: dict[str, Any],
token_expired_response: dict[str, Any],
) -> None:
"""Test that failing to get a new access token is handled correctly.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
authentication_response: An API response payload.
token_expired_response: An API response payload.
"""
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
token_expired_response, status=200
),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
authentication_response, status=200
),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
token_expired_response, status=200
),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
authentication_response, status=200
),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
token_expired_response, status=200
),
)
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
authentication_response, status=200
),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client(
"user",
"password",
session=session,
# We set this parameter low so that this test doesn't take longer than
# necessary:
request_retry_delay=0,
)
# Perform a fake request that has an expired token:
with pytest.raises(InvalidCredentialsError):
await client.async_request()
aresponses.assert_plan_strictly_followed()
@pytest.mark.asyncio
async def test_http_error(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
) -> None:
"""Test that a repeated HTTP error is handled.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
"""
async with authenticated_ridwell_api_server:
authenticated_ridwell_api_server.add(
"api.ridwell.com",
"/",
"post",
response=aresponses.Response(text="Not Found", status=404),
)
async with aiohttp.ClientSession() as session:
client = await async_get_client(
"user",
"password",
session=session,
# We set this parameter low so that this test doesn't take longer than
# necessary:
request_retry_delay=0,
)
# Perform a fake request that has an expired token:
with pytest.raises(RequestError):
await client.async_request()
aresponses.assert_plan_strictly_followed()
@pytest.mark.asyncio
async def test_invalid_credentials(
aresponses: ResponsesMockServer,
invalid_credentials_response: dict[str, Any],
) -> None:
"""Test that invalid credentials on login are dealt with immediately (no retry).
Args:
aresponses: An aresponses server.
invalid_credentials_response: An API response payload.
"""
aresponses.add(
"api.ridwell.com",
"/",
"post",
response=aiohttp.web_response.json_response(
invalid_credentials_response, status=200
),
)
async with aiohttp.ClientSession() as session:
with pytest.raises(InvalidCredentialsError):
await async_get_client("user", "password", session=session)
aresponses.assert_plan_strictly_followed()
@pytest.mark.asyncio
async def test_create_client(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
) -> None:
"""Test the successful creation of a client.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
"""
async with authenticated_ridwell_api_server, aiohttp.ClientSession() as session:
client = await async_get_client("user", "password", session=session)
assert client.user_id == "userId1"
aresponses.assert_plan_strictly_followed()
@pytest.mark.asyncio
async def test_create_client_no_session(
aresponses: ResponsesMockServer,
authenticated_ridwell_api_server: ResponsesMockServer,
) -> None:
"""Test the successful creation of a client without an explicit ClientSession.
Args:
aresponses: An aresponses server.
authenticated_ridwell_api_server: A mocked authenticated Ridwell API server.
"""
async with authenticated_ridwell_api_server:
client = await async_get_client("user", "password")
assert client.user_id == "userId1"
aresponses.assert_plan_strictly_followed()
|
