ビルド イベント プロトコルの例

ビルドイベント プロトコルの完全な仕様については、プロトコル バッファ定義をご覧ください。しかし、仕様を見る前に直感を養うと役に立つかもしれません。

2 つの空のシェル スクリプト foo.sh と foo_test.sh と、次の BUILD ファイルで構成されるシンプルな Bazel ワークスペースについて考えてみましょう。

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

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

このプロジェクトで bazel test ... を実行すると、生成されたビルドイベントのビルドグラフは以下のグラフのようになります。矢印は前述の親と子の関係を示しています。わかりやすくするため、一部のビルドイベントとほとんどのフィールドは省略しています。

Bep-graph

図 1. BEP グラフ。

最初に BuildStarted イベントが公開されます。このイベントは、ビルドが bazel test コマンドで呼び出されたことと、子イベントを通知します。

  • OptionsParsed
  • WorkspaceStatus
  • CommandLine
  • UnstructuredCommandLine
  • BuildMetadata
  • BuildFinished
  • PatternExpanded
  • Progress

最初の 3 つのイベントは、Bazel の呼び出し方法に関する情報を提供します。

PatternExpanded ビルドイベントは、... パターンが //foo:foo_lib と //foo:foo_test に展開された特定のターゲットに関する分析情報を提供します。そのためには、2 つの TargetConfigured イベントを子として宣言します。Configuration が TargetConfigured イベントの前に送信された場合でも、TargetConfigured イベントが Configuration イベントを子イベントとして宣言します。

親と子の関係以外にも、イベントはビルドイベント識別子を使用して相互に参照できます。たとえば、上のグラフでは、TargetComplete イベントは fileSets フィールドで NamedSetOfFiles イベントを参照しています。

ファイルを参照するビルドイベントは通常、ファイル名とパスをイベントに埋め込みません。代わりに、NamedSetOfFiles イベントのビルドイベント識別子が含まれます。この識別子には、実際のファイル名とパスが含まれます。NamedSetOfFiles イベントを使用すると、一連のファイルを 1 回報告し、多くのターゲットから参照できます。この構造が必要なのは、Build Event Protocol の出力サイズがファイルの数に比例して大きくなる場合があるためです。NamedSetOfFiles イベントは、すべてのファイルが埋め込まれているわけではなく、ビルドイベント ID を介して他の NamedSetOfFiles イベントを参照する場合もあります。

上記のグラフの //foo:foo_lib ターゲットの TargetComplete イベントのインスタンスが、プロトコル バッファの JSON 表現に出力されています。ビルドイベント ID にはターゲットが不透明な文字列として含まれ、ビルドイベント ID を使用して Configuration イベントを参照します。このイベントは、子イベントは通知しません。ペイロードには、ターゲットが正常にビルドされたかどうか、出力ファイルのセット、ビルドされたターゲットの種類に関する情報が含まれています。

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

BEP でのアスペクトの結果

通常のビルドでは、(target, configuration) ペアに関連付けられているアクションが評価されます。アスペクトを有効にしてビルドする場合、Bazel は、有効な特定のアスペクトの影響を受けるターゲットごとに、(target, configuration, aspect) トリプルに関連付けられたターゲットも評価します。

アスペクト固有のイベントタイプがなくても、アスペクトの評価結果は BEP で使用できます。該当するアスペクトを持つ (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 ユースケースです。このセクションでは、Starlark の Depset の構造と一致する NamedSetOfFiles イベントが提供する再帰的な共有構造について説明します。

ユーザーは、NamedSetOfFiles イベントを処理するときに二次アルゴリズムを回避するように注意する必要があります。大規模なビルドにはそのようなイベントが数万件含まれ、二次複雑性のトラバーサルで何億ものオペレーションが必要になるためです。

namesetoffiles-bep-graph

図 2. NamedSetOfFiles BEP グラフ。

NamedSetOfFiles イベントは、BEP ストリームでそれを参照する TargetComplete イベントまたは NamedSetOfFiles イベントの前に常に表示されます。これは、「親子」イベントの関係とは逆で、最初のイベントを除くすべてのイベントが、少なくとも 1 つのイベントの通知の後に表示されます。NamedSetOfFiles イベントは、セマンティクスのない Progress イベントによって通知されます。

このような順序と共有の制約があるため、一般的なコンシューマーは BEP ストリームを使い切るまで、すべての NamedSetOfFiles イベントをバッファリングする必要があります。次の 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)