BUILD ファイル

問題を報告 ソースを表示

前のセクションでは、パッケージ、ターゲット、ラベル、ビルド依存関係グラフについて抽象的に説明しました。このセクションでは、パッケージの定義に使用される具体的な構文について説明します。

定義上、すべてのパッケージには短いプログラムである BUILD ファイルが含まれています。

BUILD ファイルは、命令言語 Starlark を使用して評価されます。

これらは、ステートメントの連続リストとして解釈されます。

一般的に、順序は重要です。たとえば、変数は使用する前に定義する必要があります。ただし、ほとんどの BUILD ファイルはビルドルールの宣言のみで構成され、これらのステートメントの相対的な順序は重要ではありません。重要なのは、パッケージ評価が完了するまでに、どのルールがどの値で宣言されたかです。

cc_library などのビルドルール関数を実行すると、グラフに新しいターゲットが作成されます。このターゲットは、後でラベルを使用して参照できます。

単純な BUILD ファイルでは、ルールの宣言は動作を変更せずに自由に並べ替えることができます。

コードとデータを明確に分離するため、BUILD ファイルに関数定義、for ステートメント、if ステートメントを含めることはできません(ただし、リストの理解と if 式は使用できます)。関数は .bzl ファイルで宣言できます。また、BUILD ファイルでは *args 引数と **kwargs 引数を使用できません。代わりに、すべての引数を明示的にリストします。

重要な点として、Starlark のプログラムは任意の I/O を実行できません。この不変条件により、BUILD ファイルの解釈が密閉型になり、既知の入力セットのみに依存します。これはビルドの再現性を確保するために不可欠です。詳しくは、密閉性をご覧ください。

BUILD ファイルは ASCII 文字のみを使用して記述する必要がありますが、技術的には Latin-1 文字セットを使用して解釈されます。

BUILD ファイルは、基盤となるコードの依存関係が変更されるたびに更新する必要があるため、通常、チームの複数のユーザーが管理します。BUILD ファイルの作成者は、コメントを自由に書き、各ビルド ターゲットの役割(一般公開を意図しているかどうかに関係なく)を文書化し、パッケージ自体の役割を文書化する必要があります。

拡張機能の読み込み

Bazel 拡張機能は、末尾が .bzl のファイルです。拡張機能からシンボルをインポートするには、load ステートメントを使用します。

load("//foo/bar:file.bzl", "some_library")

このコードは、foo/bar/file.bzl ファイルを読み込み、some_library シンボルを環境に追加します。新しいルール、関数、定数(文字列やリストなど)を読み込むために使用できます。load の呼び出しに追加の引数を使用すると、複数のシンボルをインポートできます。引数は文字列リテラル(変数なし)にする必要があります。load ステートメントはトップレベルに配置する必要があります。関数本体に含めることはできません。

load の最初の引数は、.bzl ファイルを識別するラベルです。相対ラベルの場合は、現在の bzl ファイルを含む(ディレクトリではなく)パッケージを基準に解決されます。load ステートメントの相対ラベルでは、先頭に : を使用する必要があります。

load はエイリアスもサポートしているため、インポートされたシンボルに異なる名前を割り当てることができます。

load("//foo/bar:file.bzl", library_alias = "some_library")

1 つの load ステートメントで複数のエイリアスを定義できます。また、引数リストには、エイリアスと通常のシンボル名の両方を含めることができます。次の例は完全に正則です(引用符を使用するタイミングに注意してください)。

load(":my_rules.bzl", "some_rule", nice_alias = "some_other_rule")

.bzl ファイルでは、_ で始まるシンボルはエクスポートされず、別のファイルから読み込めません。

読み込みの公開設定を使用して、.bzl ファイルを読み込むユーザーを制限できます。

ビルドルールのタイプ

ビルドルールの大部分は、言語別にグループ化されたファミリーにまとめられています。たとえば、cc_binarycc_librarycc_test は、それぞれ C++ バイナリ、ライブラリ、テストのビルドルールです。他の言語では、同じ命名規則を使用して異なる接頭辞を付けます(Java の場合は java_* など)。これらの関数の一部はビルド百科事典に記載されていますが、誰でも新しいルールを作成できます。

  • *_binary ルールは、指定された言語で実行可能プログラムを構築します。ビルド後、実行可能ファイルはビルドツールのバイナリ出力ツリー内のルールのラベルに対応する名前に配置されるため、//my:program$(BINDIR)/my/program などに表示されます。

    一部の言語では、このようなルールによって、ルールに属する data 属性、または依存関係の推移的なクロージャ内のルールに属するすべてのファイルを含むランファイル ディレクトリも作成されます。本番環境へのデプロイを容易にするために、このファイルのセットは 1 か所にまとめられます。

  • *_test ルールは *_binary ルールの特殊化したもので、自動テストに使用されます。テストは、成功するとゼロを返すプログラムです。

    バイナリと同様に、テストにもランファイル ツリーがあり、その下のファイルは、テストが実行時に正当に開くことができる唯一のファイルです。たとえば、プログラム cc_test(name='x', data=['//foo:bar']) は、実行中に $TEST_SRCDIR/workspace/foo/bar を開いて読み取ることができます。(各プログラミング言語には $TEST_SRCDIR の値にアクセスするための独自のユーティリティ関数がありますが、これらはすべて環境変数を直接使用する場合と同じです)。ルールを遵守しないと、リモート テストホストで実行したときにテストが失敗します。

  • *_library ルールは、特定のプログラミング言語で個別にコンパイルされたモジュールを指定します。ライブラリは他のライブラリに依存することができ、バイナリとテストはライブラリに依存し、分離コンパイルの動作が想定されます。

ラベル 依存関係