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

問題を報告するopen_in_new ソースを表示open_in_new

Build Event Protocol の完全な仕様については、プロトコル バッファの定義をご覧ください。ただし、仕様を確認する前に直感をこの場で活用すると便利です。

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 ... を実行すると、生成されたビルドイベントのビルドグラフは下のグラフのようになります。矢印は前述の親子関係を表します。一部のビルドイベントとほとんどのフィールドは、簡略化のために省略されています。

図 1. BEP グラフ。

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

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

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

PatternExpanded ビルドイベントによって、... パターンが //foo:foo_lib と //foo:foo_test に拡張されたターゲットを指定できます。これを行うには、2 つの TargetConfigured イベントを子として宣言します。TargetConfigured イベントの前に Configuration が投稿されていても、TargetConfigured イベントは Configuration イベントを子イベントとして宣言しています。

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

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

以下は、上のグラフの //foo:foo_lib ターゲットの TargetComplete イベントのインスタンスです。プロトコル バッファの JSON 表現で出力されます。 ビルドイベント識別子は、不透明な文字列としてターゲットを含み、そのビルドイベント識別子を使用して 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 ユースケースです。このセクションでは、NamedSetOfFiles イベントによって提供される再帰的な共有構造について説明します。これは、Starlark Depset の構造と一致します。

大規模なビルドでは、これらのイベントが何次も複雑になるため、数万件のオペレーションが必要になりますが、NamedSetOfFiles イベントを処理する際は、2 次アルゴリズムを避けるよう注意する必要があります。

図 2. NamedSetOfFiles BEP グラフ。

NamedSetOfFiles イベントは、常に BEP ストリームの TargetComplete イベントやそのイベントを参照する前に表示されます。これは、「親子」イベントの関係で逆の関係で表され、最初の 1 つのイベントを除くすべてのイベントが、少なくとも 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)