Definisi umum

List of labels ; optional

File yang diperlukan oleh aturan ini saat runtime. Dapat mencantumkan target file atau aturan. Umumnya memungkinkan semua target.

Output dan runfile target default di atribut data harus muncul di area *.runfiles dari file yang dapat dieksekusi yang dihasilkan oleh atau memiliki dependensi runtime pada target ini. Hal ini dapat mencakup file atau biner data yang digunakan saat srcs target ini dieksekusi. Lihat bagian dependensi data untuk mengetahui informasi selengkapnya tentang cara mengandalkan dan menggunakan file data.

Aturan baru harus menentukan atribut data jika memproses input yang mungkin menggunakan input lain saat runtime. Fungsi implementasi aturan juga harus mengisi runfile target dari output dan runfile atribut data apa pun, serta runfile dari atribut dependensi apa pun yang menyediakan kode sumber atau dependensi runtime.

List of labels ; optional

Dependensi untuk target ini. Umumnya hanya boleh mencantumkan target aturan. (Meskipun beberapa aturan mengizinkan file dicantumkan langsung di deps, hal ini harus dihindari jika memungkinkan.)

Aturan khusus bahasa umumnya membatasi target yang tercantum pada target dengan penyedia tertentu.

Semantik yang persis dari arti target bergantung pada target lainnya yang menggunakan deps bersifat spesifik untuk jenis aturan, dan dokumentasi khusus aturan akan membahas lebih mendetail. Untuk aturan yang memproses kode sumber, deps umumnya menentukan dependensi kode yang digunakan oleh kode di srcs.

Sering kali, dependensi deps digunakan untuk memungkinkan satu modul menggunakan simbol yang ditentukan dalam modul lain yang ditulis dalam bahasa pemrograman yang sama dan dikompilasi secara terpisah. Dependensi lintas bahasa juga diizinkan dalam banyak kasus: Misalnya, target java_library mungkin bergantung pada kode C++ dalam target cc_library, dengan mencantumkannya pada atribut deps. Lihat definisi dependensi untuk mengetahui informasi selengkapnya.

List of strings; optional; nonconfigurable

Daftar string jenis lisensi yang akan digunakan untuk target tertentu. Ini adalah bagian dari API pemberian lisensi yang tidak digunakan lagi yang tidak digunakan lagi oleh Bazel. Jangan gunakan ini.

List of labels ; optional

File yang diproses atau disertakan oleh aturan ini. Umumnya, daftar file langsung tercantum, tetapi mungkin mencantumkan target aturan (seperti filegroup atau genrule) untuk menyertakan output default-nya.

Aturan spesifik per bahasa sering kali mengharuskan file yang tercantum memiliki ekstensi file tertentu.

List of labels ; optional; nonconfigurable

Daftar lingkungan yang dapat dibuat untuk target ini, selain lingkungan yang didukung default.

Ini adalah bagian dari sistem batasan Bazel, yang memungkinkan pengguna mendeklarasikan target mana yang dapat dan tidak dapat saling bergantung. Misalnya, biner yang dapat di-deploy secara eksternal tidak boleh bergantung pada library dengan kode rahasia perusahaan. Lihat ConstraintSemantics untuk mengetahui detailnya.

String; optional; nonconfigurable

Pesan peringatan penjelasan yang terkait dengan target ini. Peristiwa ini biasanya digunakan untuk memberi tahu pengguna bahwa target sudah tidak digunakan lagi, atau telah digantikan oleh aturan lain, bersifat pribadi untuk paket, atau mungkin dianggap berbahaya karena alasan tertentu. Sebaiknya sertakan beberapa referensi (seperti halaman web, nomor bug, atau contoh CL migrasi) agar Anda dapat dengan mudah mengetahui perubahan yang diperlukan untuk menghindari pesan. Jika ada target baru yang dapat digunakan sebagai pengganti pengganti, sebaiknya migrasikan semua pengguna target lama.

Atribut ini tidak memengaruhi cara pembuatan sesuatu, tetapi dapat memengaruhi output diagnostik alat build. Alat build mengeluarkan peringatan saat aturan dengan atribut deprecation bergantung pada target dalam paket lain.

Dependensi intra-paket dikecualikan dari peringatan ini, sehingga misalnya, membuat pengujian aturan yang tidak digunakan lagi tidak menerima peringatan.

Jika target yang tidak digunakan lagi bergantung pada target lain yang tidak digunakan lagi, tidak ada pesan peringatan yang dikeluarkan.

Setelah pengguna berhenti menggunakannya, target dapat dihapus.

List of strings; optional; nonconfigurable

Daftar string metode distribusi yang akan digunakan untuk target khusus ini. Ini adalah bagian dari API pemberian lisensi yang tidak digunakan lagi yang tidak digunakan lagi oleh Bazel. Jangan gunakan ini.

List of labels ; optional; nonconfigurable

Daftar constraint_values yang harus ada di platform eksekusi untuk target ini. Hal ini merupakan tambahan untuk batasan yang telah ditetapkan oleh jenis aturan. Batasan digunakan untuk membatasi daftar platform eksekusi yang tersedia. Untuk mengetahui detail selengkapnya, lihat deskripsi resolusi toolchain.

Dictionary of strings; optional

Kamus string yang akan ditambahkan ke exec_properties platform yang dipilih untuk target ini. Lihat exec_properties aturan platform.

Jika kunci ada di properti tingkat platform dan target, nilainya akan diambil dari target.

List of feature strings; optional

Fitur adalah tag string yang dapat diaktifkan atau dinonaktifkan pada target. Arti suatu fitur bergantung pada aturan itu sendiri.

Atribut features ini digabungkan dengan atribut features level package. Misalnya, jika fitur ["a", "b"] diaktifkan pada tingkat paket, dan atribut features target berisi ["-a", "c"], fitur yang diaktifkan untuk aturan akan menjadi "b" dan "c". Lihat contoh.

List of labels ; optional; nonconfigurable

Daftar lingkungan tempat target ini dapat dibuat, bukan lingkungan yang didukung default.

Ini adalah bagian dari sistem batasan Bazel. Lihat compatible_with untuk mengetahui detailnya.

List of strings; optional; nonconfigurable

Tag dapat digunakan pada aturan apa pun. Tag pada pengujian dan aturan test_suite berguna untuk mengategorikan pengujian. Tag pada target non-pengujian digunakan untuk mengontrol eksekusi sandbox dari tindakan genrule dan Starlark, serta untuk penguraian oleh manusia dan/atau alat eksternal.

Bazel memodifikasi perilaku kode sandbox-nya jika menemukan kata kunci berikut dalam atribut tags target atau genrule pengujian, atau kunci execution_requirements untuk tindakan Starlark.

• Kata kunci no-sandbox menghasilkan tindakan atau pengujian yang tidak pernah di-sandbox; kata kunci tersebut masih dapat di-cache atau dijalankan dari jarak jauh - gunakan no-cache atau no-remote untuk mencegah salah satunya atau keduanya.
• Kata kunci no-cache menghasilkan tindakan atau pengujian yang tidak pernah di-cache (dari jarak jauh atau lokal)
• Kata kunci no-remote-cache menghasilkan tindakan atau pengujian yang tidak pernah disimpan dalam cache dari jarak jauh (tetapi mungkin disimpan dalam cache secara lokal; kata kunci tersebut juga dapat dijalankan dari jarak jauh). Catatan: untuk tujuan tag ini, cache disk dianggap sebagai cache lokal, sedangkan cache http dan gRPC dianggap sebagai remote. Jika kombinasi antara cache disk lokal dan cache jarak jauh digunakan (cache gabungan), akan diperlakukan sebagai cache jarak jauh dan dinonaktifkan sepenuhnya kecuali jika --incompatible_remote_results_ignore_disk ditetapkan dalam hal ini komponen lokal akan digunakan.
• Kata kunci no-remote-exec menghasilkan tindakan atau pengujian yang tidak pernah dijalankan dari jarak jauh (tetapi mungkin disimpan dalam cache dari jarak jauh).
• Kata kunci no-remote mencegah tindakan atau pengujian dijalankan dari jarak jauh atau disimpan dalam cache dari jarak jauh. Ini sama dengan menggunakan no-remote-cache dan no-remote-exec.
• Kata kunci no-remote-cache-upload menonaktifkan upload bagian cache spawn dari jarak jauh. tidak menonaktifkan eksekusi jarak jauh.
• Kata kunci local mencegah tindakan atau pengujian dari cache dari jarak jauh, dieksekusi dari jarak jauh, atau berjalan di dalam sandbox. Untuk genrules dan pengujian, menandai aturan dengan atribut local = True memiliki efek yang sama.
• Kata kunci requires-network memungkinkan akses ke jaringan eksternal dari dalam sandbox. Tag ini hanya berpengaruh jika sandbox diaktifkan.
• Kata kunci block-network memblokir akses ke jaringan eksternal dari dalam sandbox. Dalam hal ini, hanya komunikasi dengan localhost yang diizinkan. Tag ini hanya berpengaruh jika sandbox diaktifkan.
• requires-fakeroot menjalankan pengujian atau tindakan sebagai uid dan gid 0 (yaitu pengguna root). Ini hanya didukung di Linux. Tag ini lebih diprioritaskan daripada opsi command line --sandbox_fake_username.

Tag pada saat pengujian umumnya digunakan untuk menganotasi peran pengujian dalam proses debug dan rilis. Biasanya, tag paling berguna untuk pengujian C++ dan Python, yang tidak memiliki kemampuan anotasi runtime. Penggunaan tag dan elemen ukuran memberikan fleksibilitas dalam menyatukan rangkaian pengujian berdasarkan kebijakan check-in codebase.

Bazel memodifikasi perilaku pengujian jika menemukan kata kunci berikut dalam atribut tags aturan pengujian:

• exclusive akan memaksa pengujian dijalankan dalam mode "eksklusif", yang memastikan bahwa tidak ada pengujian lain yang berjalan pada saat yang sama. Pengujian tersebut akan dijalankan secara serial setelah semua aktivitas build dan pengujian non-eksklusif telah selesai. Eksekusi jarak jauh dinonaktifkan untuk pengujian tersebut karena Bazel tidak memiliki kontrol atas apa yang berjalan di mesin jarak jauh.
• exclusive-if-local akan memaksa pengujian untuk dijalankan dalam mode "eksklusif" jika dijalankan secara lokal, tetapi akan menjalankan pengujian secara paralel jika dijalankan dari jarak jauh.
• Kata kunci manual akan mengecualikan target dari perluasan karakter pengganti pola target (..., :*, :all, dll.) dan aturan test_suite yang tidak mencantumkan pengujian secara eksplisit saat menghitung kumpulan target level teratas untuk membuat/menjalankan perintah build, test, dan coverage. Hal ini tidak memengaruhi perluasan karakter pengganti atau pengujian paket dalam konteks lain, termasuk perintah query. Perhatikan bahwa manual tidak menyiratkan bahwa target tidak boleh di-build/dijalankan secara otomatis oleh sistem build/pengujian berkelanjutan. Misalnya, Anda mungkin ingin mengecualikan target dari bazel test ... karena memerlukan flag Bazel tertentu, tetapi tetap menyertakannya dalam pra-pengiriman atau pengujian berkelanjutan yang dikonfigurasi dengan benar.
• Kata kunci external akan memaksa pengujian untuk dijalankan tanpa syarat (terlepas dari nilai --cache_test_results).

List of labels ; optional

Daftar constraint_value yang harus ada di platform target agar target ini dianggap kompatibel. Hal ini merupakan tambahan dari batasan yang telah ditetapkan oleh jenis aturan. Jika platform target tidak memenuhi semua batasan yang tercantum, target dianggap tidak kompatibel. Target yang tidak kompatibel akan dilewati untuk mem-build dan menguji saat pola target diperluas (misalnya //..., :all). Jika secara eksplisit ditentukan pada command line, target yang tidak kompatibel akan menyebabkan Bazel mencetak error dan menyebabkan kegagalan build atau pengujian.

Target yang secara transitif bergantung pada target yang tidak kompatibel akan dianggap tidak kompatibel. Keduanya juga dilewati untuk pembuatan dan pengujian.

Daftar kosong (yang merupakan default) menunjukkan bahwa target kompatibel dengan semua platform.

Semua aturan selain Aturan Workspace mendukung atribut ini. Untuk beberapa aturan, atribut ini tidak berpengaruh. Misalnya, menentukan target_compatible_with untuk cc_toolchain tidak berguna.

Lihat halaman Platform untuk mengetahui informasi selengkapnya tentang cara melewati target yang tidak kompatibel.

Boolean; optional; default False except for test and test suite targets; nonconfigurable

Jika True, hanya target pengujian saja (seperti pengujian) yang dapat bergantung pada target ini.

Secara setara, aturan yang bukan testonly tidak diizinkan untuk bergantung pada aturan yang merupakan testonly.

Pengujian (aturan *_test) dan rangkaian pengujian (aturan test_suite) adalah testonly secara default.

Atribut ini dimaksudkan bahwa target tidak boleh berisi biner yang dirilis ke produksi.

Karena pengujian hanya diterapkan pada waktu build, bukan waktu proses, dan diterapkan secara merata melalui hierarki dependensi, kebijakan ini harus diterapkan dengan bijak. Misalnya, stub danPemalsuan yang berguna untuk pengujian unit juga dapat berguna untuk pengujian integrasi yang melibatkan biner yang sama yang akan dirilis ke produksi, dan karena itu mungkin tidak boleh ditandai hanya pengujian. Sebaliknya, aturan yang berbahaya untuk ditautkan, mungkin karena aturan tersebut menggantikan perilaku normal tanpa syarat, harus ditandai sebagai pengujian saja.

List of labels ; optional; nonconfigurable

Kumpulan target yang Membuat variabel yang diizinkan untuk diakses oleh target ini. Target ini adalah instance dari aturan yang menyediakan TemplateVariableInfo atau target khusus untuk jenis toolchain yang di-build ke dalam Bazel. Fitur tersebut meliputi:

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

Perhatikan bahwa ini berbeda dengan konsep resolusi toolchain yang digunakan oleh penerapan aturan untuk konfigurasi yang bergantung pada platform. Anda tidak dapat menggunakan atribut ini untuk menentukan cc_toolchain atau java_toolchain tertentu yang akan digunakan oleh target.

List of labels ; optional; default default_visibility from package if specified, or //visibility:private otherwise; nonconfigurable

Atribut visibility pada target mengontrol apakah target dapat digunakan dalam paket lain. Lihat dokumentasi untuk visibilitas.

List of strings; optional; subject to $(location) and "Make variable" substitution, and Bourne shell tokenization

Argumen command line yang diteruskan Bazel ke target saat dieksekusi dengan bazel test.

Argumen ini diteruskan sebelum nilai --test_arg apa pun yang ditentukan pada command line bazel test.

Dictionary of strings; optional; values are subject to $(location) and "Make variable" substitution

Menentukan variabel lingkungan tambahan yang akan ditetapkan saat pengujian dijalankan oleh bazel test.

Atribut ini hanya berlaku untuk aturan native, seperti cc_test, py_test, dan sh_test. Hal ini tidak berlaku untuk aturan pengujian yang ditetapkan Starlark. Untuk aturan Starlark Anda sendiri, Anda dapat menambahkan atribut "env" dan menggunakannya untuk mengisi Penyedia TestEnvironment.

List of strings; optional

Menentukan variabel lingkungan tambahan yang akan diwarisi dari lingkungan eksternal saat pengujian dijalankan oleh bazel test.

Atribut ini hanya berlaku untuk aturan native, seperti cc_test, py_test, dan sh_test. Hal ini tidak berlaku untuk aturan pengujian yang ditentukan Starlark.

String "enormous", "large" "medium" or "small", default is "medium"; optional; nonconfigurable

Menentukan "kepadatan" target pengujian: berapa banyak waktu/resource yang diperlukan untuk dijalankan.

Pengujian unit dianggap sebagai "kecil", pengujian integrasi "sedang", dan pengujian menyeluruh "besar" atau "sangat besar". Bazel menggunakan ukuran untuk menentukan waktu tunggu default, yang dapat diganti menggunakan atribut timeout. Waktu tunggu untuk semua pengujian dalam target BUILD, bukan untuk setiap pengujian individual. Saat pengujian dijalankan secara lokal, size juga digunakan untuk tujuan penjadwalan: Bazel mencoba mematuhi --local_{ram,cpu}_resources dan tidak membebani mesin lokal dengan menjalankan banyak pengujian berat secara bersamaan.

Ukuran pengujian sesuai dengan waktu tunggu default berikut dan penggunaan resource lokal puncak yang diasumsikan:

Variabel lingkungan TEST_SIZE akan ditetapkan ke nilai atribut ini saat menghasilkan pengujian.

String "short", "moderate", "long", "eternal" (with the default derived from the test's size attribute); nonconfigurable

Durasi pengujian diperkirakan sebelum berjalan kembali.

Meskipun atribut ukuran pengujian mengontrol estimasi resource, waktu tunggu pengujian dapat ditetapkan secara independen. Jika tidak ditentukan secara eksplisit, waktu tunggu akan didasarkan pada ukuran pengujian. Waktu tunggu pengujian dapat diganti dengan flag --test_timeout, misalnya untuk berjalan dalam kondisi tertentu yang diketahui lambat. Nilai waktu tunggu pengujian sesuai dengan jangka waktu berikut:

Untuk waktu selain di atas, waktu tunggu pengujian dapat diganti dengan flag bazel --test_timeout, misalnya untuk berjalan secara manual dalam kondisi yang lambat. Nilai --test_timeout dalam hitungan detik. Misalnya, --test_timeout=120 akan menetapkan waktu tunggu pengujian menjadi dua menit.

Variabel lingkungan TEST_TIMEOUT akan ditetapkan ke waktu tunggu pengujian (dalam detik) saat menghasilkan pengujian.

Boolean; optional; default False; nonconfigurable

Tanda pengujian tidak stabil.

Jika ditetapkan, jalankan pengujian hingga tiga kali dan tandai sebagai gagal hanya jika gagal setiap kali. Secara default, atribut ini ditetapkan ke Salah dan pengujian hanya dijalankan satu kali. Perhatikan bahwa penggunaan atribut ini umumnya tidak disarankan. Pengujian harus berhasil jika pernyataan tersebut ditegakkan.

Non-negative integer less than or equal to 50; optional

Menentukan jumlah shard paralel yang akan digunakan untuk menjalankan pengujian.

Nilai ini akan mengganti heuristik yang digunakan untuk menentukan jumlah shard paralel untuk menjalankan pengujian. Perlu diketahui bahwa untuk beberapa aturan pengujian, parameter ini mungkin diperlukan untuk mengaktifkan sharding di awal. Lihat juga --test_sharding_strategy.

Jika sharding pengujian diaktifkan, variabel lingkungan TEST_TOTAL_SHARDS akan ditetapkan ke nilai ini saat menghasilkan pengujian.

Sharding memerlukan runner pengujian untuk mendukung protokol sharding pengujian. Jika tidak, maka kemungkinan besar akan dijalankan di setiap pengujian dalam setiap shard, yang bukan ini yang Anda inginkan.

Lihat Melakukan Sharding di Ensiklopedia Pengujian untuk mengetahui detail tentang sharding.

Boolean; default False; nonconfigurable

Memaksa pengujian untuk dijalankan secara lokal, tanpa sandbox.

Menyetelnya ke Benar (True) sama dengan menyediakan "lokal" sebagai tag (tags=["local"]).

List of strings; optional; subject to $(location) and "Make variable" substitution, and Bourne shell tokenization; nonconfigurable

Argumen command line yang akan diteruskan oleh Bazel ke target saat dijalankan oleh perintah run atau sebagai pengujian. Argumen ini diteruskan sebelum argumen yang ditentukan pada command line bazel run atau bazel test.

CATATAN: Argumen tidak akan diteruskan saat Anda menjalankan target di luar Bazel (misalnya, dengan menjalankan biner secara manual di bazel-bin/).

Dictionary of strings; optional; values are subject to $(location) and "Make variable" substitution

Menentukan variabel lingkungan tambahan yang akan ditetapkan ketika target dijalankan oleh bazel run.

Atribut ini hanya berlaku untuk aturan native, seperti cc_binary, py_binary, dan sh_binary. Hal ini tidak berlaku untuk aturan yang dapat dieksekusi yang ditetapkan oleh Starlark.

CATATAN: Variabel lingkungan tidak ditetapkan saat Anda menjalankan target di luar Bazel (misalnya, dengan menjalankan biner secara manual di bazel-bin/).

List of strings; optional

Lisensi file output yang dihasilkan biner ini. Ini adalah bagian dari API pemberian lisensi yang tidak digunakan lagi yang tidak digunakan lagi oleh Bazel. Jangan gunakan ini.