tests: qvm-backup-restore tool tests
Very simple one, but also fix reporting errors detected by tests.
This commit is contained in:
Marek Marczykowski-Górecki
parent
3c9fb8dbac
commit
c50fc21e44
223
qubesadmin/tests/tools/qvm_backup_restore.py
Normal file
223
qubesadmin/tests/tools/qvm_backup_restore.py
Normal file
@ -0,0 +1,223 @@
|
||||
# -*- encoding: utf8 -*-
|
||||
#
|
||||
# The Qubes OS Project, http://www.qubes-os.org
|
||||
#
|
||||
# Copyright (C) 2017 Marek Marczykowski-Górecki
|
||||
# <marmarek@invisiblethingslab.com>
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Lesser General Public License as published by
|
||||
# the Free Software Foundation; either version 2.1 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU Lesser General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public License along
|
||||
# with this program; if not, see <http://www.gnu.org/licenses/>.
|
||||
import qubesadmin.tests
|
||||
import qubesadmin.tests.tools
|
||||
import qubesadmin.tools.qvm_backup_restore
|
||||
from unittest import mock
|
||||
from qubesadmin.backup import BackupRestore, BackupVM
|
||||
|
||||
|
||||
class TC_00_qvm_backup_restore(qubesadmin.tests.QubesTestCase):
|
||||
def setUp(self):
|
||||
super(TC_00_qvm_backup_restore, self).setUp()
|
||||
|
||||
def tearDown(self):
|
||||
super(TC_00_qvm_backup_restore, self).tearDown()
|
||||
|
||||
@mock.patch('qubesadmin.tools.qvm_backup_restore.input', create=True)
|
||||
@mock.patch('getpass.getpass')
|
||||
@mock.patch('qubesadmin.backup.BackupRestore')
|
||||
def test_000_simple(self, mock_backup, mock_getpass, mock_input):
|
||||
mock_getpass.return_value = 'testpass'
|
||||
mock_input.return_value = 'Y'
|
||||
vm1 = BackupVM()
|
||||
vm1.name = 'test-vm'
|
||||
vm1.backup_path = 'path/in/backup'
|
||||
vm1.template = None
|
||||
vm1.klass = 'StandaloneVM'
|
||||
vm1.label = 'red'
|
||||
mock_restore_info = {
|
||||
1: BackupRestore.VMToRestore(vm1),
|
||||
}
|
||||
mock_backup.configure_mock(**{
|
||||
'return_value.get_restore_summary.return_value': '',
|
||||
'return_value.get_restore_info.return_value': mock_restore_info,
|
||||
})
|
||||
with mock.patch('qubesadmin.tools.qvm_backup_restore.handle_broken') \
|
||||
as mock_handle_broken:
|
||||
qubesadmin.tools.qvm_backup_restore.main(['/some/path'],
|
||||
app=self.app)
|
||||
mock_handle_broken.assert_called_once_with(
|
||||
self.app, mock.ANY, mock_restore_info)
|
||||
mock_backup.assert_called_once_with(
|
||||
self.app, '/some/path', None, 'testpass')
|
||||
self.assertAllCalled()
|
||||
|
||||
@mock.patch('qubesadmin.tools.qvm_backup_restore.input', create=True)
|
||||
@mock.patch('getpass.getpass')
|
||||
@mock.patch('qubesadmin.backup.BackupRestore')
|
||||
def test_001_selected_vms(self, mock_backup, mock_getpass, mock_input):
|
||||
mock_getpass.return_value = 'testpass'
|
||||
mock_input.return_value = 'Y'
|
||||
vm1 = BackupVM()
|
||||
vm1.name = 'test-vm'
|
||||
vm1.backup_path = 'path/in/backup'
|
||||
vm1.template = None
|
||||
vm1.klass = 'StandaloneVM'
|
||||
vm1.label = 'red'
|
||||
vm2 = BackupVM()
|
||||
vm2.name = 'test-vm2'
|
||||
vm2.backup_path = 'path/in/backup2'
|
||||
vm2.template = None
|
||||
vm2.klass = 'StandaloneVM'
|
||||
vm2.label = 'red'
|
||||
mock_restore_info = {
|
||||
1: BackupRestore.VMToRestore(vm1),
|
||||
2: BackupRestore.VMToRestore(vm2),
|
||||
}
|
||||
exclude_list = []
|
||||
mock_backup.configure_mock(**{
|
||||
'return_value.get_restore_summary.return_value': '',
|
||||
'return_value.options.exclude': exclude_list,
|
||||
'return_value.get_restore_info.return_value': mock_restore_info,
|
||||
})
|
||||
qubesadmin.tools.qvm_backup_restore.main(['/some/path', 'test-vm'],
|
||||
app=self.app)
|
||||
mock_backup.assert_called_once_with(
|
||||
self.app, '/some/path', None, 'testpass')
|
||||
self.assertEqual(exclude_list, ['test-vm2'])
|
||||
self.assertAllCalled()
|
||||
|
||||
def test_010_handle_broken_no_problems(self):
|
||||
vm1 = BackupVM()
|
||||
vm1.name = 'test-vm'
|
||||
vm1.backup_path = 'path/in/backup'
|
||||
vm1.template = None
|
||||
vm1.klass = 'StandaloneVM'
|
||||
vm1.label = 'red'
|
||||
mock_restore_info = {
|
||||
1: BackupRestore.VMToRestore(vm1),
|
||||
}
|
||||
mock_args = mock.Mock()
|
||||
self.app.log = mock.Mock()
|
||||
qubesadmin.tools.qvm_backup_restore.handle_broken(
|
||||
self.app, mock_args, mock_restore_info)
|
||||
self.assertEqual(self.app.log.mock_calls, [
|
||||
mock.call.info(
|
||||
'The above VMs will be copied and added to your system.'),
|
||||
mock.call.info(
|
||||
'Exisiting VMs will NOT be removed.'),
|
||||
])
|
||||
|
||||
def assertAppropriateLogging(self, missing_name, action):
|
||||
'''
|
||||
:param missing_name: NetVM or TemplateVM
|
||||
:param action: 'skip_broken', 'ignore_missing'
|
||||
:return:
|
||||
'''
|
||||
|
||||
expected_calls = [
|
||||
mock.call.info(
|
||||
'The above VMs will be copied and added to your system.'),
|
||||
mock.call.info(
|
||||
'Exisiting VMs will NOT be removed.'),
|
||||
mock.call.warning(
|
||||
'*** One or more {}s are missing on the host! ***'.format(
|
||||
missing_name)),
|
||||
]
|
||||
if action == 'skip_broken':
|
||||
expected_calls.append(
|
||||
mock.call.warning(
|
||||
'Skipping broken entries: VMs that depend on missing {}s '
|
||||
'will NOT be restored.'.format(missing_name))
|
||||
)
|
||||
elif action == 'ignore_missing':
|
||||
expected_calls.append(
|
||||
mock.call.warning(
|
||||
'Ignoring missing entries: VMs that depend on missing '
|
||||
'{}s will have default value assigned.'.format(
|
||||
missing_name))
|
||||
)
|
||||
self.assertEqual(self.app.log.mock_calls, expected_calls)
|
||||
|
||||
|
||||
def test_011_handle_broken_missing_template(self):
|
||||
vm1 = BackupVM()
|
||||
vm1.name = 'test-vm'
|
||||
vm1.backup_path = 'path/in/backup'
|
||||
vm1.template = 'not-existing-template'
|
||||
vm1.klass = 'AppVM'
|
||||
vm1.label = 'red'
|
||||
mock_restore_info = {
|
||||
1: BackupRestore.VMToRestore(vm1),
|
||||
}
|
||||
mock_restore_info[1].problems.add(
|
||||
BackupRestore.VMToRestore.MISSING_TEMPLATE)
|
||||
with self.subTest('skip_broken'):
|
||||
mock_args = mock.Mock()
|
||||
mock_args.skip_broken = True
|
||||
self.app.log = mock.Mock()
|
||||
qubesadmin.tools.qvm_backup_restore.handle_broken(
|
||||
self.app, mock_args, mock_restore_info)
|
||||
self.assertAppropriateLogging('TemplateVM', 'skip_broken')
|
||||
with self.subTest('ignore_missing'):
|
||||
mock_args = mock.Mock()
|
||||
mock_args.skip_broken = False
|
||||
mock_args.ignore_missing = True
|
||||
self.app.log = mock.Mock()
|
||||
qubesadmin.tools.qvm_backup_restore.handle_broken(
|
||||
self.app, mock_args, mock_restore_info)
|
||||
self.assertAppropriateLogging('TemplateVM', 'ignore_missing')
|
||||
with self.subTest('error'):
|
||||
mock_args = mock.Mock()
|
||||
mock_args.skip_broken = False
|
||||
mock_args.ignore_missing = False
|
||||
self.app.log = mock.Mock()
|
||||
with self.assertRaises(qubesadmin.exc.QubesException):
|
||||
qubesadmin.tools.qvm_backup_restore.handle_broken(
|
||||
self.app, mock_args, mock_restore_info)
|
||||
self.assertAppropriateLogging('TemplateVM', 'error')
|
||||
|
||||
def test_012_handle_broken_missing_netvm(self):
|
||||
vm1 = BackupVM()
|
||||
vm1.name = 'test-vm'
|
||||
vm1.backup_path = 'path/in/backup'
|
||||
vm1.netvm = 'not-existing-netvm'
|
||||
vm1.klass = 'StandaloneVM'
|
||||
vm1.label = 'red'
|
||||
mock_restore_info = {
|
||||
1: BackupRestore.VMToRestore(vm1),
|
||||
}
|
||||
mock_restore_info[1].problems.add(
|
||||
BackupRestore.VMToRestore.MISSING_NETVM)
|
||||
with self.subTest('skip_broken'):
|
||||
mock_args = mock.Mock()
|
||||
mock_args.skip_broken = True
|
||||
self.app.log = mock.Mock()
|
||||
qubesadmin.tools.qvm_backup_restore.handle_broken(
|
||||
self.app, mock_args, mock_restore_info)
|
||||
self.assertAppropriateLogging('NetVM', 'skip_broken')
|
||||
with self.subTest('ignore_missing'):
|
||||
mock_args = mock.Mock()
|
||||
mock_args.skip_broken = False
|
||||
mock_args.ignore_missing = True
|
||||
self.app.log = mock.Mock()
|
||||
qubesadmin.tools.qvm_backup_restore.handle_broken(
|
||||
self.app, mock_args, mock_restore_info)
|
||||
self.assertAppropriateLogging('NetVM', 'ignore_missing')
|
||||
with self.subTest('error'):
|
||||
mock_args = mock.Mock()
|
||||
mock_args.skip_broken = False
|
||||
mock_args.ignore_missing = False
|
||||
self.app.log = mock.Mock()
|
||||
with self.assertRaises(qubesadmin.exc.QubesException):
|
||||
qubesadmin.tools.qvm_backup_restore.handle_broken(
|
||||
self.app, mock_args, mock_restore_info)
|
||||
self.assertAppropriateLogging('NetVM', 'error')
|
||||
@ -145,7 +145,8 @@ def handle_broken(app, args, restore_info):
|
||||
"missing TemplateVMs will NOT be restored.")
|
||||
elif args.ignore_missing:
|
||||
app.log.warning("Ignoring missing entries: VMs that depend "
|
||||
"on missing TemplateVMs will NOT be restored.")
|
||||
"on missing TemplateVMs will have default value "\
|
||||
"assigned.")
|
||||
else:
|
||||
raise qubesadmin.exc.QubesException(
|
||||
"INTERNAL ERROR! Please report this to the Qubes OS team!")
|
||||
@ -162,7 +163,7 @@ def handle_broken(app, args, restore_info):
|
||||
"missing NetVMs will NOT be restored.")
|
||||
elif args.ignore_missing:
|
||||
app.log.warning("Ignoring missing entries: VMs that depend "
|
||||
"on missing NetVMs will NOT be restored.")
|
||||
"on missing NetVMs will have default value assigned.")
|
||||
else:
|
||||
raise qubesadmin.exc.QubesException(
|
||||
"INTERNAL ERROR! Please report this to the Qubes OS team!")
|
||||
@ -186,10 +187,10 @@ def handle_broken(app, args, restore_info):
|
||||
"the existing files will be moved to this new "
|
||||
"directory.")
|
||||
|
||||
def main(args=None):
|
||||
def main(args=None, app=None):
|
||||
'''Main function of qvm-backup-restore'''
|
||||
# pylint: disable=too-many-return-statements
|
||||
args = parser.parse_args(args)
|
||||
args = parser.parse_args(args, app=app)
|
||||
|
||||
appvm = None
|
||||
if args.appvm:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user