クエリガイド

問題を報告 ソースを表示

このページでは、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 ファイル内にはありませんが、間接的な依存関係です。この依存関係パスをトレースするにはどうすればよいでしょうか。ここには、allpathssomepath という 2 つの便利な関数があります。また、可能なすべてのジョブではなく、ビルドしたアーティファクトに含まれるもののみを重視する場合は、--notool_deps でツールの依存関係を除外することもできます。

すべての依存関係のグラフを可視化するには、dot コマンドライン ツールで bazel クエリの出力をパイプします。

$ 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 の場合は解決済みのツールチェーンが含まれます。

逆依存関係

あるターゲットに依存する一連のターゲットについて知りたい場合があります。たとえば、コードの一部を変更する場合に、破損しようとしている他のコードを確認したい場合があります。rdeps(u, x) を使用すると、u の推移的クロージャ内で x 内のターゲットの逆依存関係を見つけることができます。

Bazel の Sky Queryallrdeps 関数をサポートしています。これにより、指定したユニバース内の逆依存関係をクエリできます。

その他の用途

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

存在するルールの依存関係

バーが依存する 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 テストで、//foo 本番環境バイナリが依存しない C++ ライブラリはどれですか?

bazel query 'kind("cc_library", deps(kind(".*test rule", foo/...)) except deps(//foo))'

この依存関係が存在する理由

bargroups2 に依存する理由

bazel query 'somepath(bar/...,groups2/...:*)'

このクエリの結果から、1 つのターゲットが bar の予期しない、または悪質で望ましくない依存関係として目立つことに気づくことがよくあります。このクエリは、次のようにさらに絞り込むことができます。

docker/updater:updater_systestpy_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 への最長経路は得られませんが、始点から最も遠いノード(あるいは aa)を見つけるか、x から依存するすべての y までの最長経路のaを表示できます。maxrank を使用します。

bazel query 'deps(//foo-tests)' --output maxrank | tail -1
85 //third_party/zlib:zutil.c

結果は、このビルドに順番に実行する必要がある長さ 85 のパスが存在することを示しています。