request usb device on first CalledProcessError

Author: Allie Crevier

securedrop_client/gui/widgets.py

@@ -1886,9 +1886,9 @@ def __init__(self, controller, file_uuid):
         buttons_layout = QHBoxLayout()
         buttons.setLayout(buttons_layout)
         usb_cancel_button = QPushButton(_('CANCEL'))
-        export_button = QPushButton(_('EXPORT'))
+        retry_export_button = QPushButton(_('CONTINUE'))
         buttons_layout.addWidget(usb_cancel_button)
-        buttons_layout.addWidget(export_button)
+        buttons_layout.addWidget(retry_export_button)
         usb_form_layout.addWidget(self.usb_error_message)
         usb_form_layout.addWidget(usb_instructions)
         usb_form_layout.addWidget(buttons, alignment=Qt.AlignRight)
@@ -1931,13 +1931,32 @@ def __init__(self, controller, file_uuid):
 
         usb_cancel_button.clicked.connect(self.close)
         passphrase_cancel_button.clicked.connect(self.close)
-        export_button.clicked.connect(self._export)
+        retry_export_button.clicked.connect(self._on_retry_export_button_clicked)
         unlock_disk_button.clicked.connect(self._on_unlock_disk_clicked)
 
         self._export()
 
-    @pyqtSlot()
+
     def _export(self):
+        try:
+            self.controller.run_export_preflight_checks()
+            self._request_passphrase()
+        except ExportError as e:
+            # The first time we see a CALLED_PROCESS_ERROR, tell the user to insert the USB device
+            # in case the issue is that the Export VM cannot start due to a USB device being
+            # unavailable for attachment. According to the Qubes docs:
+            #
+            #   "If the device is unavailable (physically missing or sourceVM not started), booting
+            #    the targetVM fails."
+            #
+            # For information, see https://www.qubes-os.org/doc/device-handling
+            if e.status == ExportStatus.CALLED_PROCESS_ERROR.value:
+                self._request_to_insert_usb_device()
+            else:
+                self._update(e.status)
+
+    @pyqtSlot()
+    def _on_retry_export_button_clicked(self):
         try:
             self.controller.run_export_preflight_checks()
             self._request_passphrase()

tests/gui/test_widgets.py

@@ -1444,7 +1444,7 @@ def test_FileWidget__on_export_clicked(mocker, session, source):
 
 def test_ExportDialog__export(mocker):
     """
-    Ensure export runs preflight checks and requests password.
+    Ensure happy path runs preflight checks and requests passphrase.
     """
     controller = mocker.MagicMock()
     export_dialog = ExportDialog(controller, 'mock_uuid')
@@ -1456,9 +1456,45 @@ def test_ExportDialog__export(mocker):
     export_dialog._request_passphrase.assert_called_with()
 
 
+def test_ExportDialog__export_request_to_insert_usb_device_on_CALLED_PROCESS_ERROR(mocker):
+    """
+    Ensure request to insert USB device on CALLED_PROCESS_ERROR.
+    """
+    controller = mocker.MagicMock()
+    called_process_error = ExportError(ExportStatus.CALLED_PROCESS_ERROR.value)
+    controller.run_export_preflight_checks = mocker.MagicMock(side_effect=called_process_error)
+    export_dialog = ExportDialog(controller, 'mock_uuid')
+    export_dialog._request_passphrase = mocker.MagicMock()
+    export_dialog._request_to_insert_usb_device = mocker.MagicMock()
+    export_dialog._update = mocker.MagicMock()
+
+    export_dialog._export()
+
+    export_dialog._request_passphrase.assert_not_called()
+    export_dialog._request_to_insert_usb_device.assert_called_once_with()
+    export_dialog._update.assert_not_called()
+
+
+def test_ExportDialog__export_request_to_insert_usb_device_on_USB_NOT_CONNECTED(mocker):
+    """
+    Ensure request to insert USB device on USB_NOT_CONNECTED.
+    """
+    controller = mocker.MagicMock()
+    usb_not_connected_error = ExportError(ExportStatus.USB_NOT_CONNECTED.value)
+    controller.run_export_preflight_checks = mocker.MagicMock(side_effect=usb_not_connected_error)
+    export_dialog = ExportDialog(controller, 'mock_uuid')
+    export_dialog._request_passphrase = mocker.MagicMock()
+    export_dialog._update = mocker.MagicMock()
+
+    export_dialog._export()
+
+    export_dialog._request_passphrase.assert_not_called()
+    export_dialog._update.assert_called_once_with('USB_NOT_CONNECTED')
+
+
 def test_ExportDialog__export_updates_on_ExportError(mocker):
     """
-    Ensure export runs update and does not ask for password when preflight checks error.
+    Ensure update is run for ExportError that is not USB_NOT_CONNECTED or CALLED_PROCESS_ERROR.
     """
     controller = mocker.MagicMock()
     controller.run_export_preflight_checks = mocker.MagicMock(side_effect=ExportError('mock'))
@@ -1472,6 +1508,74 @@ def test_ExportDialog__export_updates_on_ExportError(mocker):
     export_dialog._update.assert_called_once_with('mock')
 
 
+def test_ExportDialog__on_retry_export_button_clicked(mocker):
+    """
+    Ensure happy path runs preflight checks and requests passphrase.
+    """
+    controller = mocker.MagicMock()
+    export_dialog = ExportDialog(controller, 'mock_uuid')
+    export_dialog._request_passphrase = mocker.MagicMock()
+
+    export_dialog._on_retry_export_button_clicked()
+
+    controller.run_export_preflight_checks.assert_called_with()
+    export_dialog._request_passphrase.assert_called_with()
+
+
+def test_ExportDialog__on_retry_export_button_clicked_USB_NOT_CONNECTED(mocker):
+    """
+    Ensure request to insert USB device on USB_NOT_CONNECTED.
+    """
+    controller = mocker.MagicMock()
+    usb_not_connected_error = ExportError(ExportStatus.USB_NOT_CONNECTED.value)
+    controller.run_export_preflight_checks = mocker.MagicMock(side_effect=usb_not_connected_error)
+    export_dialog = ExportDialog(controller, 'mock_uuid')
+    export_dialog._request_passphrase = mocker.MagicMock()
+    export_dialog._update = mocker.MagicMock()
+
+    export_dialog._on_retry_export_button_clicked()
+
+    export_dialog._request_passphrase.assert_not_called()
+    export_dialog._update.assert_called_once_with('USB_NOT_CONNECTED')
+
+
+def test_ExportDialog__on_retry_export_button_clicked_CALLED_PROCESS_ERROR(mocker):
+    """
+    Ensure update is run on CALLED_PROCESS_ERROR.
+    """
+    controller = mocker.MagicMock()
+    called_process_error = ExportError(ExportStatus.CALLED_PROCESS_ERROR.value)
+    controller.run_export_preflight_checks = mocker.MagicMock(side_effect=called_process_error)
+    export_dialog = ExportDialog(controller, 'mock_uuid')
+    export_dialog._request_passphrase = mocker.MagicMock()
+    export_dialog._request_to_insert_usb_device = mocker.MagicMock()
+    export_dialog._update = mocker.MagicMock()
+
+    export_dialog._on_retry_export_button_clicked()
+
+    export_dialog._request_passphrase.assert_not_called()
+    export_dialog._request_to_insert_usb_device.assert_not_called()
+    export_dialog._update.assert_called_once_with('CALLED_PROCESS_ERROR')
+
+
+def test_ExportDialog__on_retry_export_button_clicked_updates_on_ExportError(mocker):
+    """
+    Ensure update is run for ExportError that is not USB_NOT_CONNECTED.
+    """
+    controller = mocker.MagicMock()
+    controller.run_export_preflight_checks = mocker.MagicMock(side_effect=ExportError('mock'))
+    export_dialog = ExportDialog(controller, 'mock_uuid')
+    export_dialog._request_passphrase = mocker.MagicMock()
+    export_dialog._request_to_insert_usb_device = mocker.MagicMock()
+    export_dialog._update = mocker.MagicMock()
+
+    export_dialog._on_retry_export_button_clicked()
+
+    export_dialog._request_passphrase.assert_not_called()
+    export_dialog._request_to_insert_usb_device.assert_not_called()
+    export_dialog._update.assert_called_once_with('mock')
+
+
 def test_ExportDialog__request_to_insert_usb_device(mocker):
     """Ensure that the correct widgets are visible or hidden."""
     export_dialog = ExportDialog(mocker.MagicMock(), 'mock_uuid')