Return UnknownDevice for assignments where device is unknown

references QubesOS/qubes-issues#10409

Author: marmarta

qubesadmin/device_protocol.py

@@ -1356,8 +1356,9 @@ def devices(self) -> List[DeviceInfo]:
     @property
     def device(self) -> DeviceInfo:
         """
-        Get single DeviceInfo object or raise an error.
-
+        Get single DeviceInfo object or UnknownDevice, if the device has
+         not been found.
+        If there are more devices than one matching, raise ProtocolError.
         If port id is set we have exactly one device
         since we can attach ony one device to one port.
         If assignment is more general we can get 0 or many devices.
@@ -1367,7 +1368,8 @@ def device(self) -> DeviceInfo:
             return devices[0]
         if len(devices) > 1:
             raise ProtocolError("Too many devices matches to assignment")
-        raise ProtocolError("No devices matches to assignment")
+        return UnknownDevice(port=self.port,
+                             device_id=self.device_id)
 
     @property
     def port(self) -> Port:

qubesadmin/tests/mock_app.py

@@ -691,6 +691,7 @@ def __init__(
         vendor: str,
         attached: Optional[str] = None,
         assigned: Optional[List[Tuple[str, str, list[Any] | None]]] = None,
+        device_unknown: bool = False,
     ):
         """
         :param qapp: QubesTest object
@@ -712,6 +713,7 @@ def __init__(
         self.assigned = assigned
         self.product = product
         self.vendor = vendor
+        self.device_unknown = device_unknown
 
         self.interface = self.device_id.split(":")[-1]
 
@@ -761,16 +763,17 @@ def update_calls(self):
             )
         ]
 
-        self.qapp.expected_calls[
-            (
-                self.backend_vm,
-                f"admin.vm.device.{self.dev_class}.Available",
-                None,
-                None,
+        if not self.device_unknown:
+            self.qapp.expected_calls[
+                (
+                    self.backend_vm,
+                    f"admin.vm.device.{self.dev_class}.Available",
+                    None,
+                    None,
+                )
+            ] = (
+                current_response + self.device_string().encode()
             )
-        ] = (
-            current_response + self.device_string().encode()
-        )
 
         if self.attached:
             current_response = self.qapp.expected_calls[

qubesadmin/tests/tools/qvm_device.py

@@ -284,12 +284,12 @@ def test_020_detach(self):
 
     def test_021_detach_unknown(self):
         """ Test detach action """
-        self.app.expected_calls[
-            ('test-vm2', 'admin.vm.device.testclass.Detach',
-             'test-vm1+dev7:0000:0000::?******', None)] = b'0\0'
-        qubesadmin.tools.qvm_device.main(
-            ['testclass', 'detach', 'test-vm2', 'test-vm1:dev7'], app=self.app)
-        self.assertAllCalled()
+        with qubesadmin.tests.tools.StderrBuffer() as stderr:
+            retcode = qubesadmin.tools.qvm_device.main(
+                ['testclass', 'detach', 'test-vm2', 'test-vm1:dev7'],
+                app=self.app)
+            self.assertEqual(retcode, 1)
+            self.assertIn("not found", stderr.getvalue())
 
     def test_022_detach_all(self):
         """ Test detach action """

qubesadmin/tools/qvm_device.py

@@ -236,6 +236,10 @@ def attach_device(args):
     try:
         try:
             dev = assignment.device
+            if isinstance(dev, UnknownDevice):
+                raise qubesadmin.exc.QubesException(
+                    "Unknown device, skipping attachment of device from the "
+                    f"port {assignment}")
         except ProtocolError as exc:
             raise qubesadmin.exc.QubesException(str(exc))
 
@@ -299,6 +303,8 @@ def detach_device(args):
 
         if not assignment.matches(actual_dev):
             raise qubesadmin.exc.QubesException(f"{device} is not attached.")
+        if isinstance(actual_dev, UnknownDevice):
+            raise qubesadmin.exc.QubesException(f"{device} not found.")
 
         vm.devices[args.devclass].detach(assignment)
     elif args.device: