ecutest.lifecycle

class ecutest.lifecycle.EcuTestController(executable: str | PathLike | None = None, xmlrpc_port: int | None = None, restapi_port: int = 5050, silent: bool = False, **kwargs: object)

用于管理 ecu.test runner 实例生命周期的控制器,供 ecu.test code 使用。

参数:
executable: str | PathLike | None = None

ecu.test runner 可执行文件的路径。如果为 None,构造函数会尝试查找合适的 ecu.test runner 可执行文件。

xmlrpc_port: int | None = None

要使用的 xmlrpc 端口。如果自动检测可执行文件,也会自动检测该端口。如果显式指定了可执行文件,并且使用的是非默认端口,则必须在此处指定。否则将使用默认端口 8000。

restapi_port: int = 5050

要使用的 REST API 端口。

silent: bool = False

禁止输出所调用外部命令的全部输出。

start(workspace: str | PathLike | None = None, tbc: str | PathLike | None = None, tcf: str | PathLike | None = None, extra_args: list[str] | None = None, allow_restart: bool = False, accept_any_version: bool = False)

在指定的 Workspace(工作区)中启动 ecu.test runner,加载指定的 Test Bench Configuration(测试台架配置,TBC)和 Test Configuration(测试配置,TCF),并启动 web API。

如果合适的 ecu.test 实例已在正确的 Workspace 中运行,则会复用该运行中的实例。

参数:
workspace: str | PathLike | None = None

要使用的 Workspace 目录。如果为 None,命令行中不会指定 Workspace,ecu.test runner 将在最近使用的 Workspace 中启动。

tbc: str | PathLike | None = None

要加载的 Test Bench Configuration 文件。如果为 None,则不会显式加载 TBC,而是使用当前已加载的 TBC,或该 Workspace 最近一次会话中加载过的 TBC。

tcf: str | PathLike | None = None

要加载的 Test Configuration 文件。如果为 None,则不会显式加载 TCF,而是使用当前已加载的 TCF,或该 Workspace 最近一次会话中加载过的 TCF。

extra_args: list[str] | None = None

传递给 ecu.test runner 的附加命令行参数。请注意,判断是否需要重启时不会考虑这些参数。

allow_restart: bool = False

决定当 Workspace 或版本/可执行文件不匹配时,是否允许重启已在运行的 ecu.test 实例。

accept_any_version: bool = False

如果为 True,只要运行中的实例位于正确的 Workspace,就会忽略其版本或可执行文件而直接复用该实例。无论是发生重启还是后续再次启动,都会使用该实例的 runner 可执行文件,而不是构造函数调用中指定的可执行文件或构造函数自动确定的可执行文件。

stop(timeout: int = 90)

请求 ecu.test runner 实例正常退出。

参数:
timeout: int = 90

抛出异常前,等待 ecu.test 实例停止的最长时间。

这同样适用于并非由此生命周期控制器启动的实例。

running_ecutest(workspace: str | PathLike | None = None, tbc: str | PathLike | None = None, tcf: str | PathLike | None = None, extra_args: list[str] | None = None, allow_restart: bool = False, accept_any_version: bool = False, stop_on_exit: bool | None = None)

上下文管理器,用于确保 ecu.test 实例在指定的 Workspace 中运行,并加载指定的 TBC 和 TCF。

参数:
stop_on_exit: bool | None = None

如果为 True,则在退出上下文管理器时停止该 ecu.test 实例。

如果为 False,则保持该 ecu.test 实例继续运行。

如果为 None,则仅当该实例由此上下文管理器启动(或重启)时才停止;如果复用了已在运行的实例,则保持其继续运行。

See:

其他参数详见 start()(启动)。

start_webapi()

在已运行的 ecu.test 实例中启动 ecu.test web API。

如果 ecu.test 尚未运行,请改用 start()(启动)方法。

is_webapi_active() → bool

检查 ecu.test web API 是否处于活动状态。如果 ecu.test 未运行或 web API 未激活,则返回 False。

get_running_ecutest_version() → str | None

获取当前运行中的 ecu.test 实例版本。如果 ecu.test 未运行,则返回 None。

is_runner() → bool | None

检查当前运行的 ecu.test 实例是否为 Runner 变体。

对于 ecu.test Runner,此方法返回 True;对于 ecu.test GUI 变体,返回 False;如果 ecu.test 未运行,则返回 None。

get_running_ecutest_install_dir() → str | None

获取当前运行中的 ecu.test 实例安装目录。如果 ecu.test 未运行,则返回 None。

get_current_workspace() → str | None

确定当前运行中的 ecu.test 实例正在使用的 Workspace。如果 ecu.test 未运行,则返回 None。

get_loaded_tbc() → str | None

确定当前运行中的 ecu.test 实例正在使用的 Test Bench Configuration(测试台架配置,TBC)。请注意,该配置可能仅被选中而尚未启动,参见 is_config_started()(配置是否已启动)。如果 ecu.test 未运行,则返回 None。

get_loaded_tcf() → str | None

确定当前运行中的 ecu.test 实例正在使用的 Test Configuration(测试配置,TCF)。请注意,该配置可能仅被选中而尚未启动,参见 is_config_started()(配置是否已启动)。如果 ecu.test 未运行,则返回 None。

is_config_started() → bool

检查运行中的 ecu.test 实例内该配置是否已启动。如果 ecu.test 未运行,则返回 False。

kill(timeout: int = 30)

请求 ecu.test runner 实例立即退出。

参数:
timeout: int = 30

在强制终止前,等待 ecu.test 实例退出的最长时间。

这同样适用于并非由此生命周期控制器启动的实例。