一般的な定義

ラベルのリスト。デフォルトは [] です。

このルールが実行時に必要とするファイル。ファイルまたはルールのターゲットを一覧表示できます。通常、任意のターゲットを許可します。

data 属性のターゲットのデフォルトの出力とランファイルは、このターゲットによって出力される、またはこのターゲットにランタイム依存関係がある実行可能ファイルの *.runfiles 領域に表示されます。これには、このターゲットの srcs の実行時に使用されるデータファイルやバイナリが含まれる可能性があります。データファイルに依存して使用する方法については、データの依存関係のセクションをご覧ください。

新しいルールで、実行時に他の入力を使用する可能性のある入力を処理する場合は、data 属性を定義する必要があります。ルールの実装関数は、data 属性の出力とランファイル、およびソースコードまたはランタイム依存関係を提供する依存関係属性のランファイルからターゲットのランファイルを入力する必要があります。

ラベルのリスト。デフォルトは [] です。

このターゲットの依存関係。通常は、ルールのターゲットのみを含めます。（一部のルールでは、ファイルを deps に直接リストすることを許可していますが、可能であれば避けてください）。

通常、言語固有のルールでは、特定のプロバイダのターゲットのみが表示されます。

ターゲットが deps を使用して別のターゲットに依存する意味の正確なセマンティクスは、ルールの種類に固有です。ルール固有のドキュメントで詳細を確認してください。ソースコードを処理するルールの場合、deps は通常、srcs のコードで使用されるコード依存関係を指定します。

ほとんどの場合、deps 依存関係は、1 つのモジュールが同じプログラミング言語で記述され、別々にコンパイルされた別のモジュールで定義されたシンボルを使用できるようにするために使用されます。多くの場合、言語間の依存関係も許可されます。たとえば、java_library ターゲットは、deps 属性に cc_library ターゲットの C++ コードをリストすることで、cc_library ターゲットの C++ コードに依存できます。詳細については、依存関係の定義をご覧ください。

文字列のリスト。構成不可。デフォルトは ["none"] です。

この特定のターゲットに使用するライセンス タイプの文字列のリスト。これは、Bazel で使用されなくなった非推奨のライセンス API の一部です。使用しないでください。

ラベルのリスト。デフォルトは [] です。

このルールによって処理または追加されたファイル。通常はファイルを直接一覧表示しますが、デフォルト出力を含めるようにルール ターゲット（filegroup や genrule など）を一覧表示することもできます。

多くの場合、言語固有のルールにより、リストされたファイルには特定のファイル拡張子を付けることが義務付けられています。

ラベルのリスト。構成不可。デフォルトは []。

デフォルトでサポートされている環境に加えて、このターゲットを構築できる環境のリスト。

これは Bazel の制約システムの一部であり、ユーザーは相互に依存できるターゲットとできないターゲットを宣言できます。たとえば、外部にデプロイ可能なバイナリは、企業秘密のコードを含むライブラリに依存しないようにしてください。詳細については、ConstraintSemantics をご覧ください。

文字列、設定不可、デフォルトは None

このターゲットに関連付けられた説明的な警告メッセージ。通常、これは、ターゲットが廃止された、別のルールに置き換えられた、パッケージ専用である、またはなんらかの理由で有害とみなされる可能性があることをユーザーに通知するために使用されます。メッセージが表示されないようにするために必要な変更を簡単に見つけられるように、参照情報（ウェブページ、バグ番号、移行 CL の例など）を含めることをおすすめします。ドロップイン リプレイスメントとして使用できる新しいターゲットがある場合は、古いターゲットのすべてのユーザーを移行することをおすすめします。

この属性はビルド方法には影響しませんが、ビルドツールの診断出力に影響する可能性があります。deprecation 属性を持つルールが別のパッケージ内のターゲットに依存している場合、ビルドツールは警告を出します。

パッケージ内の依存関係はこの警告から除外されるため、たとえば、非推奨のルールのテストをビルドしても警告は発生しません。

非推奨のターゲットが別の非推奨のターゲットに依存している場合、警告メッセージは出力されません。

ユーザーが使用しなくなったら、ターゲットを削除できます。

文字列のリスト。構成不可。デフォルトは [] です。

この特定のターゲットに使用される分散方法文字列のリスト。 これは、Bazel で使用されなくなった非推奨のライセンス API の一部です。これは使用しないでください。

ラベルのリスト。構成不可。デフォルトは []。

このターゲットの実行プラットフォームに存在する必要がある constraint_values のリスト。これは、ルールタイプによってすでに設定されている制約に加えて適用されます。制約は、使用可能な実行プラットフォームのリストを制限するために使用されます。詳細については、ツールチェーンの解決の説明をご覧ください。

文字列の辞書。デフォルトは {} です。

このターゲット用に選択したプラットフォームの exec_properties に追加される文字列の辞書。platform ルールの exec_properties をご覧ください。

プラットフォーム レベルのプロパティとターゲット レベルのプロパティの両方にキーが存在する場合、値はターゲットから取得されます。

特徴文字列のリスト。デフォルトは [] です。

特徴とは、ターゲットで有効または無効にできる文字列タグです。特徴の意味はルール自体によって異なります。

この features 属性は、 パッケージ レベルの features 属性と組み合わされます。たとえば、パッケージ レベルで特徴 ["a"、"b"] が有効になっており、ターゲットの features 属性に ["-a"、"c"] が含まれている場合、ルールで有効になる特徴は「b」と「c」になります。 例をご覧ください。

ラベルのリスト。構成不可。デフォルトは []。

デフォルトでサポートされている環境ではなく、このターゲットを構築できる環境のリスト。

これは Bazel の制約システムの一部です。詳しくは、compatible_with をご覧ください。

文字列のリスト。構成不可。デフォルトは [] です。

タグは任意のルールで使用できます。テストと test_suite ルールのタグは、テストを分類するのに役立ちます。テスト以外のターゲットのタグは、genrule と Starlark アクションのサンドボックス化された実行の制御や、人間や外部ツールによる解析に使用されます。

Bazel は、テストまたは genrule ターゲットの tags 属性、または Starlark アクションの execution_requirements のキーで次のキーワードが見つかった場合、サンドボックス化コードの動作を変更します。

• no-sandbox キーワードを使用すると、アクションまたはテストはサンドボックス化されません。キャッシュされるか、リモートで実行できます。no-cache または no-remote を使用して、このいずれかまたは両方を防止します。
• no-cache キーワードを使用すると、アクションまたはテストが（リモートまたはローカルで）キャッシュに保存されなくなります。
• no-remote-cache キーワードを使用すると、アクションまたはテストはリモートでキャッシュに保存されなくなります（ただし、ローカルにキャッシュに保存される場合や、リモートで実行される場合もあります）。注: このタグでは、ディスク キャッシュはローカル キャッシュと見なされ、http キャッシュと gRPC キャッシュはリモート キャッシュと見なされます。ローカル ディスク キャッシュとリモート キャッシュの組み合わせ（結合キャッシュ）を使用する場合、それはリモート キャッシュとして扱われ、--incompatible_remote_results_ignore_disk が設定されていない限り完全に無効になります。この場合、ローカル コンポーネントが使用されます。
• no-remote-exec キーワードを指定すると、アクションまたはテストがリモートで実行されることはありません（ただし、リモートのキャッシュは可能です）。
• no-remote キーワードを使用すると、アクションやテストがリモートで実行されたり、リモートでキャッシュに保存されたりするのを防ぐことができます。これは、no-remote-cache と no-remote-exec の両方を使用する場合と同じです。
• no-remote-cache-upload キーワードは、スポーンのリモート キャッシュのアップロード部分を無効にします。リモート実行が無効になることはありません。
• local キーワードを使用すると、アクションまたはテストがリモートでキャッシュに保存されたり、リモートで実行されたり、サンドボックス内で実行されたりすることはありません。genrule とテストの場合、local = True 属性でルールをマークしても同じ効果があります。
• requires-network キーワードを使用すると、サンドボックス内から外部ネットワークにアクセスできます。このタグは、サンドボックスが有効な場合にのみ効果があります。
• block-network キーワードは、サンドボックス内からの外部ネットワークへのアクセスをブロックします。この場合、localhost との通信のみが許可されます。このタグは、サンドボックスが有効な場合にのみ効果があります。
• requires-fakeroot は、uid と gid 0（root ユーザー）としてテストまたはアクションを実行します。これは Linux でのみサポートされています。このタグは、--sandbox_fake_username コマンドライン オプションよりも優先されます。

テストのタグは、通常、デバッグ プロセスとリリース プロセスにおけるテストの役割にアノテーションを付けるために使用されます。通常、タグは、ランタイム アノテーション機能がない C++ テストと Python テストに最も役立ちます。タグとサイズ要素を使用すると、コードベースのチェックイン ポリシーに基づいてテストスイートを柔軟に作成できます。

Bazel は、テストルールの tags 属性で次のキーワードが見つかった場合、テスト実行の動作を変更します。

• exclusive は、テストを強制的に「排他」モードで実行し、他のテストが同時に実行されないようにします。このようなテストは、すべてのビルド アクティビティと排他的でないテストが完了した後に、連続して実行されます。Bazel はリモートマシンで実行されているものを制御できないため、このようなテストではリモート実行が無効になっています。
• exclusive-if-local は、テストがローカルで実行される場合は強制的に「排他的」モードで実行しますが、リモートで実行される場合はテストを並行して実行します。
• manual キーワードは、build、test、coverage コマンドに対してビルド/実行するトップレベル ターゲット セットを計算する際に、テストを明示的にリストしない、ターゲット パターンのワイルドカード（...、:*、:all など）と test_suite ルールの拡張から対象のターゲットを除外します。query コマンドなどの他のコンテキストでのターゲット ワイルドカードやテストスイートの拡張には影響しません。manual は、継続的ビルド/テスト システムによってターゲットが自動的にビルド/実行されないことを意味するものではありません。たとえば、特定の Bazel フラグが必要なターゲットを bazel test ... から除外し、適切に構成されたプレ送信または継続的なテスト実行に含める場合があります。
• external キーワードを指定すると、（--cache_test_results 値に関係なく）テストが無条件に実行されます。

ラベルのリスト。デフォルトは [] です。

このターゲットに互換性があるとみなされるには、ターゲット プラットフォームに存在する必要がある constraint_value のリスト。これは、ルールタイプですでに設定されている制約に加えて適用されます。ターゲット プラットフォームがリストされている制約をすべて満たしていない場合、ターゲットは互換性がないとみなされます。互換性のないターゲットは、ターゲット パターンが拡張されるとき（//...、:all など）、ビルドとテストでスキップされます。コマンドラインで互換性のないターゲットを指定すると、Bazel でエラーが出力され、ビルドまたはテストが失敗します。

互換性のないターゲットに推移的に依存するターゲット自体は、互換性がないとみなされます。ビルドとテストでもスキップされます。

空のリスト（デフォルト）は、ターゲットがすべてのプラットフォームと互換性があることを示します。

Workspace Rules 以外のすべてのルールがこの属性をサポートしています。一部のルールでは、この属性は効果がありません。たとえば、cc_toolchain に target_compatible_with を指定しても意味がありません。

互換性のないターゲットのスキップの詳細については、プラットフォーム ページをご覧ください。

ブール値。構成不可。テスト ターゲットとテストスイート ターゲットを除き、デフォルトは False です。

True の場合、このターゲットに依存できるのは、testonly ターゲット（テストなど）のみです。

同様に、testonly 以外のルールが testonly のルールに依存することはできません。

テスト（*_test ルール）とテストスイート（test_suite ルール）はデフォルトで testonly です。

この属性は、本番環境にリリースされるバイナリにターゲットを含めないことを意味します。

testonly は実行時ではなくビルド時に適用され、依存関係ツリーにウイルスのように伝播するため、慎重に適用する必要があります。たとえば、単体テストに役立つスタブとフェイクは、本番環境にリリースされるのと同じバイナリを含む統合テストにも役立つため、testonly とマークしないでください。逆に、通常の動作を無条件にオーバーライドするためなど、リンクしても危険なルールは、必ず testonly とマークする必要があります。

ラベルのリスト。構成不可。デフォルトは [] です。

このターゲットがアクセスを許可されているMake 変数を持つターゲットのセット。これらのターゲットは、TemplateVariableInfo を提供するルールのインスタンスか、Bazel に組み込まれたツールチェーン タイプの特別なターゲットです。たとえば、次のようなものです。

• @bazel_tools//tools/cpp:current_cc_toolchain
• @bazel_tools//tools/jdk:current_java_runtime

これは、プラットフォーム依存の構成のルール実装で使用されるツールチェーン解決のコンセプトとは異なります。この属性を使用して、ターゲットが使用する特定の cc_toolchain または java_toolchain を特定することはできません。

ラベルのリスト。構成不可。指定されている場合はパッケージの default_visibility、指定されていない場合は "//visibility:private" がデフォルトです。

ターゲットの visibility 属性は、ターゲットを他のパッケージで使用できるかどうかを制御します。可視性については、ドキュメントをご覧ください。

文字列のリスト。$(location) と 「変数を作成」の置換、Bourne シェルのトークン化の対象。デフォルトは []

Bazel が bazel test で実行されたときにターゲットに渡すコマンドライン引数。

これらの引数は、bazel test コマンドラインで指定された --test_arg 値の前に渡されます。

文字列のディクショナリ。値は $(location) と 「変数を作成」の置換の対象となります。デフォルトは [] です。

bazel test によるテストの実行時に設定する追加の環境変数を指定します。

この属性は、cc_test、py_test、sh_test などのネイティブ ルールにのみ適用されます。Starlark で定義されたテストルールには適用されません。独自の Starlark ルールの場合は、「env」属性を追加して、TestEnvironment プロバイダに入力できます。

文字列のリスト。デフォルトは [] です。

bazel test によってテストが実行されるときに、外部環境から継承する追加の環境変数を指定します。

この属性は、cc_test、py_test、sh_test などのネイティブ ルールにのみ適用されます。Starlark で定義されたテストルールには適用されません。

文字列 "enormous"、"large"、"medium"、または "small"。構成不可。デフォルトは "medium" です。

テスト対象の「負荷」: 実行に必要な時間とリソースの量を指定します。

単体テストは「小規模」、インテグレーション テストは「中規模」、エンドツーエンド テストは「大規模」または「非常に大規模」と見なされます。Bazel はサイズを使用してデフォルトのタイムアウトを決定します。これは timeout 属性を使用してオーバーライドできます。タイムアウトは、個々のテストではなく、BUILD ターゲットのすべてのテストに適用されます。テストがローカルで実行される場合、size はスケジューリング目的でさらに使用されます。Bazel は --local_{ram,cpu}_resources を尊重し、多くの負荷の高いテストを同時に実行してローカルマシンを圧倒しないようにします。

テストサイズは、次のデフォルトのタイムアウトと想定されるピーク時のローカル リソース使用量に対応しています。

テストのスポーン時に、環境変数 TEST_SIZE がこの属性の値に設定されます。

文字列 "short"、"moderate"、"long"、または "eternal"。設定不可。デフォルトはテストの size 属性から取得されます。

テストが完了するまでに予想される時間。

テストのサイズ属性はリソースの推定値を制御しますが、テストのタイムアウトは個別に設定できます。明示的に指定しない場合、タイムアウトはテストのサイズに基づきます。テストのタイムアウトは、--test_timeout フラグでオーバーライドできます。たとえば、遅いことがわかっている特定の条件下で実行する場合などです。テストのタイムアウト値は、次の期間に対応します。

上記以外の時間では、テストのタイムアウトを --test_timeout bazel フラグでオーバーライドできます。たとえば、遅いことが判明している条件で手動で実行する場合などです。--test_timeout 値は秒単位です。たとえば、--test_timeout=120 はテストのタイムアウトを 2 分に設定します。

環境変数 TEST_TIMEOUT は、テストの生成時にテストのタイムアウト（秒単位）に設定されます。

ブール値。構成不可。デフォルトは False です。

テストを不安定なものとしてマークします。

設定されている場合、テストは最大 3 回実行され、毎回失敗した場合にのみ不合格としてマークされます。デフォルトでは、この属性は False に設定され、テストは 1 回だけ実行されます。なお、この属性の使用は、通常はおすすめしません。アサーションが維持されていれば、テストは確実に合格する必要があります。

50 以下の正の整数。デフォルトは -1 です。

テストの実行に使用する並列シャードの数を指定します。

設定すると、この値は、テストを実行する並列シャードの数を決定するために使用されるヒューリスティックをオーバーライドします。一部のテストルールでは、シャーディングを有効にするためにこのパラメータが必要になる場合があります。--test_sharding_strategy もご覧ください。

テスト シャーディングが有効になっている場合、テストのスポーン時に環境変数 TEST_TOTAL_SHARDS がこの値に設定されます。

シャーディングを行うには、テストランナーがテスト シャーディング プロトコルをサポートしている必要があります。そうしないと、すべてのシャードですべてのテストが実行される可能性が高くなりますが、これは望ましい動作ではありません。

シャーディングの詳細については、テスト エンサイクロペディアのテスト シャーディングをご覧ください。

ブール値。構成不可。デフォルトは False です。

テストをサンドボックス化せずにローカルで強制的に実行します。

この値を True に設定することは、タグ（tags=["local"]）として「local」を指定することと同様です。

文字列のリスト。$(location) と 「変数を作成」の置換、Bourne シェルのトークン化の対象。構成不可。デフォルトは []。

run コマンドまたはテストとして実行されるときに Bazel がターゲットに渡すコマンドライン引数。これらの引数は、bazel run または bazel test コマンドラインで指定された引数の前に渡されます。

注: Bazel の外部でターゲットを実行する場合（bazel-bin/ でバイナリを手動で実行するなど）、引数は渡されません。

文字列の辞書。値は $(location) と 「変数を作成」の置換の対象となります。デフォルトは {} です。

ターゲットが bazel run によって実行されるときに設定する追加の環境変数を指定します。

この属性は、cc_binary、py_binary、sh_binary などのネイティブ ルールにのみ適用されます。Starlark で定義された実行可能ルールには適用されません。

注: Bazel の外部でターゲットを実行する場合（bazel-bin/ でバイナリを手動で実行する場合など）は、環境変数は設定されません。

文字列のリスト。デフォルトは [] です。

このバイナリが生成する出力ファイルのライセンス。これは、Bazel で使用されなくなった非推奨のライセンス API の一部です。これは使用しないでください。