123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381 |
- # -*- 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 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 os
- import shutil
- import socket
- import subprocess
- import tempfile
- import unittest
- import multiprocessing
- try:
- import unittest.mock as mock
- except ImportError:
- import mock
- import qubesadmin.tests
- class TC_00_VMCollection(qubesadmin.tests.QubesTestCase):
- def test_000_list(self):
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00test-vm class=AppVM state=Running\n'
- self.assertEqual(
- list(self.app.domains.keys()),
- ['test-vm'])
- self.assertAllCalled()
- def test_001_getitem(self):
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00test-vm class=AppVM state=Running\n'
- try:
- vm = self.app.domains['test-vm']
- self.assertEqual(vm.name, 'test-vm')
- except KeyError:
- self.fail('VM not found in collection')
- self.assertAllCalled()
- with self.assertRaises(KeyError):
- vm = self.app.domains['test-non-existent']
- self.assertAllCalled()
- def test_002_in(self):
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00test-vm class=AppVM state=Running\n'
- self.assertIn('test-vm', self.app.domains)
- self.assertAllCalled()
- self.assertNotIn('test-non-existent', self.app.domains)
- self.assertAllCalled()
- def test_003_iter(self):
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00test-vm class=AppVM state=Running\n'
- self.assertEqual([vm.name for vm in self.app.domains], ['test-vm'])
- self.assertAllCalled()
- def test_004_delitem(self):
- self.app.expected_calls[('test-vm', 'admin.vm.Remove', None, None)] = \
- b'0\x00'
- del self.app.domains['test-vm']
- self.assertAllCalled()
- class TC_10_QubesBase(qubesadmin.tests.QubesTestCase):
- def test_010_new_simple(self):
- self.app.expected_calls[('dom0', 'admin.vm.Create.AppVM', None,
- b'name=new-vm label=red')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-vm class=AppVM state=Running\n'
- vm = self.app.add_new_vm('AppVM', 'new-vm', 'red')
- self.assertEqual(vm.name, 'new-vm')
- self.assertEqual(vm.__class__.__name__, 'AppVM')
- self.assertAllCalled()
- def test_011_new_template(self):
- self.app.expected_calls[('dom0', 'admin.vm.Create.TemplateVM', None,
- b'name=new-template label=red')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-template class=TemplateVM state=Running\n'
- vm = self.app.add_new_vm('TemplateVM', 'new-template', 'red')
- self.assertEqual(vm.name, 'new-template')
- self.assertEqual(vm.__class__.__name__, 'TemplateVM')
- self.assertAllCalled()
- def test_012_new_template_based(self):
- self.app.expected_calls[('dom0', 'admin.vm.Create.AppVM',
- 'some-template', b'name=new-vm label=red')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-vm class=AppVM state=Running\n'
- vm = self.app.add_new_vm('AppVM', 'new-vm', 'red', 'some-template')
- self.assertEqual(vm.name, 'new-vm')
- self.assertEqual(vm.__class__.__name__, 'AppVM')
- self.assertAllCalled()
- def test_013_new_objects_params(self):
- self.app.expected_calls[('dom0', 'admin.vm.Create.AppVM',
- 'some-template', b'name=new-vm label=red')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.label.List', None, None)] = \
- b'0\x00red\nblue\n'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-vm class=AppVM state=Running\n' \
- b'some-template class=TemplateVM state=Running\n'
- vm = self.app.add_new_vm(self.app.get_vm_class('AppVM'), 'new-vm',
- self.app.get_label('red'), self.app.domains['some-template'])
- self.assertEqual(vm.name, 'new-vm')
- self.assertEqual(vm.__class__.__name__, 'AppVM')
- self.assertAllCalled()
- def test_014_new_pool(self):
- self.app.expected_calls[('dom0', 'admin.vm.CreateInPool.AppVM', None,
- b'name=new-vm label=red pool=some-pool')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-vm class=AppVM state=Running\n'
- vm = self.app.add_new_vm('AppVM', 'new-vm', 'red', pool='some-pool')
- self.assertEqual(vm.name, 'new-vm')
- self.assertEqual(vm.__class__.__name__, 'AppVM')
- self.assertAllCalled()
- def test_015_new_pools(self):
- self.app.expected_calls[('dom0', 'admin.vm.CreateInPool.AppVM', None,
- b'name=new-vm label=red pool:private=some-pool '
- b'pool:volatile=other-pool')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-vm class=AppVM state=Running\n'
- vm = self.app.add_new_vm('AppVM', 'new-vm', 'red',
- pools={'private': 'some-pool', 'volatile': 'other-pool'})
- self.assertEqual(vm.name, 'new-vm')
- self.assertEqual(vm.__class__.__name__, 'AppVM')
- self.assertAllCalled()
- def test_020_get_label(self):
- self.app.expected_calls[('dom0', 'admin.label.List', None, None)] = \
- b'0\x00red\nblue\n'
- label = self.app.get_label('red')
- self.assertEqual(label.name, 'red')
- self.assertAllCalled()
- def test_030_clone(self):
- self.app.expected_calls[('test-vm', 'admin.vm.Clone', None,
- b'name=new-name')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-name class=AppVM state=Halted\n' \
- b'test-vm class=AppVM state=Halted\n'
- new_vm = self.app.clone_vm('test-vm', 'new-name')
- self.assertEqual(new_vm.name, 'new-name')
- self.assertAllCalled()
- def test_031_clone_object(self):
- self.app.expected_calls[('test-vm', 'admin.vm.Clone', None,
- b'name=new-name')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-name class=AppVM state=Halted\n' \
- b'test-vm class=AppVM state=Halted\n'
- new_vm = self.app.clone_vm(self.app.domains['test-vm'], 'new-name')
- self.assertEqual(new_vm.name, 'new-name')
- self.assertAllCalled()
- def test_032_clone_pool(self):
- self.app.expected_calls[('test-vm', 'admin.vm.CloneInPool', None,
- b'name=new-name pool=some-pool')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-name class=AppVM state=Halted\n' \
- b'test-vm class=AppVM state=Halted\n'
- new_vm = self.app.clone_vm('test-vm', 'new-name', pool='some-pool')
- self.assertEqual(new_vm.name, 'new-name')
- self.assertAllCalled()
- def test_033_clone_pools(self):
- self.app.expected_calls[('test-vm', 'admin.vm.CloneInPool', None,
- b'name=new-name pool:private=some-pool '
- b'pool:volatile=other-pool')] = b'0\x00'
- self.app.expected_calls[('dom0', 'admin.vm.List', None, None)] = \
- b'0\x00new-name class=AppVM state=Halted\n' \
- b'test-vm class=AppVM state=Halted\n'
- new_vm = self.app.clone_vm('test-vm', 'new-name',
- pools={'private': 'some-pool', 'volatile': 'other-pool'})
- self.assertEqual(new_vm.name, 'new-name')
- self.assertAllCalled()
- class TC_20_QubesLocal(unittest.TestCase):
- def setUp(self):
- super(TC_20_QubesLocal, self).setUp()
- self.socket_dir = tempfile.mkdtemp()
- self.orig_sock = qubesadmin.config.QUBESD_SOCKET
- qubesadmin.config.QUBESD_SOCKET = os.path.join(self.socket_dir, 'sock')
- self.proc = None
- self.app = qubesadmin.app.QubesLocal()
- def listen_and_send(self, send_data):
- '''Listen on socket and send data in response.
- :param bytes send_data: data to send
- '''
- self.socket_pipe, child_pipe = multiprocessing.Pipe()
- self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
- self.socket.bind(os.path.join(self.socket_dir, 'sock'))
- self.socket.listen(1)
- def worker(sock, pipe, send_data_):
- conn, addr = sock.accept()
- pipe.send(conn.makefile('rb').read())
- conn.sendall(send_data_)
- conn.close()
- self.proc = multiprocessing.Process(target=worker,
- args=(self.socket, child_pipe, send_data))
- self.proc.start()
- self.socket.close()
- def get_request(self):
- '''Get request sent to "qubesd" mock'''
- return self.socket_pipe.recv()
- def tearDown(self):
- qubesadmin.config.QUBESD_SOCKET = self.orig_sock
- if self.proc is not None:
- try:
- self.proc.terminate()
- except OSError:
- pass
- shutil.rmtree(self.socket_dir)
- super(TC_20_QubesLocal, self).tearDown()
- def test_000_qubesd_call(self):
- self.listen_and_send(b'0\0')
- self.app.qubesd_call('test-vm', 'some.method', 'arg1', b'payload')
- self.assertEqual(self.get_request(),
- b'dom0\0some.method\0test-vm\0arg1\0payload')
- def test_001_qubesd_call_none_arg(self):
- self.listen_and_send(b'0\0')
- self.app.qubesd_call('test-vm', 'some.method', None, b'payload')
- self.assertEqual(self.get_request(),
- b'dom0\0some.method\0test-vm\0\0payload')
- def test_002_qubesd_call_none_payload(self):
- self.listen_and_send(b'0\0')
- self.app.qubesd_call('test-vm', 'some.method', None, None)
- self.assertEqual(self.get_request(),
- b'dom0\0some.method\0test-vm\0\0')
- def test_010_run_service(self):
- self.listen_and_send(b'0\0')
- with mock.patch('subprocess.Popen') as mock_proc:
- p = self.app.run_service('some-vm', 'service.name')
- mock_proc.assert_called_once_with([
- qubesadmin.config.QREXEC_CLIENT,
- '-d', 'some-vm', 'DEFAULT:QUBESRPC service.name dom0'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE)
- self.assertEqual(self.get_request(),
- b'dom0\0admin.vm.Start\0some-vm\0\0')
- def test_011_run_service_filter_esc(self):
- self.listen_and_send(b'0\0')
- with mock.patch('subprocess.Popen') as mock_proc:
- p = self.app.run_service('some-vm', 'service.name', filter_esc=True)
- mock_proc.assert_called_once_with([
- qubesadmin.config.QREXEC_CLIENT,
- '-d', 'some-vm', '-t', '-T',
- 'DEFAULT:QUBESRPC service.name dom0'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE)
- self.assertEqual(self.get_request(),
- b'dom0\0admin.vm.Start\0some-vm\0\0')
- def test_012_run_service_user(self):
- self.listen_and_send(b'0\0')
- with mock.patch('subprocess.Popen') as mock_proc:
- p = self.app.run_service('some-vm', 'service.name', user='user')
- mock_proc.assert_called_once_with([
- qubesadmin.config.QREXEC_CLIENT,
- '-d', 'some-vm',
- 'user:QUBESRPC service.name dom0'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE)
- self.assertEqual(self.get_request(),
- b'dom0\0admin.vm.Start\0some-vm\0\0')
- def test_013_run_service_default_target(self):
- with self.assertRaises(ValueError):
- self.app.run_service('', 'service.name')
- class TC_30_QubesRemote(unittest.TestCase):
- def setUp(self):
- super(TC_30_QubesRemote, self).setUp()
- self.proc_mock = mock.Mock()
- self.proc_mock.configure_mock(**{
- 'return_value.returncode': 0
- })
- self.proc_patch = mock.patch('subprocess.Popen', self.proc_mock)
- self.proc_patch.start()
- self.app = qubesadmin.app.QubesRemote()
- def set_proc_stdout(self, send_data):
- self.proc_mock.configure_mock(**{
- 'return_value.communicate.return_value': (send_data, None)
- })
- def tearDown(self):
- self.proc_patch.stop()
- super(TC_30_QubesRemote, self).tearDown()
- def test_000_qubesd_call(self):
- self.set_proc_stdout(b'0\0')
- self.app.qubesd_call('test-vm', 'some.method', 'arg1', b'payload')
- self.assertEqual(self.proc_mock.mock_calls, [
- mock.call([qubesadmin.config.QREXEC_CLIENT_VM, 'test-vm',
- 'some.method+arg1'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE),
- mock.call().communicate(b'payload')
- ])
- def test_001_qubesd_call_none_arg(self):
- self.set_proc_stdout(b'0\0')
- self.app.qubesd_call('test-vm', 'some.method', None, b'payload')
- self.assertEqual(self.proc_mock.mock_calls, [
- mock.call([qubesadmin.config.QREXEC_CLIENT_VM, 'test-vm',
- 'some.method'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE),
- mock.call().communicate(b'payload')
- ])
- def test_002_qubesd_call_none_payload(self):
- self.set_proc_stdout(b'0\0')
- self.app.qubesd_call('test-vm', 'some.method', None, None)
- self.assertEqual(self.proc_mock.mock_calls, [
- mock.call([qubesadmin.config.QREXEC_CLIENT_VM, 'test-vm',
- 'some.method'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE),
- mock.call().communicate(None)
- ])
- def test_010_run_service(self):
- self.app.run_service('some-vm', 'service.name')
- self.proc_mock.assert_called_once_with([
- qubesadmin.config.QREXEC_CLIENT_VM,
- 'some-vm', 'service.name'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE)
- def test_011_run_service_filter_esc(self):
- with self.assertRaises(NotImplementedError):
- p = self.app.run_service('some-vm', 'service.name', filter_esc=True)
- def test_012_run_service_user(self):
- with self.assertRaises(ValueError):
- p = self.app.run_service('some-vm', 'service.name', user='user')
- def test_013_run_service_default_target(self):
- self.app.run_service('', 'service.name')
- self.proc_mock.assert_called_once_with([
- qubesadmin.config.QREXEC_CLIENT_VM,
- '', 'service.name'],
- stdin=subprocess.PIPE, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE)
|