规则
别名
alias(name, actual, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)
alias
规则会创建规则可以引用的另一个名称。
别名仅适用于“常规”目标。特别是,package_group
和 test_suite
不能有别名。
别名规则有自己的可见性声明。在所有其他方面,它的行为方式类似于它引用的规则(例如,忽略别名上的 testonly,而使用所引用规则的 testonly 性),但也有一些细微的例外情况:
-
如果命令行中提及了别名,测试不会运行。如需定义运行所引用测试的别名,请使用
test_suite
规则,且该规则的tests
属性中只有一个目标。 -
定义环境组时,不支持
environment
规则的别名。--target_environment
命令行选项也不支持它们。
示例
filegroup( name = "data", srcs = ["data.txt"], ) alias( name = "other", actual = ":data", )
参数
属性 | |
---|---|
name |
此目标的唯一名称。 |
actual
|
|
config_setting
config_setting(name, constraint_values, define_values, deprecation, distribs, features, flag_values, licenses, tags, testonly, values, visibility)
与预期配置状态(表示为 build 标志或平台约束条件)匹配,以便触发可配置属性。如需了解如何使用此规则,请参阅 select;如需大致了解一般功能,请参阅 可配置属性。
示例
以下代码会匹配设置 --compilation_mode=opt
或 -c opt
(在命令行中显式或通过 .bazelrc 文件隐式设置)的任何 build:
config_setting( name = "simple", values = {"compilation_mode": "opt"} )
以下代码会匹配任何以 ARM 为目标并应用自定义定义 FOO=bar
(例如 bazel build --cpu=arm --define FOO=bar ...
)的 build:
config_setting( name = "two_conditions", values = { "cpu": "arm", "define": "FOO=bar" } )
以下代码会匹配任何设置了用户定义的标志
--//custom_flags:foo=1
(在命令行中显式地或从 .bazelrc 文件中隐式地)的 build:
config_setting( name = "my_custom_flag_is_set", flag_values = { "//custom_flags:foo": "1" }, )
以下代码会匹配针对采用 x86_64 架构的平台和 glibc 版本 2.25 的任何 build(假设存在带有标签 //example:glibc_2_25
的 constraint_value
)。请注意,如果平台定义了上述两个范围之外的其他约束值,则平台仍然会匹配。
config_setting( name = "64bit_glibc_2_25", constraint_values = [ "@platforms//cpu:x86_64", "//example:glibc_2_25", ] )在所有这些情况下,配置都可能会在 build 中发生更改,例如,如果需要针对与其依赖项不同的平台构建目标。这意味着,即使
config_setting
与顶级命令行标志不匹配,它也可能仍然匹配某些 build 目标。
备注
- 如需了解当多个
config_setting
与当前配置状态匹配时会发生什么情况,请参阅选择。 - 对于支持简写形式(例如
--compilation_mode
与-c
)的标志,values
定义必须使用完整形式。这些函数会以任意一种形式自动匹配调用。 -
如果某个标志采用多个值(例如
--copt=-Da --copt=-Db
或列表类型的 Starlark 标志),则当"a"
存在于实际列表的任意位置时,values = { "flag": "a" }
就会匹配。values = { "myflag": "a,b" }
的工作原理相同:它与--myflag=a --myflag=b
、--myflag=a --myflag=b --myflag=c
、--myflag=a,b
和--myflag=c,b,a
匹配。确切语义因标志而异。例如,--copt
不支持在同一实例中包含多个值:--copt=a,b
会生成["a,b"]
,而--copt=a --copt=b
会生成["a", "b"]
(因此values = { "copt": "a,b" }
与前者匹配,但与后者不匹配)。但--ios_multi_cpus
(针对 Apple 规则)确实如此:-ios_multi_cpus=a,b
和ios_multi_cpus=a --ios_multi_cpus=b
都会生成["a", "b"]
。请仔细查看标志定义并测试条件,以验证确切预期。 - 如果您需要定义不是由内置构建标志建模的条件,请使用
Starlark 定义的标志。您也可以使用
--define
,但这种方法提供的支持较弱,因此不推荐使用。如需查看更多讨论,请点击此处。 - 避免在不同软件包中重复使用相同的
config_setting
定义。请改为引用规范软件包中定义的通用config_setting
。 values
、define_values
和constraint_values
可在同一config_setting
中以任意组合形式使用,但必须至少为任何config_setting
设置一个。
参数
属性 | |
---|---|
name |
此目标的唯一名称。 |
constraint_values
|
config_setting 而必须指定的最小 constraint_values 集。(此处不考虑执行平台。)平台已忽略的任何其他约束值均会被忽略。如需了解详情,请参阅
可配置的 build 属性。
如果两个 |
define_values
|
values 相同,但专门用于 --define 标志。
也就是说: config_setting( name = "a_and_b", values = { "define": "a=1", "define": "b=2", }) 不起作用,因为相同的键 ( config_setting( name = "a_and_b", define_values = { "a": "1", "b": "2", }) 与
|
flag_values
|
values 相同,但适用于
用户定义的构建标志。
这是一个不同的属性,因为用户定义的标志以标签的形式引用,而内置标志以任意字符串的形式引用。 |
values
|
此规则会继承在 为方便起见,配置值被指定为 build 标志(不带有前面的 如果未在命令行中明确设置标志,系统将使用其默认值。
如果某个键在字典中多次出现,则仅使用最后一个实例。如果某个密钥引用了可在命令行中多次设置的标志(例如
|
文件组
filegroup(name, srcs, data, compatible_with, deprecation, distribs, features, licenses, output_group, restricted_to, tags, target_compatible_with, testonly, visibility)
使用 filegroup
可方便地为目标集合命名。然后,您可以从其他规则引用这些规则。
建议使用 filegroup
,而不是直接引用目录。后一种方式听起来不合适,因为构建系统并不完全了解该目录下的所有文件,因此当这些文件发生更改时,它可能不会重新构建。与 glob 结合使用时,filegroup
可以确保构建系统明确知道所有文件。
示例
如需创建包含两个源文件的 filegroup
,请执行以下操作:
filegroup( name = "mygroup", srcs = [ "a_file.txt", "some/subdirectory/another_file.txt", ], )
或者,使用 glob
抓取 testdata 目录:
filegroup( name = "exported_testdata", srcs = glob([ "testdata/*.dat", "testdata/logs/**/*.log", ]), )
如需使用这些定义,请通过任意规则的标签引用 filegroup
:
cc_library( name = "my_library", srcs = ["foo.cc"], data = [ "//my_package:exported_testdata", "//my_package:mygroup", ], )
参数
属性 | |
---|---|
name |
此目标的唯一名称。 |
srcs
|
通常使用 glob 表达式的结果作为 |
data
|
|
output_group
|
“输出组”是在目标的实现中指定的一类输出工件。 |
genquery
genquery(name, deps, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, expression, features, licenses, opts, restricted_to, scope, strict, tags, target_compatible_with, testonly, visibility)
genquery()
会运行以 Blaze 查询语言指定的查询,并将结果转储到文件中。
为了确保 build 保持一致,查询只能访问 scope
属性中指定的目标的传递闭包。如果 strict
未指定或为 true,违反此规则的查询将在执行期间失败(如果 strict
为 false,系统将直接跳过超出范围的目标并显示一条警告)。要确保不会发生这种情况,最简单的方法是在范围中提及与查询表达式中相同的标签。
此处允许的查询与命令行中允许的查询的唯一区别是,此处不允许包含通配符目标规范(例如 //pkg:*
或 //pkg:all
)的查询。
原因有两个:第一,是因为 genquery
必须指定一个范围,以防止查询的传递闭包之外的目标影响其输出;第二,因为 BUILD
文件不支持通配符依赖项(例如,不允许使用 deps=["//a/..."]
)。
genquery 的输出使用 --order_output=full
进行排序,以便强制执行确定性输出。
输出文件的名称就是规则的名称。
示例
此示例将指定目标的传递闭包中的标签列表写入文件中。
genquery( name = "kiwi-deps", expression = "deps(//kiwi:kiwi_lib)", scope = ["//kiwi:kiwi_lib"], )
参数
属性 | |
---|---|
name |
此目标的唯一名称。 |
expression
|
a/BUILD 中,此属性中的标签 :b 将引用目标 //:b 。
|
opts
|
bazel query 的命令行选项。此处不允许使用某些查询选项:--keep_going 、--query_file 、--universe_scope 、--order_results 和 --order_output 。与在命令行 bazel query 中一样,此处未指定的选项具有默认值。
|
scope
|
|
strict
|
|
genrule
genrule(name, srcs, outs, cmd, cmd_bash, cmd_bat, cmd_ps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exec_tools, executable, features, licenses, local, message, output_licenses, output_to_bindir, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)
genrule
使用用户定义的 Bash 命令生成一个或多个文件。
Genrule 是通用的构建规则,可以在任务没有特定规则时使用。例如,您可以运行 Bash 一行代码。不过,如果您需要编译 C++ 文件,请坚持现有的 cc_*
规则,因为所有繁重工作都已为您完成。
请勿使用 Genrule 运行测试。测试和测试结果存在特殊限制,包括缓存政策和环境变量。测试通常需要在构建完成后并在目标架构上运行,而 genrule 在构建期间和在主机架构上执行(两者可能不同)。如果您需要通用测试规则,请使用 sh_test
。
交叉编译注意事项
如需详细了解交叉编译,请参阅用户手册。
虽然 genrule 在构建期间运行,但其输出通常在构建之后用于部署或测试。设想一下为微控制器编译 C 代码的示例:编译器接受 C 源文件并生成可在微控制器上运行的代码。生成的代码显然无法在用于构建代码的 CPU 上运行,但 C 编译器(如果从源代码编译)本身必须运行。
构建系统会使用主机配置来描述运行构建的机器,并使用目标配置来描述应该运行构建输出的机器。它提供了用于配置其中每个文件的选项,并将相应的文件隔离到单独的目录中,以避免冲突。
对于 genrule,构建系统确保正确构建依赖项:如有必要,会针对目标配置构建 srcs
,针对 host 配置构建 tools
,并将输出视为针对 target 配置。此外,它还提供
Make 变量,genrule 命令可以传递给相应的工具。
genrule 有意不定义任何 deps
属性:其他内置规则使用在规则之间传递的依赖于语言的元信息来自动确定如何处理依赖性规则,但这种级别的自动化不适用于 genrule。Genrule 仅在文件级别和 runfiles 级别工作。
特殊情况
主机主机编译:在某些情况下,构建系统需要运行 genrule,以便在构建期间执行输出。例如,如果一个 Genrule 构建了一些自定义编译器,随后另一个 Genrule 会使用它,则第一个 Genrule 必须为主机配置生成其输出,因为这是编译器在另一个 Genrule 中运行。在这种情况下,构建系统会自动执行正确的操作:它会为主机配置(而不是目标配置)构建第一个 Genrule 的 srcs
和 outs
。如需了解详情,请参阅用户手册。
JDK 和 C++ 工具:如需使用 JDK 或 C++ 编译器套件中的工具,构建系统提供了一组要使用的变量。如需了解详情,请参阅 Make 变量。
Genrule 环境
genrule 命令由使用 set -e -o pipefail
的 Bash shell 执行,该 shell 配置为在命令或流水线失败时失败。
构建工具会在经过清理的进程环境中执行 Bash 命令,该环境仅定义核心变量(例如 PATH
、PWD
、TMPDIR
及其他一些变量)。
为了确保构建可重现,系统不会将用户 shell 环境中定义的大多数变量传递给 genrule 的命令。然而,Bazel(而不是 Blaze)会传递用户 PATH
环境变量的值。
对 PATH
的值进行任何更改都将导致 Bazel 在下次构建时重新执行该命令。
genrule 命令不应访问网络,只是连接作为命令本身的子进程的进程,但目前并未强制执行此政策。
构建系统会自动删除所有现有的输出文件,但会在运行 genrule 之前创建所有必要的父级目录。此外,它还会在出现故障时移除所有输出文件。
一般建议
- 请务必确保由 Genrule 运行的工具确定性和封闭性。它们不应将时间戳写入输出,应为集和映射使用稳定排序,且只向输出写入相对文件路径(而非绝对路径)。不遵循此规则将导致意外的构建行为(Bazel 不会重新构建您预想的 Genrule),并降低缓存性能。
- 对于输出、工具和源代码,请广泛使用
$(location)
。由于不同配置的输出文件隔离,genrule 不能依赖于硬编码路径和/或绝对路径。 - 如果在多个位置使用了相同或非常相似的 genrule,请编写一个通用的 Starlark 宏。如果 Genrule 很复杂,请考虑在脚本中或以 Starlark 规则的形式实现。这有助于提高可读性和可测试性。
- 请确保退出代码正确指示 genrule 是成功还是失败。
- 不要将信息性消息写入 stdout 或 stderr。虽然这对调试很有用,但很容易成为噪音;成功的 Genrule 应该是静默的。另一方面,失败的 Genrule 应发出合理的错误消息。
$$
evaluates to a$
, a literal dollar-sign, so in order to invoke a shell command containing dollar-signs such asls $(dirname $x)
, one must escape it thus:ls $$(dirname $$x)
.- 避免创建符号链接和目录。Bazel 不会复制由 genrules 创建的目录/符号链接结构,并且对目录的依赖项检查不正常。
- 在其他规则中引用 genrule 时,您可以使用 Genrule 的标签,也可以使用各个输出文件的标签。有时,一种方法更具可读性,有时是另一种方法:在使用方规则的
srcs
中按名称引用输出可以避免无意中获取 genrule 的其他输出,但如果 genrule 生成许多输出,可能会非常繁琐。
示例
此示例生成 foo.h
。没有任何来源,因为该命令不接受任何输入。该命令运行的“二进制文件”是与 genrule 位于同一软件包的 perl 脚本。
genrule( name = "foo", srcs = [], outs = ["foo.h"], cmd = "./$(location create_foo.pl) > \"$@\"", tools = ["create_foo.pl"], )
以下示例展示了如何使用 filegroup
和另一个 genrule
的输出。请注意,使用 $(SRCS)
代替显式 $(location)
指令也是可行的;本示例出于演示目的使用后者。
genrule( name = "concat_all_files", srcs = [ "//some:files", # a filegroup with multiple files in it ==> $(locations) "//other:gen", # a genrule with a single output ==> $(location) ], outs = ["concatenated.txt"], cmd = "cat $(locations //some:files) $(location //other:gen) > $@", )
参数
属性 | |
---|---|
name |
此目标的唯一名称。 您可以在其他 BUILD 规则的 srcs 或 deps 部分按名称引用此规则。如果规则会生成源文件,则应使用 srcs 属性。
|
srcs
|
此属性不适合列出由
构建系统可确保在运行 genrule 命令之前构建这些前提条件;使用与原始构建请求相同的配置进行构建。这些前提条件的文件的名称在 |
outs
|
输出文件不得跨越软件包边界。输出文件名会被解释为相对于软件包。
如果设置了
genrule 命令应在预定位置创建每个输出文件。在 |
cmd
|
$(location)
和“Make”变量。
cmd_bash 、cmd_ps 和 cmd_bat 都不适用时的回退。
如果命令行长度超过平台限制(Linux/macOS 上为 64K,Windows 上为 8K),那么 genrule 会将命令写入脚本并执行该脚本来解决问题。这适用于所有 cmd 属性( |
cmd_bash
|
此属性的优先级高于 |
cmd_bat
|
此属性的优先级高于
|
cmd_ps
|
此属性的优先级高于
为了使 Powershell 更易于使用且不易出错,我们会先运行以下命令来设置环境,然后再在 genrule 中执行 Powershell 命令。
|
exec_tools
|
tools 属性完全相同,只不过这些依赖项将针对规则的执行平台(而不是主机配置)进行配置。这意味着,exec_tools 中的依赖项不会受到与 tools 中的依赖项相同的限制。特别是,它们不需要将主机配置用于自己的传递依赖项。如需了解详情,请参阅 tools 。
Blaze 团队正在迁移所有使用 |
executable
|
如果将此标志设为 True,输出项是可执行文件,可以使用 不支持为生成的可执行文件声明数据依赖关系。 |
local
|
如果设置为 True,此选项会强制此
这相当于将“local”作为标记提供 ( |
message
|
将在执行此构建步骤时输出的进度消息。默认情况下,该消息为“Generate output”(生成中也同样平淡无奇的内容),但您可以提供一个更具体的消息。在 |
output_licenses
|
common attributes
|
output_to_bindir
|
如果设置为 True,此选项会导致输出文件写入 |
tools
|
构建系统确保在运行 genrule 命令之前构建这些前提条件;使用主机配置构建这些前提条件,因为这些工具是在构建过程中执行的。您可以使用
|
test_suite
test_suite(name, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, tests, visibility)
test_suite
定义了一组被视为对人类“有用”的测试。这样一来,项目就可以定义测试集,例如“签入前必须运行的测试”“项目的压力测试”或“所有小型测试”。blaze test
命令遵循这种组织结构:对于 blaze test //some/test:suite
这样的调用,Blaze 首先枚举 //some/test:suite
目标以传递方式包含的所有测试目标(我们称之为“test_suite 扩展”),然后 Blaze 构建和测试这些目标。
示例
一个测试套件,用于运行当前软件包中的所有小型测试。
test_suite( name = "small_tests", tags = ["small"], )
运行一组指定测试的测试套件:
test_suite( name = "smoke_tests", tests = [ "system_unittest", "public_api_unittest", ], )
用于运行当前软件包中所有不不稳定的测试的测试套件。
test_suite( name = "non_flaky_test", tags = ["-flaky"], )
参数
属性 | |
---|---|
name |
此目标的唯一名称。 |
tags
|
以“-”字符开头的代码会被视为否定关键字。前面的“-”字符不会被视为标记的一部分,因此“-small”套件标记与测试的“small”尺寸匹配。所有其他标记均被视为正标记。 或者,为了使肯定标记更加明确,标记也可以以“+”字符开头,但该字符不会作为标记文本的一部分进行评估。而只是让积极区分和消极区分更易于阅读。 测试套件中只会纳入与所有肯定标记匹配且不与任何否定标记匹配的测试规则。请注意,这并不意味着系统会跳过对已过滤掉的测试的依赖项的错误检查;对已跳过测试的依赖项仍然需要是合法的(例如,不会因可见性限制而被屏蔽)。
在涉及通配符目标模式的调用时,
请注意,测试的
如果您需要的 |
tests
|
此处接受任何
如果 |