构建事件协议示例

报告问题查看源代码 每夜 build · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

如需查看 Build Event Protocol 的完整规范，请参阅其 Protocol Buffers 定义。不过，在查看规范之前，先建立一些直觉可能会很有帮助。

请考虑一个简单的 Bazel 工作区，其中包含两个空 shell 脚本 foo.sh 和 foo_test.sh，以及以下 BUILD 文件：

sh_library(
    name = "foo_lib",
    srcs = ["foo.sh"],
)

sh_test(
    name = "foo_test",
    srcs = ["foo_test.sh"],
    deps = [":foo_lib"],
)

在该项目上运行 bazel test ... 时，生成的 build 事件的 build 图表将类似于下图。箭头表示上述父子关系。请注意，为简洁起见，我们省略了一些 build 事件和大多数字段。

bep-graph

图 1. BEP 图。

最初，系统会发布 BuildStarted 事件。该事件会告知我们 build 是通过 bazel test 命令调用的，并会宣布子事件：

OptionsParsed
WorkspaceStatus
CommandLine
UnstructuredCommandLine
BuildMetadata
BuildFinished
PatternExpanded
Progress

前三个事件提供了有关 Bazel 调用方式的信息。

PatternExpanded build 事件可让您深入了解 ... 模式扩展到哪些特定目标：//foo:foo_lib 和 //foo:foo_test。它通过将两个 TargetConfigured 事件声明为子事件来实现此目的。请注意，TargetConfigured 事件会将 Configuration 事件声明为子事件，即使 Configuration 已在 TargetConfigured 事件之前发布。

除了父子关系之外，事件还可以使用其 build 事件标识符相互引用。例如，在上图中，TargetComplete 事件会引用其 fileSets 字段中的 NamedSetOfFiles 事件。

引用文件的 build 事件通常不会在事件中嵌入文件名和路径。而是包含 NamedSetOfFiles 事件的 build 事件标识符，该标识符将包含实际的文件名称和路径。NamedSetOfFiles 事件允许一次报告一组文件，并由多个目标引用。这种结构是必需的，因为在某些情况下，如果不这样做，Build Event Protocol 输出大小将随着文件数量呈二次增长。NamedSetOfFiles 事件也可能未嵌入其所有文件，而是通过其 build 事件标识符引用其他 NamedSetOfFiles 事件。

以下是上图中 //foo:foo_lib 目标的 TargetComplete 事件实例，以协议缓冲区的 JSON 表示法输出。build 事件标识符将目标作为不透明字符串包含在内，并使用其 build 事件标识符引用 Configuration 事件。此事件不会通告任何子事件。该载荷包含有关目标是否成功构建、一组输出文件以及构建的目标类型的信息。

{
  "id": {
    "targetCompleted": {
      "label": "//foo:foo_lib",
      "configuration": {
        "id": "544e39a7f0abdb3efdd29d675a48bc6a"
      }
    }
  },
  "completed": {
    "success": true,
    "outputGroup": [{
      "name": "default",
      "fileSets": [{
        "id": "0"
      }]
    }],
    "targetKind": "sh_library rule"
  }
}

BEP 中的方面结果

普通 build 会评估与 (target, configuration) 对关联的操作。启用 (target, configuration, aspect)

尽管没有特定于方面事件类型，但 BEP 中提供了方面评估结果。对于具有适用方面（aspect）的每个 (target, configuration) 对，Bazel 都会发布一个额外的 TargetConfigured 和 TargetComplete 事件，其中包含将方面应用于目标的结果。例如，如果 //:foo_lib 是使用 --aspects=aspects/myaspect.bzl%custom_aspect 构建的，此事件也会显示在 BEP 中：

{
  "id": {
    "targetCompleted": {
      "label": "//foo:foo_lib",
      "configuration": {
        "id": "544e39a7f0abdb3efdd29d675a48bc6a"
      },
      "aspect": "aspects/myaspect.bzl%custom_aspect"
    }
  },
  "completed": {
    "success": true,
    "outputGroup": [{
      "name": "default",
      "fileSets": [{
        "id": "1"
      }]
    }]
  }
}

使用 `NamedSetOfFiles`

确定给定目标（或方面）生成的工件是 BEP 的常见用例，只需进行一些准备工作即可高效完成。本部分介绍了 NamedSetOfFiles 事件提供的递归共享结构，该结构与 Starlark Depset 的结构一致。

使用方在处理 NamedSetOfFiles 事件时必须注意避免使用二次方算法，因为大型 build 可能包含数万个此类事件，在遍历时需要进行数亿次操作，而复杂度为二次方。

namedsetoffiles-bep-graph

图 2. NamedSetOfFiles BEP 图表。

NamedSetOfFiles 事件始终会在引用它的 TargetComplete 或 NamedSetOfFiles 事件之前出现在 BEP 数据流中。这与“父子”事件关系相反，在这种关系中，除第一个事件外，所有其他事件都出现在至少一个宣布该事件的事件之后。NamedSetOfFiles 事件由没有语义的 Progress 事件宣布。

鉴于这些排序和共享约束条件，典型的使用方必须缓冲所有 NamedSetOfFiles 事件，直到 BEP 流耗尽。以下 JSON 事件流和 Python 代码演示了如何在“默认”输出组中填充目标/方面与已构建工件的映射，以及如何处理部分已构建目标/方面的输出：

named_sets = {}  # type: dict[str, NamedSetOfFiles]
outputs = {}     # type: dict[str, dict[str, set[str]]]

for event in stream:
  kind = event.id.WhichOneof("id")
  if kind == "named_set":
    named_sets[event.id.named_set.id] = event.named_set_of_files
  elif kind == "target_completed":
    tc = event.id.target_completed
    target_id = (tc.label, tc.configuration.id, tc.aspect)
    outputs[target_id] = {}
    for group in event.completed.output_group:
      outputs[target_id][group.name] = {fs.id for fs in group.file_sets}

for result_id in relevant_subset(outputs.keys()):
  visit = outputs[result_id].get("default", [])
  seen_sets = set(visit)
  while visit:
    set_name = visit.pop()
    s = named_sets[set_name]
    for f in s.files:
      process_file(result_id, f)
    for fs in s.file_sets:
      if fs.id not in seen_sets:
        visit.add(fs.id)
        seen_sets.add(fs.id)

构建事件协议示例

BEP 中的方面结果

使用 NamedSetOfFiles

使用 `NamedSetOfFiles`