Skip to content

Handle global disposable preload feature #686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marmarek merged 1 commit into from
Jul 4, 2025
Merged

Handle global disposable preload feature #686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions qubes/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1732,9 +1732,12 @@ def on_property_set_default_netvm(
"property-reset:netvm", name="netvm", oldvalue=oldvalue
)

@qubes.events.handler("property-set:default_dispvm")
@qubes.events.handler(
"property-set:default_dispvm",
"property-reset:default_dispvm",
)
def on_property_set_default_dispvm(
self, event, name, newvalue, oldvalue=None
self, event, name, newvalue=None, oldvalue=None
):
# pylint: disable=unused-argument
for vm in self.domains:
Expand All @@ -1749,6 +1752,39 @@ def on_property_set_default_dispvm(
oldvalue=oldvalue,
)

if not newvalue:
newvalue = self.default_dispvm
if newvalue == oldvalue:
return
old_appvm = None
appvm = None
if oldvalue:
old_appvm = self.domains[oldvalue]
if newvalue:
appvm = self.domains[newvalue]
if (
old_appvm
and old_appvm.get_feat_global_preload_max() is not None
and old_appvm.is_global_preload_distinct()
):
reason = "it was the default_dispvm"
asyncio.ensure_future(
old_appvm.fire_event_async(
"domain-preload-dispvm-start", reason=reason
)
)
if (
appvm
and appvm.get_feat_global_preload_max() is not None
and appvm.is_global_preload_distinct()
):
reason = "it became the default_dispvm"
asyncio.ensure_future(
appvm.fire_event_async(
"domain-preload-dispvm-start", reason=reason
)
)

@qubes.events.handler("property-pre-set:default_kernel")
# pylint: disable-next=invalid-name
def on_property_pre_set_default_kernel(
Expand Down
128 changes: 116 additions & 12 deletions qubes/tests/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,13 +689,6 @@ def test_101_property_migrate_label(self):


class TC_90_Qubes(qubes.tests.QubesTestCase):
def tearDown(self):
try:
os.unlink("/tmp/qubestest.xml")
except:
pass
super().tearDown()

def setUp(self):
super(TC_90_Qubes, self).setUp()
self.app = qubes.Qubes(
Expand All @@ -707,12 +700,43 @@ def setUp(self):
self.template = self.app.add_new_vm(
"TemplateVM", name="test-template", label="green"
)
self.template.features["qrexec"] = True
self.template.features["supported-rpc.qubes.WaitForRunningSystem"] = (
True
)
self.appvm = self.app.add_new_vm(
"AppVM",
name="test-dvm",
template=self.template,
label="red",
)
self.appvm_alt = self.app.add_new_vm(
qubes.vm.appvm.AppVM,
name="test-alt-dvm",
template=self.template,
label="red",
)
for qube in [self.appvm, self.appvm_alt]:
qube.features["gui"] = False
qube.template_for_dispvms = True
self.app.save()
self.emitter = qubes.tests.TestEmitter()

def tearDown(self):
try:
os.unlink("/tmp/qubestest.xml")
except:
pass
del self.emitter
super().tearDown()

def cleanup_qubes(self):
self.app.close()
del self.app
try:
del self.template
del self.appvm
del self.appvm_alt
except AttributeError:
pass

Expand Down Expand Up @@ -932,11 +956,7 @@ def test_116_remotevm_add_and_remove(self):

assert remotevm1 in self.app.domains
del self.app.domains["remote-vm1"]

self.assertCountEqual(
{d.name for d in self.app.domains},
{"dom0", "test-template", "test-vm", "remote-vm2"},
)
assert "remote-vm1" not in self.app.domains

def test_117_remotevm_status(self):
remotevm1 = self.app.add_new_vm(
Expand Down Expand Up @@ -1096,6 +1116,90 @@ def test_207_default_kernel(self):
existence.side_effect = [True, False]
self.app.default_kernel = "unittest_GNU_Hurd_1.0.0"

def test_300_preload_default_dispvm(self):
"""Fire event for new setting from no previous one."""
self.appvm.features["preload-dispvm-max"] = "1"
with mock.patch.object(self.appvm, "fire_event_async") as mock_events:
self.app.default_dispvm = self.appvm
mock_events.assert_not_called()

self.app.default_dispvm = None
del self.appvm.features["preload-dispvm-max"]
self.app.domains["dom0"].features["preload-dispvm-max"] = "1"
with mock.patch.object(self.appvm, "fire_event_async") as mock_events:
self.app.default_dispvm = self.appvm
mock_events.assert_called_once_with(
"domain-preload-dispvm-start", reason=mock.ANY
)

def test_301_preload_default_dispvm_change(self):
"""Fire event for old and new setting."""
self.appvm.features["preload-dispvm-max"] = "1"
self.app.default_dispvm = self.appvm
self.appvm_alt.features["preload-dispvm-max"] = "1"
# Global is not set and thus there are no events.
with mock.patch.object(
self.appvm, "fire_event_async"
) as mock_old, mock.patch.object(
self.appvm_alt, "fire_event_async"
) as mock_new:
self.app.default_dispvm = self.appvm_alt
mock_old.assert_not_called()
mock_new.assert_not_called()

self.app.domains["dom0"].features["preload-dispvm-max"] = "1"
self.app.default_dispvm = self.appvm
self.appvm.features["preload-dispvm-max"] = "2"
self.appvm_alt.features["preload-dispvm-max"] = "2"
with mock.patch.object(
self.appvm, "fire_event_async"
) as mock_old, mock.patch.object(
self.appvm_alt, "fire_event_async"
) as mock_new:
self.app.default_dispvm = self.appvm_alt
mock_old.assert_called_once_with(
"domain-preload-dispvm-start", reason=mock.ANY
)
mock_new.assert_called_once_with(
"domain-preload-dispvm-start", reason=mock.ANY
)

def test_302_preload_default_dispvm_change_noop(self):
"""If global feature has the same value as the new and old setting,
don't fire the event.
"""
self.appvm.features["preload-dispvm-max"] = "1"
self.appvm_alt.features["preload-dispvm-max"] = "1"
self.app.domains["dom0"].features["preload-dispvm-max"] = "1"
self.app.default_dispvm = self.appvm
with mock.patch.object(
self.appvm, "fire_event_async"
) as mock_old, mock.patch.object(
self.appvm_alt, "fire_event_async"
) as mock_new:
self.app.default_dispvm = self.appvm_alt
mock_old.assert_not_called()
mock_new.assert_not_called()

def test_303_preload_default_dispvm_change_partial_noop(self):
"""If global feature has the same value as the new or old setting,
don't fire the event.
"""
self.appvm.features["preload-dispvm-max"] = "2"
self.appvm_alt.features["preload-dispvm-max"] = "1"
self.app.domains["dom0"].features["preload-dispvm-max"] = "2"
self.app.default_dispvm = self.appvm
with mock.patch.object(
self.appvm, "fire_event_async"
) as mock_old, mock.patch.object(
self.appvm_alt, "fire_event_async"
) as mock_new:
self.app.default_dispvm = self.appvm_alt
mock_old.assert_not_called()
mock_new.assert_called_once_with(
"domain-preload-dispvm-start", reason=mock.ANY
)

@qubes.tests.skipUnlessGit
def test_900_example_xml_in_doc(self):
self.assertXMLIsValid(
Expand Down
Loading