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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
# coding: utf-8
# Copyright 2021, 2024 IBM All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# pylint: disable=missing-docstring
import json
import logging
import time
import pytest
import responses
from ibm_cloud_sdk_core import ApiException, VPCInstanceTokenManager
# pylint: disable=line-too-long
TEST_ACCESS_TOKEN_1 = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6ImhlbGxvIiwicm9sZSI6InVzZXIiLCJwZXJtaXNzaW9ucyI6WyJhZG1pbmlzdHJhdG9yIiwiZGVwbG95bWVudF9hZG1pbiJdLCJzdWIiOiJoZWxsbyIsImlzcyI6IkpvaG4iLCJhdWQiOiJEU1giLCJ1aWQiOiI5OTkiLCJpYXQiOjE1NjAyNzcwNTEsImV4cCI6MTU2MDI4MTgxOSwianRpIjoiMDRkMjBiMjUtZWUyZC00MDBmLTg2MjMtOGNkODA3MGI1NDY4In0.cIodB4I6CCcX8vfIImz7Cytux3GpWyObt9Gkur5g1QI'
TEST_ACCESS_TOKEN_2 = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IjIzMDQ5ODE1MWMyMTRiNzg4ZGQ5N2YyMmI4NTQxMGE1In0.eyJ1c2VybmFtZSI6ImR1bW15Iiwicm9sZSI6IkFkbWluIiwicGVybWlzc2lvbnMiOlsiYWRtaW5pc3RyYXRvciIsIm1hbmFnZV9jYXRhbG9nIl0sInN1YiI6ImFkbWluIiwiaXNzIjoic3NzIiwiYXVkIjoic3NzIiwidWlkIjoic3NzIiwiaWF0IjozNjAwLCJleHAiOjE2MjgwMDcwODF9.zvUDpgqWIWs7S1CuKv40ERw1IZ5FqSFqQXsrwZJyfRM'
TEST_TOKEN = 'abc123'
TEST_IAM_TOKEN = 'iam-abc123'
TEST_IAM_PROFILE_CRN = 'crn:iam-profile:123'
TEST_IAM_PROFILE_ID = 'iam-id-123'
EXPIRATION_WINDOW = 10
def _get_current_time() -> int:
return int(time.time())
def test_constructor():
token_manager = VPCInstanceTokenManager(
iam_profile_crn=TEST_IAM_PROFILE_CRN,
)
assert token_manager.iam_profile_crn is TEST_IAM_PROFILE_CRN
assert token_manager.iam_profile_id is None
assert token_manager.access_token is None
def test_setters():
token_manager = VPCInstanceTokenManager(
iam_profile_crn=TEST_IAM_PROFILE_CRN,
)
assert token_manager.iam_profile_crn is TEST_IAM_PROFILE_CRN
assert token_manager.iam_profile_id is None
assert token_manager.access_token is None
token_manager.set_iam_profile_crn(None)
assert token_manager.iam_profile_crn is None
token_manager.set_iam_profile_id(TEST_IAM_PROFILE_ID)
assert token_manager.iam_profile_id == TEST_IAM_PROFILE_ID
@responses.activate
def test_retrieve_instance_identity_token(caplog):
caplog.set_level(logging.DEBUG)
token_manager = VPCInstanceTokenManager(
iam_profile_crn=TEST_IAM_PROFILE_CRN,
url='http://someurl.com',
)
response = {
'access_token': TEST_TOKEN,
}
responses.add(responses.PUT, 'http://someurl.com/instance_identity/v1/token', body=json.dumps(response), status=200)
ii_token = token_manager.retrieve_instance_identity_token()
assert len(responses.calls) == 1
assert responses.calls[0].request.headers['Content-Type'] == 'application/json'
assert responses.calls[0].request.headers['Accept'] == 'application/json'
assert responses.calls[0].request.headers['Metadata-Flavor'] == 'ibm'
assert responses.calls[0].request.params['version'] == '2022-03-01'
assert responses.calls[0].request.body == '{"expires_in": 300}'
assert ii_token == TEST_TOKEN
# Check the logs.
# pylint: disable=line-too-long
assert (
caplog.record_tuples[0][2]
== 'Invoking VPC \'create_access_token\' operation: http://someurl.com/instance_identity/v1/token'
)
assert caplog.record_tuples[1][2] == 'Returned from VPC \'create_access_token\' operation."'
@responses.activate
def test_retrieve_instance_identity_token_failed(caplog):
caplog.set_level(logging.DEBUG)
token_manager = VPCInstanceTokenManager(
iam_profile_crn=TEST_IAM_PROFILE_CRN,
url='http://someurl.com',
)
response = {
'errors': ['Ooops'],
}
responses.add(responses.PUT, 'http://someurl.com/instance_identity/v1/token', body=json.dumps(response), status=400)
with pytest.raises(ApiException):
token_manager.retrieve_instance_identity_token()
assert len(responses.calls) == 1
# Check the logs.
# pylint: disable=line-too-long
assert (
caplog.record_tuples[0][2]
== 'Invoking VPC \'create_access_token\' operation: http://someurl.com/instance_identity/v1/token'
)
@responses.activate
def test_request_token_with_crn(caplog):
caplog.set_level(logging.DEBUG)
token_manager = VPCInstanceTokenManager(
iam_profile_crn=TEST_IAM_PROFILE_CRN,
)
# Mock the retrieve instance identity token method.
def mock_retrieve_instance_identity_token():
return TEST_TOKEN
token_manager.retrieve_instance_identity_token = mock_retrieve_instance_identity_token
response = {
'access_token': TEST_IAM_TOKEN,
}
responses.add(
responses.POST, 'http://169.254.169.254/instance_identity/v1/iam_token', body=json.dumps(response), status=200
)
response = token_manager.request_token()
assert len(responses.calls) == 1
assert responses.calls[0].request.headers['Content-Type'] == 'application/json'
assert responses.calls[0].request.headers['Accept'] == 'application/json'
assert responses.calls[0].request.headers['Authorization'] == 'Bearer ' + TEST_TOKEN
assert responses.calls[0].request.body == '{"trusted_profile": {"crn": "crn:iam-profile:123"}}'
assert responses.calls[0].request.params['version'] == '2022-03-01'
# Check the logs.
# pylint: disable=line-too-long
assert (
caplog.record_tuples[0][2]
== 'Invoking VPC \'create_iam_token\' operation: http://169.254.169.254/instance_identity/v1/iam_token'
)
assert caplog.record_tuples[1][2] == 'Returned from VPC \'create_iam_token\' operation."'
@responses.activate
def test_request_token_with_id(caplog):
caplog.set_level(logging.DEBUG)
token_manager = VPCInstanceTokenManager(
iam_profile_id=TEST_IAM_PROFILE_ID,
)
# Mock the retrieve instance identity token method.
def mock_retrieve_instance_identity_token():
return TEST_TOKEN
token_manager.retrieve_instance_identity_token = mock_retrieve_instance_identity_token
response = {
'access_token': TEST_IAM_TOKEN,
}
responses.add(
responses.POST, 'http://169.254.169.254/instance_identity/v1/iam_token', body=json.dumps(response), status=200
)
response = token_manager.request_token()
assert len(responses.calls) == 1
assert responses.calls[0].request.headers['Content-Type'] == 'application/json'
assert responses.calls[0].request.headers['Accept'] == 'application/json'
assert responses.calls[0].request.headers['Authorization'] == 'Bearer ' + TEST_TOKEN
assert responses.calls[0].request.body == '{"trusted_profile": {"id": "iam-id-123"}}'
assert responses.calls[0].request.params['version'] == '2022-03-01'
# Check the logs.
# pylint: disable=line-too-long
assert (
caplog.record_tuples[0][2]
== 'Invoking VPC \'create_iam_token\' operation: http://169.254.169.254/instance_identity/v1/iam_token'
)
assert caplog.record_tuples[1][2] == 'Returned from VPC \'create_iam_token\' operation."'
@responses.activate
def test_request_token(caplog):
caplog.set_level(logging.DEBUG)
token_manager = VPCInstanceTokenManager()
# Mock the retrieve instance identity token method.
def mock_retrieve_instance_identity_token():
return TEST_TOKEN
token_manager.retrieve_instance_identity_token = mock_retrieve_instance_identity_token
response = {
'access_token': TEST_IAM_TOKEN,
}
responses.add(
responses.POST, 'http://169.254.169.254/instance_identity/v1/iam_token', body=json.dumps(response), status=200
)
response = token_manager.request_token()
assert len(responses.calls) == 1
assert responses.calls[0].request.headers['Content-Type'] == 'application/json'
assert responses.calls[0].request.headers['Accept'] == 'application/json'
assert responses.calls[0].request.headers['Authorization'] == 'Bearer ' + TEST_TOKEN
assert responses.calls[0].request.body is None
assert responses.calls[0].request.params['version'] == '2022-03-01'
# Check the logs.
# pylint: disable=line-too-long
assert (
caplog.record_tuples[0][2]
== 'Invoking VPC \'create_iam_token\' operation: http://169.254.169.254/instance_identity/v1/iam_token'
)
assert caplog.record_tuples[1][2] == 'Returned from VPC \'create_iam_token\' operation."'
@responses.activate
def test_request_token_failed(caplog):
caplog.set_level(logging.DEBUG)
token_manager = VPCInstanceTokenManager(
iam_profile_id=TEST_IAM_PROFILE_ID,
)
# Mock the retrieve instance identity token method.
def mock_retrieve_instance_identity_token():
return TEST_TOKEN
token_manager.retrieve_instance_identity_token = mock_retrieve_instance_identity_token
response = {
'errors': ['Ooops'],
}
responses.add(
responses.POST, 'http://169.254.169.254/instance_identity/v1/iam_token', body=json.dumps(response), status=400
)
with pytest.raises(ApiException):
token_manager.request_token()
assert len(responses.calls) == 1
# Check the logs.
# pylint: disable=line-too-long
assert (
caplog.record_tuples[0][2]
== 'Invoking VPC \'create_iam_token\' operation: http://169.254.169.254/instance_identity/v1/iam_token'
)
@responses.activate
def test_access_token():
token_manager = VPCInstanceTokenManager(
iam_profile_id=TEST_IAM_PROFILE_ID,
)
response_ii = {
'access_token': TEST_TOKEN,
}
response_iam = {
'access_token': TEST_ACCESS_TOKEN_1,
}
responses.add(
responses.PUT, 'http://169.254.169.254/instance_identity/v1/token', body=json.dumps(response_ii), status=200
)
responses.add(
responses.POST,
'http://169.254.169.254/instance_identity/v1/iam_token',
body=json.dumps(response_iam),
status=200,
)
assert token_manager.access_token is None
assert token_manager.expire_time == 0
assert token_manager.refresh_time == 0
token_manager.get_token()
assert token_manager.access_token == TEST_ACCESS_TOKEN_1
assert token_manager.expire_time > 0
assert token_manager.refresh_time > 0
@responses.activate
def test_get_token_success():
token_manager = VPCInstanceTokenManager()
# Mock the retrieve instance identity token method.
def mock_retrieve_instance_identity_token():
return TEST_TOKEN
token_manager.retrieve_instance_identity_token = mock_retrieve_instance_identity_token
response1 = {
'access_token': TEST_ACCESS_TOKEN_1,
}
response2 = {
'access_token': TEST_ACCESS_TOKEN_2,
}
responses.add(
responses.POST, 'http://169.254.169.254/instance_identity/v1/iam_token', body=json.dumps(response1), status=200
)
access_token = token_manager.get_token()
assert access_token == TEST_ACCESS_TOKEN_1
assert token_manager.access_token == TEST_ACCESS_TOKEN_1
# Verify that the token manager returns the cached value.
# Before we call `get_token` again, set the expiration and refresh time
# so that we do not fetch a new access token.
# This is necessary because we are using a fixed JWT response.
token_manager.expire_time = _get_current_time() + 1000
token_manager.refresh_time = _get_current_time() + 1000
access_token = token_manager.get_token()
assert access_token == TEST_ACCESS_TOKEN_1
assert token_manager.access_token == TEST_ACCESS_TOKEN_1
# Force expiration to get the second token.
# We'll set the expiration time to be current-time + EXPIRATION_WINDOW (10 secs)
# because we want the access token to be considered as "expired"
# when we reach the IAM-server reported expiration time minus 10 secs.
responses.add(
responses.POST, 'http://169.254.169.254/instance_identity/v1/iam_token', body=json.dumps(response2), status=200
)
token_manager.expire_time = _get_current_time() + EXPIRATION_WINDOW
access_token = token_manager.get_token()
assert access_token == TEST_ACCESS_TOKEN_2
assert token_manager.access_token == TEST_ACCESS_TOKEN_2
|
