This removes the need for a number of base test case subclasses. We use 'volume_client' rather than 'client' to avoid conflicts with clients for other services. Change-Id: I28d78f32142bb3a3fde0ba1780c504adc31cc77c Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
		
			
				
	
	
		
			436 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			436 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
#
 | 
						|
#   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 unittest.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 volume_backup
 | 
						|
 | 
						|
 | 
						|
class TestBackup(volume_fakes.TestVolumev1):
 | 
						|
    def setUp(self):
 | 
						|
        super().setUp()
 | 
						|
 | 
						|
        self.backups_mock = self.volume_client.backups
 | 
						|
        self.backups_mock.reset_mock()
 | 
						|
        self.volumes_mock = self.volume_client.volumes
 | 
						|
        self.volumes_mock.reset_mock()
 | 
						|
        self.snapshots_mock = self.volume_client.volume_snapshots
 | 
						|
        self.snapshots_mock.reset_mock()
 | 
						|
        self.restores_mock = self.volume_client.restores
 | 
						|
        self.restores_mock.reset_mock()
 | 
						|
 | 
						|
 | 
						|
class TestBackupCreate(TestBackup):
 | 
						|
    volume = volume_fakes.create_one_volume()
 | 
						|
 | 
						|
    columns = (
 | 
						|
        'availability_zone',
 | 
						|
        'container',
 | 
						|
        'description',
 | 
						|
        'id',
 | 
						|
        'name',
 | 
						|
        'object_count',
 | 
						|
        'size',
 | 
						|
        'snapshot_id',
 | 
						|
        'status',
 | 
						|
        'volume_id',
 | 
						|
    )
 | 
						|
 | 
						|
    def setUp(self):
 | 
						|
        super().setUp()
 | 
						|
        self.new_backup = volume_fakes.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 = volume_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.assertCountEqual(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.assertCountEqual(self.data, data)
 | 
						|
 | 
						|
 | 
						|
class TestBackupDelete(TestBackup):
 | 
						|
    backups = volume_fakes.create_backups(count=2)
 | 
						|
 | 
						|
    def setUp(self):
 | 
						|
        super().setUp()
 | 
						|
 | 
						|
        self.backups_mock.get = volume_fakes.get_backups(self.backups)
 | 
						|
        self.backups_mock.delete.return_value = None
 | 
						|
 | 
						|
        # Get the command object to mock
 | 
						|
        self.cmd = volume_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.create_one_volume()
 | 
						|
    backups = volume_fakes.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,
 | 
						|
                volume_backup.VolumeIdColumn(b.volume_id),
 | 
						|
                b.container,
 | 
						|
            )
 | 
						|
        )
 | 
						|
 | 
						|
    def setUp(self):
 | 
						|
        super().setUp()
 | 
						|
 | 
						|
        self.volumes_mock.list.return_value = [self.volume]
 | 
						|
        self.backups_mock.list.return_value = self.backups
 | 
						|
        self.volumes_mock.get.return_value = self.volume
 | 
						|
        # Get the command to test
 | 
						|
        self.cmd = volume_backup.ListVolumeBackup(self.app, None)
 | 
						|
 | 
						|
    def test_backup_list_without_options(self):
 | 
						|
        arglist = []
 | 
						|
        verifylist = [
 | 
						|
            ("long", False),
 | 
						|
            ("name", None),
 | 
						|
            ("status", None),
 | 
						|
            ("volume", None),
 | 
						|
            ('all_projects', False),
 | 
						|
        ]
 | 
						|
 | 
						|
        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 | 
						|
        columns, data = self.cmd.take_action(parsed_args)
 | 
						|
 | 
						|
        search_opts = {
 | 
						|
            "name": None,
 | 
						|
            "status": None,
 | 
						|
            "volume_id": None,
 | 
						|
            "all_tenants": False,
 | 
						|
        }
 | 
						|
        self.volumes_mock.get.assert_not_called()
 | 
						|
        self.backups_mock.list.assert_called_with(
 | 
						|
            search_opts=search_opts,
 | 
						|
        )
 | 
						|
        self.assertEqual(self.columns, columns)
 | 
						|
        self.assertCountEqual(self.data, list(data))
 | 
						|
 | 
						|
    def test_backup_list_with_options(self):
 | 
						|
        arglist = [
 | 
						|
            "--long",
 | 
						|
            "--name",
 | 
						|
            self.backups[0].name,
 | 
						|
            "--status",
 | 
						|
            "error",
 | 
						|
            "--volume",
 | 
						|
            self.volume.id,
 | 
						|
            "--all-projects",
 | 
						|
        ]
 | 
						|
        verifylist = [
 | 
						|
            ("long", True),
 | 
						|
            ("name", self.backups[0].name),
 | 
						|
            ("status", "error"),
 | 
						|
            ("volume", self.volume.id),
 | 
						|
            ('all_projects', True),
 | 
						|
        ]
 | 
						|
 | 
						|
        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 | 
						|
        columns, data = self.cmd.take_action(parsed_args)
 | 
						|
 | 
						|
        search_opts = {
 | 
						|
            "name": self.backups[0].name,
 | 
						|
            "status": "error",
 | 
						|
            "volume_id": self.volume.id,
 | 
						|
            "all_tenants": True,
 | 
						|
        }
 | 
						|
        self.volumes_mock.get.assert_called_once_with(self.volume.id)
 | 
						|
        self.backups_mock.list.assert_called_with(
 | 
						|
            search_opts=search_opts,
 | 
						|
        )
 | 
						|
        self.assertEqual(self.columns_long, columns)
 | 
						|
        self.assertCountEqual(self.data_long, list(data))
 | 
						|
 | 
						|
 | 
						|
class TestBackupRestore(TestBackup):
 | 
						|
    volume = volume_fakes.create_one_volume()
 | 
						|
    backup = volume_fakes.create_one_backup(
 | 
						|
        attrs={'volume_id': volume.id},
 | 
						|
    )
 | 
						|
 | 
						|
    def setUp(self):
 | 
						|
        super().setUp()
 | 
						|
 | 
						|
        self.backups_mock.get.return_value = self.backup
 | 
						|
        self.volumes_mock.get.return_value = self.volume
 | 
						|
        self.restores_mock.restore.return_value = (
 | 
						|
            volume_fakes.create_one_volume(
 | 
						|
                {'id': self.volume['id']},
 | 
						|
            )
 | 
						|
        )
 | 
						|
        # Get the command object to mock
 | 
						|
        self.cmd = volume_backup.RestoreVolumeBackup(self.app, None)
 | 
						|
 | 
						|
    def test_backup_restore(self):
 | 
						|
        arglist = [
 | 
						|
            self.backup.id,
 | 
						|
        ]
 | 
						|
        verifylist = [
 | 
						|
            ("backup", self.backup.id),
 | 
						|
            ("volume", None),
 | 
						|
        ]
 | 
						|
        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, None)
 | 
						|
        self.assertIsNotNone(result)
 | 
						|
 | 
						|
    def test_backup_restore_with_existing_volume(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.assertIsNotNone(result)
 | 
						|
 | 
						|
    def test_backup_restore_with_invalid_volume(self):
 | 
						|
        arglist = [
 | 
						|
            self.backup.id,
 | 
						|
            "unexist_volume",
 | 
						|
        ]
 | 
						|
        verifylist = [
 | 
						|
            ("backup", self.backup.id),
 | 
						|
            ("volume", "unexist_volume"),
 | 
						|
        ]
 | 
						|
        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 | 
						|
        with mock.patch.object(
 | 
						|
            utils,
 | 
						|
            'find_resource',
 | 
						|
            side_effect=exceptions.CommandError(),
 | 
						|
        ):
 | 
						|
            self.assertRaises(
 | 
						|
                exceptions.CommandError,
 | 
						|
                self.cmd.take_action,
 | 
						|
                parsed_args,
 | 
						|
            )
 | 
						|
 | 
						|
 | 
						|
class TestBackupShow(TestBackup):
 | 
						|
    columns = (
 | 
						|
        'availability_zone',
 | 
						|
        'container',
 | 
						|
        'description',
 | 
						|
        'id',
 | 
						|
        'name',
 | 
						|
        'object_count',
 | 
						|
        'size',
 | 
						|
        'snapshot_id',
 | 
						|
        'status',
 | 
						|
        'volume_id',
 | 
						|
    )
 | 
						|
 | 
						|
    def setUp(self):
 | 
						|
        super().setUp()
 | 
						|
        self.backup = volume_fakes.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 = volume_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.assertCountEqual(self.data, data)
 |