List of arbitrary text tags. Tags may be any valid string; default is
the empty list.
Tags can be used on any rule. Tags on test and
test_suite
rules are useful for categorizing the tests.
Tags on non-test rules are used to control sandboxed execution of
genrule
s and
Skylark
actions, and for parsing by humans and/or external tools.
Bazel modifies the behavior of its sandboxing code if it finds the following
keywords in the tags
attribute of any test rule or
genrule
, or the keys of execution_requirements
for
any Skylark action.
no-sandbox
keyword results in the action or test never being
sandboxed; it can still be
cached or run remotely - use no-cache
or no-remote
to prevent either or both of those.
no-cache
keyword results in the action or test never being
cached.
no-remote
keyword results in the action or test never being
executed remotely (but it may be cached remotely).
local
keyword precludes the action or test from being remotely cached,
remotely executed, or run inside the
sandbox.
For genrules and tests, marking the rule with the local = True
attribute has the same effect.
requires-network
keyword allows access to the external
network from inside the sandbox. This tag only has an effect if sandboxing
is enabled.
block-network
keyword blocks access to the external
network from inside the sandbox. In this case, only communication
with localhost is allowed. This tag only has an effect if sandboxing is
enabled.
requires-fakeroot
runs the test or action as uid and gid 0 (i.e., the root
user). This is only supported on Linux. This tag takes precedence over the
--sandbox_fake_username
command-line option.
Tags on tests are generally used to annotate a test's role in your debug and release process. Typically, tags are most useful for C++ and Python tests, which lack any runtime annotation ability. The use of tags and size elements gives flexibility in assembling suites of tests based around codebase check-in policy.
Bazel modifies test running behavior if it finds the following keywords in the
tags
attribute of the test rule:
exclusive
keyword will force the test to be run in the
"exclusive" mode, ensuring that no other tests are running at the
same time. Such tests will be executed in serial fashion after all build
activity and non-exclusive tests have been completed. They will also always
run locally and thus without sandboxing.
manual
keyword will force the test target to not be included in target pattern
wildcards (...
, :*
, :all
, etc); the test target will be
neither built nor run. It will also be ignored by the test_suite
rules that do not
mention this test explicitly. The only way to build or run such a test is to specify it via an
explicit target pattern on the command line.
external
keyword will force test to be unconditionally
executed (regardless of --cache_test_results
value).