cinder/cinder/tests/unit/volume/drivers/test_sheepdog.py

1397 lines
62 KiB
Python

# Copyright (c) 2013 Zelin.io
# Copyright (C) 2015 Nippon Telegraph and Telephone Corporation.
# 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 contextlib
import errno
import mock
from oslo_concurrency import processutils
from oslo_utils import importutils
from oslo_utils import units
from cinder import context
from cinder import exception
from cinder.i18n import _
from cinder.image import image_utils
from cinder import test
from cinder.tests.unit import fake_constants as fake
from cinder.tests.unit import fake_snapshot
from cinder.tests.unit import fake_volume
from cinder import utils
from cinder.volume import configuration as conf
from cinder.volume.drivers import sheepdog
SHEEP_ADDR = '127.0.0.1'
SHEEP_PORT = 7000
class SheepdogDriverTestDataGenerator(object):
def __init__(self):
self.TEST_VOLUME = self._make_fake_volume(self.TEST_VOL_DATA)
self.TEST_CLONED_VOLUME = self._make_fake_volume(
self.TEST_CLONED_VOL_DATA)
self.TEST_SNAPSHOT = self._make_fake_snapshot(
self.TEST_SNAPSHOT_DATA, self.TEST_VOLUME)
def sheepdog_cmd_error(self, cmd, exit_code, stdout, stderr):
return (('(Command: %(cmd)s) '
'(Return Code: %(exit_code)s) '
'(Stdout: %(stdout)s) '
'(Stderr: %(stderr)s)') %
{'cmd': cmd,
'exit_code': exit_code,
'stdout': stdout.replace('\n', '\\n'),
'stderr': stderr.replace('\n', '\\n')})
def _make_fake_volume(self, volume_data):
return fake_volume.fake_volume_obj(context.get_admin_context(),
**volume_data)
def _make_fake_snapshot(self, snapshot_data, src_volume):
snapshot_obj = fake_snapshot.fake_snapshot_obj(
context.get_admin_context(), **snapshot_data)
snapshot_obj.volume = src_volume
return snapshot_obj
def cmd_dog_vdi_create(self, name, size):
return ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'vdi', 'create', name,
'%sG' % size, '-a', SHEEP_ADDR, '-p', SHEEP_PORT)
def cmd_dog_vdi_delete(self, name):
return ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'vdi', 'delete', name,
'-a', SHEEP_ADDR, '-p', SHEEP_PORT)
def cmd_dog_vdi_create_snapshot(self, vdiname, snapname):
return ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'vdi', 'snapshot', '-s',
snapname, '-a', SHEEP_ADDR, '-p', SHEEP_PORT, vdiname)
def cmd_dog_vdi_delete_snapshot(self, vdiname, snapname):
return ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'vdi', 'delete', '-s',
snapname, '-a', SHEEP_ADDR, '-p', SHEEP_PORT, vdiname)
def cmd_qemuimg_vdi_clone(self, src_vdiname, src_snapname, dst_vdiname,
size):
return ('env', 'LC_ALL=C', 'LANG=C', 'qemu-img', 'create', '-b',
'sheepdog:%(addr)s:%(port)s:%(src_vdiname)s:%(src_snapname)s' %
{'addr': SHEEP_ADDR, 'port': SHEEP_PORT,
'src_vdiname': src_vdiname, 'src_snapname': src_snapname},
'sheepdog:%(addr)s:%(port)s:%(dst_vdiname)s' %
{'addr': SHEEP_ADDR, 'port': SHEEP_PORT,
'dst_vdiname': dst_vdiname}, '%sG' % size)
def cmd_dog_vdi_resize(self, name, size):
return ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'vdi', 'resize', name,
size, '-a', SHEEP_ADDR, '-p', SHEEP_PORT)
def cmd_dog_vdi_list(self, name):
return ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'vdi', 'list', name,
'-r', '-a', SHEEP_ADDR, '-p', SHEEP_PORT)
def cmd_dog_node_info(self):
return ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'node', 'info',
'-a', SHEEP_ADDR, '-p', SHEEP_PORT, '-r')
def cmd_dog_node_list(self):
return ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'node', 'list',
'-a', SHEEP_ADDR, '-p', SHEEP_PORT, '-r')
CMD_DOG_CLUSTER_INFO = ('env', 'LC_ALL=C', 'LANG=C', 'dog', 'cluster',
'info', '-a', SHEEP_ADDR, '-p', SHEEP_PORT)
TEST_VOL_DATA = {
'size': 1,
'id': fake.VOLUME_ID,
'provider_auth': None,
'host': 'host@backendsec#unit_test_pool',
'project_id': fake.PROJECT_ID,
'provider_location': 'location',
'display_name': 'vol1',
'display_description': 'unit test volume',
'volume_type_id': None,
'consistencygroup_id': None,
}
TEST_CLONED_VOL_DATA = {
'size': 2,
'id': fake.VOLUME2_ID,
'provider_auth': None,
'host': 'host@backendsec#unit_test_pool',
'project_id': fake.PROJECT_ID,
'provider_location': 'location',
'display_name': 'vol3',
'display_description': 'unit test cloned volume',
'volume_type_id': None,
'consistencygroup_id': None,
}
TEST_SNAPSHOT_DATA = {
'id': fake.SNAPSHOT_ID,
}
COLLIE_NODE_INFO = """
0 107287605248 3623897354 3%
Total 107287605248 3623897354 3% 54760833024
"""
COLLIE_NODE_LIST = """
0 127.0.0.1:7000 128 1
"""
COLLIE_VDI_LIST = """
= testvolume 0 0 0 0 1467037106 fd32fc 3
"""
COLLIE_CLUSTER_INFO_0_5 = """\
Cluster status: running
Cluster created at Tue Jun 25 19:51:41 2013
Epoch Time Version
2013-06-25 19:51:41 1 [127.0.0.1:7000, 127.0.0.1:7001, 127.0.0.1:7002]
"""
COLLIE_CLUSTER_INFO_0_6 = """\
Cluster status: running, auto-recovery enabled
Cluster created at Tue Jun 25 19:51:41 2013
Epoch Time Version
2013-06-25 19:51:41 1 [127.0.0.1:7000, 127.0.0.1:7001, 127.0.0.1:7002]
"""
DOG_CLUSTER_RUNNING = """\
Cluster status: running, auto-recovery enabled
Cluster created at Thu Jun 18 17:24:56 2015
Epoch Time Version [Host:Port:V-Nodes,,,]
2015-06-18 17:24:56 1 [127.0.0.1:7000:128, 127.0.0.1:7001:128,\
127.0.0.1:7002:128]
"""
DOG_CLUSTER_INFO_TO_BE_FORMATTED = """\
Cluster status: Waiting for cluster to be formatted
"""
DOG_CLUSTER_INFO_WAITING_OTHER_NODES = """\
Cluster status: Waiting for other nodes to join cluster
Cluster created at Thu Jun 18 17:24:56 2015
Epoch Time Version [Host:Port:V-Nodes,,,]
2015-06-18 17:24:56 1 [127.0.0.1:7000:128, 127.0.0.1:7001:128]
"""
DOG_CLUSTER_INFO_SHUTTING_DOWN = """\
Cluster status: System is shutting down
"""
DOG_VDI_CREATE_VDI_ALREADY_EXISTS = """\
Failed to create VDI %(vdiname)s: VDI exists already
"""
DOG_VDI_SNAPSHOT_VDI_NOT_FOUND = """\
Failed to create snapshot for volume-00000000-0000-0000-0000-000000000001: \
No VDI found
"""
DOG_VDI_SNAPSHOT_ALREADY_EXISTED = """\
Failed to create snapshot for volume-00000000-0000-0000-0000-000000000001, \
maybe snapshot id (0) or tag (snapshot-00000000-0000-0000-0000-000000000002) \
is existed
"""
DOG_VDI_SNAPSHOT_TAG_NOT_FOUND = """\
Failed to open VDI volume-00000000-0000-0000-0000-000000000001 \
(snapshot id: 0 snapshot tag: snapshot-00000000-0000-0000-0000-000000000002): \
Failed to find requested tag
"""
DOG_VDI_SNAPSHOT_VOLUME_NOT_FOUND = """\
Failed to open VDI volume-00000000-0000-0000-0000-000000000001 \
(snapshot id: 0 snapshot tag: snapshot-00000000-0000-0000-0000-000000000002): \
No VDI found
"""
DOG_VDI_RESIZE_SIZE_SHRINK = """\
Shrinking VDIs is not implemented
"""
DOG_VDI_RESIZE_TOO_LARGE = """\
New VDI size is too large. This volume's max size is 4398046511104
"""
DOG_COMMAND_ERROR_VDI_NOT_EXISTS = """\
Failed to open VDI %(vdiname)s (snapshot id: 0 snapshot tag: ): No VDI found
"""
DOG_COMMAND_ERROR_FAIL_TO_CONNECT = """\
failed to connect to 127.0.0.1:7000: Connection refused
failed to connect to 127.0.0.1:7000: Connection refused
Failed to get node list
"""
QEMU_IMG_VDI_ALREADY_EXISTS = """\
qemu-img: sheepdog:volume-00000000-0000-0000-0000-000000000001: \
VDI exists already,
"""
QEMU_IMG_VDI_NOT_FOUND = """\
qemu-img: sheepdog:volume-00000000-0000-0000-0000-000000000003: \
cannot get vdi info, No vdi found, \
volume-00000000-0000-0000-0000-000000000001 \
snapshot-00000000-0000-0000-0000-000000000002
"""
QEMU_IMG_SNAPSHOT_NOT_FOUND = """\
qemu-img: sheepdog:volume-00000000-0000-0000-0000-000000000003: \
cannot get vdi info, Failed to find the requested tag, \
volume-00000000-0000-0000-0000-000000000001 \
snapshot-00000000-0000-0000-0000-000000000002
"""
QEMU_IMG_SIZE_TOO_LARGE = """\
qemu-img: sheepdog:volume-00000000-0000-0000-0000-000000000001: \
An image is too large. The maximum image size is 4096GB
"""
QEMU_IMG_FAILED_TO_CONNECT = """\
qemu-img: sheepdog::volume-00000000-0000-0000-0000-000000000001: \
Failed to connect socket: Connection refused
"""
class FakeImageService(object):
def download(self, context, image_id, path):
pass
class SheepdogIOWrapperTestCase(test.TestCase):
def setUp(self):
super(SheepdogIOWrapperTestCase, self).setUp()
self.volume = {'name': 'volume-2f9b2ff5-987b-4412-a91c-23caaf0d5aff'}
self.snapshot_name = 'snapshot-bf452d80-068a-43d7-ba9f-196cf47bd0be'
self.vdi_wrapper = sheepdog.SheepdogIOWrapper(
SHEEP_ADDR, SHEEP_PORT, self.volume)
self.snapshot_wrapper = sheepdog.SheepdogIOWrapper(
SHEEP_ADDR, SHEEP_PORT, self.volume, self.snapshot_name)
self.execute = mock.MagicMock()
self.mock_object(processutils, 'execute', self.execute)
def test_init(self):
self.assertEqual(self.volume['name'], self.vdi_wrapper._vdiname)
self.assertIsNone(self.vdi_wrapper._snapshot_name)
self.assertEqual(0, self.vdi_wrapper._offset)
self.assertEqual(self.snapshot_name,
self.snapshot_wrapper._snapshot_name)
def test_execute(self):
cmd = ('cmd1', 'arg1')
data = 'data1'
self.vdi_wrapper._execute(cmd, data)
self.execute.assert_called_once_with(*cmd, process_input=data)
def test_execute_error(self):
cmd = ('cmd1', 'arg1')
data = 'data1'
self.mock_object(processutils, 'execute',
mock.MagicMock(side_effect=OSError))
args = (cmd, data)
self.assertRaises(exception.VolumeDriverException,
self.vdi_wrapper._execute,
*args)
def test_read_vdi(self):
self.vdi_wrapper.read()
self.execute.assert_called_once_with(
'dog', 'vdi', 'read', '-a', SHEEP_ADDR, '-p', SHEEP_PORT,
self.volume['name'], 0, process_input=None)
def test_read_vdi_invalid(self):
self.vdi_wrapper._valid = False
self.assertRaises(exception.VolumeDriverException,
self.vdi_wrapper.read)
def test_write_vdi(self):
data = 'data1'
self.vdi_wrapper.write(data)
self.execute.assert_called_once_with(
'dog', 'vdi', 'write', '-a', SHEEP_ADDR, '-p', SHEEP_PORT,
self.volume['name'], 0, len(data),
process_input=data)
self.assertEqual(len(data), self.vdi_wrapper.tell())
def test_write_vdi_invalid(self):
self.vdi_wrapper._valid = False
self.assertRaises(exception.VolumeDriverException,
self.vdi_wrapper.write, 'dummy_data')
def test_read_snapshot(self):
self.snapshot_wrapper.read()
self.execute.assert_called_once_with(
'dog', 'vdi', 'read', '-a', SHEEP_ADDR, '-p', SHEEP_PORT,
'-s', self.snapshot_name, self.volume['name'], 0,
process_input=None)
def test_seek(self):
self.vdi_wrapper.seek(12345)
self.assertEqual(12345, self.vdi_wrapper.tell())
self.vdi_wrapper.seek(-2345, whence=1)
self.assertEqual(10000, self.vdi_wrapper.tell())
# This results in negative offset.
self.assertRaises(IOError, self.vdi_wrapper.seek, -20000, whence=1)
def test_seek_invalid(self):
seek_num = 12345
self.vdi_wrapper._valid = False
self.assertRaises(exception.VolumeDriverException,
self.vdi_wrapper.seek, seek_num)
def test_flush(self):
# flush does nothing.
self.vdi_wrapper.flush()
self.assertFalse(self.execute.called)
def test_fileno(self):
self.assertRaises(IOError, self.vdi_wrapper.fileno)
class SheepdogClientTestCase(test.TestCase):
def setUp(self):
super(SheepdogClientTestCase, self).setUp()
self._cfg = conf.Configuration(None)
self._cfg.sheepdog_store_address = SHEEP_ADDR
self._cfg.sheepdog_store_port = SHEEP_PORT
self.driver = sheepdog.SheepdogDriver(configuration=self._cfg)
db_driver = self.driver.configuration.db_driver
self.db = importutils.import_module(db_driver)
self.driver.db = self.db
self.driver.do_setup(None)
self.test_data = SheepdogDriverTestDataGenerator()
node_list = [SHEEP_ADDR]
self.client = sheepdog.SheepdogClient(node_list, SHEEP_PORT)
self._addr = SHEEP_ADDR
self._port = SHEEP_PORT
self._vdiname = self.test_data.TEST_VOLUME.name
self._vdisize = self.test_data.TEST_VOLUME.size
self._src_vdiname = self.test_data.TEST_SNAPSHOT.volume_name
self._snapname = self.test_data.TEST_SNAPSHOT.name
self._dst_vdiname = self.test_data.TEST_CLONED_VOLUME.name
self._dst_vdisize = self.test_data.TEST_CLONED_VOLUME.size
@mock.patch.object(utils, 'execute')
def test_run_dog_success(self, fake_execute):
args = ('cluster', 'info')
expected_cmd = self.test_data.CMD_DOG_CLUSTER_INFO
fake_execute.return_value = ('', '')
self.client._run_dog(*args)
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_dog_command_not_found(self, fake_logger, fake_execute):
args = ('cluster', 'info')
expected_msg = 'No such file or directory'
expected_errno = errno.ENOENT
fake_execute.side_effect = OSError(expected_errno, expected_msg)
self.assertRaises(OSError, self.client._run_dog, *args)
self.assertTrue(fake_logger.error.called)
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_dog_operation_not_permitted(self, fake_logger, fake_execute):
args = ('cluster', 'info')
expected_msg = 'Operation not permitted'
expected_errno = errno.EPERM
fake_execute.side_effect = OSError(expected_errno, expected_msg)
self.assertRaises(OSError, self.client._run_dog, *args)
self.assertTrue(fake_logger.error.called)
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_dog_fail_to_connect(self, fake_logger, fake_execute):
args = ('cluster', 'info')
cmd = self.test_data.CMD_DOG_CLUSTER_INFO
exit_code = 2
stdout = 'stdout dummy'
stderr = self.test_data.DOG_COMMAND_ERROR_FAIL_TO_CONNECT
expected_reason = (_('Failed to connect to sheep daemon. '
'addr: %(addr)s, port: %(port)s'),
{'addr': SHEEP_ADDR, 'port': SHEEP_PORT})
fake_execute.side_effect = processutils.ProcessExecutionError(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
ex = self.assertRaises(sheepdog.SheepdogError,
self.client._run_dog, *args)
self.assertEqual(expected_reason, ex.kwargs['reason'])
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_dog_fail_to_connect_bugcase(self, fake_logger, fake_execute):
# NOTE(zhangsong): Sheepdog's bug case.
# details are written to Sheepdog driver code.
args = ('node', 'list')
stdout = ''
stderr = self.test_data.DOG_COMMAND_ERROR_FAIL_TO_CONNECT
expected_reason = (_('Failed to connect to sheep daemon. '
'addr: %(addr)s, port: %(port)s'),
{'addr': SHEEP_ADDR, 'port': SHEEP_PORT})
fake_execute.return_value = (stdout, stderr)
ex = self.assertRaises(sheepdog.SheepdogError,
self.client._run_dog, *args)
self.assertEqual(expected_reason, ex.kwargs['reason'])
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_dog_unknown_error(self, fake_logger, fake_execute):
args = ('cluster', 'info')
cmd = self.test_data.CMD_DOG_CLUSTER_INFO
exit_code = 1
stdout = 'stdout dummy'
stderr = 'stderr dummy'
expected_msg = self.test_data.sheepdog_cmd_error(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
fake_execute.side_effect = processutils.ProcessExecutionError(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client._run_dog, *args)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(utils, 'execute')
def test_run_qemu_img_success(self, fake_execute):
# multiple part of args match the prefix and
# volume name is matched the prefix unfortunately
expected_cmd = ('env', 'LC_ALL=C', 'LANG=C',
'qemu-img', 'create', '-b',
'sheepdog:%(addr)s:%(port)s:sheepdog:snap' %
{'addr': SHEEP_ADDR, 'port': SHEEP_PORT},
'sheepdog:%(addr)s:%(port)s:clone' %
{'addr': SHEEP_ADDR, 'port': SHEEP_PORT}, '10G')
fake_execute.return_value = ('', '')
self.client._run_qemu_img('create', '-b', 'sheepdog:sheepdog:snap',
'sheepdog:clone', '10G')
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_qemu_img_command_not_found(self, fake_logger, fake_execute):
args = ('create', 'dummy')
expected_msg = 'No such file or directory'
expected_errno = errno.ENOENT
fake_execute.side_effect = OSError(expected_errno, expected_msg)
self.assertRaises(OSError, self.client._run_qemu_img, *args)
self.assertTrue(fake_logger.error.called)
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_qemu_img_unknown_os_error(self, fake_logger, fake_execute):
args = ('create', 'dummy')
expected_msg = 'unknown'
expected_errno = errno.EPERM
fake_execute.side_effect = OSError(expected_errno, expected_msg)
self.assertRaises(OSError, self.client._run_qemu_img, *args)
self.assertTrue(fake_logger.error.called)
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_qemu_img_fail_to_connect(self, fake_logger, fake_execute):
args = ('create', 'dummy')
cmd = ('qemu-img', 'create', 'dummy')
exit_code = 1
stdout = 'stdout dummy'
stderr = self.test_data.QEMU_IMG_FAILED_TO_CONNECT
expected_reason = (_('Failed to connect to sheep daemon. '
'addr: %(addr)s, port: %(port)s'),
{'addr': SHEEP_ADDR, 'port': SHEEP_PORT})
fake_execute.side_effect = processutils.ProcessExecutionError(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
ex = self.assertRaises(sheepdog.SheepdogError,
self.client._run_qemu_img, *args)
self.assertEqual(expected_reason, ex.kwargs['reason'])
@mock.patch.object(utils, 'execute')
@mock.patch.object(sheepdog, 'LOG')
def test_run_qemu_img_unknown_execution_error(self, fake_logger,
fake_execute):
args = ('create', 'dummy')
cmd = ('qemu-img', 'create', 'dummy')
exit_code = 1
stdout = 'stdout dummy'
stderr = 'stderr dummy'
expected_msg = self.test_data.sheepdog_cmd_error(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
fake_execute.side_effect = processutils.ProcessExecutionError(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client._run_qemu_img, *args)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_check_cluster_status_success(self, fake_logger, fake_execute):
stdout = self.test_data.DOG_CLUSTER_RUNNING
stderr = ''
expected_cmd = ('cluster', 'info')
fake_execute.return_value = (stdout, stderr)
self.client.check_cluster_status()
fake_execute.assert_called_once_with(*expected_cmd)
self.assertTrue(fake_logger.debug.called)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_check_cluster_status_v0_5(self, fake_execute):
stdout = self.test_data.COLLIE_CLUSTER_INFO_0_5
stderr = ''
fake_execute.return_value = (stdout, stderr)
self.client.check_cluster_status()
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_check_cluster_status_v0_6(self, fake_execute):
stdout = self.test_data.COLLIE_CLUSTER_INFO_0_6
stderr = ''
fake_execute.return_value = (stdout, stderr)
self.client.check_cluster_status()
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_check_cluster_status_not_formatted(self, fake_logger,
fake_execute):
stdout = self.test_data.DOG_CLUSTER_INFO_TO_BE_FORMATTED
stderr = ''
expected_reason = _('Cluster is not formatted. '
'You should probably perform '
'"dog cluster format".')
fake_execute.return_value = (stdout, stderr)
ex = self.assertRaises(sheepdog.SheepdogError,
self.client.check_cluster_status)
self.assertEqual(expected_reason, ex.kwargs['reason'])
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_check_cluster_status_waiting_to_join_cluster(self, fake_logger,
fake_execute):
stdout = self.test_data.DOG_CLUSTER_INFO_WAITING_OTHER_NODES
stderr = ''
expected_reason = _('Waiting for all nodes to join cluster. '
'Ensure all sheep daemons are running.')
fake_execute.return_value = (stdout, stderr)
ex = self.assertRaises(sheepdog.SheepdogError,
self.client.check_cluster_status)
self.assertEqual(expected_reason, ex.kwargs['reason'])
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_check_cluster_status_shutting_down(self, fake_logger,
fake_execute):
stdout = self.test_data.DOG_CLUSTER_INFO_SHUTTING_DOWN
stderr = ''
expected_reason = _('Invalid sheepdog cluster status.')
fake_execute.return_value = (stdout, stderr)
ex = self.assertRaises(sheepdog.SheepdogError,
self.client.check_cluster_status)
self.assertEqual(expected_reason, ex.kwargs['reason'])
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_check_cluster_status_unknown_error(self, fake_logger,
fake_execute):
cmd = self.test_data.CMD_DOG_CLUSTER_INFO
exit_code = 2
stdout = 'stdout_dummy'
stderr = 'stdout_dummy'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.check_cluster_status)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_create_success(self, fake_execute):
expected_cmd = ('vdi', 'create', self._vdiname, '%sG' % self._vdisize)
fake_execute.return_value = ('', '')
self.client.create(self._vdiname, self._vdisize)
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_create_vdi_already_exists(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_vdi_create(self._vdiname, self._vdisize)
exit_code = 1
stdout = ''
stderr = (self.test_data.DOG_VDI_CREATE_VDI_ALREADY_EXISTS %
{'vdiname': self._vdiname})
expected_msg = self.test_data.sheepdog_cmd_error(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError, self.client.create,
self._vdiname, self._vdisize)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_create_unknown_error(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_vdi_create(self._vdiname, self._vdisize)
exit_code = 1
stdout = 'stdout_dummy'
stderr = 'stderr_dummy'
expected_msg = self.test_data.sheepdog_cmd_error(
cmd=cmd, exit_code=exit_code, stdout=stdout, stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError, self.client.create,
self._vdiname, self._vdisize)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_delete_success(self, fake_execute):
expected_cmd = ('vdi', 'delete', self._vdiname)
fake_execute.return_value = ('', '')
self.client.delete(self._vdiname)
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_delete_vdi_not_found(self, fake_logger, fake_execute):
stdout = ''
stderr = (self.test_data.DOG_COMMAND_ERROR_VDI_NOT_EXISTS %
{'vdiname': self._vdiname})
fake_execute.return_value = (stdout, stderr)
self.client.delete(self._vdiname)
self.assertTrue(fake_logger.warning.called)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_delete_unknown_error(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_vdi_delete(self._vdiname)
exit_code = 2
stdout = 'stdout_dummy'
stderr = 'stderr_dummy'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.delete, self._vdiname)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_create_snapshot_success(self, fake_execute):
args = (self._src_vdiname, self._snapname)
expected_cmd = ('vdi', 'snapshot', '-s', self._snapname,
self._src_vdiname)
fake_execute.return_value = ('', '')
self.client.create_snapshot(*args)
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_create_snapshot_vdi_not_found(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname)
cmd = self.test_data.cmd_dog_vdi_create_snapshot(*args)
exit_code = 1
stdout = ''
stderr = self.test_data.DOG_VDI_SNAPSHOT_VDI_NOT_FOUND
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.create_snapshot, *args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_create_snapshot_snap_name_already_used(self, fake_logger,
fake_execute):
args = (self._src_vdiname, self._snapname)
cmd = self.test_data.cmd_dog_vdi_create_snapshot(*args)
exit_code = 1
stdout = 'stdout_dummy'
stderr = self.test_data.DOG_VDI_SNAPSHOT_ALREADY_EXISTED
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.create_snapshot, *args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_create_snapshot_unknown_error(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname)
cmd = self.test_data.cmd_dog_vdi_create_snapshot(*args)
exit_code = 1
stdout = 'stdout_dummy'
stderr = 'unknown_error'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.create_snapshot, *args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_delete_snapshot_success(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname)
expected_cmd = ('vdi', 'delete', '-s', self._snapname,
self._src_vdiname)
fake_execute.return_value = ('', '')
self.client.delete_snapshot(*args)
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_delete_snapshot_not_found(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname)
stdout = ''
stderr = self.test_data.DOG_VDI_SNAPSHOT_TAG_NOT_FOUND
fake_execute.return_value = (stdout, stderr)
self.client.delete_snapshot(*args)
self.assertTrue(fake_logger.warning.called)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_delete_snapshot_vdi_not_found(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname)
stdout = ''
stderr = self.test_data.DOG_VDI_SNAPSHOT_VOLUME_NOT_FOUND
fake_execute.return_value = (stdout, stderr)
self.client.delete_snapshot(*args)
self.assertTrue(fake_logger.warning.called)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_delete_snapshot_unknown_error(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname)
cmd = self.test_data.cmd_dog_vdi_delete_snapshot(*args)
exit_code = 2
stdout = 'stdout_dummy'
stderr = 'unknown_error'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.delete_snapshot, *args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_qemu_img')
def test_clone_success(self, fake_execute):
args = (self._src_vdiname, self._snapname,
self._dst_vdiname, self._dst_vdisize)
src_volume = 'sheepdog:%(src_vdiname)s:%(snapname)s' % {
'src_vdiname': self._src_vdiname, 'snapname': self._snapname}
dst_volume = 'sheepdog:%s' % self._dst_vdiname
expected_cmd = ('create', '-b', src_volume, dst_volume,
'%sG' % self._dst_vdisize)
fake_execute.return_code = ("", "")
self.client.clone(*args)
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_qemu_img')
@mock.patch.object(sheepdog, 'LOG')
def test_clone_dst_vdi_already_exists(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname,
self._dst_vdiname, self._dst_vdisize)
cmd = self.test_data.cmd_qemuimg_vdi_clone(*args)
exit_code = 2
stdout = 'stdout_dummy'
stderr = self.test_data.QEMU_IMG_VDI_ALREADY_EXISTS
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError, self.client.clone,
*args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_qemu_img')
@mock.patch.object(sheepdog, 'LOG')
def test_clone_src_vdi_not_found(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname,
self._dst_vdiname, self._dst_vdisize)
cmd = self.test_data.cmd_qemuimg_vdi_clone(*args)
exit_code = 2
stdout = 'stdout_dummy'
stderr = self.test_data.QEMU_IMG_VDI_NOT_FOUND
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError, self.client.clone,
*args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_qemu_img')
@mock.patch.object(sheepdog, 'LOG')
def test_clone_src_snapshot_not_found(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname,
self._dst_vdiname, self._dst_vdisize)
cmd = self.test_data.cmd_qemuimg_vdi_clone(*args)
exit_code = 2
stdout = 'stdout_dummy'
stderr = self.test_data.QEMU_IMG_SNAPSHOT_NOT_FOUND
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError, self.client.clone,
*args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_qemu_img')
@mock.patch.object(sheepdog, 'LOG')
def test_clone_too_large_volume_size(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname,
self._dst_vdiname, self._dst_vdisize)
cmd = self.test_data.cmd_qemuimg_vdi_clone(*args)
exit_code = 2
stdout = 'stdout_dummy'
stderr = self.test_data.QEMU_IMG_SIZE_TOO_LARGE
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError, self.client.clone,
*args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_qemu_img')
@mock.patch.object(sheepdog, 'LOG')
def test_clone_unknown_error(self, fake_logger, fake_execute):
args = (self._src_vdiname, self._snapname,
self._dst_vdiname, self._dst_vdisize)
cmd = self.test_data.cmd_qemuimg_vdi_clone(*args)
exit_code = 2
stdout = 'stdout_dummy'
stderr = 'stderr_dummy'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError, self.client.clone,
*args)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_resize_success(self, fake_execute):
expected_cmd = ('vdi', 'resize', self._vdiname, 10 * 1024 ** 3)
fake_execute.return_value = ('', '')
self.client.resize(self._vdiname, 10)
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_resize_vdi_not_found(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_vdi_resize(self._vdiname, 10 * 1024 ** 3)
exit_code = 1
stdout = 'stdout_dummy'
stderr = (self.test_data.DOG_COMMAND_ERROR_VDI_NOT_EXISTS %
{'vdiname': self._vdiname})
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.resize, self._vdiname, 1)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_resize_shrinking_not_supported(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_vdi_resize(self._vdiname, 1 * 1024 ** 3)
exit_code = 1
stdout = 'stdout_dummy'
stderr = self.test_data.DOG_VDI_RESIZE_SIZE_SHRINK
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.resize, self._vdiname, 1)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_resize_too_large_size(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_vdi_resize(self._vdiname, 5 * 1024 ** 4)
exit_code = 64
stdout = 'stdout_dummy'
stderr = self.test_data.DOG_VDI_RESIZE_TOO_LARGE
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.resize, self._vdiname, 5120)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_resize_unknown_error(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_vdi_resize(self._vdiname, 10 * 1024 ** 3)
exit_code = 2
stdout = 'stdout_dummy'
stderr = 'stderr_dummy'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.resize, self._vdiname, 10)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_get_volume_stats_success(self, fake_execute):
expected_cmd = ('node', 'info', '-r')
fake_execute.return_value = (self.test_data.COLLIE_NODE_INFO, '')
self.client.get_volume_stats()
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_get_volume_stats_unknown_error(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_node_info()
exit_code = 2
stdout = 'stdout_dummy'
stderr = 'stderr_dummy'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.get_volume_stats)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_get_vdi_info_success(self, fake_execute):
expected_cmd = ('vdi', 'list', self._vdiname, '-r')
fake_execute.return_value = (self.test_data.COLLIE_VDI_LIST, '')
self.client.get_vdi_info(self._vdiname)
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_get_vdi_info_unknown_error(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_vdi_list(self._vdiname)
exit_code = 2
stdout = 'stdout_dummy'
stderr = 'stderr_dummy'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.get_vdi_info, self._vdiname)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_update_node_list_success(self, fake_execute):
expected_cmd = ('node', 'list', '-r')
fake_execute.return_value = (self.test_data.COLLIE_NODE_LIST, '')
self.client.update_node_list()
fake_execute.assert_called_once_with(*expected_cmd)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
@mock.patch.object(sheepdog, 'LOG')
def test_update_node_list_unknown_error(self, fake_logger, fake_execute):
cmd = self.test_data.cmd_dog_node_list()
exit_code = 2
stdout = 'stdout_dummy'
stderr = 'stderr_dummy'
expected_msg = self.test_data.sheepdog_cmd_error(cmd=cmd,
exit_code=exit_code,
stdout=stdout,
stderr=stderr)
fake_execute.side_effect = sheepdog.SheepdogCmdError(
cmd=cmd, exit_code=exit_code, stdout=stdout.replace('\n', '\\n'),
stderr=stderr.replace('\n', '\\n'))
ex = self.assertRaises(sheepdog.SheepdogCmdError,
self.client.update_node_list)
self.assertTrue(fake_logger.error.called)
self.assertEqual(expected_msg, ex.msg)
class SheepdogDriverTestCase(test.TestCase):
def setUp(self):
super(SheepdogDriverTestCase, self).setUp()
self._cfg = conf.Configuration(None)
self._cfg.sheepdog_store_address = SHEEP_ADDR
self._cfg.sheepdog_store_port = SHEEP_PORT
self.driver = sheepdog.SheepdogDriver(configuration=self._cfg)
db_driver = self.driver.configuration.db_driver
self.db = importutils.import_module(db_driver)
self.driver.db = self.db
self.driver.do_setup(None)
self.test_data = SheepdogDriverTestDataGenerator()
self.client = self.driver.client
self._addr = SHEEP_ADDR
self._port = SHEEP_PORT
self._vdiname = self.test_data.TEST_VOLUME.name
self._vdisize = self.test_data.TEST_VOLUME.size
self._src_vdiname = self.test_data.TEST_SNAPSHOT.volume_name
self._snapname = self.test_data.TEST_SNAPSHOT.name
self._dst_vdiname = self.test_data.TEST_CLONED_VOLUME.name
self._dst_vdisize = self.test_data.TEST_CLONED_VOLUME.size
@mock.patch.object(sheepdog.SheepdogClient, 'update_node_list')
@mock.patch.object(sheepdog.SheepdogClient, 'check_cluster_status')
def test_check_for_setup_error(self, fake_check, fake_update):
self.driver.check_for_setup_error()
fake_check.assert_called_once_with()
fake_update.assert_called_once_with()
@mock.patch.object(sheepdog.SheepdogClient, 'create')
def test_create_volume(self, fake_execute):
self.driver.create_volume(self.test_data.TEST_VOLUME)
fake_execute.assert_called_once_with(self._vdiname, self._vdisize)
@mock.patch.object(sheepdog.SheepdogClient, 'delete')
def test_delete_volume(self, fake_execute):
self.driver.delete_volume(self.test_data.TEST_VOLUME)
fake_execute.assert_called_once_with(self._vdiname)
@mock.patch.object(sheepdog.SheepdogClient, 'get_volume_stats')
def test_update_volume_stats(self, fake_execute):
fake_execute.return_value = self.test_data.COLLIE_NODE_INFO
expected = dict(
volume_backend_name='sheepdog',
vendor_name='Open Source',
driver_version=self.driver.VERSION,
storage_protocol='sheepdog',
total_capacity_gb=float(107287605248) / units.Gi,
free_capacity_gb=float(107287605248 - 3623897354) / units.Gi,
reserved_percentage=0,
QoS_support=False)
actual = self.driver.get_volume_stats(True)
self.assertDictEqual(expected, actual)
@mock.patch.object(sheepdog.SheepdogClient, '_run_dog')
def test_copy_image_to_volume(self, fake_run_dog):
@contextlib.contextmanager
def fake_temp_file():
class FakeTmp(object):
def __init__(self, name):
self.name = name
yield FakeTmp('test').name
def fake_try_execute(obj, *command, **kwargs):
return True
self.mock_object(image_utils, 'temporary_file', fake_temp_file)
self.mock_object(image_utils, 'fetch_verify_image',
return_value=None)
self.mock_object(image_utils, 'convert_image',
return_value=None)
self.mock_object(sheepdog.SheepdogDriver, '_try_execute',
fake_try_execute)
fake_run_dog.return_value = ('fake_stdout', 'fake_stderr')
self.driver.copy_image_to_volume(None, self.test_data.TEST_VOLUME,
FakeImageService(), None)
@mock.patch('six.moves.builtins.open')
@mock.patch('cinder.image.image_utils.temporary_file')
def test_copy_volume_to_image(self, mock_temp, mock_open):
fake_context = {}
fake_volume = {'name': 'volume-00000001'}
fake_image_service = mock.Mock()
fake_image_meta = {'id': '10958016-e196-42e3-9e7f-5d8927ae3099'}
temp_file = mock_temp.return_value.__enter__.return_value
patch = mock.patch.object
with patch(self.driver, '_try_execute') as fake_try_execute:
self.driver.copy_volume_to_image(fake_context,
fake_volume,
fake_image_service,
fake_image_meta)
expected_cmd = ('qemu-img',
'convert',
'-f', 'raw',
'-t', 'none',
'-O', 'raw',
'sheepdog:%s:%s:%s' % (
self._addr,
self._port,
fake_volume['name']),
mock.ANY)
mock_open.assert_called_once_with(temp_file, 'rb')
fake_try_execute.assert_called_once_with(*expected_cmd)
fake_image_service.update.assert_called_once_with(
fake_context, fake_image_meta['id'], mock.ANY, mock.ANY)
@mock.patch('six.moves.builtins.open')
@mock.patch('cinder.image.image_utils.temporary_file')
def test_copy_volume_to_image_nonexistent_volume(self, mock_temp,
mock_open):
fake_context = {}
fake_volume = {
'name': 'nonexistent-volume-82c4539e-c2a5-11e4-a293-0aa186c60fe0'}
fake_image_service = mock.Mock()
fake_image_meta = {'id': '10958016-e196-42e3-9e7f-5d8927ae3099'}
patch = mock.patch.object
with patch(self.driver, '_try_execute') as fake_try_execute:
fake_try_execute.side_effect = (
processutils.ProcessExecutionError)
args = (fake_context, fake_volume, fake_image_service,
fake_image_meta)
expected_cmd = ('qemu-img',
'convert',
'-f', 'raw',
'-t', 'none',
'-O', 'raw',
'sheepdog:%s:%s:%s' % (
self._addr,
self._port,
fake_volume['name']),
mock.ANY)
self.assertRaises(processutils.ProcessExecutionError,
self.driver.copy_volume_to_image,
*args)
fake_try_execute.assert_called_once_with(*expected_cmd)
mock_open.assert_not_called()
fake_image_service.update.assert_not_called()
@mock.patch.object(sheepdog.SheepdogClient, 'create_snapshot')
@mock.patch.object(sheepdog.SheepdogClient, 'clone')
@mock.patch.object(sheepdog.SheepdogClient, 'delete_snapshot')
def test_create_cloned_volume(self, fake_delete_snapshot,
fake_clone, fake_create_snapshot):
src_vol = self.test_data.TEST_VOLUME
cloned_vol = self.test_data.TEST_CLONED_VOLUME
self.driver.create_cloned_volume(cloned_vol, src_vol)
snapshot_name = 'tmp-snap-%s-%s' % (src_vol.name, cloned_vol.id)
fake_create_snapshot.assert_called_once_with(src_vol.name,
snapshot_name)
fake_clone.assert_called_once_with(src_vol.name, snapshot_name,
cloned_vol.name, cloned_vol.size)
fake_delete_snapshot.assert_called_once_with(src_vol.name,
snapshot_name)
@mock.patch.object(sheepdog.SheepdogClient, 'create_snapshot')
@mock.patch.object(sheepdog.SheepdogClient, 'clone')
@mock.patch.object(sheepdog.SheepdogClient, 'delete_snapshot')
@mock.patch.object(sheepdog, 'LOG')
def test_create_cloned_volume_failure(self, fake_logger,
fake_delete_snapshot,
fake_clone, fake_create_snapshot):
src_vol = self.test_data.TEST_VOLUME
cloned_vol = self.test_data.TEST_CLONED_VOLUME
snapshot_name = 'tmp-snap-%s-%s' % (src_vol.name, cloned_vol.id)
fake_clone.side_effect = sheepdog.SheepdogCmdError(
cmd='dummy', exit_code=1, stdout='dummy', stderr='dummy')
self.assertRaises(sheepdog.SheepdogCmdError,
self.driver.create_cloned_volume,
cloned_vol, src_vol)
fake_delete_snapshot.assert_called_once_with(src_vol.name,
snapshot_name)
self.assertTrue(fake_logger.error.called)
@mock.patch.object(sheepdog.SheepdogClient, 'create_snapshot')
def test_create_snapshot(self, fake_create_snapshot):
snapshot = self.test_data.TEST_SNAPSHOT
self.driver.create_snapshot(snapshot)
fake_create_snapshot.assert_called_once_with(snapshot.volume_name,
snapshot.name)
@mock.patch.object(sheepdog.SheepdogClient, 'delete_snapshot')
def test_delete_snapshot(self, fake_delete_snapshot):
snapshot = self.test_data.TEST_SNAPSHOT
self.driver.delete_snapshot(snapshot)
fake_delete_snapshot.assert_called_once_with(snapshot.volume_name,
snapshot.name)
def test_clone_image_success(self):
context = {}
image_id = "caa4ffd0-fake-fake-fake-f8631a807f5a"
image_location = ('sheepdog://192.168.1.111:7000:%s' % image_id, None)
image_meta = {'id': image_id, 'size': 1, 'disk_format': 'raw'}
image_service = ''
patch = mock.patch.object
with patch(self.driver, '_is_cloneable', return_value=True):
with patch(self.driver, 'create_cloned_volume'):
with patch(self.client, 'resize'):
model_updated, cloned = self.driver.clone_image(
context, self.test_data.TEST_CLONED_VOLUME,
image_location, image_meta, image_service)
self.assertTrue(cloned)
self.assertEqual("sheepdog:%s:%s:%s" % (
self._addr,
self._port,
self.test_data.TEST_CLONED_VOLUME.name),
model_updated['provider_location'])
def test_clone_image_failure(self):
context = {}
fake_vol = {}
image_location = ('image_location', None)
image_meta = {}
image_service = ''
with mock.patch.object(self.driver, '_is_cloneable',
lambda *args: False):
result = self.driver.clone_image(
context, fake_vol, image_location, image_meta, image_service)
self.assertEqual(({}, False), result)
def test_is_cloneable(self):
uuid = '87f1b01c-f46c-4537-bd5d-23962f5f4316'
location = 'sheepdog://127.0.0.1:7000:%s' % uuid
image_meta = {'id': uuid, 'size': 1, 'disk_format': 'raw'}
invalid_image_meta = {'id': uuid, 'size': 1, 'disk_format': 'iso'}
with mock.patch.object(self.client, 'get_vdi_info') as fake_execute:
fake_execute.return_value = self.test_data.COLLIE_VDI_LIST
self.assertTrue(
self.driver._is_cloneable(location, image_meta))
# Test for invalid location
self.assertFalse(
self.driver._is_cloneable('invalid-location', image_meta))
# Test for image not exist in sheepdog cluster
fake_execute.return_value = ''
self.assertFalse(
self.driver._is_cloneable(location, image_meta))
# Test for invalid image meta
self.assertFalse(
self.driver._is_cloneable(location, invalid_image_meta))
def test_create_volume_from_snapshot(self):
dst_volume = self.test_data.TEST_CLONED_VOLUME
snapshot = self.test_data.TEST_SNAPSHOT
with mock.patch.object(self.client, 'clone') as fake_execute:
self.driver.create_volume_from_snapshot(dst_volume, snapshot)
fake_execute.assert_called_once_with(self._src_vdiname,
self._snapname,
self._dst_vdiname,
self._dst_vdisize)
def test_initialize_connection(self):
fake_volume = self.test_data.TEST_VOLUME
expected = {
'driver_volume_type': 'sheepdog',
'data': {
'name': fake_volume.name,
'hosts': ["127.0.0.1"],
'ports': ["7000"],
}
}
actual = self.driver.initialize_connection(fake_volume, None)
self.assertDictEqual(expected, actual)
@mock.patch.object(sheepdog.SheepdogClient, 'resize')
@mock.patch.object(sheepdog, 'LOG')
def test_extend_volume(self, fake_logger, fake_execute):
self.driver.extend_volume(self.test_data.TEST_VOLUME, 10)
fake_execute.assert_called_once_with(self._vdiname, 10)
self.assertTrue(fake_logger.debug.called)