Skip to main content

ExternalRunnerTestInfo

Provider that signals that a rule can be tested using an external runner. This is the Buck1-compatible API for tests.

ExternalRunnerTestInfo.command

ExternalRunnerTestInfo.command: list

A Starlark value representing the command for this test. The external test runner is what gives meaning to this command.

ExternalRunnerTestInfo.contacts

ExternalRunnerTestInfo.contacts: list[str]

A starlark value representing the contacts for this test. This is largely expected to be an oncall, though it's not validated in any way.

ExternalRunnerTestInfo.default_executor

ExternalRunnerTestInfo.default_executor: command_executor_config

Default executor to use to run tests. If none is passed we will default to the execution platform.

ExternalRunnerTestInfo.env

ExternalRunnerTestInfo.env: dict[str, typing.Any]

A Starlark value representing the environment for this test. Here again, the external test runner is what will this meaning. This is of type dict[str, ArgLike].

ExternalRunnerTestInfo.executor_overrides

ExternalRunnerTestInfo.executor_overrides: dict[str, command_executor_config]

Executors that Tpx can use to override the default executor.

ExternalRunnerTestInfo.labels

ExternalRunnerTestInfo.labels: list[str]

A starlark value representing the labels for this test.

ExternalRunnerTestInfo.local_resources

ExternalRunnerTestInfo.local_resources: dict[str, None | label]

Mapping from a local resource type to a target with a corresponding provider. Required types are passed from test runner. If the value for a corresponding type is omitted it means local resource should be ignored when executing tests even if those are passed as required from test runner.

ExternalRunnerTestInfo.required_local_resources

ExternalRunnerTestInfo.required_local_resources: list[RequiredTestLocalResource]

List of local resource types which should be set up additionally to those which are passed from test runner. Allows specifying local resources on a per-rule basis.

ExternalRunnerTestInfo.run_from_project_root

ExternalRunnerTestInfo.run_from_project_root: bool

Whether this test should run from the project root, as opposed to the cell root

Defaults to True.

ExternalRunnerTestInfo.test_type

ExternalRunnerTestInfo.test_type: str

A Starlark value representing the type of this test.

ExternalRunnerTestInfo.use_project_relative_paths

ExternalRunnerTestInfo.use_project_relative_paths: bool

Whether this test should use relative paths

ExternalRunnerTestInfo.worker

ExternalRunnerTestInfo.worker: WorkerInfo

Configuration needed to spawn a new worker. This worker will be used to run every single command related to test execution, including listing.