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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
|
"""
SoftLayer.tests.CLI.modules.user_tests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Tests for the user cli command
"""
import json
import sys
import unittest
from SoftLayer.fixtures import SoftLayer_User_Customer
from SoftLayer import testing
from unittest import mock as mock
class UserCLITests(testing.TestCase):
"""User list tests"""
def test_user_list(self):
result = self.run_command(['user', 'list'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_Account', 'getUsers')
def test_user_list_only_id(self):
result = self.run_command(['user', 'list', '--columns=id'])
self.assert_no_fail(result)
self.assertEqual([{"id": 11100}, {"id": 11111}], json.loads(result.output))
"""User detail tests"""
def test_detail(self):
result = self.run_command(['user', 'detail', '11100'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'getObject')
def test_detail_keys(self):
result = self.run_command(['user', 'detail', '11100', '-k'])
self.assert_no_fail(result)
self.assertIn('APIKEY', result.output)
def test_detail_permissions(self):
result = self.run_command(['user', 'detail', '11100', '-p'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'getPermissions')
self.assertIn('ACCESS_ALL_HARDWARE', result.output)
def test_detail_hardware(self):
result = self.run_command(['user', 'detail', '11100', '-h'])
self.assert_no_fail(result)
self.assert_called_with(
'SoftLayer_User_Customer', 'getObject', identifier=11100,
mask='mask[id, hardware, dedicatedHosts]'
)
def test_detail_virtual(self):
result = self.run_command(['user', 'detail', '11100', '-v'])
self.assert_no_fail(result)
self.assert_called_with(
'SoftLayer_User_Customer', 'getObject', identifier=11100,
mask='mask[id, virtualGuests]'
)
def test_detail_logins(self):
result = self.run_command(['user', 'detail', '11100', '-l'])
self.assert_no_fail(result)
self.assert_called_with(
'SoftLayer_User_Customer', 'getLoginAttempts', identifier=11100
)
def test_detail_events(self):
result = self.run_command(['user', 'detail', '11100', '-e'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_Event_Log', 'getAllObjects')
def test_print_hardware_access(self):
mock = self.set_mock('SoftLayer_User_Customer', 'getObject')
mock.return_value = {
'accountId': 12345,
'address1': '315 Test Street',
'city': 'Houston',
'companyName': 'SoftLayer Development Community',
'country': 'US',
'displayName': 'Test',
'email': 'test@us.ibm.com',
'firstName': 'Test',
'id': 244956,
'lastName': 'Testerson',
'postalCode': '77002',
'state': 'TX',
'statusDate': None,
'hardware': [
{'id': 1234,
'fullyQualifiedDomainName': 'test.test.test',
'provisionDate': '2018-05-08T15:28:32-06:00',
'primaryBackendIpAddress': '175.125.126.118',
'primaryIpAddress': '175.125.126.118'}
],
'dedicatedHosts': [
{'id': 1234,
'fullyQualifiedDomainName': 'test.test.test',
'provisionDate': '2018-05-08T15:28:32-06:00',
'primaryBackendIpAddress': '175.125.126.118',
'primaryIpAddress': '175.125.126.118'}
],
}
result = self.run_command(['user', 'detail', '11100', '-h'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'getObject', identifier=11100,
mask="mask[id, hardware, dedicatedHosts]")
"""User permissions tests"""
def test_permissions_list(self):
result = self.run_command(['user', 'permissions', '11100'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Permission_Department', 'getAllObjects')
self.assert_called_with(
'SoftLayer_User_Customer', 'getObject', identifier=11100,
mask='mask[id, permissions, isMasterUserFlag, roles]'
)
"""User edit-permissions tests"""
def test_edit_perms_on(self):
result = self.run_command(['user', 'edit-permissions', '11100', '--enable', '-p', 'TEST'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'addBulkPortalPermission', identifier=11100)
def test_edit_perms_on_bad(self):
result = self.run_command(['user', 'edit-permissions', '11100', '--enable', '-p', 'TEST_NOt_exist'])
self.assertEqual(result.exit_code, 1)
def test_edit_perms_off(self):
result = self.run_command(['user', 'edit-permissions', '11100', '--disable', '-p', 'TEST'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'removeBulkPortalPermission', identifier=11100)
@mock.patch('SoftLayer.CLI.user.edit_permissions.click')
def test_edit_perms_off_failure(self, click):
permission_mock = self.set_mock('SoftLayer_User_Customer', 'removeBulkPortalPermission')
permission_mock.return_value = False
result = self.run_command(['user', 'edit-permissions', '11100', '--disable', '-p', 'TEST'])
click.secho.assert_called_with('Failed to update permissions: TEST', fg='red')
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'removeBulkPortalPermission', identifier=11100)
def test_edit_perms_from_user(self):
result = self.run_command(['user', 'edit-permissions', '11100', '-u', '1234'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'getPermissions', identifier=1234)
self.assert_called_with('SoftLayer_User_Customer', 'removeBulkPortalPermission', identifier=11100)
self.assert_called_with('SoftLayer_User_Customer', 'addBulkPortalPermission', identifier=11100)
"""User create tests"""
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user(self, confirm_mock):
confirm_mock.return_value = True
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com', '-p', 'testword'])
self.assert_no_fail(result)
self.assertIn('test@us.ibm.com', result.output)
self.assert_called_with('SoftLayer_Account', 'getCurrentUser')
self.assert_called_with('SoftLayer_User_Customer', 'createObject', args=mock.ANY)
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user_no_confirm(self, confirm_mock):
confirm_mock.return_value = False
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com', '-p', 'testword'])
self.assertEqual(result.exit_code, 2)
@unittest.skipIf(sys.version_info < (3, 6), "Secrets module only exists in version 3.6+")
@mock.patch('secrets.choice')
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user_generate_password_36(self, confirm_mock, secrets):
secrets.return_value = 'Q'
confirm_mock.return_value = True
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com', '-p', 'generate'])
self.assert_no_fail(result)
self.assertIn('test@us.ibm.com', result.output)
self.assertIn('QQQQQQQQQQQQQQQQQQQQQQ', result.output)
self.assert_called_with('SoftLayer_Account', 'getCurrentUser')
self.assert_called_with('SoftLayer_User_Customer', 'createObject', args=mock.ANY)
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user_generate_password_2(self, confirm_mock):
if sys.version_info >= (3, 6):
self.skipTest("Python needs to be < 3.6 for this test.")
confirm_mock.return_value = True
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com', '-p', 'generate'])
self.assertIn(result.output, "ImportError")
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user_and_apikey(self, confirm_mock):
confirm_mock.return_value = True
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com'])
self.assert_no_fail(result)
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user_with_template(self, confirm_mock):
confirm_mock.return_value = True
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com',
'-t', '{"firstName": "Supermand"}'])
self.assertIn('Supermand', result.output)
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user_with_bad_template(self, confirm_mock):
confirm_mock.return_value = True
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com',
'-t', '{firstName: "Supermand"}'])
self.assertIn("Argument Error", result.exception.message)
self.assertEqual(result.exit_code, 2)
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user_with_no_confirm(self, confirm_mock):
confirm_mock.return_value = False
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com'])
self.assertIn("Canceling creation!", result.exception.message)
self.assertEqual(result.exit_code, 2)
@mock.patch('SoftLayer.CLI.formatting.confirm')
def test_create_user_from_user(self, confirm_mock):
confirm_mock.return_value = True
result = self.run_command(['user', 'create', 'test', '-e', 'test@us.ibm.com', '-u', '1234'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'getObject', identifier=1234)
"""User edit-details tests"""
@mock.patch('SoftLayer.CLI.user.edit_details.click')
def test_edit_details(self, click):
result = self.run_command(['user', 'edit-details', '1234', '-t', '{"firstName":"Supermand"}'])
click.secho.assert_called_with('1234 updated successfully', fg='green')
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'editObject',
args=({'firstName': 'Supermand'},), identifier=1234)
@mock.patch('SoftLayer.CLI.user.edit_details.click')
def test_edit_details_failure(self, click):
mock = self.set_mock('SoftLayer_User_Customer', 'editObject')
mock.return_value = False
result = self.run_command(['user', 'edit-details', '1234', '-t', '{"firstName":"Supermand"}'])
click.secho.assert_called_with('Failed to update 1234', fg='red')
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'editObject',
args=({'firstName': 'Supermand'},), identifier=1234)
def test_edit_details_bad_json(self):
result = self.run_command(['user', 'edit-details', '1234', '-t', '{firstName:"Supermand"}'])
self.assertIn("Argument Error", result.exception.message)
self.assertEqual(result.exit_code, 2)
"""User delete tests"""
@mock.patch('SoftLayer.CLI.user.delete.click')
def test_delete(self, click):
result = self.run_command(['user', 'delete', '12345'])
click.secho.assert_called_with('12345 deleted successfully', fg='green')
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'editObject',
args=({'userStatusId': 1021},), identifier=12345)
@mock.patch('SoftLayer.CLI.user.delete.click')
def test_delete_failure(self, click):
mock = self.set_mock('SoftLayer_User_Customer', 'editObject')
mock.return_value = False
result = self.run_command(['user', 'delete', '12345'])
click.secho.assert_called_with('Failed to delete 12345', fg='red')
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'editObject',
args=({'userStatusId': 1021},), identifier=12345)
"""User vpn manual config tests"""
@mock.patch('SoftLayer.CLI.user.vpn_manual.click')
def test_vpn_manual(self, click):
result = self.run_command(['user', 'vpn-manual', '12345', '--enable'])
click.secho.assert_called_with('12345 vpn manual config enable', fg='green')
self.assert_no_fail(result)
def test_vpn_manual_fail(self):
mock = self.set_mock('SoftLayer_User_Customer', 'editObject')
mock.return_value = False
result = self.run_command(['user', 'vpn-manual', '12345', '--enable'])
self.assert_no_fail(result)
"""User vpn subnet tests"""
@mock.patch('SoftLayer.CLI.user.vpn_subnet.click')
def test_vpn_subnet_add(self, click):
result = self.run_command(['user', 'vpn-subnet', '12345', '--add', '1234'])
click.secho.assert_called_with('12345 updated successfully', fg='green')
self.assert_no_fail(result)
def test_vpn_subnet_add_fail(self):
mock = self.set_mock('SoftLayer_Network_Service_Vpn_Overrides', 'createObjects')
mock.return_value = False
result = self.run_command(['user', 'vpn-subnet', '12345', '--add', '1234'])
self.assert_no_fail(result)
@mock.patch('SoftLayer.CLI.user.vpn_subnet.click')
def test_vpn_subnet_remove(self, click):
result = self.run_command(['user', 'vpn-subnet', '12345', '--remove', '1234'])
click.secho.assert_called_with('12345 updated successfully', fg='green')
self.assert_no_fail(result)
"""User notification tests"""
def test_notificacions_list(self):
result = self.run_command(['user', 'notifications'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_Email_Subscription', 'getAllObjects', mask='mask[enabled]')
"""User edit-notification tests"""
def test_edit_notification_on(self):
result = self.run_command(['user', 'edit-notifications', '--enable', 'Test notification'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_Email_Subscription', 'enable', identifier=111)
def test_edit_notification_on_bad(self):
result = self.run_command(['user', 'edit-notifications', '--enable', 'Test not exist'])
self.assertEqual(result.exit_code, 1)
def test_edit_notifications_off(self):
result = self.run_command(['user', 'edit-notifications', '--disable', 'Test notification'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_Email_Subscription', 'disable', identifier=111)
@mock.patch('SoftLayer.CLI.user.edit_notifications.click')
def test_edit_notification_off_failure(self, click):
notification = self.set_mock('SoftLayer_Email_Subscription', 'disable')
notification.return_value = False
result = self.run_command(['user', 'edit-notifications', '--disable', 'Test notification'])
click.secho.assert_called_with('Failed to update notifications: Test notification', fg='red')
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_Email_Subscription', 'disable', identifier=111)
def test_devices_access(self):
result = self.run_command(['user', 'device-access', '111'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'getPermissions')
self.assert_called_with('SoftLayer_User_Customer', 'getHardware')
self.assert_called_with('SoftLayer_User_Customer', 'getDedicatedHosts')
self.assert_called_with('SoftLayer_User_Customer', 'getVirtualGuests')
def test_grant_access_hardware(self):
result = self.run_command(['user', 'grant-access', '123456', '--hardware', '147258'])
self.assert_no_fail(result)
def test_grant_access_virtual(self):
result = self.run_command(['user', 'grant-access', '123456', '--virtual', '987456'])
self.assert_no_fail(result)
def test_grant_access_dedicated(self):
result = self.run_command(['user', 'grant-access', '123456', '--dedicated', '369852'])
self.assert_no_fail(result)
def test_grant_without_device(self):
result = self.run_command(['user', 'grant-access', '123456'])
self.assertEqual(2, result.exit_code)
self.assertIn('A device option is required.', result.exception.message)
def test_remove_access_hardware(self):
result = self.run_command(['user', 'remove-access', '123456', '--hardware', '147258'])
self.assert_no_fail(result)
def test_remove_access_virtual(self):
result = self.run_command(['user', 'remove-access', '123456', '--virtual', '987456'])
self.assert_no_fail(result)
def test_remove_access_dedicated(self):
result = self.run_command(['user', 'remove-access', '123456', '--dedicated', '369852'])
self.assert_no_fail(result)
def test_remove_without_device(self):
result = self.run_command(['user', 'remove-access', '123456'])
self.assertEqual(2, result.exit_code)
self.assertIn('A device option is required.', result.exception.message)
def test_update_vpn_password(self):
result = self.run_command(['user', 'vpn-password', '123456', '--password', 'Mypassword1.'])
self.assert_no_fail(result)
def test_remove_without_password(self):
result = self.run_command(['user', 'vpn-password', '123456'])
self.assertEqual(2, result.exit_code)
self.assertIn("Missing option '--password'", result.output)
def test_api_key_without_option(self):
result = self.run_command(['user', 'apikey', '123456'])
self.assertEqual(2, result.exit_code)
self.assertIn('At least one option is required', result.exception.message)
def test_api_key_with_all_option(self):
result = self.run_command(['user', 'apikey', '123456', '--add', '--remove', '--refresh'])
self.assertEqual(2, result.exit_code)
self.assertIn('Can only specify one option', result.exception.message)
def test_remove_api_authentication_key_without_api_key(self):
mock = self.set_mock('SoftLayer_User_Customer', 'getApiAuthenticationKeys')
mock.return_value = SoftLayer_User_Customer.getEmptyApiAuthenticationKeys
result = self.run_command(['user', 'apikey', '123456', '--remove'])
self.assert_no_fail(result)
def test_add_api_authentication_key(self):
result = self.run_command(['user', 'apikey', '123456', '--add'])
self.assert_no_fail(result)
def test_remove_api_authentication_key(self):
result = self.run_command(['user', 'apikey', '123456', '--remove'])
self.assert_no_fail(result)
def test_refresh_api_authentication_key(self):
result = self.run_command(['user', 'apikey', '123456', '--refresh'])
self.assert_no_fail(result)
def test_vpn_disable(self):
result = self.run_command(['user', 'vpn-disable', '8344458'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'editObject', identifier=8344458)
result = self.run_command(['user', 'vpn-disable', '8344458'])
permission_m = self.set_mock('SoftLayer_User_Customer', 'editObject')
permission_m.return_value = {'sslVpnAllowedFlag': False}
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'editObject', identifier=8344458)
self.assertEqual('8344458 vpn is successfully disabled\n', result.output)
def test_vpn_enable(self):
result = self.run_command(['user', 'vpn-enable', '8344458'])
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'editObject', identifier=8344458)
result = self.run_command(['user', 'vpn-enable', '8344458'])
permission_m = self.set_mock('SoftLayer_User_Customer', 'editObject')
permission_m.return_value = {'sslVpnAllowedFlag': True}
self.assert_no_fail(result)
self.assert_called_with('SoftLayer_User_Customer', 'editObject', identifier=8344458)
self.assertEqual('8344458 vpn is successfully enabled\n', result.output)
|
