# -*- encoding: utf-8 -*-
#
# 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/>.
# pylint: disable=missing-docstring
import asyncio
import qubesadmin.tests
import qubesadmin.tests.tools
import qubesadmin.tools.qvm_shutdown
[docs]
class TC_00_qvm_shutdown(qubesadmin.tests.QubesTestCase):
[docs]
def test_000_with_vm(self):
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n'
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', None, None)] = b'0\x00'
qubesadmin.tools.qvm_shutdown.main(['some-vm'], app=self.app)
self.assertAllCalled()
[docs]
def test_001_missing_vm(self):
with self.assertRaises(SystemExit):
with qubesadmin.tests.tools.StderrBuffer() as stderr:
qubesadmin.tools.qvm_shutdown.main([], app=self.app)
self.assertIn('one of the arguments --all VMNAME is required',
stderr.getvalue())
self.assertAllCalled()
[docs]
def test_002_invalid_vm(self):
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n'
with self.assertRaises(SystemExit):
with qubesadmin.tests.tools.StderrBuffer() as stderr:
qubesadmin.tools.qvm_shutdown.main(['no-such-vm'], app=self.app)
self.assertIn('no such domain', stderr.getvalue())
self.assertAllCalled()
[docs]
def test_003_not_running(self):
# TODO: some option to ignore this error?
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', None, None)] = \
b'2\x00QubesVMNotStartedError\x00\x00Domain is powered off: ' \
b'some-vm\x00'
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Halted\n'
qubesadmin.tools.qvm_shutdown.main(['some-vm'], app=self.app)
self.assertAllCalled()
[docs]
def test_004_multiple_vms(self):
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', None, None)] = \
b'0\x00'
self.app.expected_calls[
('other-vm', 'admin.vm.Shutdown', None, None)] = \
b'0\x00'
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n' \
b'other-vm class=AppVM state=Running\n'
qubesadmin.tools.qvm_shutdown.main(['some-vm', 'other-vm'],
app=self.app)
self.assertAllCalled()
[docs]
def test_010_wait(self):
'''test --wait option'''
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'wait', None)] = \
b'0\x00'
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n'
qubesadmin.tools.qvm_shutdown.main(['--wait', 'some-vm'], app=self.app)
self.assertAllCalled()
[docs]
def test_012_wait_all(self):
'''test --wait option, with multiple VMs'''
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'force+wait', None)] = \
b'0\x00'
self.app.expected_calls[
('other-vm', 'admin.vm.Shutdown', 'force+wait', None)] = \
b'0\x00'
self.app.expected_calls[
('sys-net', 'admin.vm.Shutdown', 'force+wait', None)] = \
b'0\x00'
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00' \
b'sys-net class=AppVM state=Running\n' \
b'some-vm class=AppVM state=Running\n' \
b'other-vm class=AppVM state=Running\n'
qubesadmin.tools.qvm_shutdown.main(['--wait', '--all'], app=self.app)
self.assertAllCalled()
[docs]
def test_015_wait_all_kill_timeout(self):
'''test --wait option, with multiple VMs and killing on timeout'''
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'force+wait', None)] = \
b'2\x00QubesVMShutdownTimeoutError\x00\x00Shutdown timed out\x00'
self.app.expected_calls[
('some-vm', 'admin.vm.Kill', None, None)] = \
b'2\x00QubesVMNotStartedError\x00\x00Domain is powered off\x00'
self.app.expected_calls[
('other-vm', 'admin.vm.Shutdown', 'force+wait', None)] = \
b'2\x00QubesVMShutdownTimeoutError\x00\x00Shutdown timed out\x00'
self.app.expected_calls[
('other-vm', 'admin.vm.Kill', None, None)] = \
b'0\x00'
self.app.expected_calls[
('sys-net', 'admin.vm.Shutdown', 'force+wait', None)] = \
b'0\x00'
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00' \
b'sys-net class=AppVM state=Running\n' \
b'some-vm class=AppVM state=Running\n' \
b'other-vm class=AppVM state=Running\n'
qubesadmin.tools.qvm_shutdown.main(['--wait', '--all'], app=self.app)
self.assertAllCalled()
[docs]
def test_016_all_exclude_noforce(self):
'''test --all --exclude does NOT imply --force'''
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', None, None)] = \
b'0\x00'
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00' \
b'some-vm class=AppVM state=Running\n' \
b'other-vm class=AppVM state=Running\n'
qubesadmin.tools.qvm_shutdown.main(['--all', '--exclude', 'other-vm'],
app=self.app)
self.assertAllCalled()
[docs]
def test_017_all_exclude_force_explicit(self):
'''test --all --exclude --force DOES imply --force'''
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'force', None)] = \
b'0\x00'
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00' \
b'some-vm class=AppVM state=Running\n' \
b'other-vm class=AppVM state=Running\n'
qubesadmin.tools.qvm_shutdown.main(['--all', '--exclude', 'other-vm',
'--force'],
app=self.app)
self.assertAllCalled()
[docs]
def test_005_force(self):
'''test --force sends force flag to shutdown call'''
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n'
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'force', None)] = b'0\x00'
qubesadmin.tools.qvm_shutdown.main(
['--force', 'some-vm'], app=self.app)
self.assertAllCalled()
[docs]
def test_006_dry_run(self):
'''test --dry-run skips shutdown calls'''
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n'
qubesadmin.tools.qvm_shutdown.main(
['--dry-run', 'some-vm'], app=self.app)
self.assertAllCalled()
[docs]
def test_011_wait_retry_simple(self):
'''test --wait retries VMs whose shutdown request failed'''
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00' \
b'some-vm class=AppVM state=Running\n' \
b'other-vm class=AppVM state=Running\n'
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'wait', None)] = \
b'0\x00'
# other-vm fails first attempt, succeeds on retry
self.app.expected_calls[
('other-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
b'0\x00',
]
qubesadmin.tools.qvm_shutdown.main(
['--wait', 'some-vm', 'other-vm'], app=self.app)
self.assertAllCalled()
[docs]
def test_011_wait_retry_once_succeed(self):
'''test --wait retry quits early if none fail'''
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = (
b'0\x00'
b'some-vm class=AppVM state=Running\n'
b'other-vm class=AppVM state=Running\n'
b'another-vm class=AppVM state=Running\n'
)
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
b'0\x00'
]
self.app.expected_calls[
('other-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
b'0\x00',
]
self.app.expected_calls[
('another-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
b'0\x00',
]
qubesadmin.tools.qvm_shutdown.main(
['--wait', 'some-vm', 'other-vm', 'another-vm'], app=self.app)
self.assertAllCalled()
[docs]
def test_011_wait_retry_once_fail(self):
'''test --wait retry quits early if none succeed'''
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = (
b'0\x00'
b'some-vm class=AppVM state=Running\n'
b'other-vm class=AppVM state=Running\n'
b'another-vm class=AppVM state=Running\n'
)
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
]
self.app.expected_calls[
('other-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
]
self.app.expected_calls[
('another-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
]
with self.assertRaises(SystemExit) as cmg:
qubesadmin.tools.qvm_shutdown.main(
['--wait', 'some-vm', 'other-vm', 'another-vm'], app=self.app)
self.assertEqual(cmg.exception.code, 3)
self.assertAllCalled()
[docs]
def test_011_wait_retry_as_many_as_in_use(self):
'''test --wait retries VMs whose shutdown request failed as many as
there were used qubes'''
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00' \
b'some-vm class=AppVM state=Running\n' \
b'other-vm class=AppVM state=Running\n'
# some-vm fails first attempt, succeeds on retry
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00', \
b'0\x00'
]
# other-vm fails first and second attempt, succeeds on retry
self.app.expected_calls[
('other-vm', 'admin.vm.Shutdown', 'wait', None)] = [
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00', \
b'2\x00QubesVMInUseError\x00\x00Denied as qube is in use\x00',
b'0\x00',
]
qubesadmin.tools.qvm_shutdown.main(
['--wait', 'some-vm', 'other-vm'], app=self.app)
self.assertAllCalled()
[docs]
def test_013_wait_all_shutdown_fail(self):
'''test --wait exits with error when all shutdown requests fail'''
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n'
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'wait', None)] = \
b'2\x00QubesException\x00\x00Shutdown refused\x00'
with self.assertRaises(SystemExit) as cmg:
qubesadmin.tools.qvm_shutdown.main(
['--wait', 'some-vm'], app=self.app)
self.assertEqual(cmg.exception.code, 1)
self.assertAllCalled()
[docs]
def test_014_timeout_deprecated_means_wait(self):
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n'
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'wait', None)] = \
b'2\x00QubesVMShutdownTimeoutError\x00\x00Shutdown timed out\x00'
self.app.expected_calls[
('some-vm', 'admin.vm.Kill', None, None)] = \
b'2\x00QubesException\x00\x00Kill failed\x00'
with self.assertRaises(SystemExit) as cmg:
qubesadmin.tools.qvm_shutdown.main(
['--timeout=3', 'some-vm'], app=self.app)
self.assertEqual(cmg.exception.code, 1)
self.assertAllCalled()
[docs]
def test_016_wait_kill_exception(self):
'''test --wait timeout where kill raises QubesException'''
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
self.app.expected_calls[
('dom0', 'admin.vm.List', None, None)] = \
b'0\x00some-vm class=AppVM state=Running\n'
self.app.expected_calls[
('some-vm', 'admin.vm.Shutdown', 'wait', None)] = \
b'2\x00QubesVMShutdownTimeoutError\x00\x00Shutdown timed out\x00'
self.app.expected_calls[
('some-vm', 'admin.vm.Kill', None, None)] = \
b'2\x00QubesException\x00\x00Kill failed\x00'
with self.assertRaises(SystemExit) as cmg:
qubesadmin.tools.qvm_shutdown.main(
['--wait', 'some-vm'], app=self.app)
self.assertEqual(cmg.exception.code, 1)
self.assertAllCalled()