Petunjuk Kueri Bazel

Halaman ini membahas cara memulai penggunaan bahasa kueri Bazel untuk melacak dependensi dalam kode Anda.

Untuk mengetahui detail bahasa dan --output flag details, lihat panduan referensi, Referensi kueri Bazel dan Referensi cquery Bazel. Anda bisa mendapatkan bantuan dengan mengetik bazel help query atau bazel help cquery di command line.

Untuk menjalankan kueri sambil mengabaikan error seperti target yang tidak ada, gunakan flag --keep_going.

Menemukan dependensi aturan

Untuk melihat dependensi //foo, gunakan fungsi deps dalam kueri bazel:

$ bazel query "deps(//foo)"
//foo:foo
//foo:foo-dep
...

Ini adalah kumpulan semua target yang diperlukan untuk mem-build //foo.

Melacak rantai dependensi antara dua paket

Library //third_party/zlib:zlibonly tidak ada dalam file BUILD untuk //foo, tetapi merupakan dependensi tidak langsung. Bagaimana cara melacak jalur dependensi ini? Ada dua fungsi yang berguna di sini: allpaths dan somepath. Anda mungkin juga ingin mengecualikan dependensi alat dengan --notool_deps jika hanya ingin mengetahui apa yang disertakan dalam artefak yang Anda buat, dan bukan setiap tugas yang mungkin.

Untuk memvisualisasikan grafik semua dependensi, salurkan output kueri bazel melalui alat command line dot:

$ bazel query "allpaths(//foo, third_party/...)" --notool_deps --output graph | dot -Tsvg > /tmp/deps.svg

Jika grafik dependensi besar dan rumit, sebaiknya mulai dengan satu jalur:

$ 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

Jika Anda tidak menentukan --output graph dengan allpaths, Anda akan mendapatkan daftar grafik dependensi yang diratakan.

$ 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

Selain itu: dependensi implisit

File BUILD untuk //foo tidak pernah mereferensikan //translations/tools:aggregator. Jadi, di mana dependensi langsungnya?

Aturan tertentu menyertakan dependensi implisit pada library atau alat tambahan. Misalnya, untuk mem-build aturan genproto, Anda harus mem-build Protocol Compiler terlebih dahulu, sehingga setiap aturan genproto memiliki dependensi implisit pada compiler protokol. Dependensi ini tidak disebutkan dalam file build, tetapi ditambahkan oleh alat build. Kumpulan lengkap dependensi implisit saat ini tidak didokumentasikan. Menggunakan --noimplicit_deps memungkinkan Anda memfilter dependensi ini dari hasil kueri. Untuk cquery, hal ini akan mencakup rantai alat yang diselesaikan.

Dependensi terbalik

Anda mungkin ingin mengetahui kumpulan target yang bergantung pada target tertentu. Misalnya, jika Anda akan mengubah beberapa kode, Anda mungkin ingin mengetahui kode lain yang akan Anda rusak. Anda dapat menggunakan rdeps(u, x) untuk menemukan dependensi terbalik dari target di x dalam penutupan transitif u.

Sky Query Bazel mendukung fungsi allrdeps yang memungkinkan Anda membuat kueri dependensi terbalik di universe yang Anda tentukan.

Penggunaan lain-lain

Anda dapat menggunakan bazel query untuk menganalisis banyak hubungan dependensi.

Apa yang ada ...

Paket apa yang ada di bawah foo?

bazel query 'foo/...' --output package

Aturan apa yang ditentukan dalam paket foo?

bazel query 'kind(rule, foo:*)' --output label_kind

File apa yang dibuat oleh aturan dalam paket foo?

bazel query 'kind("generated file", //foo:*)'

Target apa yang dibuat oleh makro starlark foo?

bazel query 'attr(generator_function, foo, //path/to/search/...)'

Apa kumpulan file BUILD yang diperlukan untuk mem-build //foo?

bazel query 'buildfiles(deps(//foo))' | cut -f1 -d:

Apa saja pengujian individual yang diperluas oleh test_suite?

bazel query 'tests(//foo:smoke_tests)'

Manakah di antaranya yang merupakan pengujian C++?

bazel query 'kind(cc_.*, tests(//foo:smoke_tests))'

Manakah di antaranya yang kecil? Sedang? Besar?

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))'

Apa saja pengujian di bawah foo yang cocok dengan pola?

bazel query 'filter("pa?t", kind(".*_test rule", //foo/...))'

Pola ini adalah ekspresi reguler dan diterapkan ke nama lengkap aturan. Hal ini mirip dengan melakukan

bazel query 'kind(".*_test rule", //foo/...)' | grep -E 'pa?t'

Paket apa yang berisi file path/to/file/bar.java?

 bazel query path/to/file/bar.java --output=package

Apa label build untuk path/to/file/bar.java?

bazel query path/to/file/bar.java

Target aturan apa yang berisi file path/to/file/bar.java sebagai sumber?

fullname=$(bazel query path/to/file/bar.java)
bazel query "attr('srcs', $fullname, ${fullname//:*/}:*)"

Dependensi paket apa yang ada ...

Paket apa yang bergantung pada foo? (Apa yang perlu saya periksa untuk mem-build foo)

bazel query 'buildfiles(deps(//foo:foo))' --output package

Paket apa yang bergantung pada pohon foo, tidak termasuk foo/contrib?

bazel query 'deps(foo/... except foo/contrib/...)' --output package

Dependensi aturan apa yang ada ...

Aturan genproto apa yang bergantung pada bar?

bazel query 'kind(genproto, deps(bar/...))'

Temukan definisi beberapa library JNI (C++) yang bergantung secara transitif oleh aturan biner Java di pohon servlet.

bazel query 'some(kind(cc_.*library, deps(kind(java_binary, //java/com/example/frontend/...))))' --output location
...Sekarang temukan definisi semua biner Java yang bergantung padanya
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)'

Dependensi file apa yang ada ...

Apa kumpulan lengkap file sumber Java yang diperlukan untuk mem-build foo?

File sumber:

bazel query 'kind("source file", deps(//path/to/target/foo/...))' | grep java$

File yang dibuat:

bazel query 'kind("generated file", deps(//path/to/target/foo/...))' | grep java$

Apa kumpulan lengkap file sumber Java yang diperlukan untuk mem-build pengujian QUX?

File sumber:

bazel query 'kind("source file", deps(kind(".*_test rule", javatests/com/example/qux/...)))' | grep java$

File yang dibuat:

bazel query 'kind("generated file", deps(kind(".*_test rule", javatests/com/example/qux/...)))' | grep java$

Perbedaan dependensi antara X dan Y apa yang ada ...

Target apa yang bergantung pada //foo yang tidak bergantung pada //foo:foolib?

bazel query 'deps(//foo) except deps(//foo:foolib)'

Library C++ apa yang bergantung pada pengujian foo yang //foo biner produksi tidak bergantung pada?

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

Mengapa dependensi ini ada ...

Mengapa bar bergantung pada groups2?

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

Setelah mendapatkan hasil kueri ini, Anda akan sering menemukan bahwa satu target menonjol sebagai dependensi bar yang tidak terduga atau sangat tidak diinginkan. Kueri kemudian dapat disaring lebih lanjut menjadi:

Tampilkan jalur dari docker/updater:updater_systest (py_test) ke beberapa cc_library yang bergantung padanya:

bazel query 'let cc = kind(cc_library, deps(docker/updater:updater_systest)) in
  somepath(docker/updater:updater_systest, $cc)'

Mengapa library //photos/frontend:lib bergantung pada dua varian library yang sama, //third_party/jpeglib dan //third_party/jpeg?

Kueri ini dapat disimpulkan menjadi: "tampilkan subgraf //photos/frontend:lib yang bergantung pada kedua library". Jika ditampilkan dalam urutan topologi, elemen terakhir dari hasil adalah penyebab yang paling mungkin.

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

Apa yang bergantung pada ...

Aturan apa di bawah bar yang bergantung pada Y?

bazel query 'bar/... intersect allpaths(bar/..., Y)'

Target apa yang bergantung langsung pada T, dalam paket T?

bazel query 'same_pkg_direct_rdeps(T)'

Bagaimana cara memutus dependensi ...

Jalur dependensi apa yang harus saya putus agar bar tidak lagi bergantung pada X?

Untuk menampilkan grafik ke file svg:

bazel query 'allpaths(bar/...,X)' --output graph | dot -Tsvg > /tmp/dep.svg

Lain-lain

Berapa banyak langkah berurutan dalam build //foo-tests?

Sayangnya, bahasa kueri saat ini tidak dapat memberikan jalur terpanjang dari x ke y, tetapi dapat menemukan node terjauh (atau lebih tepatnya a) dari titik awal, atau menunjukkan panjang jalur terpanjang dari x ke setiap y yang bergantung padanya. Gunakan maxrank:

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

Hasilnya menunjukkan bahwa ada jalur dengan panjang 85 yang harus terjadi secara berurutan dalam build ini.