このページでは、Bazel のクエリ言語を使用してコード内の依存関係をトレースする方法について説明します。
言語の詳細と --output フラグの詳細については、リファレンス マニュアルの Bazel クエリ リファレンスと Bazel cquery リファレンスをご覧ください。コマンドラインから bazel help query または bazel help cquery と入力すると、ヘルプを取得できます。
ターゲットの欠落などのエラーを無視してクエリを実行するには、--keep_going フラグを使用します。
ルールの依存関係の検索
//foo の依存関係を確認するには、bazel クエリで deps 関数を使用します。
$ bazel query "deps(//foo)" //foo:foo //foo:foo-dep ...
これは、//foo のビルドに必要なすべてのターゲットのセットです。
2 つのパッケージ間の依存関係チェーンをトレースする
ライブラリ //third_party/zlib:zlibonly は //foo の BUILD ファイルにはありませんが、間接的な依存関係です。この依存関係パスをトレースするにはどうすればよいですか？便利な関数は allpaths と somepath の 2 つです。ビルドしたアーティファクトに含まれるもののみを対象とし、すべてのジョブを対象としない場合は、--notool_deps を使用してツールの依存関係を除外することもできます。
すべての依存関係のグラフを可視化するには、bazel クエリの出力を dot コマンドライン ツールにパイプします。
$ bazel query "allpaths(//foo, third_party/...)" --notool_deps --output graph | dot -Tsvg > /tmp/deps.svg
依存関係グラフが大きく複雑な場合は、1 つのパスから始めると役に立ちます。
$ bazel query "somepath(//foo:foo, third_party/zlib:zlibonly)" //foo:foo //translations/tools:translator //translations/base:base //third_party/py/MySQL:MySQL //third_party/py/MySQL:_MySQL.so //third_party/mysql:mysql //third_party/zlib:zlibonly
allpaths で --output graph を指定しない場合、依存関係グラフのフラット化されたリストが返されます。
$ bazel query "allpaths(//foo, third_party/...)" ...many errors detected in BUILD files... //foo:foo //translations/tools:translator //translations/tools:aggregator //translations/base:base //tools/pkg:pex //tools/pkg:pex_phase_one //tools/pkg:pex_lib //third_party/python:python_lib //translations/tools:messages //third_party/py/xml:xml //third_party/py/xml:utils/boolean.so //third_party/py/xml:parsers/sgmlop.so //third_party/py/xml:parsers/pyexpat.so //third_party/py/MySQL:MySQL //third_party/py/MySQL:_MySQL.so //third_party/mysql:mysql //third_party/openssl:openssl //third_party/zlib:zlibonly //third_party/zlib:zlibonly_v1_2_3 //third_party/python:headers //third_party/openssl:crypto
余談: 暗黙的な依存関係
//foo の BUILD ファイルは //translations/tools:aggregator を参照しません。直接依存関係はどこにあるのでしょうか。
特定のルールには、追加のライブラリやツールに対する暗黙的な依存関係が含まれています。たとえば、genproto ルールをビルドするには、まずプロトコル コンパイラをビルドする必要があります。そのため、すべての genproto ルールにはプロトコル コンパイラに対する暗黙的な依存関係があります。これらの依存関係はビルドファイルには記載されていませんが、ビルドツールによって追加されます。暗黙的な依存関係の完全なセットは現在ドキュメント化されていません。--noimplicit_deps を使用すると、これらの依存関係をクエリ結果から除外できます。cquery の場合、解決された toolchain が含まれます。
依存関係を逆にする
特定のターゲットに依存するターゲット セットを知りたい場合があります。たとえば、コードを変更する場合は、破壊する他のコードを把握しておく必要があります。rdeps(u, x) を使用すると、u の推移閉包内で x のターゲットの逆依存関係を見つけることができます。
Bazel の Sky Query は、指定したユニバースでリバース依存関係をクエリできる allrdeps 関数をサポートしています。
その他の用途
bazel query を使用すると、多くの依存関係を分析できます。
存在する ...
foo の下に存在するパッケージ
bazel query 'foo/...' --output package
foo パッケージで定義されているルール
bazel query 'kind(rule, foo:*)' --output label_kind
foo パッケージのルールによって生成されるファイル
bazel query 'kind("generated file", //foo:*)'Starlark マクロ foo によって生成されるターゲット
bazel query 'attr(generator_function, foo, //path/to/search/...)'
//foo のビルドに必要な BUILD ファイルのセットはどれですか？
bazel query 'buildfiles(deps(//foo))' | cut -f1 -d:
test_suite が展開される個々のテストは何ですか？
bazel query 'tests(//foo:smoke_tests)'
どのテストが C++ テストですか？
bazel query 'kind(cc_.*, tests(//foo:smoke_tests))'
小さいのはどれですか？中程度？大きい？
bazel query 'attr(size, small, tests(//foo:smoke_tests))' bazel query 'attr(size, medium, tests(//foo:smoke_tests))' bazel query 'attr(size, large, tests(//foo:smoke_tests))'
foo の下にある、パターンに一致するテストは何ですか？
bazel query 'filter("pa?t", kind(".*_test rule", //foo/...))'パターンは正規表現で、ルールのフルネームに適用されます。これは、
bazel query 'kind(".*_test rule", //foo/...)' | grep -E 'pa?t'ファイル path/to/file/bar.java が含まれているパッケージ
bazel query path/to/file/bar.java --output=package
path/to/file/bar.java? のビルドラベル
bazel query path/to/file/bar.java
ファイル path/to/file/bar.java がソースとして含まれているルール ターゲット
fullname=$(bazel query path/to/file/bar.java)
bazel query "attr('srcs', $fullname, ${fullname//:*/}:*)"
存在するパッケージの依存関係
foo はどのパッケージに依存していますか？（foo をビルドするためにチェックアウトする必要があるもの）
bazel query 'buildfiles(deps(//foo:foo))' --output package
foo ツリーは、foo/contrib を除くどのパッケージに依存していますか。
bazel query 'deps(foo/... except foo/contrib/...)' --output package
どのようなルールの依存関係が存在するか
bar はどの genproto ルールに依存していますか？
bazel query 'kind(genproto, deps(bar/...))'
サーブレット ツリー内の Java バイナリルールによって推移的に依存されている JNI（C++）ライブラリの定義を見つけます。
bazel query 'some(kind(cc_.*library, deps(kind(java_binary, //java/com/example/frontend/...))))' --output location
...次に、それらに依存するすべての Java バイナリの定義を探します。
bazel query 'let jbs = kind(java_binary, //java/com/example/frontend/...) in
let cls = kind(cc_.*library, deps($jbs)) in
$jbs intersect allpaths($jbs, $cls)'
どのようなファイル依存関係が存在するのか
foo のビルドに必要な Java ソースファイルの完全なセットは何ですか。
ソースファイル:
bazel query 'kind("source file", deps(//path/to/target/foo/...))' | grep java$生成されたファイル:
bazel query 'kind("generated file", deps(//path/to/target/foo/...))' | grep java$QUX のテストビルドに必要な Java ソースファイルの完全なセットは何ですか。
ソースファイル:
bazel query 'kind("source file", deps(kind(".*_test rule", javatests/com/example/qux/...)))' | grep java$生成されたファイル:
bazel query 'kind("generated file", deps(kind(".*_test rule", javatests/com/example/qux/...)))' | grep java$X と Y の依存関係の違い
//foo は //foo:foolib が依存していないターゲットに依存しています。
bazel query 'deps(//foo) except deps(//foo:foolib)'
foo テストが依存する C++ ライブラリのうち、//foo 本番環境バイナリが依存しないものはどれですか？
bazel query 'kind("cc_library", deps(kind(".*test rule", foo/...)) except deps(//foo))'この依存関係が存在する理由
bar が groups2 に依存するのはなぜですか？
bazel query 'somepath(bar/...,groups2/...:*)'
このクエリの結果を取得すると、bar の予期しない、または悪質で望ましくない依存関係として、単一のターゲットが目立つことがよくあります。このクエリをさらに絞り込むと、次のようにできます。
docker/updater:updater_systest（py_test）から、それが依存する cc_library へのパスを表示します。
bazel query 'let cc = kind(cc_library, deps(docker/updater:updater_systest)) in somepath(docker/updater:updater_systest, $cc)'
ライブラリ //photos/frontend:lib が同じライブラリ //third_party/jpeglib と //third_party/jpeg の 2 つのバリアントに依存しているのはなぜですか？
このクエリは、「両方のライブラリに依存する //photos/frontend:lib のサブグラフを表示」に要約できます。トポロジ順に表示された結果の最後の要素が原因である可能性が高いです。
bazel query 'allpaths(//photos/frontend:lib, //third_party/jpeglib)
intersect
allpaths(//photos/frontend:lib, //third_party/jpeg)'
//photos/frontend:lib
//photos/frontend:lib_impl
//photos/frontend:lib_dispatcher
//photos/frontend:icons
//photos/frontend/modules/gadgets:gadget_icon
//photos/thumbnailer:thumbnail_lib
//third_party/jpeg/img:renderer
次に依存する内容
バーの下にあるどのルールが Y に依存していますか。
bazel query 'bar/... intersect allpaths(bar/..., Y)'
T のパッケージ内の T に直接依存するターゲットはどれですか。
bazel query 'same_pkg_direct_rdeps(T)'
依存関係を破棄するにはどうすればよいですか？
bar が X に依存しないようにするには、どの依存関係パスを破壊する必要がありますか？
グラフを svg ファイルに出力するには:
bazel query 'allpaths(bar/...,X)' --output graph | dot -Tsvg > /tmp/dep.svg
その他
//foo-tests ビルドには連続したステップがいくつありますか。
残念ながら、現在のところ、クエリ言語では x から y までの最長パスを取得できませんが、開始点から最も遠いノード（またはノード）を見つけたり、x から依存するすべての y までの最長パスの長さを表示したりすることはできます。maxrank を使用します。
bazel query 'deps(//foo-tests)' --output maxrank | tail -1 85 //third_party/zlib:zutil.c
この結果は、このビルドで順序付けが必要な長さ 85 のパスが存在することを示しています。