Add handler for internal feature

For: QubesOS/qubes-issues#1512

Author: ben-grande

qubes_menu/tests/test_vmmanager.py

@@ -28,16 +28,20 @@
 def test_vm_manager(test_qapp):
     dispatcher = qubesadmin.events.EventsDispatcher(test_qapp)
     vm_manager = VMManager(test_qapp, dispatcher)
+    vm_name = "test-vm"
+    template_name = "fedora-36"
 
-    entry_test = vm_manager.load_vm_from_name("test-vm")
+    entry_test = vm_manager.load_vm_from_name(vm_name)
     assert entry_test
-    assert entry_test.vm_name == "test-vm"
+    assert entry_test.vm_name == vm_name
     assert entry_test.vm_icon_name == "appvm-green"
-    entry_template = vm_manager.load_vm_from_name("fedora-36")
+    entry_template = vm_manager.load_vm_from_name(template_name)
     assert entry_template
     assert not entry_template.has_network
+    assert not entry_template.internal
     assert not entry_test.is_dispvm_template
     assert not entry_test.service_vm
+    assert not entry_test.internal
 
     test_qapp._qubes["fedora-36"].properties["netvm"] = Property(
         "sys-firewall", "vm", False
@@ -53,44 +57,62 @@ def test_vm_manager(test_qapp):
     )
     assert entry_template.has_network
 
-    test_qapp._qubes["test-vm"].properties["label"] = Property(
+    test_qapp._qubes[vm_name].properties["label"] = Property(
         "red", "label", False
     )
-    test_qapp._qubes["test-vm"].properties["icon"] = Property(
+    test_qapp._qubes[vm_name].properties["icon"] = Property(
         "appvm-red", "str", False
     )
-    test_qapp._qubes["test-vm"].update_calls()
-
+    test_qapp._qubes[vm_name].update_calls()
     vm_manager._update_domain_property(
-        "test-vm",
+        vm_name,
         "property-set:label",
         name="label",
         newvalue="red",
         oldvalue="blue",
     )
     assert entry_test.vm_icon_name == "appvm-red"
 
-    test_qapp._qubes["test-vm"].properties["template_for_dispvms"] = Property(
+    test_qapp._qubes[vm_name].properties["template_for_dispvms"] = Property(
         "True", "bool", False
     )
-    test_qapp._qubes["test-vm"].update_calls()
-
+    test_qapp._qubes[vm_name].update_calls()
     vm_manager._update_domain_property(
-        "test-vm",
+        vm_name,
         "property-set:template_for_dispvms",
         name="template_for_dispvms",
         newvalue=True,
     )
     assert entry_test.is_dispvm_template
 
-    test_qapp._qubes["test-vm"].features["servicevm"] = 1
-    test_qapp._qubes["test-vm"].update_calls()
-
+    test_qapp._qubes[vm_name].features["servicevm"] = 1
+    test_qapp._qubes[vm_name].update_calls()
     vm_manager._update_domain_feature(
-        "test-vm", "feature-set:servicevm", feature="servicevm", value=1
+        vm_name, "feature-set:servicevm", feature="servicevm", value=1
     )
     assert entry_test.service_vm
 
+    test_qapp._qubes[vm_name].features["internal"] = 1
+    test_qapp._qubes[vm_name].update_calls()
+    vm_manager._update_domain_feature(
+        vm_name, "feature-set:internal", feature="internal", value=1
+    )
+    assert entry_test.internal
+
+    del test_qapp._qubes[vm_name].features["internal"]
+    test_qapp._qubes[vm_name].update_calls()
+    vm_manager._update_domain_feature(
+        vm_name, "feature-delete:internal", feature="internal"
+    )
+    assert not entry_test.internal
+
+    test_qapp._qubes[template_name].features["internal"] = 1
+    test_qapp._qubes[vm_name].update_calls()
+    vm_manager._update_domain_feature(
+        vm_name, "feature-set:internal", feature="internal", value=1
+    )
+    assert entry_test.internal
+
 
 def test_filter(test_qapp):
     dispatcher = qubesadmin.events.EventsDispatcher(test_qapp)

qubes_menu/vm_manager.py

@@ -21,6 +21,7 @@
 Helper class that manages all events related to VMs.
 """
 import qubesadmin.events
+import qubesadmin.exc
 from qubesadmin.vm import QubesVM
 from typing import Optional, Dict, List, Callable
 
@@ -49,6 +50,12 @@ def __init__(self, vm: QubesVM):
             # the space here is to assure correct sorting for dispvm children
             self.sort_name = self.vm_name.lower() + " "
 
+        try:
+            self._internal = bool(
+                self.vm.features.check_with_template("internal", False)
+            )
+        except qubesadmin.exc.QubesDaemonAccessError:
+            self._internal = False
         self._servicevm = bool(self.vm.features.get("servicevm", False))
         self._is_dispvm_template = getattr(
             self.vm, "template_for_dispvms", False
@@ -133,6 +140,16 @@ def is_dispvm_template(self, new_value):
         self._is_dispvm_template = new_value
         self.update_entries(update_type=True)
 
+    @property
+    def internal(self):
+        """Is the VM internal"""
+        return self._internal
+
+    @internal.setter
+    def internal(self, new_value):
+        self._internal = new_value
+        self.update_entries(update_type=True)
+
     @property
     def service_vm(self):
         """Does the VM provide network"""
@@ -146,6 +163,8 @@ def service_vm(self, new_value):
     @property
     def show_in_apps(self):
         """Should this qube be shown in the Apps section of the menu?"""
+        if self.internal:
+            return False
         if self.service_vm:
             return False
         if self.vm_klass == "TemplateVM":
@@ -212,8 +231,11 @@ def load_vm_from_name(self, vm_name: str) -> Optional[VMEntry]:
             vm: QubesVM = self.qapp.domains[vm_name]
         except KeyError:
             return None
-        if vm.features.get("internal", False):
-            return None
+        try:
+            if vm.features.check_with_template("internal", False):
+                return None
+        except qubesadmin.exc.QubesDaemonAccessError:
+            pass
 
         return self._add_vm(vm)
 
@@ -289,6 +311,14 @@ def _update_domain_feature(
         value = bool(value)
 
         try:
+            if feature == "internal":
+                vm_entry.internal = value
+                for derived in self.qapp.domains:
+                    if not getattr(derived, "template", None) == vm:
+                        continue
+                    derived_vm_entry = self.load_vm_from_name(derived)
+                    if derived_vm_entry:
+                        derived_vm_entry.internal = value
             if feature == "servicevm":
                 vm_entry.service_vm = value
             if feature == "appmenus-dispvm":
@@ -354,3 +384,9 @@ def register_events(self):
         self.dispatcher.add_handler(
             "domain-feature-delete:appmenus-dispvm", self._update_domain_feature
         )
+        self.dispatcher.add_handler(
+            "domain-feature-set:internal", self._update_domain_feature
+        )
+        self.dispatcher.add_handler(
+            "domain-feature-delete:internal", self._update_domain_feature
+        )