598223985a
mock was adopted into standard python in version 3.3 [1]. Since manila no longer supports python2.7, we can use the inbuilt mock package rather than the third party lib. Fix some issues with imports that weren't following our import conventions of grouping imports [3] Add a hacking test to ensure we don't regress on this. [1] https://docs.python.org/3/library/unittest.mock.html [2] http://lists.openstack.org/pipermail/openstack-discuss/2020-March/013281.html [3] https://docs.openstack.org/hacking/latest/user/hacking.html#imports Co-Authored-By: Sean McGinnis <sean.mcginnis@gmail.com> Change-Id: If857a49fbf526983e712282a25d7e8bef5093533 Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
291 lines
11 KiB
Python
291 lines
11 KiB
Python
# Copyright 2014 Mirantis, 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 cinderclient import exceptions as cinder_exception
|
|
import ddt
|
|
|
|
from manila import context
|
|
from manila import exception
|
|
from manila import test
|
|
from manila.tests import utils as test_utils
|
|
from manila.volume import cinder
|
|
|
|
|
|
class FakeCinderClient(object):
|
|
class Volumes(object):
|
|
def get(self, volume_id):
|
|
return {'id': volume_id}
|
|
|
|
def list(self, detailed, search_opts={}):
|
|
return [{'id': 'id1'}, {'id': 'id2'}]
|
|
|
|
def create(self, *args, **kwargs):
|
|
return {'id': 'created_id'}
|
|
|
|
def __getattr__(self, item):
|
|
return None
|
|
|
|
def __init__(self):
|
|
self.volumes = self.Volumes()
|
|
self.volume_snapshots = self.volumes
|
|
|
|
|
|
def get_fake_auth_obj():
|
|
return type('FakeAuthObj', (object, ), {'get_client': mock.Mock()})
|
|
|
|
|
|
class CinderclientTestCase(test.TestCase):
|
|
|
|
@mock.patch('manila.volume.cinder.AUTH_OBJ', None)
|
|
def test_no_auth_obj(self):
|
|
mock_client_loader = self.mock_object(
|
|
cinder.client_auth, 'AuthClientLoader')
|
|
fake_context = 'fake_context'
|
|
data = {
|
|
'cinder': {
|
|
'http_retries': 3,
|
|
'endpoint_type': 'foo_endpoint_type',
|
|
'region_name': 'foo_region_name',
|
|
}
|
|
}
|
|
|
|
with test_utils.create_temp_config_with_opts(data):
|
|
cinder.cinderclient(fake_context)
|
|
|
|
mock_client_loader.assert_called_once_with(
|
|
client_class=cinder.cinder_client.Client,
|
|
exception_module=cinder.cinder_exception,
|
|
cfg_group=cinder.CINDER_GROUP
|
|
)
|
|
mock_client_loader.return_value.get_client.assert_called_once_with(
|
|
fake_context,
|
|
retries=data['cinder']['http_retries'],
|
|
endpoint_type=data['cinder']['endpoint_type'],
|
|
region_name=data['cinder']['region_name'],
|
|
)
|
|
|
|
@mock.patch('manila.volume.cinder.AUTH_OBJ', get_fake_auth_obj())
|
|
def test_with_auth_obj(self):
|
|
fake_context = 'fake_context'
|
|
data = {
|
|
'cinder': {
|
|
'http_retries': 3,
|
|
'endpoint_type': 'foo_endpoint_type',
|
|
'region_name': 'foo_region_name',
|
|
}
|
|
}
|
|
|
|
with test_utils.create_temp_config_with_opts(data):
|
|
cinder.cinderclient(fake_context)
|
|
|
|
cinder.AUTH_OBJ.get_client.assert_called_once_with(
|
|
fake_context,
|
|
retries=data['cinder']['http_retries'],
|
|
endpoint_type=data['cinder']['endpoint_type'],
|
|
region_name=data['cinder']['region_name'],
|
|
)
|
|
|
|
|
|
@ddt.ddt
|
|
class CinderApiTestCase(test.TestCase):
|
|
def setUp(self):
|
|
super(CinderApiTestCase, self).setUp()
|
|
|
|
self.api = cinder.API()
|
|
self.cinderclient = FakeCinderClient()
|
|
self.ctx = context.get_admin_context()
|
|
self.mock_object(cinder, 'cinderclient',
|
|
mock.Mock(return_value=self.cinderclient))
|
|
self.mock_object(cinder, '_untranslate_volume_summary_view',
|
|
lambda ctx, vol: vol)
|
|
self.mock_object(cinder, '_untranslate_snapshot_summary_view',
|
|
lambda ctx, snap: snap)
|
|
|
|
def test_get(self):
|
|
volume_id = 'volume_id1'
|
|
result = self.api.get(self.ctx, volume_id)
|
|
self.assertEqual(volume_id, result['id'])
|
|
|
|
@ddt.data(
|
|
{'cinder_e': cinder_exception.NotFound(404),
|
|
'manila_e': exception.VolumeNotFound},
|
|
{'cinder_e': cinder_exception.BadRequest(400),
|
|
'manila_e': exception.InvalidInput},
|
|
)
|
|
@ddt.unpack
|
|
def test_get_failed(self, cinder_e, manila_e):
|
|
cinder.cinderclient.side_effect = cinder_e
|
|
volume_id = 'volume_id'
|
|
self.assertRaises(manila_e, self.api.get, self.ctx, volume_id)
|
|
|
|
def test_create(self):
|
|
result = self.api.create(self.ctx, 1, '', '')
|
|
self.assertEqual('created_id', result['id'])
|
|
|
|
def test_create_failed(self):
|
|
cinder.cinderclient.side_effect = cinder_exception.BadRequest(400)
|
|
self.assertRaises(exception.InvalidInput,
|
|
self.api.create, self.ctx, 1, '', '')
|
|
|
|
def test_create_not_found_error(self):
|
|
cinder.cinderclient.side_effect = cinder_exception.NotFound(404)
|
|
self.assertRaises(exception.NotFound,
|
|
self.api.create, self.ctx, 1, '', '')
|
|
|
|
def test_create_failed_exception(self):
|
|
cinder.cinderclient.side_effect = Exception("error msg")
|
|
self.assertRaises(exception.ManilaException,
|
|
self.api.create, self.ctx, 1, '', '')
|
|
|
|
def test_get_all(self):
|
|
cinder._untranslate_volume_summary_view.return_value = ['id1', 'id2']
|
|
self.assertEqual([{'id': 'id1'}, {'id': 'id2'}],
|
|
self.api.get_all(self.ctx))
|
|
|
|
def test_check_attach_volume_status_error(self):
|
|
volume = {'status': 'error'}
|
|
self.assertRaises(exception.InvalidVolume,
|
|
self.api.check_attach, self.ctx, volume)
|
|
|
|
def test_check_attach_volume_already_attached(self):
|
|
volume = {'status': 'available'}
|
|
volume['attach_status'] = "attached"
|
|
self.assertRaises(exception.InvalidVolume,
|
|
self.api.check_attach, self.ctx, volume)
|
|
|
|
def test_check_attach_availability_zone_differs(self):
|
|
volume = {'status': 'available'}
|
|
volume['attach_status'] = "detached"
|
|
instance = {'availability_zone': 'zone1'}
|
|
volume['availability_zone'] = 'zone2'
|
|
cinder.CONF.set_override('cross_az_attach', False, 'cinder')
|
|
self.assertRaises(exception.InvalidVolume,
|
|
self.api.check_attach, self.ctx, volume, instance)
|
|
volume['availability_zone'] = 'zone1'
|
|
self.assertIsNone(self.api.check_attach(self.ctx, volume, instance))
|
|
cinder.CONF.reset()
|
|
|
|
def test_check_attach(self):
|
|
volume = {'status': 'available'}
|
|
volume['attach_status'] = "detached"
|
|
volume['availability_zone'] = 'zone1'
|
|
instance = {'availability_zone': 'zone1'}
|
|
cinder.CONF.set_override('cross_az_attach', False, 'cinder')
|
|
self.assertIsNone(self.api.check_attach(self.ctx, volume, instance))
|
|
cinder.CONF.reset()
|
|
|
|
def test_check_detach(self):
|
|
volume = {'status': 'available'}
|
|
self.assertRaises(exception.InvalidVolume,
|
|
self.api.check_detach, self.ctx, volume)
|
|
volume['status'] = 'non-available'
|
|
self.assertIsNone(self.api.check_detach(self.ctx, volume))
|
|
|
|
def test_update(self):
|
|
fake_volume = {'fake': 'fake'}
|
|
self.mock_object(self.cinderclient.volumes, 'get',
|
|
mock.Mock(return_value=fake_volume))
|
|
self.mock_object(self.cinderclient.volumes, 'update')
|
|
fake_volume_id = 'fake_volume'
|
|
fake_data = {'test': 'test'}
|
|
|
|
self.api.update(self.ctx, fake_volume_id, fake_data)
|
|
|
|
self.cinderclient.volumes.get.assert_called_once_with(fake_volume_id)
|
|
self.cinderclient.volumes.update.assert_called_once_with(fake_volume,
|
|
**fake_data)
|
|
|
|
def test_reserve_volume(self):
|
|
self.mock_object(self.cinderclient.volumes, 'reserve')
|
|
self.api.reserve_volume(self.ctx, 'id1')
|
|
self.cinderclient.volumes.reserve.assert_called_once_with('id1')
|
|
|
|
def test_unreserve_volume(self):
|
|
self.mock_object(self.cinderclient.volumes, 'unreserve')
|
|
self.api.unreserve_volume(self.ctx, 'id1')
|
|
self.cinderclient.volumes.unreserve.assert_called_once_with('id1')
|
|
|
|
def test_begin_detaching(self):
|
|
self.mock_object(self.cinderclient.volumes, 'begin_detaching')
|
|
self.api.begin_detaching(self.ctx, 'id1')
|
|
self.cinderclient.volumes.begin_detaching.assert_called_once_with(
|
|
'id1')
|
|
|
|
def test_roll_detaching(self):
|
|
self.mock_object(self.cinderclient.volumes, 'roll_detaching')
|
|
self.api.roll_detaching(self.ctx, 'id1')
|
|
self.cinderclient.volumes.roll_detaching.assert_called_once_with('id1')
|
|
|
|
def test_attach(self):
|
|
self.mock_object(self.cinderclient.volumes, 'attach')
|
|
self.api.attach(self.ctx, 'id1', 'uuid', 'point')
|
|
self.cinderclient.volumes.attach.assert_called_once_with('id1',
|
|
'uuid',
|
|
'point')
|
|
|
|
def test_detach(self):
|
|
self.mock_object(self.cinderclient.volumes, 'detach')
|
|
self.api.detach(self.ctx, 'id1')
|
|
self.cinderclient.volumes.detach.assert_called_once_with('id1')
|
|
|
|
def test_initialize_connection(self):
|
|
self.mock_object(self.cinderclient.volumes, 'initialize_connection')
|
|
self.api.initialize_connection(self.ctx, 'id1', 'connector')
|
|
(self.cinderclient.volumes.initialize_connection.
|
|
assert_called_once_with('id1', 'connector'))
|
|
|
|
def test_terminate_connection(self):
|
|
self.mock_object(self.cinderclient.volumes, 'terminate_connection')
|
|
self.api.terminate_connection(self.ctx, 'id1', 'connector')
|
|
(self.cinderclient.volumes.terminate_connection.
|
|
assert_called_once_with('id1', 'connector'))
|
|
|
|
def test_delete(self):
|
|
self.mock_object(self.cinderclient.volumes, 'delete')
|
|
self.api.delete(self.ctx, 'id1')
|
|
self.cinderclient.volumes.delete.assert_called_once_with('id1')
|
|
|
|
def test_get_snapshot(self):
|
|
snapshot_id = 'snapshot_id1'
|
|
result = self.api.get_snapshot(self.ctx, snapshot_id)
|
|
self.assertEqual(snapshot_id, result['id'])
|
|
|
|
def test_get_snapshot_failed(self):
|
|
cinder.cinderclient.side_effect = cinder_exception.NotFound(404)
|
|
snapshot_id = 'snapshot_id'
|
|
self.assertRaises(exception.VolumeSnapshotNotFound,
|
|
self.api.get_snapshot, self.ctx, snapshot_id)
|
|
|
|
def test_get_all_snapshots(self):
|
|
cinder._untranslate_snapshot_summary_view.return_value = ['id1', 'id2']
|
|
self.assertEqual([{'id': 'id1'}, {'id': 'id2'}],
|
|
self.api.get_all_snapshots(self.ctx))
|
|
|
|
def test_create_snapshot(self):
|
|
result = self.api.create_snapshot(self.ctx, {'id': 'id1'}, '', '')
|
|
self.assertEqual('created_id', result['id'])
|
|
|
|
def test_create_force(self):
|
|
result = self.api.create_snapshot_force(self.ctx,
|
|
{'id': 'id1'}, '', '')
|
|
self.assertEqual('created_id', result['id'])
|
|
|
|
def test_delete_snapshot(self):
|
|
self.mock_object(self.cinderclient.volume_snapshots, 'delete')
|
|
self.api.delete_snapshot(self.ctx, 'id1')
|
|
self.cinderclient.volume_snapshots.delete.assert_called_once_with(
|
|
'id1')
|