Definisi umum

Daftar label; defaultnya adalah []

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

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

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

Daftar label; defaultnya adalah []

Dependensi untuk target ini. Umumnya hanya akan mencantumkan target aturan. (Meskipun beberapa aturan mengizinkan file dicantumkan langsung di deps, sebaiknya hindari hal ini jika memungkinkan.)

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

Semantik yang tepat tentang arti target bergantung pada target lain menggunakan deps khusus untuk jenis aturan, dan dokumentasi khusus aturan membahasnya secara lebih mendetail. Untuk aturan yang memproses kode sumber, deps umumnya menentukan dependensi kode yang digunakan oleh kode dalam srcs.

Sebagian besar, 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 dapat bergantung pada kode C++ dalam target cc_library, dengan mencantumkan yang terakhir dalam atribut deps. Lihat definisi dependensi untuk mengetahui informasi selengkapnya.

Daftar string; tidak dapat dikonfigurasi; defaultnya adalah ["none"]

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

Daftar label; defaultnya adalah []

File yang diproses atau disertakan oleh aturan ini. Biasanya mencantumkan file secara langsung, tetapi dapat mencantumkan target aturan (seperti filegroup atau genrule) untuk menyertakan output defaultnya.

Aturan khusus bahasa sering kali mewajibkan file yang tercantum memiliki ekstensi file tertentu.

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Daftar lingkungan yang dapat dibangun untuk target ini, selain lingkungan yang didukung secara 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; tidak dapat dikonfigurasi; defaultnya adalah None

Pesan peringatan penjelasan yang terkait dengan target ini. Biasanya, hal ini digunakan untuk memberi tahu pengguna bahwa target sudah tidak berlaku, 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 orang dapat dengan mudah mengetahui perubahan apa yang diperlukan untuk menghindari pesan tersebut. Jika ada target baru yang dapat digunakan sebagai pengganti langsung, sebaiknya migrasikan saja semua pengguna target lama.

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

Dependensi dalam paket dikecualikan dari peringatan ini, sehingga, misalnya, membangun pengujian aturan yang tidak digunakan lagi tidak menemui peringatan.

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

Setelah orang berhenti menggunakannya, target dapat dihapus.

Daftar string; tidak dapat dikonfigurasi; defaultnya adalah []

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

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Daftar constraint_values yang harus ada di platform eksekusi untuk target ini. Selain itu, batasan ini juga berlaku untuk batasan yang sudah ditetapkan oleh jenis aturan. Batasan digunakan untuk membatasi daftar platform eksekusi yang tersedia. Untuk mengetahui detail selengkapnya, lihat deskripsi penyelesaian toolchain.

Kamus string; defaultnya adalah {}

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, nilai akan diambil dari target.

Daftar string fitur; defaultnya adalah []

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

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

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Daftar lingkungan yang dapat dibangun untuk target ini, bukan lingkungan yang didukung secara default.

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

Daftar string; tidak dapat dikonfigurasi; defaultnya adalah []

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 genruledan Starlark tindakan, dan untuk penguraian oleh manusia dan/atau alat eksternal.

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

• no-sandbox kata kunci menyebabkan tindakan atau pengujian 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 satu atau keduanya.
• no-cache kata kunci menyebabkan tindakan atau pengujian tidak pernah di-cache (dari jarak jauh atau secara lokal)
• Kata kunci no-remote-cache menyebabkan tindakan atau pengujian tidak pernah di-cache dari jarak jauh (tetapi dapat di-cache secara lokal; juga dapat dieksekusi dari jarak jauh). Catatan: untuk tujuan tag ini, disk-cache dianggap sebagai cache lokal, sedangkan cache http dan gRPC dianggap sebagai cache jarak jauh. Jika kombinasi cache disk lokal dan cache jarak jauh digunakan (cache gabungan), cache tersebut 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 menyebabkan tindakan atau pengujian tidak pernah dieksekusi dari jarak jauh (tetapi dapat di-cache dari jarak jauh).
• Kata kunci no-remote mencegah tindakan atau pengujian dieksekusi dari jarak jauh atau di-cache dari jarak jauh. Ini setara dengan menggunakan no-remote-cache dan no-remote-exec.
• Kata kunci no-remote-cache-upload menonaktifkan bagian upload dari caching jarak jauh pada spawn. tidak menonaktifkan eksekusi jarak jauh.
• Kata kunci local mencegah tindakan atau pengujian di-cache dari jarak jauh, dieksekusi dari jarak jauh, atau dijalankan 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). Fitur ini hanya didukung di Linux. Tag ini lebih diprioritaskan daripada opsi command line --sandbox_fake_username.

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

Bazel mengubah perilaku menjalankan pengujian jika menemukan kata kunci berikut di atribut tags aturan pengujian:

• exclusive akan memaksa pengujian dijalankan dalam mode "eksklusif", sehingga memastikan tidak ada pengujian lain yang berjalan pada waktu yang sama. Pengujian tersebut akan dieksekusi secara berurutan setelah semua aktivitas build dan pengujian non-eksklusif 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 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 set target tingkat teratas yang akan dibuat/dijalankan untuk perintah build, test, dan coverage. Hal ini tidak memengaruhi perluasan wildcard target atau rangkaian pengujian dalam konteks lain, termasuk perintah query. Perhatikan bahwa manual tidak menyiratkan bahwa target tidak boleh dibuat/dijalankan secara otomatis oleh sistem build/pengujian berkelanjutan. Misalnya, Anda mungkin ingin mengecualikan target dari bazel test ... karena memerlukan tanda Bazel tertentu, tetapi tetap menyertakannya dalam pra-kirim atau pengujian berkelanjutan yang dikonfigurasi dengan benar.
• Kata kunci external akan memaksa pengujian dijalankan tanpa syarat (terlepas dari nilai --cache_test_results).

Daftar label; defaultnya adalah []

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

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

Daftar kosong (yang merupakan default) menandakan 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 melewati target yang tidak kompatibel.

Boolean; tidak dapat dikonfigurasi; defaultnya adalah False kecuali untuk target pengujian dan rangkaian pengujian

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

Dengan kata lain, aturan yang bukan testonly tidak diizinkan untuk bergantung pada aturan apa pun yang merupakan testonly.

Pengujian (aturan *_test) dan test suite (aturan test_suite) testonly secara default.

Atribut ini dimaksudkan untuk berarti bahwa target tidak boleh terkandung dalam biner yang dirilis ke produksi.

Karena testOnly diterapkan pada waktu build, bukan waktu proses, dan menyebar secara viral melalui hierarki dependensi, testOnly harus diterapkan dengan bijak. Misalnya, stub dan tiruan yang berguna untuk pengujian unit juga dapat berguna untuk pengujian integrasi yang melibatkan biner yang sama yang akan dirilis ke produksi, dan oleh karena itu, mungkin tidak boleh ditandai sebagai testonly. Sebaliknya, aturan yang bahkan berbahaya untuk ditautkan, mungkin karena aturan tersebut menggantikan perilaku normal tanpa syarat, harus ditandai sebagai testonly.

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Kumpulan target yang Buat variabel-nya diizinkan untuk diakses oleh target ini. Target ini adalah instance aturan yang menyediakan TemplateVariableInfo atau target khusus untuk jenis toolchain yang dibuat ke dalam Bazel. Hal ini mencakup:

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

Perhatikan bahwa hal ini berbeda dengan konsep penyelesaian 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 target.

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah default_visibility dari paket jika ditentukan, atau "//visibility:private" jika tidak

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

Daftar string; tunduk pada substitusi $(location) dan "Buat variabel", serta tokenisasi Bourne shell; defaultnya adalah []

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

Argumen ini diteruskan sebelum nilai --test_arg yang ditentukan di command line bazel test.

Kamus string; nilai tunduk pada penggantian $(location) dan "Buat variabel"; defaultnya adalah []

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 ditentukan Starlark. Untuk aturan Starlark Anda sendiri, Anda dapat menambahkan atribut "env" dan menggunakannya untuk mengisi Penyedia TestEnvironment.

Daftar string; defaultnya adalah []

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", atau "small"; tidak dapat dikonfigurasi; defaultnya adalah "medium"

Menentukan "bobot" target pengujian: berapa banyak waktu/resource yang diperlukan untuk menjalankan pengujian.

Pengujian unit dianggap "kecil", pengujian integrasi "sedang", dan pengujian end-to-end "besar" atau "sangat besar". Bazel menggunakan ukuran untuk menentukan waktu tunggu default, yang dapat diganti menggunakan atribut timeout. Waktu tunggu adalah 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 dan penggunaan resource lokal puncak yang diasumsikan berikut:

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

String "short", "moderate", "long", atau "eternal"; tidak dapat dikonfigurasi; default berasal dari atribut size pengujian

Berapa lama pengujian diperkirakan akan berjalan sebelum ditampilkan.

Meskipun atribut ukuran pengujian mengontrol estimasi resource, waktu tunggu pengujian dapat ditetapkan secara terpisah. Jika tidak ditentukan secara eksplisit, waktu tunggu didasarkan pada ukuran pengujian. Waktu tunggu pengujian dapat diganti dengan tanda --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 menjalankan secara manual dalam kondisi yang diketahui lambat. Nilai --test_timeout dalam 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 memunculkan pengujian.

Boolean; tidak dapat dikonfigurasi; defaultnya adalah False

Menandai pengujian sebagai tidak stabil.

Jika ditetapkan, menjalankan pengujian hingga tiga kali, menandainya sebagai gagal hanya jika gagal setiap kali. Secara default, atribut ini ditetapkan ke False dan pengujian dieksekusi hanya satu kali. Perhatikan bahwa penggunaan atribut ini umumnya tidak disarankan - pengujian harus lulus dengan andal saat pernyataannya ditegakkan.

Bilangan bulat non-negatif kurang dari atau sama dengan 50; defaultnya adalah -1

Menentukan jumlah shard paralel yang akan digunakan untuk menjalankan pengujian.

Jika disetel, nilai ini akan menggantikan semua heuristik yang digunakan untuk menentukan jumlah shard paralel yang akan digunakan untuk menjalankan pengujian. Perhatikan bahwa untuk beberapa aturan pengujian, parameter ini mungkin diperlukan untuk mengaktifkan sharding sejak awal. Lihat juga: --test_sharding_strategy.

Jika sharding pengujian diaktifkan, variabel lingkungan TEST_TOTAL_SHARDS akan disetel ke nilai ini saat membuat pengujian.

Sharding mengharuskan test runner mendukung protokol sharding pengujian. Jika tidak, kemungkinan besar semua pengujian akan dijalankan di setiap shard, yang bukan yang Anda inginkan.

Lihat Test Sharding di Test Encyclopedia untuk mengetahui detail tentang sharding.

Boolean; tidak dapat dikonfigurasi; defaultnya adalah False

Memaksa pengujian dijalankan secara lokal, tanpa sandbox.

Menetapkan ini ke True sama dengan memberikan "local" sebagai tag (tags=["local"]).

Daftar string; tunduk pada penggantian $(location) dan "Buat variabel", dan tokenisasi Bourne shell; tidak dapat dikonfigurasi; defaultnya adalah []

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

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

Kamus string; nilai tunduk pada substitusi $(location) dan "Buat variabel"; defaultnya adalah {}

Menentukan variabel lingkungan tambahan yang akan disetel saat target dieksekusi 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 ditentukan Starlark.

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

Daftar string; defaultnya adalah []

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