#!/usr/bin/python # vim: fileencoding=utf-8 # # The Qubes OS Project, https://www.qubes-os.org/ # # Copyright (C) 2014-2015 # Marek Marczykowski-Górecki # Copyright (C) 2015 Wojtek Porczyk # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU 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 General Public License for more details. # # You should have received a copy of the GNU General Public License along # with this program; if not, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # import multiprocessing import os import shutil import subprocess import tempfile import unittest import time import libvirt import qubes import qubes.vm.qubesvm import qubes.vm.appvm import qubes.vm.templatevm import qubes.tests class TC_00_Basic(qubes.tests.SystemTestsMixin, qubes.tests.QubesTestCase): def setUp(self): super(TC_00_Basic, self).setUp() self.init_default_template() def test_000_qubes_create(self): self.assertIsInstance(self.app, qubes.Qubes) def test_001_qvm_create_default_template(self): self.app.add_new_vm def test_100_qvm_create(self): vmname = self.make_vm_name('appvm') vm = self.app.add_new_vm(qubes.vm.appvm.AppVM, name=vmname, template=self.app.default_template, label='red' ) self.assertIsNotNone(vm) self.assertEqual(vm.name, vmname) self.assertEqual(vm.template, self.app.default_template) vm.create_on_disk() with self.assertNotRaises(qubes.exc.QubesException): vm.verify_files() class TC_01_Properties(qubes.tests.SystemTestsMixin, qubes.tests.QubesTestCase): def setUp(self): super(TC_01_Properties, self).setUp() self.init_default_template() self.vmname = self.make_vm_name('appvm') self.vm = self.app.add_new_vm(qubes.vm.appvm.AppVM, name=self.vmname, label='red') self.vm.create_on_disk() def save_and_reload_db(self): super(TC_01_Properties, self).save_and_reload_db() if hasattr(self, 'vm'): self.vm = self.app.domains[self.vm.qid] if hasattr(self, 'netvm'): self.netvm = self.app[self.netvm.qid] def test_000_rename(self): newname = self.make_vm_name('newname') self.assertEqual(self.vm.name, self.vmname) self.vm.write_firewall_conf({'allow': False, 'allowDns': False}) self.vm.autostart = True self.addCleanup(os.system, 'sudo systemctl -q disable qubes-vm@{}.service || :'. format(self.vmname)) pre_rename_firewall = self.vm.get_firewall_conf() with self.assertNotRaises( (OSError, libvirt.libvirtError, qubes.exc.QubesException)): self.vm.name = newname self.assertEqual(self.vm.name, newname) self.assertEqual(self.vm.dir_path, os.path.join(qubes.config.system_path['qubes_appvms_dir'], newname)) self.assertEqual(self.vm.conf_file, os.path.join(self.vm.dir_path, newname + '.conf')) self.assertTrue(os.path.exists( os.path.join(self.vm.dir_path, "apps", newname + "-vm.directory"))) # FIXME: set whitelisted-appmenus.list first self.assertTrue(os.path.exists( os.path.join(self.vm.dir_path, "apps", newname + "-firefox.desktop"))) self.assertTrue(os.path.exists( os.path.join(os.getenv("HOME"), ".local/share/desktop-directories", newname + "-vm.directory"))) self.assertTrue(os.path.exists( os.path.join(os.getenv("HOME"), ".local/share/applications", newname + "-firefox.desktop"))) self.assertFalse(os.path.exists( os.path.join(os.getenv("HOME"), ".local/share/desktop-directories", self.vmname + "-vm.directory"))) self.assertFalse(os.path.exists( os.path.join(os.getenv("HOME"), ".local/share/applications", self.vmname + "-firefox.desktop"))) self.assertEquals(pre_rename_firewall, self.vm.get_firewall_conf()) with self.assertNotRaises((qubes.exc.QubesException, OSError)): self.vm.write_firewall_conf({'allow': False}) self.assertTrue(self.vm.autostart) self.assertTrue(os.path.exists( '/etc/systemd/system/multi-user.target.wants/' 'qubes-vm@{}.service'.format(newname))) self.assertFalse(os.path.exists( '/etc/systemd/system/multi-user.target.wants/' 'qubes-vm@{}.service'.format(self.vmname))) def test_001_rename_libvirt_undefined(self): self.vm.libvirt_domain.undefine() self.vm._libvirt_domain = None newname = self.make_vm_name('newname') with self.assertNotRaises( (OSError, libvirt.libvirtError, qubes.exc.QubesException)): self.vm.name = newname def test_030_clone(self): testvm1 = self.app.add_new_vm( qubes.vm.appvm.AppVM, name=self.make_vm_name("vm"), label='red') testvm1.create_on_disk() testvm2 = self.app.add_new_vm(testvm1.__class__, name=self.make_vm_name("clone"), template=testvm1.template, label='red', ) testvm2.clone_properties(testvm1) testvm2.clone_disk_files(testvm1) # qubes.xml reload self.save_and_reload_db() testvm1 = self.app.domains[testvm1.qid] testvm2 = self.app.domains[testvm2.qid] self.assertEquals(testvm1.label, testvm2.label) self.assertEquals(testvm1.netvm, testvm2.netvm) self.assertEquals(testvm1.property_is_default('netvm'), testvm2.property_is_default('netvm')) self.assertEquals(testvm1.kernel, testvm2.kernel) self.assertEquals(testvm1.kernelopts, testvm2.kernelopts) self.assertEquals(testvm1.property_is_default('kernel'), testvm2.property_is_default('kernel')) self.assertEquals(testvm1.property_is_default('kernelopts'), testvm2.property_is_default('kernelopts')) self.assertEquals(testvm1.memory, testvm2.memory) self.assertEquals(testvm1.maxmem, testvm2.maxmem) # TODO # self.assertEquals(testvm1.pcidevs, testvm2.pcidevs) self.assertEquals(testvm1.include_in_backups, testvm2.include_in_backups) self.assertEquals(testvm1.default_user, testvm2.default_user) self.assertEquals(testvm1.features, testvm2.features) self.assertEquals(testvm1.get_firewall_conf(), testvm2.get_firewall_conf()) # now some non-default values testvm1.netvm = None testvm1.label = 'orange' testvm1.memory = 512 firewall = testvm1.get_firewall_conf() firewall['allowDns'] = False firewall['allowYumProxy'] = False firewall['rules'] = [{'address': '1.2.3.4', 'netmask': 24, 'proto': 'tcp', 'portBegin': 22, 'portEnd': 22, }] testvm1.write_firewall_conf(firewall) testvm3 = self.app.add_new_vm(testvm1.__class__, name=self.make_vm_name("clone2"), template=testvm1.template, label='red', ) testvm3.clone_properties(testvm1) testvm3.clone_disk_files(testvm1) # qubes.xml reload self.save_and_reload_db() testvm1 = self.app.domains[testvm1.qid] testvm3 = self.app.domains[testvm3.qid] self.assertEquals(testvm1.label, testvm3.label) self.assertEquals(testvm1.netvm, testvm3.netvm) self.assertEquals(testvm1.property_is_default('netvm'), testvm3.property_is_default('netvm')) self.assertEquals(testvm1.kernel, testvm3.kernel) self.assertEquals(testvm1.kernelopts, testvm3.kernelopts) self.assertEquals(testvm1.property_is_default('kernel'), testvm3.property_is_default('kernel')) self.assertEquals(testvm1.property_is_default('kernelopts'), testvm3.property_is_default('kernelopts')) self.assertEquals(testvm1.memory, testvm3.memory) self.assertEquals(testvm1.maxmem, testvm3.maxmem) # TODO # self.assertEquals(testvm1.pcidevs, testvm3.pcidevs) self.assertEquals(testvm1.include_in_backups, testvm3.include_in_backups) self.assertEquals(testvm1.default_user, testvm3.default_user) self.assertEquals(testvm1.features, testvm3.features) self.assertEquals(testvm1.get_firewall_conf(), testvm3.get_firewall_conf()) def test_020_name_conflict_app(self): # TODO decide what exception should be here with self.assertRaises((qubes.exc.QubesException, ValueError)): self.vm2 = self.app.add_new_vm(qubes.vm.appvm.AppVM, name=self.vmname, template=self.app.default_template) self.vm2.create_on_disk() def test_021_name_conflict_template(self): # TODO decide what exception should be here with self.assertRaises((qubes.exc.QubesException, ValueError)): self.vm2 = self.app.add_new_vm(qubes.vm.templatevm.TemplateVM, name=self.vmname) self.vm2.create_on_disk() def test_030_rename_conflict_app(self): vm2name = self.make_vm_name('newname') self.vm2 = self.app.add_new_vm(qubes.vm.appvm.AppVM, name=vm2name, template=self.app.default_template, label='red') self.vm2.create_on_disk() with self.assertNotRaises(OSError): with self.assertRaises(qubes.exc.QubesException): self.vm2.name = self.vmname class TC_02_QvmPrefs(qubes.tests.SystemTestsMixin, qubes.tests.QubesTestCase): def setUp(self): super(TC_02_QvmPrefs, self).setUp() self.init_default_template() self.sharedopts = ['--qubesxml', qubes.tests.XMLPATH] def setup_appvm(self): self.testvm = self.app.add_new_vm( qubes.vm.appvm.AppVM, name=self.make_vm_name("vm"), label='red') self.testvm.create_on_disk() self.save_and_reload_db() def setup_hvm(self): self.testvm = self.app.add_new_vm( qubes.vm.appvm.AppVM, name=self.make_vm_name("hvm"), label='red') self.testvm.hvm = True self.testvm.create_on_disk() self.save_and_reload_db() def pref_set(self, name, value, valid=True): p = subprocess.Popen( ['qvm-prefs'] + self.sharedopts + (['--'] if value != '-D' else []) + [self.testvm.name, name, value], stdout=subprocess.PIPE, stderr=subprocess.PIPE, ) (stdout, stderr) = p.communicate() if valid: self.assertEquals(p.returncode, 0, "qvm-prefs .. '{}' '{}' failed: {}{}".format( name, value, stdout, stderr )) else: self.assertNotEquals(p.returncode, 0, "qvm-prefs should reject value '{}' for " "property '{}'".format(value, name)) def pref_get(self, name): p = subprocess.Popen(['qvm-prefs'] + self.sharedopts + ['--', self.testvm.name, name], stdout=subprocess.PIPE) (stdout, _) = p.communicate() self.assertEquals(p.returncode, 0) return stdout.strip() bool_test_values = [ ('true', 'True', True), ('False', 'False', True), ('0', 'False', True), ('1', 'True', True), ('invalid', '', False) ] def execute_tests(self, name, values): """ Helper function, which executes tests for given property. :param values: list of tuples (value, expected, valid), where 'value' is what should be set and 'expected' is what should qvm-prefs returns as a property value and 'valid' marks valid and invalid values - if it's False, qvm-prefs should reject the value :return: None """ for (value, expected, valid) in values: self.pref_set(name, value, valid) if valid: self.assertEquals(self.pref_get(name), expected) @unittest.skip('test not converted to core3 API') def test_006_template(self): templates = [tpl for tpl in self.app.domains.values() if tpl.is_template()] if not templates: self.skipTest("No templates installed") some_template = templates[0].name self.setup_appvm() self.execute_tests('template', [ (some_template, some_template, True), ('invalid', '', False), ]) @unittest.skip('test not converted to core3 API') def test_014_pcidevs(self): self.setup_appvm() self.execute_tests('pcidevs', [ ('[]', '[]', True), ('[ "00:00.0" ]', "['00:00.0']", True), ('invalid', '', False), ('[invalid]', '', False), # TODO: #('["12:12.0"]', '', False) ]) @unittest.skip('test not converted to core3 API') def test_024_pv_reject_hvm_props(self): self.setup_appvm() self.execute_tests('guiagent_installed', [('False', '', False)]) self.execute_tests('qrexec_installed', [('False', '', False)]) self.execute_tests('drive', [('/tmp/drive.img', '', False)]) self.execute_tests('timezone', [('localtime', '', False)]) @unittest.skip('test not converted to core3 API') def test_025_hvm_reject_pv_props(self): self.setup_hvm() self.execute_tests('kernel', [('default', '', False)]) self.execute_tests('kernelopts', [('default', '', False)]) class TC_03_QvmRevertTemplateChanges(qubes.tests.SystemTestsMixin, qubes.tests.QubesTestCase): def setUp(self): super(TC_03_QvmRevertTemplateChanges, self).setUp() self.init_default_template() def setup_pv_template(self): self.test_template = self.app.add_new_vm( qubes.vm.templatevm.TemplateVM, name=self.make_vm_name("pv-clone"), label='red' ) self.test_template.clone_properties(self.app.default_template) self.test_template.clone_disk_files(self.app.default_template) self.save_and_reload_db() def setup_hvm_template(self): self.test_template = self.app.add_new_vm( qubes.vm.templatevm.TemplateVM, name=self.make_vm_name("hvm"), label='red', hvm=True ) self.test_template.create_on_disk() self.save_and_reload_db() def get_rootimg_checksum(self): p = subprocess.Popen(['sha1sum', self.test_template.root_img], stdout=subprocess.PIPE) return p.communicate()[0] def _do_test(self): checksum_before = self.get_rootimg_checksum() self.test_template.start() self.shutdown_and_wait(self.test_template) checksum_changed = self.get_rootimg_checksum() if checksum_before == checksum_changed: self.log.warning("template not modified, test result will be " "unreliable") with self.assertNotRaises(subprocess.CalledProcessError): subprocess.check_call(['sudo', 'qvm-revert-template-changes', '--force', self.test_template.name]) checksum_after = self.get_rootimg_checksum() self.assertEquals(checksum_before, checksum_after) def test_000_revert_pv(self): """ Test qvm-revert-template-changes for PV template """ self.setup_pv_template() self._do_test() @unittest.skip('HVM not yet implemented') def test_000_revert_hvm(self): """ Test qvm-revert-template-changes for HVM template """ # TODO: have some system there, so the root.img will get modified self.setup_hvm_template() self._do_test() class TC_04_DispVM(qubes.tests.SystemTestsMixin, qubes.tests.QubesTestCase): def setUp(self): self.skipTest('DisposableVMs not implemented in core3 yet') super(TC_04_DispVM, self).setUp() self.init_default_template() disp_tpl = self.host_app.domains[self.get_dispvm_template_name()] self.disp_tpl = self.app.add_new_vm(disp_tpl.__class__, name=disp_tpl.name, template=disp_tpl.template, label='red' ) self.app.save() @staticmethod def get_dispvm_template_name(): # FIXME: currently qubes.xml doesn't contain this information... vmdir = os.readlink('/var/lib/qubes/dvmdata/vmdir') return os.path.basename(vmdir) def test_000_firewall_propagation(self): """ Check firewall propagation VM->DispVM, when VM have some firewall rules """ testvm1 = self.app.add_new_vm(qubes.vm.appvm.AppVM, name=self.make_vm_name('vm1'), label='red') testvm1.create_on_disk() firewall = testvm1.get_firewall_conf() firewall['allowDns'] = False firewall['allowYumProxy'] = False firewall['rules'] = [{'address': '1.2.3.4', 'netmask': 24, 'proto': 'tcp', 'portBegin': 22, 'portEnd': 22, }] testvm1.write_firewall_conf(firewall) self.app.save() testvm1.start() p = testvm1.run("qvm-run --dispvm 'qubesdb-read /name; echo ERROR;" " read x'", passio_popen=True) dispvm_name = p.stdout.readline().strip() self.reload_db() dispvm = self.app.domains[dispvm_name] self.assertIsNotNone(dispvm, "DispVM {} not found in qubes.xml".format( dispvm_name)) # check if firewall was propagated to the DispVM self.assertEquals(testvm1.get_firewall_conf(), dispvm.get_firewall_conf()) # and only there (#1608) self.assertNotEquals(self.disp_tpl.get_firewall_conf(), dispvm.get_firewall_conf()) # then modify some rule firewall = dispvm.get_firewall_conf() firewall['rules'] = [{'address': '4.3.2.1', 'netmask': 24, 'proto': 'tcp', 'portBegin': 22, 'portEnd': 22, }] dispvm.write_firewall_conf(firewall) # and check again if wasn't saved anywhere else (#1608) self.assertNotEquals(self.disp_tpl.get_firewall_conf(), dispvm.get_firewall_conf()) self.assertNotEquals(testvm1.get_firewall_conf(), dispvm.get_firewall_conf()) p.stdin.write('\n') p.wait() def test_001_firewall_propagation(self): """ Check firewall propagation VM->DispVM, when VM have no firewall rules """ testvm1 = self.app.add_new_vm(qubes.vm.appvm.AppVM, name=self.make_vm_name('vm1'), label='red') testvm1.create_on_disk() self.app.save() original_firewall = None if os.path.exists(self.disp_tpl.firewall_conf): original_firewall = tempfile.TemporaryFile() with open(self.disp_tpl.firewall_conf) as f: original_firewall.write(f.read()) try: firewall = self.disp_tpl.get_firewall_conf() firewall['allowDns'] = False firewall['allowYumProxy'] = False firewall['rules'] = [{'address': '1.2.3.4', 'netmask': 24, 'proto': 'tcp', 'portBegin': 22, 'portEnd': 22, }] self.disp_tpl.write_firewall_conf(firewall) testvm1.start() p = testvm1.run("qvm-run --dispvm 'qubesdb-read /name; echo ERROR;" " read x'", passio_popen=True) dispvm_name = p.stdout.readline().strip() self.reload_db() dispvm = self.app.domains[dispvm_name] self.assertIsNotNone(dispvm, "DispVM {} not found in qubes.xml".format( dispvm_name)) # check if firewall was propagated to the DispVM from the right VM self.assertEquals(testvm1.get_firewall_conf(), dispvm.get_firewall_conf()) # and only there (#1608) self.assertNotEquals(self.disp_tpl.get_firewall_conf(), dispvm.get_firewall_conf()) # then modify some rule firewall = dispvm.get_firewall_conf() firewall['rules'] = [{'address': '4.3.2.1', 'netmask': 24, 'proto': 'tcp', 'portBegin': 22, 'portEnd': 22, }] dispvm.write_firewall_conf(firewall) # and check again if wasn't saved anywhere else (#1608) self.assertNotEquals(self.disp_tpl.get_firewall_conf(), dispvm.get_firewall_conf()) self.assertNotEquals(testvm1.get_firewall_conf(), dispvm.get_firewall_conf()) p.stdin.write('\n') p.wait() finally: if original_firewall: original_firewall.seek(0) with open(self.disp_tpl.firewall_conf, 'w') as f: f.write(original_firewall.read()) original_firewall.close() else: os.unlink(self.disp_tpl.firewall_conf) def test_002_cleanup(self): p = subprocess.Popen(['/usr/lib/qubes/qfile-daemon-dvm', 'qubes.VMShell', 'dom0', 'DEFAULT'], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=open(os.devnull, 'w')) (stdout, _) = p.communicate(input="echo test; qubesdb-read /name; " "echo ERROR\n") self.assertEquals(p.returncode, 0) lines = stdout.splitlines() self.assertEqual(lines[0], "test") dispvm_name = lines[1] self.reload_db() dispvm = self.app.domains[dispvm_name] self.assertIsNone(dispvm, "DispVM {} still exists in qubes.xml".format( dispvm_name)) def test_003_cleanup_destroyed(self): """ Check if DispVM is properly removed even if it terminated itself (#1660) :return: """ p = subprocess.Popen(['/usr/lib/qubes/qfile-daemon-dvm', 'qubes.VMShell', 'dom0', 'DEFAULT'], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=open(os.devnull, 'w')) p.stdin.write("qubesdb-read /name\n") p.stdin.write("echo ERROR\n") p.stdin.write("poweroff\n") # do not close p.stdin on purpose - wait to automatic disconnect when # domain is destroyed timeout = 30 while timeout > 0: if p.poll(): break time.sleep(1) timeout -= 1 # includes check for None - timeout self.assertEquals(p.returncode, 0) lines = p.stdout.read().splitlines() dispvm_name = lines[0] self.assertNotEquals(dispvm_name, "ERROR") self.reload_db() dispvm = self.app.domains[dispvm_name] self.assertIsNone(dispvm, "DispVM {} still exists in qubes.xml".format( dispvm_name)) # vim: ts=4 sw=4 et