1.1.3.1.1.1.3. test_automation.targets.fpga.fpga_runtime_options

Runtime option dataclasses used by the FPGA networking and controller layers for log paths, remote command execution, and UART login handling.

1.1.3.1.1.1.3.1. Classes

LogPathOptions

Log destination overrides.

RemoteRunSpec

Structured specification for executing a remote command.

ShellPromptWaitOptions

Configuration options for waiting on a shell prompt in a UART log.

LoginWaitOptions

Configuration options for waiting on a UART login prompt and shell prompt.

1.1.3.1.1.1.3.2. Module Contents

class test_automation.targets.fpga.fpga_runtime_options.LogPathOptions[source]

Log destination overrides.

Parameters:

  • log_dir – Optional base directory for logs (default: <cwd>/logs).

  • log_prefix – Optional prefix for generating timestamped log folders.

log_dir: str | None = None[source]
log_prefix: str | None = None[source]
class test_automation.targets.fpga.fpga_runtime_options.RemoteRunSpec[source]

Structured specification for executing a remote command.

Parameters:

  • env_setup_cmds – Sequence of shell commands used to prepare the environment before running the main remote command.

  • remote_cmd – The primary command to execute on the remote host.

  • remote_workdir – Optional remote working directory. If provided, the execution flow will change into this directory before running remote_cmd.

env_setup_cmds: Sequence[str][source]
remote_cmd: str[source]
remote_workdir: str | None = None[source]
class test_automation.targets.fpga.fpga_runtime_options.ShellPromptWaitOptions[source]

Configuration options for waiting on a shell prompt in a UART log.

Parameters:

  • timeout_s – Maximum time to wait for detection of login prompt.

  • poll_s – Polling interval in seconds between login prompt checks.

  • tail_lines – Number of lines from the end of the UART log inspected when searching for the login marker.

timeout_s: int = 120[source]
poll_s: float = 1.0[source]
tail_lines: int = 200[source]
class test_automation.targets.fpga.fpga_runtime_options.LoginWaitOptions[source]

Configuration options for waiting on a UART login prompt and shell prompt.

Parameters:

  • timeout_s – Maximum time to wait for detection of login prompt.

  • poll_s – Polling interval in seconds between login prompt checks.

  • tail_lines – Number of lines from the end of the UART log inspected when searching for the login marker.

  • shell_prompt_timeout_s – Maximum time to wait for the shell prompt after sending the login username.

timeout_s: int = 900[source]
poll_s: float = 2.0[source]
tail_lines: int = 150[source]
shell_prompt_timeout_s: int = 120[source]