Refactor worklist.py, flash_uf2.py, cli_flash.py, and mpremoteboard/__init__.py files

Author: Josverl

src/mpflash/mpflash/cli_flash.py

@@ -13,7 +13,7 @@
 from .cli_list import show_mcus
 from .config import config
 from .flash import flash_list
-from .worklist import WorkList, full_auto_worklist, manual_worklist, single_auto_worklist
+from .worklist import MPRemoteBoard, WorkList, full_auto_worklist, manual_worklist, single_auto_worklist
 
 # #########################################################################################################
 # CLI
@@ -104,6 +104,11 @@ def cli_flash_board(**kwargs):
     if not params.boards or params.boards == []:
         # nothing specified - detect connected boards
         params.ports, params.boards = connected_ports_boards()
+        if params.boards == []:
+            # No MicroPython boards detected, but it could be unflashed or not in bootloader mode
+            # Ask for serial port and board_id to flash
+            params.serial = "?"
+            params.boards = ["?"]
     else:
         for board_id in params.boards:
             if board_id == "":

src/mpflash/mpflash/flash_uf2.py

@@ -56,6 +56,6 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
     log.success("Done copying, resetting the board and wait for it to restart")
     if sys.platform in ["linux", "darwin"]:
         dismount_uf2()
-    for _ in track(range(5 + 2)):
+    for _ in track(range(5 + 2), description="Waiting for the board to restart", transient=True):
         time.sleep(1)  # 5 secs to short on linux
     return mcu

src/mpflash/mpflash/mpremoteboard/__init__.py

@@ -65,23 +65,24 @@ def __str__(self):
 
     @staticmethod
     def connected_boards(bluetooth: bool = False) -> List[str]:
+        # TODO: rename to connected_comports
         """
-        Get a list of connected boards.
+        Get a list of connected comports.
 
         Parameters:
         - bluetooth (bool): Whether to include Bluetooth ports. Default is False.
 
         Returns:
         - List[str]: A list of connected board ports.
         """
-        ports = serial.tools.list_ports.comports()
+        comports = serial.tools.list_ports.comports()
 
         if not bluetooth:
             # filter out bluetooth ports
-            ports = [p for p in ports if "bluetooth" not in p.description.lower()]
-            ports = [p for p in ports if "BTHENUM" not in p.hwid]
+            comports = [p for p in comports if "bluetooth" not in p.description.lower()]
+            comports = [p for p in comports if "BTHENUM" not in p.hwid]
 
-        return sorted([p.device for p in ports])
+        return sorted([p.device for p in comports])
 
     @retry(stop=stop_after_attempt(RETRIES), wait=wait_fixed(1), reraise=True)  # type: ignore ## retry_error_cls=ConnectionError,
     def get_mcu_info(self, timeout: int = 2):

src/mpflash/mpflash/worklist.py

@@ -24,7 +24,7 @@ def auto_update(
     *,
     selector: Optional[Dict[str, str]] = None,
 ) -> WorkList:
-    """Builds a list of boards to update based on the connected boards and the firmware available
+    """Builds a list of boards to update based on the connected boards and the firmwares available locally in the firmware folder.
 
     Args:
         conn_boards (List[MPRemoteBoard]): List of connected boards

src/mpflash/tests/cli/test_cli_flash.py

@@ -27,7 +27,7 @@ def fakeboard(serialport="COM99"):
     return fake
 
 
-def fake_ask_missing_params(params: DownloadParams, action: str = "flash") -> DownloadParams:
+def fake_ask_missing_params(params: DownloadParams, action: str) -> DownloadParams:
     # no input during tests
     return params
 
@@ -136,3 +136,110 @@ def test_mpflash_connected_boards(
         assert result.exit_code == 0
     else:
         assert result.exit_code == 1
+
+
+## if no boards are connected , but there are serial port , then set serial --> ? and board to ? if not set
+@pytest.mark.parametrize(
+    "id, serialports, ports, boards",
+    [
+        ("One", ["COM99"], [], []),
+        ("None", [], [], []),
+    ],
+)
+def test_mpflash_no_detected_boards(
+    id,
+    serialports: List[str],
+    ports: List[str],
+    boards: List[str],
+    mocker: MockerFixture,
+):
+    # no boards specified - detect connected boards
+    args = ["flash"]
+
+    # fakes = [fakeboard(port) for port in serialports]
+
+    m_connected_ports_boards = mocker.patch(
+        "mpflash.cli_flash.connected_ports_boards",
+        return_value=(ports, boards),
+        autospec=True,
+    )
+    m_flash_list = mocker.patch("mpflash.cli_flash.flash_list", return_value=None, autospec=True)
+    m_ask_missing_params = mocker.patch(
+        "mpflash.cli_flash.ask_missing_params",
+        Mock(side_effect=fake_ask_missing_params),
+    )
+
+    m_full_auto_worklist = mocker.patch("mpflash.cli_flash.full_auto_worklist", return_value=[])
+    m_manual_worklist = mocker.patch("mpflash.cli_flash.manual_worklist", return_value=[])
+    m_single_auto_worklist = mocker.patch("mpflash.cli_flash.single_auto_worklist", return_value=[])
+
+    runner = CliRunner()
+    result = runner.invoke(cli_main.cli, args)
+
+    m_connected_ports_boards.assert_called_once()
+    m_ask_missing_params.assert_called_once()
+
+    if serialports:
+        ## if no boards are responding , but there are serial port , then set serial --> ? and board to ? if not set
+        assert m_ask_missing_params.call_args.args[0].serial == "?"
+        assert m_ask_missing_params.call_args.args[0].boards == ["?"]
+
+
+# Flash a interactive version
+
+# TEST DOES NOT REALLY ADD ANY VALUE
+# @pytest.mark.parametrize(
+#     "version, serialports, ports, boards",
+#     [
+#         ("preview", ["COM99"], ["esp32"], ["ESP32_GENERIC"]),
+#         ("v1.22.0", ["COM99"], ["esp32"], ["ESP32_GENERIC"]),
+#         ("1.22.0", ["COM99"], ["esp32"], ["ESP32_GENERIC"]),
+#     ],
+# )
+# def test_mpflash_version_interactive(
+#     version: str,
+#     serialports: List[str],
+#     ports: List[str],
+#     boards: List[str],
+#     mocker: MockerFixture,
+# ):
+#     # no boards specified - detect connected boards
+#     def fake_ask_missing_version(params: DownloadParams, action: str) -> DownloadParams:
+#         # no input during tests
+#         params.versions = [version]
+#         return params
+
+#     args = ["flash"]
+
+#     fakes = [fakeboard(port) for port in serialports]
+
+#     m_connected_ports_boards = mocker.patch(
+#         "mpflash.cli_flash.connected_ports_boards",
+#         return_value=(ports, boards),
+#         autospec=True,
+#     )
+#     m_flash_list = mocker.patch("mpflash.cli_flash.flash_list", return_value=None, autospec=True)
+#     m_ask_missing_params = mocker.patch(
+#         "mpflash.cli_flash.ask_missing_params",
+#         Mock(side_effect=fake_ask_missing_version),
+#     )
+
+#     # m_full_auto_worklist = mocker.patch("mpflash.cli_flash.full_auto_worklist", return_value=[])
+#     m_manual_worklist = mocker.patch("mpflash.cli_flash.manual_worklist", return_value=[])
+#     m_single_auto_worklist = mocker.patch("mpflash.cli_flash.single_auto_worklist", return_value=[])
+
+#     runner = CliRunner()
+#     result = runner.invoke(cli_main.cli, args)
+
+#     if serialports:
+#         # m_full_auto_worklist.assert_called_once()
+#         m_manual_worklist.assert_not_called()
+#         m_single_auto_worklist.assert_not_called()
+
+#     m_connected_ports_boards.assert_called_once()
+#     m_ask_missing_params.assert_called_once()
+
+#     if serialports:
+#         assert result.exit_code == 0
+#     else:
+#         assert result.exit_code == 1