Perintah aquery
memungkinkan Anda membuat kueri untuk tindakan dalam grafik build.
Analisis ini beroperasi pada Grafik Target yang Dikonfigurasi pasca-analisis dan menampilkan
informasi tentang Tindakan, Artefak, dan hubungan keduanya.
aquery
berguna jika Anda tertarik dengan properti Tindakan/Artefak
yang dihasilkan dari Konfigurasi Target Grafik. Misalnya, perintah yang
sebenarnya berjalan
dan input/output/mnemoniknya.
Alat ini menerima beberapa opsi command line. Secara khusus, perintah {i>aquery<i} berjalan di atas {i>build<i} Bazel biasa dan mewarisi seperangkat opsi yang tersedia selama proses build.
Alat ini mendukung serangkaian fungsi yang
sama yang juga tersedia untuk
query
tetapi siblings
, buildfiles
, dan
tests
.
Contoh output aquery
(tanpa detail spesifik):
$ bazel aquery 'deps(//some:label)' action 'Writing file some_file_name' Mnemonic: ... Target: ... Configuration: ... ActionKey: ... Inputs: [...] Outputs: [...]
Sintaksis dasar
Contoh sederhana sintaksis untuk aquery
adalah sebagai berikut:
bazel aquery "aquery_function(function(//target))"
Ekspresi kueri (dalam tanda kutip) terdiri dari hal berikut:
aquery_function(...)
: fungsi khusus untukaquery
. Lihat detail selengkapnya di bawah.function(...)
: fungsi standar sebagaiquery
tradisional.//target
adalah label bagi target yang tertarik.
# aquery examples: # Get the action graph generated while building //src/target_a $ bazel aquery '//src/target_a' # Get the action graph generated while building all dependencies of //src/target_a $ bazel aquery 'deps(//src/target_a)' # Get the action graph generated while building all dependencies of //src/target_a # whose inputs filenames match the regex ".*cpp". $ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'
Menggunakan fungsi kueri
Ada tiga fungsi aquery
:
inputs
: memfilter tindakan menurut input.outputs
: tindakan filter menurut outputmnemonic
: memfilter tindakan menurut mnemonik
expr ::= inputs(word, expr)
Operator inputs
menampilkan tindakan yang dihasilkan dari gedung expr
,
yang nama file inputnya cocok dengan ekspresi reguler yang disediakan oleh word
.
$ bazel aquery 'inputs(".*cpp", deps(//src/target_a))'
Fungsi outputs
dan mnemonic
memiliki sintaksis yang serupa.
Anda juga dapat menggabungkan fungsi untuk mencapai operasi AND. Contoh:
$ bazel aquery 'mnemonic("Cpp.*", (inputs(".*cpp", inputs("foo.*", //src/target_a))))'
Perintah di atas akan menemukan semua tindakan yang terlibat dalam pembuatan //src/target_a
,
yang mnemoniknya cocok dengan "Cpp.*"
dan inputnya cocok dengan pola
".*cpp"
dan "foo.*"
.
Contoh error sintaksis yang dihasilkan:
$ bazel aquery 'deps(inputs(".*cpp", //src/target_a))' ERROR: aquery filter functions (inputs, outputs, mnemonic) produce actions, and therefore can't be the input of other function types: deps deps(inputs(".*cpp", //src/target_a))
Opsi
Opsi build
aquery
berjalan di atas build Bazel reguler sehingga mewarisi set
opsi
yang tersedia selama build.
Opsi kueri
--output=(text|summary|proto|jsonproto|textproto), default=text
Format output default (text
) adalah
yang dapat dibaca manusia,
gunakan proto
, textproto
, atau jsonproto
untuk format yang dapat dibaca mesin.
Pesan proto adalah analysis.ActionGraphContainer
.
--include_commandline, default=true
Menyertakan konten command line tindakan di output (kemungkinan besar).
--include_artifacts, default=true
Menyertakan nama input dan output tindakan dalam output (kemungkinan besar).
--include_aspects, default=true
Apakah akan menyertakan tindakan yang dihasilkan Aspek di output.
--include_param_files, default=false
Sertakan konten file parameter yang digunakan dalam perintah (kemungkinan besar).
--include_file_write_contents, default=false
Sertakan konten file untuk tindakan actions.write()
dan konten
file manifes untuk tindakan SourceSymlinkManifest
. Isi file adalah
ditampilkan di kolom file_contents
dengan --output=
xxxproto
.
Dengan --output=text
, output-nya memiliki
FileWriteContents: [<base64-encoded file contents>]
garis
--skyframe_state, default=false
Tanpa melakukan analisis tambahan, buang Action Graph dari Skyframe.
Alat dan fitur lainnya
Membuat kueri untuk status Skyframe
Skyframe adalah evaluasi dan model inkrementalitas Bazel. Pada setiap {i>instance<i} server Bazel, Skyframe menyimpan grafik dependensi yang dibuat dari proses fase Analisis sebelumnya.
Dalam beberapa kasus, akan berguna jika melakukan kueri Action Graph di Skyframe. Contoh kasus penggunaannya adalah:
- Jalankan
bazel build //target_a
- Jalankan
bazel build //target_b
- File
foo.out
telah dibuat.
Sebagai pengguna Bazel, saya ingin menentukan apakah foo.out
dibuat dari build
//target_a
atau //target_b
.
Seseorang dapat menjalankan bazel aquery 'outputs("foo.out", //target_a)'
dan
bazel aquery 'outputs("foo.out", //target_b)'
untuk mengetahui tindakan yang bertanggung jawab
untuk membuat foo.out
, lalu targetnya. Namun, jumlah perbedaan
target yang sebelumnya dibuat bisa lebih besar dari 2, sehingga menjalankan beberapa aquery
perintah yang merepotkan.
Sebagai alternatif, flag --skyframe_state
dapat digunakan:
# List all actions on Skyframe's action graph $ bazel aquery --output=proto --skyframe_state # or # List all actions on Skyframe's action graph, whose output matches "foo.out" $ bazel aquery --output=proto --skyframe_state 'outputs("foo.out")'
Dengan mode --skyframe_state
, aquery
mengambil konten Grafik Tindakan
yang disimpan Skyframe pada {i>instance<i} Bazel, (secara opsional) melakukan penyaringan pada {i>instance<i} itu dan
menghasilkan output konten, tanpa
menjalankan ulang fase analisis.
Pertimbangan khusus
Format output
--skyframe_state
saat ini hanya tersedia untuk --output=proto
dan --output=textproto
Tidak disertakannya label target dalam ekspresi kueri
Saat ini, --skyframe_state
mengkueri seluruh grafik tindakan yang ada di Skyframe,
terlepas dari targetnya. Memiliki label target yang ditentukan dalam kueri bersama dengan
--skyframe_state
dianggap sebagai error sintaksis:
# WRONG: Target Included $ bazel aquery --output=proto --skyframe_state **//target_a** ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported. # WRONG: Target Included $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java", **//target_a**)' ERROR: Error while parsing '//target_a)': Specifying build target(s) [//target_a] with --skyframe_state is currently not supported. # CORRECT: Without Target $ bazel aquery --output=proto --skyframe_state $ bazel aquery --output=proto --skyframe_state 'inputs(".*.java")'
Membandingkan output kueri
Anda dapat membandingkan output dari dua pemanggilan kueri yang berbeda menggunakan alat aquery_differ
.
Misalnya: saat Anda membuat beberapa perubahan pada definisi aturan dan ingin memverifikasi bahwa
baris perintah yang dijalankan tidak berubah. aquery_differ
adalah alat untuk itu.
Alat ini tersedia di repositori bazelbuild/bazel. Untuk menggunakannya, clone repositori ke komputer lokal Anda. Contoh penggunaan:
$ bazel run //tools/aquery_differ -- \ --before=/path/to/before.proto \ --after=/path/to/after.proto \ --input_type=proto \ --attrs=cmdline \ --attrs=inputs
Perintah di atas menampilkan perbedaan antara output kueri before
dan after
:
tindakan mana yang ada di salah satunya, tetapi tidak yang lain, yang tindakan memiliki
command line/input berikut di setiap output kueri, ...). Hasil dari menjalankan perintah di atas adalah:
Aquery output 'after' change contains an action that generates the following outputs that aquery output 'before' change doesn't: ... /list of output files/ ... [cmdline] Difference in the action that generates the following output(s): /path/to/abc.out --- /path/to/before.proto +++ /path/to/after.proto @@ -1,3 +1,3 @@ ... /cmdline diff, in unified diff format/ ...
Opsi perintah
--before, --after
: File output kueri yang akan dibandingkan
--input_type=(proto|text_proto), default=proto
: format input
. Dukungan diberikan untuk output kueri proto
dan textproto
.
--attrs=(cmdline|inputs), default=cmdline
: atribut tindakan
untuk dibandingkan.
Aspek di aspek
Dimungkinkan untuk Aspek untuk diterapkan di atas satu sama lain. Output kueri dari tindakan yang dihasilkan oleh Aspek ini kemudian akan menyertakan Jalur aspek, yang merupakan urutan Aspek yang diterapkan ke target yang menghasilkan tindakan.
Contoh Aspect-on-Aspect:
t0 ^ | <- a1 t1 ^ | <- a2 t2
Anggap i menjadi target aturan ri, yang menerapkan Aspek ai pada dependensinya.
Asumsikan bahwa a2 menghasilkan tindakan X saat diterapkan ke target t0. Output teks dari
bazel aquery --include_aspects 'deps(//t2)'
untuk tindakan X adalah:
action ... Mnemonic: ... Target: //my_pkg:t0 Configuration: ... AspectDescriptors: [//my_pkg:rule.bzl%**a2**(foo=...) -> //my_pkg:rule.bzl%**a1**(bar=...)] ...
Ini berarti bahwa tindakan X
dihasilkan oleh Aspek a2
yang diterapkan ke
a1(t0)
, dengan a1(t0)
adalah hasil Aspek a1
yang diterapkan
ke target t0
.
Setiap AspectDescriptor
memiliki format berikut:
AspectClass([param=value,...])
AspectClass
dapat berupa nama class Aspect (untuk Aspek native) atau
bzl_file%aspect_name
(untuk Starlark Aspects). AspectDescriptor
adalah
diurutkan dalam urutan topologis
grafik dependensi.
Menautkan dengan profil JSON
Sementara kueri memberikan informasi tentang tindakan yang sedang dijalankan dalam build (mengapa mereka dijalankan, input/outputnya), profil JSON memberi tahu kita waktu dan durasi eksekusinya. 2 set informasi ini dapat digabungkan melalui penyebut yang sama: output utama suatu tindakan.
Untuk menyertakan tindakan di profil JSON, buat profil dengan
--experimental_include_primary_output --noslim_profile
.
Profil ramping tidak kompatibel dengan penyertaan output utama. Output utama tindakan
disertakan secara {i>
default<i} oleh kueri.
Saat ini kami tidak menyediakan alat kanonis untuk menggabungkan 2 sumber data ini, tetapi Anda harus mampu membuat skrip Anda sendiri dengan informasi di atas.
Masalah umum
Menangani tindakan bersama
Terkadang tindakan dibagikan di antara target yang dikonfigurasi.
Pada fase eksekusi, tindakan
bersama tersebut akan
hanya dianggap sebagai satu dan hanya dijalankan sekali.
Namun, kueri beroperasi pada grafik tindakan pra-eksekusi, pasca-analisis, dan karenanya memperlakukan
seperti tindakan terpisah yang Artefak outputnya memiliki execPath
yang sama persis. Hasilnya,
Artefak yang setara akan tampak
terduplikasi.
Daftar masalah kueri/fitur yang direncanakan dapat ditemukan di GitHub.
FAQ
ActionKey tetap sama meskipun konten file input berubah.
Dalam konteks kueri, ActionKey
mengacu pada String
yang diperoleh dari
ActionAnalysisMetadata#getKey:
Returns a string encoding all of the significant behaviour of this Action that might affect the output. The general contract of `getKey` is this: if the work to be performed by the execution of this action changes, the key must change. ... Examples of changes that should affect the key are: - Changes to the BUILD file that materially affect the rule which gave rise to this Action. - Changes to the command-line options, environment, or other global configuration resources which affect the behaviour of this kind of Action (other than changes to the names of the input/output files, which are handled externally). - An upgrade to the build tools which changes the program logic of this kind of Action (typically this is achieved by incorporating a UUID into the key, which is changed each time the program logic of this action changes). Note the following exception: for actions that discover inputs, the key must change if any input names change or else action validation may falsely validate.
Pengecualian ini tidak mencakup perubahan pada isi {i>file<i} {i>input<i}, dan jangan tertukar dengan RemoteCacheClient#ActionKey.
Pembaruan
Untuk masalah/permintaan fitur, ajukan masalah di sini.