Add unit tests for backup commands in volume v1

There was not any unit tests for backup commands
in volume v1 so that sometimes some small bugs
maybe ignored, this patch add unit tests for them.

Change-Id: Ic67c1b80243f7b3d15dabd25e4e4a1b1517a8b59
This commit is contained in:
Huanxuan Ao 2016-09-23 17:22:44 +08:00
parent fd876e4cc6
commit df8ef60603
2 changed files with 435 additions and 0 deletions

View File

@ -451,6 +451,10 @@ class FakeVolumev1Client(object):
self.transfers.resource_class = fakes.FakeResource(None, {})
self.volume_snapshots = mock.Mock()
self.volume_snapshots.resource_class = fakes.FakeResource(None, {})
self.backups = mock.Mock()
self.backups.resource_class = fakes.FakeResource(None, {})
self.restores = mock.Mock()
self.restores.resource_class = fakes.FakeResource(None, {})
self.auth_token = kwargs['token']
self.management_url = kwargs['endpoint']
@ -624,3 +628,79 @@ class FakeSnapshot(object):
snapshots = FakeSnapshot.create_snapshots(count)
return mock.Mock(side_effect=snapshots)
class FakeBackup(object):
"""Fake one or more backup."""
@staticmethod
def create_one_backup(attrs=None):
"""Create a fake backup.
:param Dictionary attrs:
A dictionary with all attributes
:return:
A FakeResource object with id, name, volume_id, etc.
"""
attrs = attrs or {}
# Set default attributes.
backup_info = {
"id": 'backup-id-' + uuid.uuid4().hex,
"name": 'backup-name-' + uuid.uuid4().hex,
"volume_id": 'volume-id-' + uuid.uuid4().hex,
"snapshot_id": 'snapshot-id' + uuid.uuid4().hex,
"description": 'description-' + uuid.uuid4().hex,
"object_count": None,
"container": 'container-' + uuid.uuid4().hex,
"size": random.randint(1, 20),
"status": "error",
"availability_zone": 'zone' + uuid.uuid4().hex,
"links": 'links-' + uuid.uuid4().hex,
}
# Overwrite default attributes.
backup_info.update(attrs)
backup = fakes.FakeResource(
info=copy.deepcopy(backup_info),
loaded=True)
return backup
@staticmethod
def create_backups(attrs=None, count=2):
"""Create multiple fake backups.
:param Dictionary attrs:
A dictionary with all attributes
:param int count:
The number of backups to fake
:return:
A list of FakeResource objects faking the backups
"""
backups = []
for i in range(0, count):
backup = FakeBackup.create_one_backup(attrs)
backups.append(backup)
return backups
@staticmethod
def get_backups(backups=None, count=2):
"""Get an iterable MagicMock object with a list of faked backups.
If backups list is provided, then initialize the Mock object with the
list. Otherwise create one.
:param List volumes:
A list of FakeResource objects faking backups
:param Integer count:
The number of backups to be faked
:return
An iterable Mock object with side_effect set to a list of faked
backups
"""
if backups is None:
backups = FakeBackup.create_backups(count)
return mock.Mock(side_effect=backups)

View File

@ -0,0 +1,355 @@
#
# 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 mock
from mock import call
from osc_lib import exceptions
from osc_lib import utils
from openstackclient.tests.unit.volume.v1 import fakes as volume_fakes
from openstackclient.volume.v1 import backup
class TestBackup(volume_fakes.TestVolumev1):
def setUp(self):
super(TestBackup, self).setUp()
self.backups_mock = self.app.client_manager.volume.backups
self.backups_mock.reset_mock()
self.volumes_mock = self.app.client_manager.volume.volumes
self.volumes_mock.reset_mock()
self.snapshots_mock = self.app.client_manager.volume.volume_snapshots
self.snapshots_mock.reset_mock()
self.restores_mock = self.app.client_manager.volume.restores
self.restores_mock.reset_mock()
class TestBackupCreate(TestBackup):
volume = volume_fakes.FakeVolume.create_one_volume()
columns = (
'availability_zone',
'container',
'description',
'id',
'name',
'object_count',
'size',
'snapshot_id',
'status',
'volume_id',
)
def setUp(self):
super(TestBackupCreate, self).setUp()
self.new_backup = volume_fakes.FakeBackup.create_one_backup(
attrs={'volume_id': self.volume.id})
self.data = (
self.new_backup.availability_zone,
self.new_backup.container,
self.new_backup.description,
self.new_backup.id,
self.new_backup.name,
self.new_backup.object_count,
self.new_backup.size,
self.new_backup.snapshot_id,
self.new_backup.status,
self.new_backup.volume_id,
)
self.volumes_mock.get.return_value = self.volume
self.backups_mock.create.return_value = self.new_backup
# Get the command object to test
self.cmd = backup.CreateVolumeBackup(self.app, None)
def test_backup_create(self):
arglist = [
"--name", self.new_backup.name,
"--description", self.new_backup.description,
"--container", self.new_backup.container,
self.new_backup.volume_id,
]
verifylist = [
("name", self.new_backup.name),
("description", self.new_backup.description),
("container", self.new_backup.container),
("volume", self.new_backup.volume_id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.backups_mock.create.assert_called_with(
self.new_backup.volume_id,
self.new_backup.container,
self.new_backup.name,
self.new_backup.description,
)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)
def test_backup_create_without_name(self):
arglist = [
"--description", self.new_backup.description,
"--container", self.new_backup.container,
self.new_backup.volume_id,
]
verifylist = [
("description", self.new_backup.description),
("container", self.new_backup.container),
("volume", self.new_backup.volume_id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.backups_mock.create.assert_called_with(
self.new_backup.volume_id,
self.new_backup.container,
None,
self.new_backup.description,
)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)
class TestBackupDelete(TestBackup):
backups = volume_fakes.FakeBackup.create_backups(count=2)
def setUp(self):
super(TestBackupDelete, self).setUp()
self.backups_mock.get = (
volume_fakes.FakeBackup.get_backups(self.backups))
self.backups_mock.delete.return_value = None
# Get the command object to mock
self.cmd = backup.DeleteVolumeBackup(self.app, None)
def test_backup_delete(self):
arglist = [
self.backups[0].id
]
verifylist = [
("backups", [self.backups[0].id])
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.backups_mock.delete.assert_called_with(
self.backups[0].id)
self.assertIsNone(result)
def test_delete_multiple_backups(self):
arglist = []
for b in self.backups:
arglist.append(b.id)
verifylist = [
('backups', arglist),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
calls = []
for b in self.backups:
calls.append(call(b.id))
self.backups_mock.delete.assert_has_calls(calls)
self.assertIsNone(result)
def test_delete_multiple_backups_with_exception(self):
arglist = [
self.backups[0].id,
'unexist_backup',
]
verifylist = [
('backups', arglist),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
find_mock_result = [self.backups[0], exceptions.CommandError]
with mock.patch.object(utils, 'find_resource',
side_effect=find_mock_result) as find_mock:
try:
self.cmd.take_action(parsed_args)
self.fail('CommandError should be raised.')
except exceptions.CommandError as e:
self.assertEqual('1 of 2 backups failed to delete.',
str(e))
find_mock.assert_any_call(self.backups_mock, self.backups[0].id)
find_mock.assert_any_call(self.backups_mock, 'unexist_backup')
self.assertEqual(2, find_mock.call_count)
self.backups_mock.delete.assert_called_once_with(
self.backups[0].id,
)
class TestBackupList(TestBackup):
volume = volume_fakes.FakeVolume.create_one_volume()
backups = volume_fakes.FakeBackup.create_backups(
attrs={'volume_id': volume.display_name}, count=3)
columns = [
'ID',
'Name',
'Description',
'Status',
'Size',
]
columns_long = columns + [
'Availability Zone',
'Volume',
'Container',
]
data = []
for b in backups:
data.append((
b.id,
b.name,
b.description,
b.status,
b.size,
))
data_long = []
for b in backups:
data_long.append((
b.id,
b.name,
b.description,
b.status,
b.size,
b.availability_zone,
b.volume_id,
b.container,
))
def setUp(self):
super(TestBackupList, self).setUp()
self.volumes_mock.list.return_value = [self.volume]
self.backups_mock.list.return_value = self.backups
# Get the command to test
self.cmd = backup.ListVolumeBackup(self.app, None)
def test_backup_list_without_options(self):
arglist = []
verifylist = [("long", False)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, list(data))
def test_backup_list_with_options(self):
arglist = ["--long"]
verifylist = [("long", True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(self.columns_long, columns)
self.assertEqual(self.data_long, list(data))
class TestBackupRestore(TestBackup):
volume = volume_fakes.FakeVolume.create_one_volume()
backup = volume_fakes.FakeBackup.create_one_backup(
attrs={'volume_id': volume.id})
def setUp(self):
super(TestBackupRestore, self).setUp()
self.backups_mock.get.return_value = self.backup
self.volumes_mock.get.return_value = self.volume
self.restores_mock.restore.return_value = None
# Get the command object to mock
self.cmd = backup.RestoreVolumeBackup(self.app, None)
def test_backup_restore(self):
arglist = [
self.backup.id,
self.backup.volume_id
]
verifylist = [
("backup", self.backup.id),
("volume", self.backup.volume_id)
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.restores_mock.restore.assert_called_with(self.backup.id,
self.backup.volume_id)
self.assertIsNone(result)
class TestBackupShow(TestBackup):
columns = (
'availability_zone',
'container',
'description',
'id',
'name',
'object_count',
'size',
'snapshot_id',
'status',
'volume_id',
)
def setUp(self):
super(TestBackupShow, self).setUp()
self.backup = volume_fakes.FakeBackup.create_one_backup()
self.data = (
self.backup.availability_zone,
self.backup.container,
self.backup.description,
self.backup.id,
self.backup.name,
self.backup.object_count,
self.backup.size,
self.backup.snapshot_id,
self.backup.status,
self.backup.volume_id,
)
self.backups_mock.get.return_value = self.backup
# Get the command object to test
self.cmd = backup.ShowVolumeBackup(self.app, None)
def test_backup_show(self):
arglist = [
self.backup.id
]
verifylist = [
("backup", self.backup.id)
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.backups_mock.get.assert_called_with(self.backup.id)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)