feat: add --port-by-serial option to filter ports by serial number

Author: horw

pytest-embedded-serial-esp/pyproject.toml

@@ -32,7 +32,7 @@ requires-python = ">=3.7"
 
 dependencies = [
     "pytest-embedded-serial~=1.16.1",
-    "esptool~=4.5",
+    "esptool~=4.9.0",
 ]
 
 [project.urls]

pytest-embedded-serial-esp/pytest_embedded_serial_esp/serial.py

@@ -55,6 +55,7 @@ def __init__(
         target: Optional[str] = None,
         beta_target: Optional[str] = None,
         port: Optional[str] = None,
+        port_by_serial: Optional[str] = None,
         port_mac: Optional[str] = None,
         baud: int = Serial.DEFAULT_BAUDRATE,
         esptool_baud: int = ESPTOOL_DEFAULT_BAUDRATE,
@@ -66,11 +67,14 @@ def __init__(
         **kwargs,
     ) -> None:
         self._meta = meta
+        filters = {}
+        if port_by_serial:
+            filters['serials'] = [s.strip() for s in port_by_serial.split(',') if s.strip()]
 
         esptool_target = beta_target or target or 'auto'
         if port is None or port.endswith('*'):
             port_filter = port.strip('*') if port else ''
-            available_ports = [_p for _p in esptool.get_port_list() if port_filter in _p]
+            available_ports = [_p for _p in esptool.get_port_list(**filters) if port_filter in _p]
             ports = list(set(available_ports) - set(self.occupied_ports.keys()) - set(ports_to_occupy))
 
             # sort to make /dev/ttyS* ports before /dev/ttyUSB* ports

pytest-embedded/pytest_embedded/dut_factory.py

@@ -120,6 +120,7 @@ def _fixture_classes_and_options_fn(
     app_path,
     build_dir,
     port,
+    port_by_serial,
     port_location,
     port_mac,
     target,
@@ -210,6 +211,7 @@ def _fixture_classes_and_options_fn(
                     'target': target,
                     'beta_target': beta_target,
                     'port': os.getenv('ESPPORT') or port,
+                    'port_by_serial': port_by_serial,
                     'port_location': port_location,
                     'port_mac': port_mac,
                     'baud': int(baud or EspSerial.DEFAULT_BAUDRATE),
@@ -632,6 +634,7 @@ def create(
         app_path: str = '',
         build_dir: str = 'build',
         port: t.Optional[str] = None,
+        port_by_serial: t.Optional[str] = None,
         port_location: t.Optional[str] = None,
         port_mac: t.Optional[str] = None,
         target: t.Optional[str] = None,
@@ -680,6 +683,7 @@ def create(
             app_path: Path to the application.
             build_dir: Directory for build output (default is 'build').
             port: Port configuration.
+            port_by_serial: Filters the port based on the specified serial number.
             port_location: Port location.
             port_mac: Port MAC address.
             target: Target configuration.
@@ -744,6 +748,7 @@ def create(
                 'app_path': app_path,
                 'build_dir': build_dir,
                 'port': port,
+                'port_by_serial': port_by_serial,
                 'port_location': port_location,
                 'port_mac': port_mac,
                 'target': target,

pytest-embedded/pytest_embedded/plugin.py

@@ -203,6 +203,9 @@ def pytest_addoption(parser):
         '--port-mac',
         help='MAC address of the board. (Default: None)',
     )
+    esp_group.addoption(
+        '--port-by-serial', help='Comma-separated list of serial numbers to filter ports by. (Default: None)'
+    )
     esp_group.addoption(
         '--esp-flash-force',
         action='store_true',
@@ -855,6 +858,13 @@ def port_mac(request: FixtureRequest) -> t.Optional[str]:
     return _request_param_or_config_option_or_default(request, 'port_mac', None)
 
 
+@pytest.fixture
+@multi_dut_argument
+def port_by_serial(request: FixtureRequest) -> t.Optional[str]:
+    """Enable parametrization for the same cli option"""
+    return _request_param_or_config_option_or_default(request, 'port_by_serial', None)
+
+
 #######
 # idf #
 #######
@@ -1044,6 +1054,7 @@ def parametrize_fixtures(
     app_path,
     build_dir,
     port,
+    port_by_serial,
     port_location,
     port_mac,
     target,