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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import pytest
import time
from unittest import TestCase
try:
from unittest.mock import MagicMock, patch
except ImportError: # python < 3.3
from mock import MagicMock, patch # type: ignore
import azure.communication.identity._shared.user_credential as user_credential
from azure.communication.identity._shared.user_credential import (
CommunicationTokenCredential,
)
from azure.communication.identity._shared.utils import create_access_token
from azure.communication.identity._shared.utils import get_current_utc_as_int
from _shared.helper import (
generate_token_with_custom_expiry_epoch,
generate_token_with_custom_expiry,
)
class DummyToken:
def __init__(self, token, expires_on):
self.token = token
self.expires_on = expires_on
class DummyTokenExchangeClient:
def __init__(self, resource_endpoint, token_credential, scopes):
self.resource_endpoint = resource_endpoint
self.token_credential = token_credential
self.scopes = scopes
def exchange_entra_token(self):
return DummyToken("dummy", 9999999999)
class DummyTokenExchangeClientSwitch:
def __init__(self, resource_endpoint, token_credential, scopes):
self.resource_endpoint = resource_endpoint
self.token_credential = token_credential
self.scopes = scopes
self.call_count = 0
def exchange_entra_token(self):
self.call_count += 1
if self.call_count == 1:
return DummyToken("dummy_expired", int(time.time()) - 5 * 60)
else:
return DummyToken("dummy_valid", int(time.time()) + 60 * 60)
class TestCommunicationTokenCredential(TestCase):
@classmethod
def setUpClass(cls):
cls.sample_token = generate_token_with_custom_expiry_epoch(32503680000) # 1/1/2030
cls.expired_token = generate_token_with_custom_expiry_epoch(100) # 1/1/1970
def test_communicationtokencredential_decodes_token(self):
credential = CommunicationTokenCredential(self.sample_token)
access_token = credential.get_token()
self.assertEqual(access_token.token, self.sample_token)
def test_communicationtokencredential_throws_if_invalid_token(self):
self.assertRaises(ValueError, lambda: CommunicationTokenCredential("foo.bar.tar"))
def test_communicationtokencredential_throws_if_nonstring_token(self):
self.assertRaises(TypeError, lambda: CommunicationTokenCredential(454))
def test_communicationtokencredential_throws_if_proactive_refresh_enabled_without_token_refresher(
self,
):
with pytest.raises(ValueError) as err:
CommunicationTokenCredential(self.sample_token, proactive_refresh=True)
assert str(err.value) == "When 'proactive_refresh' is True, 'token_refresher' must not be None."
with pytest.raises(ValueError) as err:
CommunicationTokenCredential(self.sample_token, proactive_refresh=True, token_refresher=None)
assert str(err.value) == "When 'proactive_refresh' is True, 'token_refresher' must not be None."
def test_communicationtokencredential_static_token_returns_expired_token(self):
credential = CommunicationTokenCredential(self.expired_token)
self.assertEqual(credential.get_token().token, self.expired_token)
def test_communicationtokencredential_token_expired_refresh_called(self):
refresher = MagicMock(return_value=create_access_token(self.sample_token))
credential = CommunicationTokenCredential(self.expired_token, token_refresher=refresher)
access_token = credential.get_token()
refresher.assert_called_once()
self.assertEqual(access_token.token, self.sample_token)
def test_communicationtokencredential_raises_if_refresher_returns_expired_token(
self,
):
refresher = MagicMock(return_value=create_access_token(self.expired_token))
credential = CommunicationTokenCredential(self.expired_token, token_refresher=refresher)
with self.assertRaises(ValueError):
credential.get_token()
self.assertEqual(refresher.call_count, 1)
def test_uses_initial_token_as_expected(self):
refresher = MagicMock(return_value=create_access_token(self.expired_token))
credential = CommunicationTokenCredential(self.sample_token, token_refresher=refresher, proactive_refresh=True)
access_token = credential.get_token()
self.assertEqual(refresher.call_count, 0)
self.assertEqual(access_token.token, self.sample_token)
def test_proactive_refresher_should_not_be_called_before_specified_time(self):
refresh_minutes = 10
token_validity_minutes = 60
start_timestamp = get_current_utc_as_int()
skip_to_timestamp = start_timestamp + (refresh_minutes - 5) * 60
initial_token = generate_token_with_custom_expiry(token_validity_minutes * 60)
refreshed_token = generate_token_with_custom_expiry(2 * token_validity_minutes * 60)
refresher = MagicMock(return_value=create_access_token(refreshed_token))
with patch(
user_credential.__name__ + "." + get_current_utc_as_int.__name__,
return_value=skip_to_timestamp,
):
credential = CommunicationTokenCredential(initial_token, token_refresher=refresher, proactive_refresh=True)
access_token = credential.get_token()
assert refresher.call_count == 0
assert access_token.token == initial_token
# check that next refresh is always scheduled
assert credential._timer is None
def test_proactive_refresher_should_be_called_after_specified_time(self):
refresh_minutes = 10
token_validity_minutes = 60
start_timestamp = get_current_utc_as_int()
skip_to_timestamp = start_timestamp + (token_validity_minutes - refresh_minutes + 5) * 60
initial_token = generate_token_with_custom_expiry(token_validity_minutes * 60)
refreshed_token = generate_token_with_custom_expiry(2 * token_validity_minutes * 60)
refresher = MagicMock(return_value=create_access_token(refreshed_token))
with patch(
user_credential.__name__ + "." + get_current_utc_as_int.__name__,
return_value=skip_to_timestamp,
):
credential = CommunicationTokenCredential(initial_token, token_refresher=refresher, proactive_refresh=True)
access_token = credential.get_token()
assert refresher.call_count == 1
assert access_token.token == refreshed_token
# check that next refresh is always scheduled
assert credential._timer is not None
def test_proactive_refresher_keeps_scheduling_again(self):
refresh_minutes = 10
token_validity_minutes = 60
expired_token = generate_token_with_custom_expiry(-5 * 60)
skip_to_timestamp = get_current_utc_as_int() + (token_validity_minutes - refresh_minutes) * 60 + 1
first_refreshed_token = create_access_token(generate_token_with_custom_expiry(token_validity_minutes * 60))
last_refreshed_token = create_access_token(generate_token_with_custom_expiry(2 * token_validity_minutes * 60))
refresher = MagicMock(side_effect=[first_refreshed_token, last_refreshed_token])
credential = CommunicationTokenCredential(expired_token, token_refresher=refresher, proactive_refresh=True)
access_token = credential.get_token()
with patch(
user_credential.__name__ + "." + get_current_utc_as_int.__name__,
return_value=skip_to_timestamp,
):
access_token = credential.get_token()
assert refresher.call_count == 2
assert access_token.token == last_refreshed_token.token
# check that next refresh is always scheduled
assert credential._timer is not None
def test_fractional_backoff_applied_when_token_expiring(self):
token_validity_seconds = 5 * 60
expiring_token = generate_token_with_custom_expiry(token_validity_seconds)
refresher = MagicMock(
side_effect=[
create_access_token(expiring_token),
create_access_token(expiring_token),
]
)
credential = CommunicationTokenCredential(expiring_token, token_refresher=refresher, proactive_refresh=True)
next_milestone = token_validity_seconds / 2
with patch(
user_credential.__name__ + "." + get_current_utc_as_int.__name__,
return_value=(get_current_utc_as_int() + next_milestone),
):
credential.get_token()
assert refresher.call_count == 1
next_milestone = next_milestone / 2
assert credential._timer.interval == next_milestone
def test_refresher_should_not_be_called_when_token_still_valid(self):
generated_token = generate_token_with_custom_expiry(15 * 60)
new_token = generate_token_with_custom_expiry(10 * 60)
refresher = MagicMock(return_value=create_access_token(new_token))
credential = CommunicationTokenCredential(generated_token, token_refresher=refresher, proactive_refresh=False)
for _ in range(10):
access_token = credential.get_token()
refresher.assert_not_called()
assert generated_token == access_token.token
def test_exit_cancels_timer(self):
refreshed_token = create_access_token(generate_token_with_custom_expiry(30 * 60))
refresher = MagicMock(return_value=refreshed_token)
credential = CommunicationTokenCredential(self.expired_token, token_refresher=refresher, proactive_refresh=True)
credential.get_token()
credential.close()
assert credential._timer is None
def test_exit_enter_scenario_throws_exception(self):
refreshed_token = create_access_token(generate_token_with_custom_expiry(30 * 60))
refresher = MagicMock(return_value=refreshed_token)
credential = CommunicationTokenCredential(self.expired_token, token_refresher=refresher, proactive_refresh=True)
credential.get_token()
credential.close()
assert credential._timer is None
with pytest.raises(RuntimeError) as err:
credential.get_token()
assert str(err.value) == "An instance of CommunicationTokenCredential cannot be reused once it has been closed."
def test_missing_fields_raises_value_error(self):
# Only resource_endpoint provided
with pytest.raises(ValueError) as excinfo:
CommunicationTokenCredential(resource_endpoint="https://endpoint")
assert "Missing: token_credential" in str(excinfo.value)
# Only token_credential provided
with pytest.raises(ValueError) as excinfo:
CommunicationTokenCredential(token_credential=MagicMock())
assert "Missing: resource_endpoint" in str(excinfo.value)
# Only scopes provided
with pytest.raises(ValueError) as excinfo:
CommunicationTokenCredential(scopes=["scope"])
assert "Missing: resource_endpoint, token_credential" in str(excinfo.value)
def test_all_fields_present_calls_token_exchange(monkeypatch):
# Patch TokenExchangeClient to our dummy
with patch("azure.communication.identity._shared.user_credential.TokenExchangeClient", DummyTokenExchangeClient):
cred = CommunicationTokenCredential(
resource_endpoint="https://endpoint",
token_credential=MagicMock(),
scopes=["scope"]
)
token = cred.get_token()
assert token.token == "dummy"
assert token.expires_on == 9999999999
def test_missing_scopes_calls_token_exchange(monkeypatch):
# Patch TokenExchangeClient to our dummy
with patch("azure.communication.identity._shared.user_credential.TokenExchangeClient", DummyTokenExchangeClient):
cred = CommunicationTokenCredential(
resource_endpoint="https://endpoint",
token_credential=MagicMock()
)
token = cred.get_token()
assert token.token == "dummy"
assert token.expires_on == 9999999999
def test_token_exchange_refreshes_from_expired_to_valid(monkeypatch):
# Patch TokenExchangeClient to DummyTokenExchangeClientSwitch
# First call returns expired token - when initializing the token
with patch("azure.communication.identity._shared.user_credential.TokenExchangeClient", DummyTokenExchangeClientSwitch):
cred = CommunicationTokenCredential(
resource_endpoint="https://endpoint",
token_credential=MagicMock(),
scopes=["scope"]
)
# Second call will trigger a refresh and generate a valid token
token2 = cred.get_token()
assert token2.token == "dummy_valid"
|
