From 899941c60e1ace9d6859b303a1e497e65349b45c Mon Sep 17 00:00:00 2001
From: Valeriy Ponomaryov <vponomaryov@mirantis.com>
Date: Fri, 4 Nov 2016 12:30:24 +0200
Subject: [PATCH] Remove fake CG support from Generic share driver
Generic share driver has fake support of consistency groups. It was
implemented only for testing purpose. Now, it is redundant, because
we have 'dummy' share driver that already used to test this behavior.
So, drop fake CG support from Generic share driver and disable
appropriate tempest tests.
Change-Id: I6ce07fd3a11cd62a3a01ba4ee7c424b839a62757
Closes-Bug: #1638994
---
contrib/ci/post_test_hook.sh | 1 +
manila/share/drivers/generic.py | 176 +--------------
manila/tests/share/drivers/test_generic.py | 209 +-----------------
...-from-generic-driver-16efce98f94b1b6b.yaml | 4 +
4 files changed, 8 insertions(+), 382 deletions(-)
create mode 100644 releasenotes/notes/bug-1638994-drop-fake-cg-support-from-generic-driver-16efce98f94b1b6b.yaml
diff --git a/contrib/ci/post_test_hook.sh b/contrib/ci/post_test_hook.sh
index 5ec1a1684b..e47e65ed37 100755
--- a/contrib/ci/post_test_hook.sh
+++ b/contrib/ci/post_test_hook.sh
@@ -149,6 +149,7 @@ elif [[ "$DRIVER" == "generic" ]]; then
iniset $TEMPEST_CONFIG share enable_protocols nfs
fi
MANILA_TESTS="(^manila_tempest_tests.tests.api)(?=.*\[.*\bbackend\b.*\])"
+ RUN_MANILA_CG_TESTS=False
fi
if [[ "$DRIVER" == "lvm" ]]; then
diff --git a/manila/share/drivers/generic.py b/manila/share/drivers/generic.py
index b3e484610e..117fde516d 100644
--- a/manila/share/drivers/generic.py
+++ b/manila/share/drivers/generic.py
@@ -620,7 +620,7 @@ class GenericShareDriver(driver.ExecuteMixin, driver.ShareDriver):
share_backend_name=self.backend_name,
storage_protocol='NFS_CIFS',
reserved_percentage=self.configuration.reserved_share_percentage,
- consistency_group_support='pool',
+ consistency_group_support=None,
)
super(GenericShareDriver, self)._update_share_stats(data)
@@ -1073,177 +1073,3 @@ class GenericShareDriver(driver.ExecuteMixin, driver.ShareDriver):
raise exception.InvalidShare(reason=msg)
return size
-
- @ensure_server
- def create_consistency_group(self, context, cg_dict, share_server=None):
- """Creates a consistency group.
-
- Since we are faking the CG object, apart from verifying if the
- share_server is valid, we do nothing else here.
- """
-
- LOG.debug('Created a Consistency Group with ID: %s.', cg_dict['id'])
-
- msg = _LW('The Generic driver has no means to guarantee consistency '
- 'group snapshots are actually consistent. This '
- 'implementation is for reference and testing purposes only.')
- LOG.warning(msg)
-
- def delete_consistency_group(self, context, cg_dict, share_server=None):
- """Deletes a consistency group.
-
- Since we are faking the CG object we do nothing here.
- """
-
- LOG.debug('Deleted the consistency group with ID %s.', cg_dict['id'])
-
- def _cleanup_cg_share_snapshot(self, context, share_snapshot,
- share_server):
- """Deletes the snapshot of a share belonging to a consistency group."""
-
- try:
- self.delete_snapshot(context, share_snapshot, share_server)
- except exception.ManilaException:
- msg = _LE('Could not delete CG Snapshot %(snap)s '
- 'for share %(share)s.')
- LOG.error(msg % {
- 'snap': share_snapshot['id'],
- 'share': share_snapshot['share_id'],
- })
- raise
-
- @ensure_server
- def create_cgsnapshot(self, context, snap_dict, share_server=None):
- """Creates a consistency group snapshot one or more shares."""
-
- LOG.debug('Attempting to create a CG snapshot %s.' % snap_dict['id'])
-
- msg = _LW('The Consistency Group Snapshot being created is '
- 'not expected to be consistent. This implementation is '
- 'for reference and testing purposes only.')
- LOG.warning(msg)
-
- cg_members = snap_dict.get('cgsnapshot_members', [])
- if not cg_members:
- LOG.warning(_LW('No shares in Consistency Group to Create CG '
- 'snapshot.'))
- else:
- share_snapshots = []
- for member in cg_members:
- share_snapshot = {
- 'share_id': member['share_id'],
- 'id': member['id'],
- }
- try:
- self.create_snapshot(context, share_snapshot, share_server)
- share_snapshots.append(share_snapshot)
- except exception.ManilaException as e:
- msg = _LE('Could not create CG Snapshot. Failed '
- 'to create share snapshot %(snap)s for '
- 'share %(share)s.')
- LOG.exception(msg % {
- 'snap': share_snapshot['id'],
- 'share': share_snapshot['share_id']
- })
-
- # clean up any share snapshots previously created
- LOG.debug('Attempting to clean up snapshots due to '
- 'failure...')
- for share_snapshot in share_snapshots:
- self._cleanup_cg_share_snapshot(context,
- share_snapshot,
- share_server)
- raise e
-
- LOG.debug('Successfully created CG snapshot %s.' % snap_dict['id'])
-
- return None, None
-
- @ensure_server
- def delete_cgsnapshot(self, context, snap_dict, share_server=None):
- """Deletes a consistency group snapshot."""
-
- cg_members = snap_dict.get('cgsnapshot_members', [])
-
- LOG.debug('Deleting CG snapshot %s.' % snap_dict['id'])
-
- for member in cg_members:
- share_snapshot = {
- 'share_id': member['share_id'],
- 'id': member['id'],
- }
-
- self._cleanup_cg_share_snapshot(context,
- share_snapshot,
- share_server)
-
- LOG.debug('Deleted CG snapshot %s.' % snap_dict['id'])
-
- return None, None
-
- @ensure_server
- def create_consistency_group_from_cgsnapshot(self, context, cg_dict,
- cgsnapshot_dict,
- share_server=None):
- """Creates a consistency group from an existing CG snapshot."""
-
- # Ensure that the consistency group snapshot has members
- if not cgsnapshot_dict['cgsnapshot_members']:
- return None, None
-
- clone_list = self._collate_cg_snapshot_info(cg_dict, cgsnapshot_dict)
- share_update_list = list()
-
- LOG.debug('Creating consistency group from CG snapshot %s.',
- cgsnapshot_dict['id'])
-
- for clone in clone_list:
-
- kwargs = {}
- if self.driver_handles_share_servers:
- kwargs['share_server'] = share_server
- export_location = (
- self.create_share_from_snapshot(
- context,
- clone['share'],
- clone['snapshot'],
- **kwargs))
-
- share_update_list.append({
- 'id': clone['share']['id'],
- 'export_locations': export_location,
- })
-
- return None, share_update_list
-
- def _collate_cg_snapshot_info(self, cg_dict, cgsnapshot_dict):
- """Collate the data for a clone of the CG snapshot.
-
- Given two data structures, a CG snapshot (cgsnapshot_dict) and a new
- CG to be cloned from the snapshot (cg_dict), match up both
- structures into a list of dicts (share & snapshot) suitable for use
- by existing method that clones individual share snapshots.
- """
-
- clone_list = list()
-
- for share in cg_dict['shares']:
-
- clone_info = {'share': share}
-
- for cgsnapshot_member in cgsnapshot_dict['cgsnapshot_members']:
- if (share['source_cgsnapshot_member_id'] ==
- cgsnapshot_member['id']):
- clone_info['snapshot'] = {
- 'id': cgsnapshot_member['id'],
- }
- break
-
- if len(clone_info) != 2:
- msg = _("Invalid data supplied for creating consistency "
- "group from CG snapshot %s.") % cgsnapshot_dict['id']
- raise exception.InvalidConsistencyGroup(reason=msg)
-
- clone_list.append(clone_info)
-
- return clone_list
diff --git a/manila/tests/share/drivers/test_generic.py b/manila/tests/share/drivers/test_generic.py
index 82d466409b..2e9b233a48 100644
--- a/manila/tests/share/drivers/test_generic.py
+++ b/manila/tests/share/drivers/test_generic.py
@@ -65,7 +65,7 @@ def get_fake_snap_dict():
'deleted': '0',
'created_at': '2015-08-10 00:05:58',
'updated_at': '2015-08-10 00:05:58',
- 'consistency_group_id': '4b04fdc3-00b9-4909-ba1a-06e9b3f88b67',
+ 'consistency_group_id': None,
'cgsnapshot_members': [
{
'status': 'available',
@@ -119,7 +119,7 @@ def get_fake_cg_dict():
{
'id': 'f6aa3b56-45a5-9631-02a32f06e1937b',
'deleted': False,
- 'consistency_group_id': '4b04fdc3-00b9-4909-ba1a-06e9b3f88b67',
+ 'consistency_group_id': None,
'share_type_id': '1a9ed31e-ee70-483d-93ba-89690e028d7f',
},
],
@@ -1828,211 +1828,6 @@ class GenericShareDriverTestCase(test.TestCase):
self.assertEqual(result, actual_result)
- @ddt.data({'consistency_group': {'share_server_id': 'fake'},
- 'result': {'id': 'fake'}},
- {'consistency_group': None, 'result': {'id': 'fake'}},
- {'consistency_group': {'share_server_id': 'test'},
- 'result': {'id': 'test'}})
- @ddt.unpack
- def tests_choose_share_server_compatible_with_share_and_cg(
- self, consistency_group, result):
- share_servers = [{'id': 'fake'}, {'id': 'test'}]
- fake_share = "fake"
-
- actual_result = self._driver.choose_share_server_compatible_with_share(
- self._context, share_servers, fake_share,
- consistency_group=consistency_group
- )
-
- self.assertEqual(result, actual_result)
-
- def test_create_consistency_group(self):
- FAKE_SNAP_DICT = get_fake_snap_dict()
-
- result = self._driver.create_consistency_group(
- self._context, FAKE_SNAP_DICT, share_server=self.server)
-
- self.assertEqual(1, self.mock_debug_log.call_count)
- self.assertEqual(1, self.mock_warning_log.call_count)
- self.assertIsNone(result)
-
- def test_delete_consistency_group(self):
- FAKE_SNAP_DICT = get_fake_snap_dict()
-
- result = self._driver.delete_consistency_group(
- self._context, FAKE_SNAP_DICT, share_server=self.server)
-
- self.assertEqual(1, self.mock_debug_log.call_count)
- self.assertIsNone(result)
-
- def test_create_cgsnapshot_no_cg_members(self):
- FAKE_SNAP_DICT = dict(get_fake_snap_dict(), cgsnapshot_members=[])
- mock_snapshot_creation = self.mock_object(generic.GenericShareDriver,
- 'create_snapshot')
-
- result = self._driver.create_cgsnapshot(
- self._context, FAKE_SNAP_DICT, share_server=self.server)
-
- self.assertEqual(1, self.mock_debug_log.call_count)
- self.assertEqual(2, self.mock_warning_log.call_count)
- self.assertFalse(mock_snapshot_creation.called)
- self.assertEqual((None, None), result)
-
- @ddt.data(
- {
- 'delete_snap_side_effect': None,
- 'expected_error_log_call_count': 0,
- },
- {
- 'delete_snap_side_effect': exception.ManilaException,
- 'expected_error_log_call_count': 1,
- }
- )
- @ddt.unpack
- def test_create_cgsnapshot_manila_exception_on_create_and_delete(
- self, delete_snap_side_effect, expected_error_log_call_count):
- FAKE_SNAP_DICT = get_fake_snap_dict()
- # Append another fake share
- FAKE_SHARE = dict(FAKE_SNAP_DICT['cgsnapshot_members'][0])
- FAKE_SNAP_DICT['cgsnapshot_members'].append(FAKE_SHARE)
-
- self.mock_object(generic.GenericShareDriver,
- 'create_snapshot',
- mock.Mock(side_effect=[
- None,
- exception.ManilaException,
- ]))
- self.mock_object(generic.GenericShareDriver,
- 'delete_snapshot',
- mock.Mock(side_effect=delete_snap_side_effect))
-
- self.assertRaises(exception.ManilaException,
- self._driver.create_cgsnapshot,
- self._context, FAKE_SNAP_DICT,
- share_server=self.server)
- self.assertEqual(2, self.mock_debug_log.call_count)
- self.assertEqual(1, self.mock_warning_log.call_count)
- self.assertEqual(1, self.mock_exception_log.call_count)
- self.assertEqual(expected_error_log_call_count,
- self.mock_error_log.call_count)
-
- def test_create_cgsnapshot(self):
- FAKE_SNAP_DICT = get_fake_snap_dict()
- FAKE_SHARE_SNAPSHOT = {
- 'share_id': 'e14b5174-e534-4f35-bc4f-fe81c1575d6f',
- 'id': '03e2f06e-14f2-45a5-9631-0949d1937bd8',
- }
-
- mock_snapshot_creation = self.mock_object(generic.GenericShareDriver,
- 'create_snapshot')
-
- result = self._driver.create_cgsnapshot(
- self._context, FAKE_SNAP_DICT, share_server=self.server)
-
- mock_snapshot_creation.assert_called_once_with(self._context,
- FAKE_SHARE_SNAPSHOT,
- self.server)
-
- self.assertEqual(2, self.mock_debug_log.call_count)
- self.assertEqual(1, self.mock_warning_log.call_count)
- self.assertFalse(self.mock_error_log.called)
- self.assertEqual((None, None), result)
-
- def test_delete_cgsnapshot_manila_exception(self):
- FAKE_SNAP_DICT = get_fake_snap_dict()
- self.mock_object(generic.GenericShareDriver,
- 'delete_snapshot',
- mock.Mock(side_effect=exception.ManilaException))
-
- self.assertRaises(exception.ManilaException,
- self._driver.delete_cgsnapshot,
- self._context, FAKE_SNAP_DICT,
- share_server=self.server)
-
- self.assertEqual(1, self.mock_error_log.call_count)
-
- def test_delete_cgsnapshot(self):
- FAKE_SNAP_DICT = get_fake_snap_dict()
- FAKE_SHARE_SNAPSHOT = {
- 'share_id': 'e14b5174-e534-4f35-bc4f-fe81c1575d6f',
- 'id': '03e2f06e-14f2-45a5-9631-0949d1937bd8',
- }
- mock_snapshot_creation = self.mock_object(generic.GenericShareDriver,
- 'delete_snapshot')
-
- result = self._driver.delete_cgsnapshot(
- self._context, FAKE_SNAP_DICT, share_server=self.server)
-
- mock_snapshot_creation.assert_called_once_with(self._context,
- FAKE_SHARE_SNAPSHOT,
- self.server)
-
- self.assertEqual(2, self.mock_debug_log.call_count)
- self.assertEqual((None, None), result)
-
- def test_create_consistency_group_from_cgsnapshot_no_members(self):
- FAKE_CG_DICT = get_fake_cg_dict()
- FAKE_CGSNAP_DICT = dict(get_fake_snap_dict(), cgsnapshot_members=[])
- mock_share_creation = self.mock_object(generic.GenericShareDriver,
- 'create_share_from_snapshot')
-
- result = self._driver.create_consistency_group_from_cgsnapshot(
- self._context, FAKE_CG_DICT, FAKE_CGSNAP_DICT,
- share_server=self.server)
-
- self.assertFalse(self.mock_debug_log.called)
- self.assertFalse(mock_share_creation.called)
- self.assertEqual((None, None), result)
-
- def test_create_consistency_group_from_cgsnapshot(self):
- FAKE_CG_DICT = get_fake_cg_dict()
- FAKE_CGSNAP_DICT = get_fake_snap_dict()
- FAKE_COLLATED_INFO = get_fake_collated_cg_snap_info()
- FAKE_SHARE_UPDATE_LIST = [
- {
- 'id': '02a32f06e-14f2-45a5-9631-7483f1937bd8',
- 'export_locations': 'xyzzy',
- }
- ]
- self.mock_object(generic.GenericShareDriver,
- '_collate_cg_snapshot_info',
- mock.Mock(return_value=FAKE_COLLATED_INFO))
- mock_share_creation = self.mock_object(generic.GenericShareDriver,
- 'create_share_from_snapshot',
- mock.Mock(return_value='xyzzy'))
-
- result = self._driver.create_consistency_group_from_cgsnapshot(
- self._context, FAKE_CG_DICT, FAKE_CGSNAP_DICT,
- share_server=self.server)
-
- self.assertEqual((None, FAKE_SHARE_UPDATE_LIST), result)
- self.assertEqual(1, self.mock_debug_log.call_count)
- mock_share_creation.assert_called_once_with(
- self._context,
- FAKE_COLLATED_INFO[0]['share'],
- FAKE_COLLATED_INFO[0]['snapshot'],
- share_server=self.server
- )
-
- def test_collate_cg_snapshot_info_invalid_cg(self):
- FAKE_CG_DICT = get_fake_cg_dict()
- FAKE_CGSNAP_DICT = dict(get_fake_snap_dict(), cgsnapshot_members=[])
-
- self.assertRaises(exception.InvalidConsistencyGroup,
- self._driver._collate_cg_snapshot_info,
- FAKE_CG_DICT,
- FAKE_CGSNAP_DICT)
-
- def test_collate_cg_snapshot(self):
- FAKE_CG_DICT = get_fake_cg_dict()
- FAKE_CGSNAP_DICT = get_fake_snap_dict()
- FAKE_COLLATED_INFO = get_fake_collated_cg_snap_info()
-
- result = self._driver._collate_cg_snapshot_info(
- FAKE_CG_DICT, FAKE_CGSNAP_DICT)
-
- self.assertEqual(FAKE_COLLATED_INFO, result)
-
def test_manage_snapshot_not_found(self):
snapshot_instance = {'id': 'snap_instance_id',
'provider_location': 'vol_snap_id'}
diff --git a/releasenotes/notes/bug-1638994-drop-fake-cg-support-from-generic-driver-16efce98f94b1b6b.yaml b/releasenotes/notes/bug-1638994-drop-fake-cg-support-from-generic-driver-16efce98f94b1b6b.yaml
new file mode 100644
index 0000000000..909def2df5
--- /dev/null
+++ b/releasenotes/notes/bug-1638994-drop-fake-cg-support-from-generic-driver-16efce98f94b1b6b.yaml
@@ -0,0 +1,4 @@
+---
+other:
+ - Removed fake Consistency Group support from Generic driver.
+ It was added only for testing purpose and now it is redundant.