fix: Fix --port-filter argument parsing

Closes espressif#1101
Closes espressif#1103

Author: peterdragun

esptool/cli_util.py

@@ -300,7 +300,7 @@ def add_to_parser(self, parser, ctx):
         def parser_process(value, state):
             # Method to hook into the parser.process
             done = False
-            value = [value]
+            values = [value]
             # Grab everything up to the next option/command
             while state.rargs and not done:
                 for prefix in self._eat_all_parser.prefixes:
@@ -310,10 +310,16 @@ def parser_process(value, state):
                 if state.rargs[0] in self._commands_list:
                     done = True
                 if not done:
-                    value.append(state.rargs.pop(0))
+                    values.append(state.rargs.pop(0))
 
             # Call the original parser process method on the rest of the arguments
-            self._previous_parser_process(value, state)
+            if self.multiple:
+                # If multiple options can be used, Click does not support extending the
+                # value; as the 'value' is list, we need to process each item separately
+                for v in values:
+                    self._previous_parser_process(v, state)
+            else:
+                self._previous_parser_process(values, state)
 
         retval = super(OptionEatAll, self).add_to_parser(parser, ctx)
         for name in self.opts:
@@ -379,7 +385,7 @@ def arg_auto_int(x: str) -> int:
 
 
 def parse_port_filters(
-    value: list[str],
+    value: tuple[str],
 ) -> tuple[list[int], list[int], list[str], list[str]]:
     """Parse port filter arguments into separate lists for each filter type"""
     filterVids = []
@@ -389,7 +395,7 @@ def parse_port_filters(
     for f in value:
         kvp = f.split("=")
         if len(kvp) != 2:
-            FatalError("Option --port-filter argument must consist of key=value.")
+            raise FatalError("Option --port-filter argument must consist of key=value.")
         if kvp[0] == "vid":
             filterVids.append(arg_auto_int(kvp[1]))
         elif kvp[0] == "pid":

test/test_esptool.py

@@ -152,7 +152,9 @@ def run_espsecure(self, args):
             print(e.output)
             raise e
 
-    def run_esptool(self, args, baud=None, chip=None, port=None, preload=True):
+    def run_esptool(
+        self, args, baud=arg_baud, chip=arg_chip, port=arg_port, preload=True
+    ):
         """
         Run esptool with the specified arguments. --chip, --port and --baud
         are filled in automatically from the command line.
@@ -189,12 +191,12 @@ def run_esptool_process(cmd):
             esptool = ["-m", "esptool"]
         trace_arg = ["--trace"] if arg_trace else []
         base_cmd = [sys.executable] + esptool + trace_arg
-        if chip or arg_chip is not None and chip != "auto":
-            base_cmd += ["--chip", chip or arg_chip]
-        if port or arg_port is not None:
-            base_cmd += ["--port", port or arg_port]
-        if baud or arg_baud is not None:
-            base_cmd += ["--baud", str(baud or arg_baud)]
+        if chip and chip != "auto":
+            base_cmd += ["--chip", chip]
+        if port:
+            base_cmd += ["--port", port]
+        if baud:
+            base_cmd += ["--baud", str(baud)]
         usb_jtag_serial_reset = ["--before", "usb-reset"] if arg_preload_port else []
         usb_otg_dont_reset = (
             ["--after", "no-reset-stub"] if "ESPTOOL_TEST_USB_OTG" in os.environ else []
@@ -206,6 +208,7 @@ def run_esptool_process(cmd):
         # Preload a dummy binary to disable the RTC watchdog, needed in USB-JTAG/Serial
         if (
             preload
+            and port
             and arg_preload_port
             and arg_chip
             in [
@@ -240,15 +243,15 @@ def run_esptool_process(cmd):
 
         return output
 
-    def run_esptool_error(self, args, baud=None, chip=None):
+    def run_esptool_error(self, args, baud=arg_baud, chip=arg_chip, port=arg_port):
         """
         Run esptool similar to run_esptool, but expect an error.
 
         Verifies the error is an expected error not an unhandled exception,
         and returns the output from esptool as a string.
         """
         with pytest.raises(subprocess.CalledProcessError) as fail:
-            self.run_esptool(args, baud, chip)
+            self.run_esptool(args, baud, chip, port)
         failure = fail.value
         assert failure.returncode in [1, 2]  # UnsupportedCmdError and FatalError codes
         return failure.output.decode("utf-8")
@@ -1913,3 +1916,28 @@ def test_esp_rfc2217_server_py(self):
         decoded = output.decode("utf-8")
         assert "esp_rfc2217_server.py" in decoded
         assert "DEPRECATED" in decoded
+
+
+@pytest.mark.host_test
+class TestPortFilter(EsptoolTestCase):
+    def test_port_filter_name(self):
+        """Test CLI with --port-filter non-existent name option"""
+        output = self.run_esptool_error(
+            "--port-filter name=NonExistentChip flash-id", port=None
+        )
+        # The command should fail due to no device found, not due to parsing error
+        assert "Option --port-filter argument key not recognized" not in output
+        # Should fail with device connection error instead
+        assert "Found 0 serial ports..." in output
+
+    def test_port_filter_invalid_key_error(self):
+        """Test CLI with invalid --port-filter key still shows correct error"""
+        output = self.run_esptool_error(
+            "--port-filter invalidkey=123 flash-id", port=None
+        )
+        assert "Option --port-filter argument key not recognized" in output
+
+    def test_port_filter_missing_equal_sign(self):
+        """Test CLI with missing equal sign in --port-filter option"""
+        output = self.run_esptool_error("--port-filter name123 flash-id", port=None)
+        assert "Option --port-filter argument must consist of key=value." in output