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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
|
# Copyright 2012 Red Hat, Inc.
#
# 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.
from unittest import mock
from django.conf import settings
from django.test.utils import override_settings
import cinderclient as cinder_client
from openstack_dashboard import api
from openstack_dashboard.test import helpers as test
class CinderApiTests(test.APIMockTestCase):
def _stub_cinderclient_with_generic_group(self):
p = mock.patch.object(api.cinder,
'_cinderclient_with_generic_groups').start()
return p.return_value
@test.create_mocks({
api.cinder: [
'cinderclient',
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_list(self):
search_opts = {'all_tenants': 1}
detailed = True
volumes = self.cinder_volumes.list()
volume_transfers = self.cinder_volume_transfers.list()
cinderclient = self.mock_cinderclient.return_value
cinderclient_with_group = self.mock_cinderclient_groups.return_value
volumes_mock = cinderclient_with_group.volumes.list
volumes_mock.return_value = volumes
transfers_mock = cinderclient.transfers.list
transfers_mock.return_value = volume_transfers
api_volumes = api.cinder.volume_list(self.request,
search_opts=search_opts)
volumes_mock.assert_called_once_with(search_opts=search_opts)
transfers_mock.assert_called_once_with(detailed=detailed,
search_opts=search_opts)
self.assertEqual(len(volumes), len(api_volumes))
@test.create_mocks({
api.cinder: [
'cinderclient',
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_list_paged(self):
search_opts = {'all_tenants': 1}
detailed = True
volumes = self.cinder_volumes.list()
volume_transfers = self.cinder_volume_transfers.list()
cinderclient = self.mock_cinderclient.return_value
cinderclient_with_group = self.mock_cinderclient_groups.return_value
volumes_mock = cinderclient_with_group.volumes.list
volumes_mock.return_value = volumes
transfers_mock = cinderclient.transfers.list
transfers_mock.return_value = volume_transfers
api_volumes, has_more, has_prev = api.cinder.volume_list_paged(
self.request, search_opts=search_opts)
volumes_mock.assert_called_once_with(search_opts=search_opts)
transfers_mock.assert_called_once_with(detailed=detailed,
search_opts=search_opts)
self.assertEqual(len(volumes), len(api_volumes))
self.assertFalse(has_more)
self.assertFalse(has_prev)
@override_settings(API_RESULT_PAGE_SIZE=2)
@override_settings(OPENSTACK_API_VERSIONS={'volume': 2})
@test.create_mocks({
api.cinder: [
'cinderclient',
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_list_paginate_first_page(self):
api.cinder.VERSIONS._active = None
page_size = settings.API_RESULT_PAGE_SIZE
volumes = self.cinder_volumes.list()
volume_transfers = self.cinder_volume_transfers.list()
search_opts = {'all_tenants': 1}
mock_volumes = volumes[:page_size + 1]
expected_volumes = mock_volumes[:-1]
cinderclient = self.mock_cinderclient.return_value
cinderclient_with_group = self.mock_cinderclient_groups.return_value
volumes_mock = cinderclient_with_group.volumes.list
volumes_mock.return_value = mock_volumes
transfers_mock = cinderclient.transfers.list
transfers_mock.return_value = volume_transfers
api_volumes, more_data, prev_data = api.cinder.volume_list_paged(
self.request, search_opts=search_opts, paginate=True)
volumes_mock.assert_called_once_with(search_opts=search_opts,
limit=page_size + 1,
sort='created_at:desc',
marker=None)
transfers_mock.assert_called_once_with(detailed=True,
search_opts=search_opts)
self.assertEqual(len(expected_volumes), len(api_volumes))
self.assertTrue(more_data)
self.assertFalse(prev_data)
@override_settings(API_RESULT_PAGE_SIZE=2)
@override_settings(OPENSTACK_API_VERSIONS={'volume': 2})
@test.create_mocks({
api.cinder: [
'cinderclient',
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_list_paginate_second_page(self):
api.cinder.VERSIONS._active = None
page_size = settings.API_RESULT_PAGE_SIZE
volumes = self.cinder_volumes.list()
volume_transfers = self.cinder_volume_transfers.list()
search_opts = {'all_tenants': 1}
mock_volumes = volumes[page_size:page_size * 2 + 1]
expected_volumes = mock_volumes[:-1]
marker = expected_volumes[0].id
cinderclient = self.mock_cinderclient.return_value
cinderclient_with_group = self.mock_cinderclient_groups.return_value
volumes_mock = cinderclient_with_group.volumes.list
volumes_mock.return_value = mock_volumes
transfers_mock = cinderclient.transfers.list
transfers_mock.return_value = volume_transfers
api_volumes, more_data, prev_data = api.cinder.volume_list_paged(
self.request, search_opts=search_opts, marker=marker,
paginate=True)
volumes_mock.assert_called_once_with(search_opts=search_opts,
limit=page_size + 1,
sort='created_at:desc',
marker=marker)
transfers_mock.assert_called_once_with(detailed=True,
search_opts=search_opts)
self.assertEqual(len(expected_volumes), len(api_volumes))
self.assertTrue(more_data)
self.assertTrue(prev_data)
@override_settings(API_RESULT_PAGE_SIZE=2)
@override_settings(OPENSTACK_API_VERSIONS={'volume': 2})
@test.create_mocks({
api.cinder: [
'cinderclient',
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_list_paginate_last_page(self):
api.cinder.VERSIONS._active = None
page_size = settings.API_RESULT_PAGE_SIZE
volumes = self.cinder_volumes.list()
volume_transfers = self.cinder_volume_transfers.list()
search_opts = {'all_tenants': 1}
mock_volumes = volumes[-1 * page_size:]
expected_volumes = mock_volumes
marker = expected_volumes[0].id
cinderclient = self.mock_cinderclient.return_value
cinderclient_with_group = self.mock_cinderclient_groups.return_value
volumes_mock = cinderclient_with_group.volumes.list
volumes_mock.return_value = mock_volumes
transfers_mock = cinderclient.transfers.list
transfers_mock.return_value = volume_transfers
api_volumes, more_data, prev_data = api.cinder.volume_list_paged(
self.request, search_opts=search_opts, marker=marker,
paginate=True)
volumes_mock.assert_called_once_with(search_opts=search_opts,
limit=page_size + 1,
sort='created_at:desc',
marker=marker)
transfers_mock.assert_called_once_with(detailed=True,
search_opts=search_opts)
self.assertEqual(len(expected_volumes), len(api_volumes))
self.assertFalse(more_data)
self.assertTrue(prev_data)
@override_settings(API_RESULT_PAGE_SIZE=2)
@override_settings(OPENSTACK_API_VERSIONS={'volume': 2})
@test.create_mocks({
api.cinder: [
'cinderclient',
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_list_paginate_back_from_some_page(self):
api.cinder.VERSIONS._active = None
page_size = settings.API_RESULT_PAGE_SIZE
volumes = self.cinder_volumes.list()
volume_transfers = self.cinder_volume_transfers.list()
search_opts = {'all_tenants': 1}
mock_volumes = volumes[page_size:page_size * 2 + 1]
expected_volumes = mock_volumes[:-1]
marker = expected_volumes[0].id
cinderclient = self.mock_cinderclient.return_value
cinderclient_with_group = self.mock_cinderclient_groups.return_value
volumes_mock = cinderclient_with_group.volumes.list
volumes_mock.return_value = mock_volumes
transfers_mock = cinderclient.transfers.list
transfers_mock.return_value = volume_transfers
api_volumes, more_data, prev_data = api.cinder.volume_list_paged(
self.request, search_opts=search_opts, sort_dir="asc",
marker=marker, paginate=True)
volumes_mock.assert_called_once_with(search_opts=search_opts,
limit=page_size + 1,
sort='created_at:asc',
marker=marker)
transfers_mock.assert_called_once_with(detailed=True,
search_opts=search_opts)
self.assertEqual(len(expected_volumes), len(api_volumes))
self.assertTrue(more_data)
self.assertTrue(prev_data)
@override_settings(API_RESULT_PAGE_SIZE=2)
@override_settings(OPENSTACK_API_VERSIONS={'volume': 2})
@test.create_mocks({
api.cinder: [
'cinderclient',
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_list_paginate_back_to_first_page(self):
api.cinder.VERSIONS._active = None
page_size = settings.API_RESULT_PAGE_SIZE
volumes = self.cinder_volumes.list()
volume_transfers = self.cinder_volume_transfers.list()
search_opts = {'all_tenants': 1}
mock_volumes = volumes[:page_size]
expected_volumes = mock_volumes
marker = expected_volumes[0].id
cinderclient = self.mock_cinderclient.return_value
cinderclient_with_group = self.mock_cinderclient_groups.return_value
volumes_mock = cinderclient_with_group.volumes.list
volumes_mock.return_value = mock_volumes
transfers_mock = cinderclient.transfers.list
transfers_mock.return_value = volume_transfers
api_volumes, more_data, prev_data = api.cinder.volume_list_paged(
self.request, search_opts=search_opts, sort_dir="asc",
marker=marker, paginate=True)
volumes_mock.assert_called_once_with(search_opts=search_opts,
limit=page_size + 1,
sort='created_at:asc',
marker=marker)
transfers_mock.assert_called_once_with(detailed=True,
search_opts=search_opts)
self.assertEqual(len(expected_volumes), len(api_volumes))
self.assertTrue(more_data)
self.assertFalse(prev_data)
@test.create_mocks({
api.cinder: [
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_snapshot_list(self):
search_opts = {'all_tenants': 1}
volume_snapshots = self.cinder_volume_snapshots.list()
cinderclient = self.mock_cinderclient_groups.return_value
snapshots_mock = cinderclient.volume_snapshots.list
snapshots_mock.return_value = volume_snapshots
api.cinder.volume_snapshot_list(self.request, search_opts=search_opts)
snapshots_mock.assert_called_once_with(search_opts=search_opts)
@test.create_mocks({
api.cinder: [
('_cinderclient_with_generic_groups', 'cinderclient_groups'),
]
})
def test_volume_snapshot_list_no_volume_configured(self):
# remove volume from service catalog
catalog = self.service_catalog
for service in catalog:
if service["type"] == "volume":
self.service_catalog.remove(service)
search_opts = {'all_tenants': 1}
volume_snapshots = self.cinder_volume_snapshots.list()
cinderclient = self.mock_cinderclient_groups.return_value
snapshots_mock = cinderclient.volume_snapshots.list
snapshots_mock.return_value = volume_snapshots
api.cinder.volume_snapshot_list(self.request, search_opts=search_opts)
snapshots_mock.assert_called_once_with(search_opts=search_opts)
@mock.patch.object(api.cinder, 'cinderclient')
def test_volume_type_list_with_qos_associations(self, mock_cinderclient):
volume_types = self.cinder_volume_types.list()
# Due to test data limitations, we can only run this test using
# one qos spec, which is associated with one volume type.
# If we use multiple qos specs, the test data will always
# return the same associated volume type, which is invalid
# and prevented by the UI.
qos_specs_full = self.cinder_qos_specs.list()
qos_specs_only_one = [qos_specs_full[0]]
associations = self.cinder_qos_spec_associations.list()
cinderclient = mock_cinderclient.return_value
volume_types_mock = cinderclient.volume_types.list
volume_types_mock.return_value = volume_types
cinderclient.qos_specs.list.return_value = qos_specs_only_one
qos_associations_mock = cinderclient.qos_specs.get_associations
qos_associations_mock.return_value = associations
assoc_vol_types = \
api.cinder.volume_type_list_with_qos_associations(self.request)
associate_spec = assoc_vol_types[0].associated_qos_spec
volume_types_mock.assert_called_once()
cinderclient.qos_specs.list.assert_called_once()
qos_associations_mock.assert_called_once_with(qos_specs_only_one[0].id)
self.assertEqual(associate_spec, qos_specs_only_one[0].name)
@mock.patch.object(api.cinder, 'cinderclient')
def test_volume_type_get_with_qos_association(self, mock_cinderclient):
volume_type = self.cinder_volume_types.first()
qos_specs_full = self.cinder_qos_specs.list()
qos_specs_only_one = [qos_specs_full[0]]
associations = self.cinder_qos_spec_associations.list()
cinderclient = mock_cinderclient.return_value
volume_types_mock = cinderclient.volume_types.get
volume_types_mock.return_value = volume_type
qos_specs_mock = cinderclient.qos_specs.list
qos_specs_mock.return_value = qos_specs_only_one
qos_associations_mock = cinderclient.qos_specs.get_associations
qos_associations_mock.return_value = associations
assoc_vol_type = \
api.cinder.volume_type_get_with_qos_association(self.request,
volume_type.id)
associate_spec = assoc_vol_type.associated_qos_spec
volume_types_mock.assert_called_once_with(volume_type.id)
qos_specs_mock.assert_called_once()
qos_associations_mock.assert_called_once_with(qos_specs_only_one[0].id)
self.assertEqual(associate_spec, qos_specs_only_one[0].name)
@mock.patch.object(api.cinder, '_cinderclient_with_features')
def test_absolute_limits_with_negative_values(self, mock_cinderclient):
values = {"maxTotalVolumes": -1, "totalVolumesUsed": -1}
expected_results = {"maxTotalVolumes": float("inf"),
"totalVolumesUsed": 0}
class AbsoluteLimit(object):
def __init__(self, absolute):
self.absolute = absolute
class FakeLimit(object):
def __init__(self, name, value):
self.name = name
self.value = value
fake_limits = [FakeLimit(k, v) for k, v in values.items()]
cinderclient = mock_cinderclient.return_value
mock_limit = cinderclient.limits.get
mock_limit.return_value = AbsoluteLimit(fake_limits)
ret_val = api.cinder.tenant_absolute_limits(self.request)
for key in expected_results:
self.assertEqual(expected_results[key], ret_val[key])
mock_limit.assert_called_once()
mock_cinderclient.assert_called_once_with(
self.request, ['limits_project_id_query'], message=test.IsA(str))
@mock.patch.object(api.cinder, 'cinderclient')
def test_pool_list(self, mock_cinderclient):
pools = self.cinder_pools.list()
cinderclient = mock_cinderclient.return_value
cinderclient.pools.list.return_value = pools
api.cinder.pool_list(self.request, detailed=True)
cinderclient.pools.list.assert_called_once_with(detailed=True)
@mock.patch.object(api.cinder, 'cinderclient')
def test_volume_type_default(self, mock_cinderclient):
volume_type = self.cinder_volume_types.first()
cinderclient = mock_cinderclient.return_value
cinderclient.volume_types.default.return_value = volume_type
default_volume_type = api.cinder.volume_type_default(self.request)
self.assertEqual(default_volume_type, volume_type)
cinderclient.volume_types.default.assert_called_once()
@test.create_mocks({
api.cinder: [('_cinderclient_with_features', 'cinderclient'), ]})
def test_cinder_message_list(self):
search_opts = {'resource_type': 'VOLUME',
'resource_uuid': '6d53d143-e10f-440a-a65f-16a6b6d068f7'}
messages = self.cinder_messages.list()
cinderclient = self.mock_cinderclient.return_value
messages_mock = cinderclient.messages.list
messages_mock.return_value = messages
api.cinder.message_list(self.request, search_opts=search_opts)
messages_mock.assert_called_once_with(search_opts)
class CinderApiVersionTests(test.TestCase):
def setUp(self):
super().setUp()
# The version is set when the module is loaded. Reset the
# active version each time so that we can test with different
# versions.
api.cinder.VERSIONS._active = None
def test_default_client_is_v3(self):
client = api.cinder.cinderclient(self.request)
self.assertIsInstance(client, cinder_client.v3.client.Client)
def test_get_v3_volume_attributes(self):
# Get a v3 volume
volume = self.cinder_volumes.get(name="v3_volume")
self.assertTrue(hasattr(volume._apiresource, 'name'))
name = "A v3 test volume name"
description = "A v3 volume description"
setattr(volume._apiresource, 'name', name)
setattr(volume._apiresource, 'description', description)
self.assertEqual(name, volume.name)
self.assertEqual(description, volume.description)
def test_get_v3_snapshot_attributes(self):
# Get a v3 snapshot
snapshot = self.cinder_volume_snapshots.get(
description="v3 volume snapshot description")
self.assertFalse(hasattr(snapshot._apiresource, 'display_name'))
name = "A v3 test snapshot name"
description = "A v3 snapshot description"
setattr(snapshot._apiresource, 'name', name)
setattr(snapshot._apiresource, 'description', description)
self.assertEqual(name, snapshot.name)
self.assertEqual(description, snapshot.description)
def test_get_v3_snapshot_metadata(self):
# Get a v3 snapshot with metadata
snapshot = self.cinder_volume_snapshots.get(
description="v3 volume snapshot with metadata description")
self.assertTrue(hasattr(snapshot._apiresource, 'metadata'))
self.assertFalse(hasattr(snapshot._apiresource, 'display_name'))
key_name = "snapshot_meta_key"
key_value = "snapshot_meta_value"
metadata_value = {key_name: key_value}
setattr(snapshot._apiresource, 'metadata', metadata_value)
self.assertIn(key_name, snapshot.metadata.keys())
self.assertEqual(key_value, snapshot.metadata['snapshot_meta_key'])
def test_get_id_for_nameless_volume(self):
volume = self.cinder_volumes.first()
self.assertEqual('Volume name', volume.name)
|
