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
|
import aiohttp
import pytest
from sharkiq.ayla_api import get_ayla_api, AylaApi
from sharkiq.const import SHARK_APP_ID, SHARK_APP_SECRET, AUTH0_CLIENT_ID
from sharkiq.exc import (
SharkIqAuthError,
SharkIqAuthExpiringError,
SharkIqNotAuthedError,
AUTH_EXPIRED_MESSAGE,
NOT_AUTHED_MESSAGE,
)
from datetime import datetime, timedelta
def test_get_ayla_api():
api = get_ayla_api("myusername@mysite.com", "mypassword")
assert api._email == "myusername@mysite.com"
assert api._password == "mypassword"
assert api._access_token is None
assert api._refresh_token is None
assert api._auth_expiration is None
assert api._is_authed == False
assert api._app_id == SHARK_APP_ID
assert api._app_secret == SHARK_APP_SECRET
assert api.websession is None
class TestAylaApi:
def test_init__required_vals(self):
api = AylaApi(
"myusername@mysite.com", "mypassword", "app_id_123", "client_id_123", "appsecret_123"
)
assert api._email == "myusername@mysite.com"
assert api._password == "mypassword"
assert api._access_token is None
assert api._refresh_token is None
assert api._auth_expiration is None
assert api._is_authed == False
assert api._app_id == "app_id_123"
assert api._app_secret == "appsecret_123"
assert api._auth0_client_id == "client_id_123"
assert api.websession is None
@pytest.mark.asyncio
async def test_ensure_session(self, dummy_api):
# Initially created with no websession
assert dummy_api.websession is None
session = await dummy_api.ensure_session()
# Check that session was created and returned
assert isinstance(session, aiohttp.ClientSession)
assert dummy_api.websession is session
def test_property__login_data(self, dummy_api):
assert dummy_api._login_data["app_id"] == SHARK_APP_ID
assert dummy_api._login_data["app_secret"] == SHARK_APP_SECRET
def test_auth0__login_data(self, dummy_api):
assert dummy_api._auth0_login_data == {
"grant_type":"password",
"client_id": AUTH0_CLIENT_ID,
"username": "myusername@mysite.com",
"password": "mypassword",
"scope": "openid profile email offline_access"
}
def test_set_id_token__401_requires_verification_response(self, dummy_api):
with pytest.raises(SharkIqAuthError) as e:
dummy_api._set_id_token(401, {"error": "requires_verification", "error_description": "description"})
assert e.value.args[0] == "description (Try logging in with the SharkClean app, then try again)"
def test_set_id_token__401_response(self, dummy_api):
with pytest.raises(SharkIqAuthError) as e:
dummy_api._set_id_token(401, {"error": "generic", "error_description": "generic"})
assert e.value.args[0] == "generic (Confirm client_id is correct)"
def test_set_id_token__400_response(self, dummy_api):
with pytest.raises(SharkIqAuthError) as e:
dummy_api._set_id_token(400, {"error": "generic", "error_description": "generic"})
assert e.value.args[0] == "generic"
def test_set_id_token__403_response(self, dummy_api):
with pytest.raises(SharkIqAuthError) as e:
dummy_api._set_id_token(403, {"error": "generic", "error_description": "generic"})
assert e.value.args[0] == "generic"
def test_set_credentials__404_response(self, dummy_api):
with pytest.raises(SharkIqAuthError) as e:
dummy_api._set_credentials(404, {"errors": "Not found"})
assert (
e.value.args[0] == "Not found (Confirm app_id and app_secret are correct)"
)
def test_set_credentials__401_response(self, dummy_api):
with pytest.raises(SharkIqAuthError) as e:
dummy_api._set_credentials(401, {"errors": "Unauthorized"})
assert e.value.args[0] == "Unauthorized"
def test_set_credentials__valid_response(self, dummy_api):
assert dummy_api._access_token is "token123"
assert dummy_api._refresh_token is "token321"
assert dummy_api._auth_expiration.timestamp() == pytest.approx(
(datetime.now() + timedelta(seconds=700)).timestamp()
)
assert dummy_api._is_authed == True
t1 = datetime.now() + timedelta(seconds=3600)
dummy_api._set_credentials(
200,
{
"access_token": "token123",
"refresh_token": "token321",
"expires_in": 3600,
},
)
assert dummy_api._access_token == "token123"
assert dummy_api._refresh_token == "token321"
assert dummy_api._auth_expiration.timestamp() == pytest.approx(t1.timestamp())
assert dummy_api._is_authed == True
def test_property__sign_out_data(self, dummy_api):
assert dummy_api.sign_out_data == {
"user": {"access_token": dummy_api._access_token}
}
def test_clear_auth(self, dummy_api):
assert dummy_api._is_authed == True
dummy_api._clear_auth()
assert dummy_api._access_token is None
assert dummy_api._refresh_token is None
assert dummy_api._auth_expiration is None
assert dummy_api._is_authed == False
def test_property__auth_expiration__not_authed(self, dummy_api):
dummy_api._is_authed = False
dummy_api._auth_expiration = None
assert dummy_api.auth_expiration is None
def test_property__auth_expiration__no_expiration(self, dummy_api):
# mock the invalid state
dummy_api._is_authed = True
dummy_api._auth_expiration = None
# Check that the correct exception is raised when accessing property
with pytest.raises(SharkIqNotAuthedError) as e:
_ = dummy_api.auth_expiration
assert e.value.args[0] == "Invalid state. Please reauthorize."
def test_property__auth_expiration__not_authed(self, dummy_api):
dummy_api._is_authed = True
t = datetime.now() + timedelta(seconds=3600)
dummy_api._auth_expiration = t
assert dummy_api.auth_expiration == t
def test_property__token_expired__false(self, dummy_api):
dummy_api._is_authed = True
dummy_api._auth_expiration = datetime.now() + timedelta(seconds=3600)
assert dummy_api.token_expired == False
def test_property__token_expired__true(self, dummy_api):
dummy_api._is_authed = True
dummy_api._auth_expiration = datetime.now() - timedelta(seconds=3600)
assert dummy_api.token_expired == True
def test_property__token_expired__not_authed(self, dummy_api):
dummy_api._is_authed = False
dummy_api._auth_expiration = datetime.now() + timedelta(seconds=3600)
assert dummy_api.token_expired == True
def test_property__token_expiring_soon__false(self, dummy_api):
dummy_api._is_authed = True
# "soon" is considered to be within 600 seconds from the current time
dummy_api._auth_expiration = datetime.now() + timedelta(seconds=605)
assert dummy_api.token_expiring_soon == False
def test_property__token_expiring_soon__true(self, dummy_api):
dummy_api._is_authed = True
dummy_api._auth_expiration = datetime.now() + timedelta(seconds=595)
assert dummy_api.token_expiring_soon == True
def test_property__token_expiring_soon__not_authed(self, dummy_api):
dummy_api._is_authed = False
dummy_api._auth_expiration = datetime.now() + timedelta(seconds=3600)
assert dummy_api.token_expiring_soon == True
@pytest.mark.parametrize(
"access_token,auth_state,auth_timedelta",
[
("token123", True, timedelta(seconds=-100)), # auth expiry passed
(None, True, timedelta(seconds=700)), # invalid token
("token123", False, timedelta(seconds=-100)), # not authed
],
)
def test_check_auth__not_authed(
self, dummy_api, access_token, auth_state, auth_timedelta
):
dummy_api._access_token = access_token
dummy_api._is_authed = auth_state
dummy_api._auth_expiration = datetime.now() + auth_timedelta
with pytest.raises(SharkIqNotAuthedError) as e:
dummy_api.check_auth()
assert e.value.args[0] == NOT_AUTHED_MESSAGE
assert dummy_api._is_authed == False
def test_check_auth__expiring_soon_exception(self, dummy_api):
dummy_api._auth_expiration = datetime.now() + timedelta(seconds=400)
with pytest.raises(SharkIqAuthExpiringError) as e:
dummy_api.check_auth(raise_expiring_soon=True)
assert e.value.args[0] == AUTH_EXPIRED_MESSAGE
# No exception raised when set to False
dummy_api.check_auth(raise_expiring_soon=False)
def test_check_auth__valid(self, dummy_api):
assert dummy_api.check_auth() is None
def test_auth_header(self, dummy_api):
dummy_api._access_token = "myfaketoken"
assert dummy_api.auth_header == {
"Authorization": "auth_token myfaketoken"
}
def test_get_headers__no_kwargs(self, dummy_api):
headers = dummy_api._get_headers({})
assert headers == dummy_api.auth_header
def test_get_headers__kwargs_(self, dummy_api):
headers = dummy_api._get_headers({"headers": {"X-Test": "val"}})
assert headers == {
"X-Test": "val",
"Authorization": f"auth_token {dummy_api._access_token}"
}
|
