Skip to content

Update test exec platform documentation. #27750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update test exec platform documentation. #27750

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 24 additions & 16 deletions site/en/reference/test-encyclopedia.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -706,26 +706,34 @@ via [toolchain resolution](/extending/toolchains#toolchain-resolution), just
like for any other action. Each test rule has an implicitly defined [
`test` exec group](/extending/exec-groups#exec-groups-for-native-rules) that,
unless overridden, has a mandatory toolchain requirement on
`@bazel_tools//tools/test:default_test_toolchain_type`. Toolchains of this type
do not carry any data in the form of providers, but can be used to influence the
execution platform of the test action. By default, Bazel registers two such
toolchains:
`@bazel_tools//tools/test:default_test_toolchain_type`.

Toolchains of this type do not carry any data in the form of providers, but can
be used to influence the execution platform of the test action.

Bazel registers two such toolchains, which take effect if users don't explicitly
define their own::

* If `--@bazel_tools//tools/test:incompatible_use_default_test_toolchain` is
disabled (the current default), the active test toolchain is
`@bazel_tools//tools/test:legacy_test_toolchain`. This toolchain does not
impose any constraints and thus test actions without manually specified exec
constraints are configured for the first registered execution platform. This
is often not the intended behavior in multi-platform builds as it can result
in e.g. a test binary built for Linux on a Windows machine to be executed on
Windows.
* If `--@bazel_tools//tools/test:incompatible_use_default_test_toolchain` is
enabled, the active test toolchain is
enabled (**default**), the active test toolchain is
`@bazel_tools//tools/test:default_test_toolchain`. This toolchain requires an
execution platform to match all the constraints of the test rule's target
platform. In particular, the target platform is compatible with this toolchain
execution platform to match all of the test rule's target platform constraints.

In particular, the target platform is compatible with this toolchain
if it is also registered as an execution platform. If no such platform is
found, the test rule fails with a toolchain resolution error.
found, the test rule fails with a toolchain resolution error
* If `--@bazel_tools//tools/test:incompatible_use_default_test_toolchain` is
disabled, the active test toolchain is
`@bazel_tools//tools/test:legacy_test_toolchain`. This toolchain does not
impose any constraints and thus test actions without manually specified exec
constraints are configured for the first registered execution platform.

This is often not the intended behavior in multi-platform builds as it can
result in e.g. a test binary built for Linux on a Windows machine to be
executed on Windows.

As a legacy setting, expect this option to be unavailable in a future Bazel
release.

Users can register additional toolchains for this type to influence this
behavior and their toolchains will take precedence over the default ones.
Expand Down