一般規則

ルール

• alias
• config_setting
• filegroup
• genquery
• genrule
• starlark_doc_extract
• test_suite

エイリアス

alias(name, actual, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)

alias ルールは、ルールを参照できる別の名前を作成します。

エイリアシングは「通常」のターゲットでのみ機能します。特に、package_group と test_suite はエイリアス化できません。

エイリアスは、ターゲットの名前を変更すると多くのファイルに変更が必要になる大規模なリポジトリで役立ちます。複数のターゲットでロジックを再利用する場合は、エイリアス ルールを使用して select 関数呼び出しを保存することもできます。

エイリアス ルールには独自の可視性宣言があります。その他の点では、参照先のルールと同様に動作します（たとえば、エイリアスの testonly は無視され、参照先のルールの testonly-ness が代わりに使用されます）。ただし、いくつかの例外があります。

• エイリアスがコマンドラインで指定されている場合、テストは実行されません。参照されるテストを実行するエイリアスを定義するには、tests 属性に単一のターゲットを持つ test_suite ルールを使用します。
• 環境グループを定義する場合、environment ルールのエイリアスはサポートされていません。--target_environment コマンドライン オプションでもサポートされていません。

例

filegroup(
    name = "data",
    srcs = ["data.txt"],
)

alias(
    name = "other",
    actual = ":data",
)

引数

config_setting

config_setting(name, constraint_values, define_values, deprecation, distribs, features, flag_values, licenses, tags, testonly, values, visibility)

構成可能な属性をトリガーする目的で、想定される構成状態（ビルドフラグまたはプラットフォーム制約として表現）と一致します。このルールを使用する方法については select を、一般的な機能の概要については 構成可能な属性をご覧ください。

例

次の例は、--compilation_mode=opt または -c opt を設定するビルド（コマンドラインで明示的に設定するか、.bazelrc ファイルから暗黙的に設定する）に一致します。

  config_setting(
      name = "simple",
      values = {"compilation_mode": "opt"}
  )
  

次の例では、ARM をターゲットとするビルドに一致し、カスタム定義 FOO=bar（bazel build --cpu=arm --define FOO=bar ... など）を適用します。

  config_setting(
      name = "two_conditions",
      values = {
          "cpu": "arm",
          "define": "FOO=bar"
      }
  )
  

次のパターンは、ユーザー定義フラグ --//custom_flags:foo=1 を設定するビルド（コマンドラインで明示的に設定するか、.bazelrc ファイルから暗黙的に設定する）に一致します。

  config_setting(
      name = "my_custom_flag_is_set",
      flag_values = { "//custom_flags:foo": "1" },
  )
  

次の例は、ラベル //example:glibc_2_25 の constraint_value が存在することを前提として、x86_64 アーキテクチャと glibc バージョン 2.25 のプラットフォームをターゲットとするビルドに一致します。この 2 つ以外に制約値を定義している場合でも、プラットフォームは一致します。

  config_setting(
      name = "64bit_glibc_2_25",
      constraint_values = [
          "@platforms//cpu:x86_64",
          "//example:glibc_2_25",
      ]
  )
  

メモ

• 複数の config_setting が現在の構成状態と一致した場合の動作については、select をご覧ください。
• 短縮形をサポートするフラグ（--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 に対して少なくとも 1 つを設定する必要があります。

引数

            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",
                })
          

filegroup

filegroup(name, srcs, data, compatible_with, deprecation, distribs, features, licenses, output_group, restricted_to, tags, target_compatible_with, testonly, visibility)

filegroup を使用して、一連のターゲットの出力を単一のラベルにまとめます。

ターゲットには出力以外の多くのプロパティがあり、それらは同じ方法で収集されないため、filegroup はコマンドラインまたは別のルールの属性でターゲットを一覧表示する代わりにはなりません。ただし、genrule の srcs 属性や *_binary ルールの data 属性など、多くのケースで役立ちます。

ディレクトリを直接参照するのではなく、filegroup を使用することをおすすめします。ディレクトリを直接参照することはおすすめしません。ビルドシステムはディレクトリ内のすべてのファイルを把握していないため、これらのファイルが変更されても再ビルドされない可能性があります。glob と組み合わせると、filegroup はすべてのファイルがビルドシステムに明示的に認識されるようにします。

例

2 つのソースファイルで構成される filegroup を作成するには、

filegroup(
    name = "mygroup",
    srcs = [
        "a_file.txt",
        "//a/library:target",
        "//a/binary:target",
    ],
)

または、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",
    ],
)

引数

genquery

genquery(name, deps, data, compatible_with, compressed_output, deprecation, distribs, exec_compatible_with, exec_properties, expression, features, licenses, opts, restricted_to, scope, strict, tags, target_compatible_with, testonly, visibility)

genquery() は、Bazel クエリ言語で指定されたクエリを実行し、結果をファイルにダンプします。

ビルドの一貫性を保つため、クエリは scope 属性で指定されたターゲットの推移閉包のみを対象とします。このルールに違反するクエリは、strict が指定されていないか true の場合、実行時に失敗します（strict が false の場合、範囲外のターゲットは警告とともにスキップされます）。これを回避する最も簡単な方法は、クエリ式と同じラベルをスコープで指定することです。

ここで許可されるクエリとコマンドラインで許可されるクエリの唯一の違いは、ワイルドカード ターゲット仕様（//pkg:* や //pkg:all など）を含むクエリがここでは許可されないことです。これには 2 つの理由があります。1 つ目は、genquery でスコープを指定して、クエリの推移的閉包外のターゲットがその出力に影響を与えないようにする必要があるためです。2 つ目は、BUILD ファイルがワイルドカード依存関係をサポートしていないためです（deps=["//a/..."] などは許可されていません）。

genquery の出力は、決定論的出力を強制するために辞書順に並べ替えられます。ただし、--output=graph|minrank|maxrank の場合、または somepath がトップレベル関数として使用されている場合は除きます。

出力ファイルの名前はルールの名前です。

例

この例では、指定されたターゲットの推移閉包内のラベルのリストをファイルに書き込みます。

genquery(
    name = "kiwi-deps",
    expression = "deps(//kiwi:kiwi_lib)",
    scope = ["//kiwi:kiwi_lib"],
)

引数

genrule

genrule(name, srcs, outs, cmd, cmd_bash, cmd_bat, cmd_ps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, executable, features, licenses, local, message, output_licenses, output_to_bindir, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)

genrule は、ユーザー定義の Bash コマンドを使用して 1 つ以上のファイルを生成します。

Genrule は、タスクに固有のルールがない場合に使用できる汎用ビルドルールです。たとえば、Bash のワンライナーを実行できます。ただし、C++ ファイルをコンパイルする必要がある場合は、既存の cc_* ルールを使用してください。すべての処理がすでに完了しています。

genrule では、コマンド引数を解釈するためにシェルが必要になります。PATH で使用可能な任意のプログラムを参照することも簡単ですが、コマンドが非密閉型になり、再現できない可能性があります。単一のツールのみを実行する必要がある場合は、代わりに run_binary の使用を検討してください。

他のすべてのアクションと同様に、genrules によって作成されたアクションは、作業ディレクトリについて何も想定してはなりません。Bazel が保証するのは、宣言された入力が、ラベルに対して $(location) が返すパスで使用可能になることだけです。たとえば、アクションがサンドボックスまたはリモートで実行される場合、サンドボックスまたはリモート実行の実装によって作業ディレクトリが決まります。直接実行（standalone 戦略を使用）すると、作業ディレクトリは実行ルート（bazel info execution_root の結果）になります。

テストの実行に genrule を使用しないでください。テストとテスト結果には、キャッシュ保存ポリシーや環境変数など、特別な免除措置があります。テストは通常、ビルドの完了後、ターゲット アーキテクチャで実行する必要がありますが、genrule はビルド中、実行アーキテクチャで実行されます（この 2 つは異なる場合があります）。汎用テストルールが必要な場合は、sh_test を使用します。

クロスコンパイルに関する考慮事項

クロス コンパイルについて詳しくは、ユーザー マニュアルをご覧ください。

genrule はビルド中に実行されますが、その出力はビルド後（デプロイやテストなど）に使用されることがよくあります。マイクロコントローラ用の C コードのコンパイルの例を考えてみましょう。コンパイラは C ソースファイルを受け取り、マイクロコントローラで実行されるコードを生成します。生成されたコードは、明らかにビルドに使用された CPU で実行できませんが、C コンパイラ（ソースからコンパイルされた場合）自体は実行できる必要があります。

ビルドシステムは、実行構成を使用してビルドが実行されるマシンを記述し、ターゲット構成を使用してビルドの出力が実行されるマシンを記述します。これらの各項目を構成するオプションが用意されており、競合を避けるために対応するファイルが個別のディレクトリに分離されます。

genrule の場合、ビルドシステムは依存関係が適切にビルドされるようにします。ターゲット構成に対して srcs が（必要に応じて）ビルドされ、実行構成に対して tools がビルドされ、出力はターゲット構成のものとみなされます。また、genrule コマンドが対応するツールに渡すことができる 「Make」変数も提供します。

genrule が deps 属性を定義しないのは意図的なものです。他の組み込みルールは、ルール間で渡される言語依存のメタ情報を使用して、依存ルールを処理する方法を自動的に決定しますが、genrule ではこのレベルの自動化はできません。Genrule は、ファイルと runfile のレベルでのみ機能します。

特別なケース

Exec-exec コンパイル: ビルド システムで、ビルド中に実行可能な出力を生成する genrule を実行する必要がある場合があります。たとえば、genrule がカスタム コンパイラをビルドし、そのコンパイラが別の genrule で使用される場合、最初の genrule は exec 構成の出力を生成する必要があります。これは、コンパイラが別の genrule で実行される場所であるためです。この場合、ビルドシステムは自動的に適切な処理を行います。ターゲット構成ではなく、実行構成の最初の genrule の srcs と outs をビルドします。詳しくは、ユーザー マニュアルをご覧ください。

JDK と C++ ツール: JDK または C++ コンパイラ スイートのツールを使用するには、ビルドシステムが使用する変数のセットを提供します。詳しくは、「Make」変数をご覧ください。

Genrule 環境

genrule コマンドは、コマンドまたはパイプラインが失敗した場合に set -e -o pipefail を使用して失敗するように構成された Bash シェルによって実行されます。

ビルドツールは、PATH、PWD、TMPDIR などのコア変数のみを定義するサニタイズされたプロセス環境で Bash コマンドを実行します。ビルドの再現性を確保するため、ユーザーのシェル環境で定義されたほとんどの変数は 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 as ls $(dirname $x), one must escape it thus: ls $$(dirname $$x)。
• シンボリック リンクとディレクトリの作成は避けてください。Bazel は genrule によって作成されたディレクトリ/シンボリック リンク構造をコピーせず、ディレクトリの依存関係チェックが不健全です。
• 他のルールで 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 の出力を使用する方法を示しています。明示的な $(location) ディレクティブの代わりに $(SRCS) を使用しても機能します。この例では、説明のために後者を使用しています。

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) > $@",
)

引数

starlark_doc_extract

starlark_doc_extract(name, deps, src, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, render_main_repo_name, restricted_to, symbol_names, tags, target_compatible_with, testonly, visibility)

starlark_doc_extract() は、特定の .bzl ファイルまたは .scl ファイルで定義または再エクスポートされたルール、関数（マクロを含む）、アスペクト、プロバイダのドキュメントを抽出します。このルールの出力は、Bazel ソースツリーの stardoc_output.proto で定義されている ModuleInfo バイナリ proto です。

暗黙的な出力ターゲット

• name.binaryproto（デフォルトの出力）: ModuleInfo バイナリ プロト。
• name.textproto（明示的にリクエストされた場合にのみビルド）: name.binaryproto のテキスト プロトコル バージョン。

警告: このルールの出力形式は安定しているとは限りません。これは主に Stardoc の内部使用を目的としています。

引数

test_suite

test_suite(name, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, tests, visibility)

test_suite は、人間にとって「有用」と見なされる一連のテストを定義します。これにより、プロジェクトで「チェックイン前に実行する必要があるテスト」、「プロジェクトのストレステスト」、「すべての小規模テスト」などのテストセットを定義できます。bazel test コマンドはこの種の編成を尊重します。bazel test //some/test:suite などの呼び出しの場合、Bazel はまず //some/test:suite ターゲットによって推移的に含まれるすべてのテスト ターゲットを列挙し（これを「test_suite 拡張」と呼びます）、次に Bazel はこれらのターゲットをビルドしてテストします。

例

現在のパッケージ内のすべての小規模テストを実行するテストスイート。

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"],
)

引数