esp-test-utils 0.2.1__tar.gz → 0.2.2__tar.gz

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.2.2 (2025-10-29)
+
+
+- feat: get test variables from shell env
+- fix: flash esp32 option no-stub
+
 ## v0.2.1 (2025-09-24)
 
 

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esp-test-utils
-Version: 0.2.1
+Version: 0.2.2
 Summary: ESP Test Utils
 Author-email: Chen Yudong <chenyudong@espressif.com>
 License:                              Apache License

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/esp_test_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esp-test-utils
-Version: 0.2.1
+Version: 0.2.2
 Summary: ESP Test Utils
 Author-email: Chen Yudong <chenyudong@espressif.com>
 License:                              Apache License

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/esptest/adapter/dut/dut_base.py

@@ -11,7 +11,7 @@ from esptool.loader import ESPLoader
 
 import esptest.common.compat_typing as t
 
-from ...common.timestamp import timestamp_str
+from ...common.timestamp import timestamp_slug
 from ...interface.dut import DutInterface
 from ...interface.port import PortInterface
 from ...logger import get_logger
@@ -62,7 +62,7 @@ class DutConfig:
         self._auto_gen_name()
         if not self.log_file:
             _log_path = self.log_path or './dut_logs'
-            _file_name = f'{self.name}_{timestamp_str()}.log'.replace(':', '-')
+            _file_name = f'{self.name}_{timestamp_slug()}.log'.replace(':', '-')
             self.log_file = str(Path(_log_path) / _file_name)
         # serial configs
         _serial_configs = DEFAULT_SERIAL_CONFIGS.copy()
@@ -229,6 +229,12 @@ class DutBase(VariablesMixin, DutInterface):  # pylint: disable=too-many-public-
             return self._base_port_proxy.raw_port
         raise NotImplementedError()
 
+    @property
+    def log_file(self) -> t.Any:
+        if self._base_port_proxy:
+            return self._base_port_proxy.log_file
+        return None
+
     @property
     def name(self) -> t.Any:
         return self.dut_config.name

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/esptest/adapter/dut/esp_mixin.py

@@ -95,7 +95,7 @@ class EspMixin(BaseProtocol):
             esptool=self.dut_config.use_esptool,
             erase_nvs=erase_nvs,
         )
-        if not self.esp.IS_STUB:
+        if not self.esp.IS_STUB and self.esp.CHIP_NAME not in ['ESP32']:
             # preview or dev targets
             down_bin_tool.force_no_stub = True
         with self.disable_redirect_thread():
@@ -105,6 +105,11 @@ class EspMixin(BaseProtocol):
     def start_redirect_thread(self) -> None:
         if self.esp:
             self.esp._port.open()  # pylint: disable=protected-access
+            if self.log_file:
+                with open(self.log_file, 'a', encoding='utf-8') as log_f:
+                    log_f.write(
+                        f'------------ reopen port: {self.esp._port.port} {self.esp._port.baudrate} --------------- \n'  # pylint: disable=protected-access
+                    )
         super().start_redirect_thread()
 
     def stop_redirect_thread(self) -> bool:

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/esptest/config/env_config.py

@@ -5,6 +5,30 @@ from typing import Any, List, Optional
 
 import yaml
 
+VAR_NAME_MAPPING = {
+    'ap_ssid': ['RUNNER_WIFI_SSID', 'RUNNER_AP_SSID'],
+    'ap_password': ['RUNNER_WIFI_PASSWORD', 'RUNNER_AP_PASSWORD'],
+    'pc_nic': ['RUNNER_PC_NIC'],
+    'dut1': ['ESPPORT1'],
+    'dut2': ['ESPPORT2'],
+    'dut3': ['ESPPORT3'],
+}
+
+
+def get_variable_from_env(key: str) -> Any:
+    """Get test variable from shell environment
+
+    Args:
+        key (str): which variable to get
+    """
+    if key in VAR_NAME_MAPPING:
+        for var_name in VAR_NAME_MAPPING[key]:
+            var = os.getenv(var_name)
+            if var is not None:
+                logging.debug(f'Got env variable from shell env {var_name}: {var}')
+                return var
+    return None
+
 
 class EnvConfig:
     """Get test environment variables from config file.
@@ -32,6 +56,8 @@ class EnvConfig:
     # Find env config file from project root path
     # CI_PROJECT_DIR was set by gitlab CI
     PROJECT_ROOT_DIR = os.getenv('PROJECT_ROOT_DIR') or os.getenv('CI_PROJECT_DIR', '')
+    # allow EnvConfig load shell env variables, default enabled
+    DISABLE_LOAD_SHELL_ENV = os.getenv('ESPTEST_DISABLE_LOAD_SHELL_ENV', '').lower() in ('true', '1', 'yes', 'y')
 
     # Allow input variables from terminal during local debugging
     ALLOW_INPUT = not os.getenv('CI')
@@ -115,14 +141,18 @@ class EnvConfig:
         # do not use dict.get because we can input the variable for local tests
         if key in self.config_data:
             var = self.config_data[key]
-        elif default:
+        elif default is not None:
             var = default
         else:
-            logging.warning(f'Failed to get env variable {self.env_tag}/{key}.')
-            logging.info(self.__doc__)
-            if not self.ALLOW_INPUT:
-                raise ValueError(f'Env variable not found: {self.env_tag}/{key}')
-            # For local test, support input the variable from console
-            var = input('You can input the variable now:')
+            if not self.DISABLE_LOAD_SHELL_ENV:
+                # Try to get from shell environment variables
+                var = get_variable_from_env(key)
+            if var is None:
+                logging.warning(f'Failed to get env variable {self.env_tag}/{key}.')
+                logging.info(self.__doc__)
+                if not self.ALLOW_INPUT:
+                    raise ValueError(f'Env variable not found: {self.env_tag}/{key}')
+                # For local test, support input the variable from console
+                var = input('You can input the variable now:')
         logging.debug(f'Got env variable {self.env_tag}/{key}: {var}')
         return var

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/esptest/devices/esp_serial.py

@@ -84,3 +84,14 @@ def list_all_esp_ports() -> t.List[EspPortInfo]:
     for port in get_all_serial_ports():
         esp_ports.append(detect_one_port(port))
     return esp_ports
+
+
+def get_available_ports(target: str, max_num: int = 0) -> t.List[EspPortInfo]:
+    detect_ports = []
+    for port in get_all_serial_ports():
+        esp_port = detect_one_port(port)
+        if esp_port.target == target:
+            detect_ports.append(esp_port)
+        if max_num > 0 and len(detect_ports) >= max_num:  # pylint: disable=chained-comparison
+            return detect_ports
+    return detect_ports

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/esptest/tools/download_bin.py

@@ -77,7 +77,7 @@ class DownBinTool:
         parttool: str = '',
         esptool: str = '',
         erase_nvs: bool = True,
-        force_no_stub: bool = True,
+        force_no_stub: bool = False,
     ):  # pylint: disable=too-many-positional-arguments,too-many-arguments
         self.bin_path = bin_path
         self.port = compute_serial_port(port, strict=True)

{esp_test_utils-0.2.1 → esp_test_utils-0.2.2}/esptest/utility/parse_bin_path.py

@@ -4,6 +4,7 @@ import os
 import subprocess
 import tempfile
 from dataclasses import dataclass
+from functools import lru_cache
 from pathlib import Path
 
 import esptest.common.compat_typing as t
@@ -181,6 +182,7 @@ class ParseBinPath:
             except subprocess.SubprocessError as e:
                 logger.error(f'Failed to gen partition-table.csv: {str(e)}')
 
+    @lru_cache()
     def parse_partitions(self) -> t.List[PartitionInfo]:
         """Parse partitions from partition-table.csv"""
         self._gen_partition_table()
@@ -293,3 +295,9 @@ class ParseBinPath:
             # erase nvs
             return args + list(self._gen_erase_nvs_bin())
         raise ValueError('Can not find nvs partition info')
+
+    def get_partition_info(self, part_name: str) -> PartitionInfo:
+        for part in self.parse_partitions():
+            if part.name == part_name:
+                return part
+        raise ValueError('Can not find nvs partition info')