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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
# pylint: disable=missing-docstring
# coding: utf-8
# Copyright 2019, 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.
import logging
import os
import pytest
from ibm_cloud_sdk_core import get_authenticator_from_environment
from ibm_cloud_sdk_core.authenticators import Authenticator, BasicAuthenticator, IAMAuthenticator
from .utils.logger_utils import setup_test_logger
setup_test_logger(logging.ERROR)
# pylint: disable=too-many-statements
def test_get_authenticator_from_credential_file():
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-iam.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('ibm watson')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM
assert authenticator.token_manager.apikey == '5678efgh'
assert authenticator.token_manager.url == 'https://iam.cloud.ibm.com'
assert authenticator.token_manager.client_id is None
assert authenticator.token_manager.client_secret is None
assert authenticator.token_manager.disable_ssl_verification is False
assert authenticator.token_manager.scope is None
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-iam-assume.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service 1')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM_ASSUME
assert authenticator.token_manager.iam_delegate.apikey == 'my-api-key'
assert authenticator.token_manager.iam_profile_id == 'iam-profile-1'
assert authenticator.token_manager.url == 'https://iam.cloud.ibm.com'
assert authenticator.token_manager.client_id is None
assert authenticator.token_manager.client_secret is None
assert authenticator.token_manager.disable_ssl_verification is False
assert authenticator.token_manager.scope is None
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-basic.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('watson')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_BASIC
assert authenticator.username == 'my_username'
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-container.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service 1')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_CONTAINER
assert authenticator.token_manager.cr_token_filename == 'crtoken.txt'
assert authenticator.token_manager.iam_profile_name == 'iam-user-123'
assert authenticator.token_manager.iam_profile_id == 'iam-id-123'
assert authenticator.token_manager.url == 'https://iamhost/iam/api'
assert authenticator.token_manager.scope == 'scope1'
assert authenticator.token_manager.client_id == 'iam-client-123'
assert authenticator.token_manager.client_secret == 'iam-secret-123'
assert authenticator.token_manager.disable_ssl_verification is True
authenticator = get_authenticator_from_environment('service 2')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_CONTAINER
assert authenticator.token_manager.cr_token_filename is None
assert authenticator.token_manager.iam_profile_name == 'iam-user-123'
assert authenticator.token_manager.iam_profile_id is None
assert authenticator.token_manager.url == 'https://iam.cloud.ibm.com'
assert authenticator.token_manager.scope is None
assert authenticator.token_manager.client_id is None
assert authenticator.token_manager.client_secret is None
assert authenticator.token_manager.disable_ssl_verification is False
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-cp4d.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('watson')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_CP4D
assert authenticator.token_manager.username == 'my_username'
assert authenticator.token_manager.password == 'my_password'
assert authenticator.token_manager.url == 'https://my_url/v1/authorize'
assert authenticator.token_manager.apikey is None
assert authenticator.token_manager.disable_ssl_verification is False
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-no-auth.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('watson')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_NOAUTH
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-bearer.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('watson')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_BEARERTOKEN
assert authenticator.bearer_token is not None
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service_1')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM
assert authenticator.token_manager.apikey == 'V4HXmoUtMjohnsnow=KotN'
assert authenticator.token_manager.client_id == 'somefake========id'
assert authenticator.token_manager.client_secret == '==my-client-secret=='
assert authenticator.token_manager.url == 'https://iamhost/iam/api='
assert authenticator.token_manager.scope is None
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-vpc.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service1')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_VPC
assert authenticator.token_manager.iam_profile_crn is None
assert authenticator.token_manager.iam_profile_id is None
assert authenticator.token_manager.url == 'http://169.254.169.254'
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-vpc.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service2')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_VPC
assert authenticator.token_manager.iam_profile_crn == 'crn:iam-profile1'
assert authenticator.token_manager.iam_profile_id is None
assert authenticator.token_manager.url == 'http://vpc.imds.com/api'
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-vpc.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service3')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_VPC
assert authenticator.token_manager.iam_profile_crn is None
assert authenticator.token_manager.iam_profile_id == 'iam-profile1-id'
assert authenticator.token_manager.url == 'http://169.254.169.254'
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-mcsp.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service1')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_MCSP
assert authenticator.token_manager.url == 'https://mcsp.ibm.com'
assert authenticator.token_manager.apikey == 'my-api-key'
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-mcspv2.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service1')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_MCSPV2
assert authenticator.token_manager.url == 'https://mcspv2.ibm.com'
assert authenticator.token_manager.apikey == 'my-api-key'
assert authenticator.token_manager.scope_collection_type == 'accounts'
assert authenticator.token_manager.scope_id == 'global_account'
assert authenticator.token_manager.include_builtin_actions is False
assert authenticator.token_manager.include_custom_actions is False
assert authenticator.token_manager.include_roles is True
assert authenticator.token_manager.prefix_roles is False
assert authenticator.token_manager.caller_ext_claim is None
assert authenticator.token_manager.disable_ssl_verification is False
assert authenticator.token_manager.headers is None
assert authenticator.token_manager.proxies is None
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-mcspv2.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service2')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_MCSPV2
assert authenticator.token_manager.url == 'https://mcspv2.ibm.com'
assert authenticator.token_manager.apikey == 'my-api-key'
assert authenticator.token_manager.scope_collection_type == 'accounts'
assert authenticator.token_manager.scope_id == 'global_account'
assert authenticator.token_manager.include_builtin_actions is True
assert authenticator.token_manager.include_custom_actions is True
assert authenticator.token_manager.include_roles is False
assert authenticator.token_manager.prefix_roles is True
assert authenticator.token_manager.caller_ext_claim == {"productID": "prod-123"}
assert authenticator.token_manager.disable_ssl_verification is True
assert authenticator.token_manager.headers is None
assert authenticator.token_manager.proxies is None
del os.environ['IBM_CREDENTIALS_FILE']
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials-mcspv2.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
with pytest.raises(Exception) as err:
authenticator = get_authenticator_from_environment('error1')
assert (
str(err.value)
== 'An error occurred while unmarshalling the CALLER_EXT_CLAIM configuration property: {not json}'
)
del os.environ['IBM_CREDENTIALS_FILE']
def test_get_authenticator_from_credential_file_scope():
file_path = os.path.join(os.path.dirname(__file__), '../resources/ibm-credentials.env')
os.environ['IBM_CREDENTIALS_FILE'] = file_path
authenticator = get_authenticator_from_environment('service_2')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM
assert authenticator.token_manager.apikey == 'V4HXmoUtMjohnsnow=KotN'
assert authenticator.token_manager.client_id == 'somefake========id'
assert authenticator.token_manager.client_secret == '==my-client-secret=='
assert authenticator.token_manager.url == 'https://iamhost/iam/api='
assert authenticator.token_manager.scope == 'A B C D'
del os.environ['IBM_CREDENTIALS_FILE']
def test_get_authenticator_from_env_variables():
os.environ['TEST_APIKEY'] = '5678efgh'
authenticator = get_authenticator_from_environment('test')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM
assert authenticator.token_manager.apikey == '5678efgh'
del os.environ['TEST_APIKEY']
os.environ['TEST_IAM_PROFILE_ID'] = 'iam-profile-id1'
authenticator = get_authenticator_from_environment('test')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_CONTAINER
assert authenticator.token_manager.iam_profile_id == 'iam-profile-id1'
del os.environ['TEST_IAM_PROFILE_ID']
os.environ['SERVICE_1_APIKEY'] = 'V4HXmoUtMjohnsnow=KotN'
authenticator = get_authenticator_from_environment('service_1')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM
assert authenticator.token_manager.apikey == 'V4HXmoUtMjohnsnow=KotN'
del os.environ['SERVICE_1_APIKEY']
os.environ['SERVICE_2_APIKEY'] = 'johnsnow'
os.environ['SERVICE_2_SCOPE'] = 'A B C D'
authenticator = get_authenticator_from_environment('service_2')
assert authenticator is not None
assert authenticator.token_manager.apikey == 'johnsnow'
assert authenticator.token_manager.scope == 'A B C D'
del os.environ['SERVICE_2_APIKEY']
del os.environ['SERVICE_2_SCOPE']
os.environ['SERVICE3_AUTH_TYPE'] = 'mCsP'
os.environ['SERVICE3_AUTH_URL'] = 'https://mcsp.ibm.com'
os.environ['SERVICE3_APIKEY'] = 'my-api-key'
authenticator = get_authenticator_from_environment('service3')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_MCSP
assert authenticator.token_manager.apikey == 'my-api-key'
assert authenticator.token_manager.url == 'https://mcsp.ibm.com'
del os.environ['SERVICE3_APIKEY']
del os.environ['SERVICE3_AUTH_TYPE']
del os.environ['SERVICE3_AUTH_URL']
def test_vcap_credentials():
vcap_services = '{"test":[{"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"username":"bogus username", \
"password":"bogus password"}}]}'
os.environ['VCAP_SERVICES'] = vcap_services
authenticator = get_authenticator_from_environment('test')
assert isinstance(authenticator, BasicAuthenticator)
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_BASIC
assert authenticator.username == 'bogus username'
assert authenticator.password == 'bogus password'
del os.environ['VCAP_SERVICES']
vcap_services = '{"test":[{"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"apikey":"bogus apikey"}}]}'
os.environ['VCAP_SERVICES'] = vcap_services
authenticator = get_authenticator_from_environment('test')
assert isinstance(authenticator, IAMAuthenticator)
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM
assert authenticator.token_manager.apikey == 'bogus apikey'
del os.environ['VCAP_SERVICES']
vcap_services = '{"test":[{"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"iam_apikey":"bogus apikey"}}]}'
os.environ['VCAP_SERVICES'] = vcap_services
authenticator = get_authenticator_from_environment('test')
assert isinstance(authenticator, IAMAuthenticator)
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM
assert authenticator.token_manager.apikey == 'bogus apikey'
del os.environ['VCAP_SERVICES']
vcap_services = '{"test":[{"name": "testname",\
"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"username":"bogus username", \
"password":"bogus password"}}]}'
os.environ['VCAP_SERVICES'] = vcap_services
authenticator = get_authenticator_from_environment('testname')
assert isinstance(authenticator, BasicAuthenticator)
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_BASIC
assert authenticator.username == 'bogus username'
assert authenticator.password == 'bogus password'
del os.environ['VCAP_SERVICES']
def test_vcap_credentials_2():
vcap_services = '{\
"test":[{"name": "testname",\
"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"username":"bogus username2", \
"password":"bogus password2"}},\
{"name": "othertestname",\
"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"username":"bogus username3", \
"password":"bogus password3"}}],\
"testname":[{"name": "nottestname",\
"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"username":"bogus username", \
"password":"bogus password"}}],\
"equals_sign_test":[{"name": "equals_sign_test",\
"credentials":{ \
"iam_apikey": "V4HXmoUtMjohnsnow=KotN",\
"iam_apikey_description": "Auto generated apikey...",\
"iam_apikey_name": "auto-generated-apikey-111-222-333",\
"iam_role_crn": "crn:v1:bluemix:public:iam::::serviceRole:Manager",\
"iam_serviceid_crn": "crn:v1:staging:public:iam-identity::a/::serviceid:ServiceID-1234",\
"url": "https://gateway.watsonplatform.net/testService",\
"auth_url": "https://iamhost/iam/api="}}]}'
os.environ['VCAP_SERVICES'] = vcap_services
authenticator = get_authenticator_from_environment('testname')
assert isinstance(authenticator, BasicAuthenticator)
assert authenticator.username == 'bogus username2'
assert authenticator.password == 'bogus password2'
authenticator = get_authenticator_from_environment('equals_sign_test')
assert isinstance(authenticator, IAMAuthenticator)
assert authenticator.token_manager.apikey == 'V4HXmoUtMjohnsnow=KotN'
del os.environ['VCAP_SERVICES']
vcap_services = '{"test":[{\
"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"username":"bogus username", \
"password":"bogus password"}},\
{"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"username":"bogus username2", \
"password":"bogus password2"}}\
]}'
os.environ['VCAP_SERVICES'] = vcap_services
authenticator = get_authenticator_from_environment('test')
assert isinstance(authenticator, BasicAuthenticator)
assert authenticator.username == 'bogus username'
assert authenticator.password == 'bogus password'
del os.environ['VCAP_SERVICES']
vcap_services = '{"first":[],\
"test":[{"credentials":{ \
"url":"https://gateway.watsonplatform.net/compare-comply/api",\
"username":"bogus username", \
"password":"bogus password"}}],\
"last":[]}'
os.environ['VCAP_SERVICES'] = vcap_services
authenticator = get_authenticator_from_environment('test')
assert isinstance(authenticator, BasicAuthenticator)
assert authenticator.username == 'bogus username'
assert authenticator.password == 'bogus password'
del os.environ['VCAP_SERVICES']
vcap_services = '{"test":[],\
"last":[]}'
os.environ['VCAP_SERVICES'] = vcap_services
authenticator = get_authenticator_from_environment('test')
assert authenticator is None
del os.environ['VCAP_SERVICES']
def test_multi_word_service_name():
os.environ['PERSONALITY_INSIGHTS_APIKEY'] = '5678efgh'
authenticator = get_authenticator_from_environment('personality-insights')
assert authenticator is not None
assert authenticator.authentication_type() == Authenticator.AUTHTYPE_IAM
assert authenticator.token_manager.apikey == '5678efgh'
del os.environ['PERSONALITY_INSIGHTS_APIKEY']
|
