Definisi umum

Daftar label; default adalah []

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

Output dan runfile default target dalam atribut data harus muncul di area *.runfiles dari file apa pun yang dapat dieksekusi yang yang dihasilkan oleh atau memiliki dependensi runtime pada target ini. Hal ini dapat mencakup data atau biner yang digunakan saat srcs dieksekusi. Lihat dependensi data untuk informasi lebih lanjut tentang cara bergantung pada dan menggunakan file data.

Aturan baru harus menentukan atribut data jika diproses yang mungkin menggunakan input lain pada runtime. Aturan fungsi implementasi juga harus mengisi runfiles dari output dan runfile atribut data apa pun, serta {i>runfile<i} dari atribut dependensi apa pun yang menyediakan kode sumber atau dependensi runtime.

Daftar label; default adalah []

Dependensi untuk target ini. Umumnya hanya boleh mencantumkan target aturan. (Meskipun beberapa aturan mengizinkan file dicantumkan langsung di deps, sebaiknya dihindari sebisa mungkin.)

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

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

Paling sering, dependensi deps digunakan untuk mengizinkan penggunaan satu modul simbol yang didefinisikan dalam modul lain yang ditulis dalam bahasa pemrograman yang sama dan dikompilasi secara terpisah. Dependensi lintas bahasa juga diizinkan di banyak kasus: Misalnya, target java_library mungkin bergantung pada kode C++ dalam target cc_library, dengan mencantumkan yang terakhir di Atribut deps. Lihat definisi dependencies untuk informasi selengkapnya.

Daftar {i>string<i}; tidak dapat dikonfigurasi; default adalah ["none"]

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

Daftar label; default 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 spesifik bahasa sering kali mengharuskan file yang tercantum memiliki ekstensi file.

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

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

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

String; tidak dapat dikonfigurasi; default adalah None

Pesan peringatan penjelasan yang terkait dengan target ini. Biasanya, ini digunakan untuk memberi tahu pengguna bahwa target sudah tidak berlaku, atau telah digantikan oleh aturan lain, bersifat pribadi untuk suatu paket, atau mungkin dianggap berbahaya karena alasan tertentu. Ada baiknya untuk menyertakan beberapa referensi (seperti laman web, nomor {i>bug<i} atau contoh CL migrasi) jadi orang dapat dengan mudah mengetahui perubahan apa yang diperlukan untuk menghindari pesan tersebut. Jika ada target baru yang dapat digunakan sebagai penurunan penggantian, itu adalah ide yang bagus untuk memigrasikan semua pengguna dari target lama.

Atribut ini tidak berpengaruh pada cara objek dibuat, 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, membangun pengujian aturan yang sudah tidak digunakan lagi mendapatkan peringatan.

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

Setelah orang berhenti menggunakannya, target dapat dihapus.

Daftar string; tidak dapat dikonfigurasi; default adalah []

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

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

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

Kamus string; default-nya adalah {}

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

Jika kunci ada di properti level target dan platform, nilai akan diambil dari target.

Daftar string fitur; default adalah []

Fitur adalah tag string yang dapat diaktifkan atau dinonaktifkan di target. Tujuan arti fitur tergantung pada aturan itu sendiri.

Atribut features ini dikombinasikan dengan paket level features. Misalnya, jika fitur ["a", "b"] diaktifkan di level paket, dan Atribut features berisi ["-a", "c"], fitur yang diaktifkan untuk aturannya adalah "b" dan "c". Lihat contoh.

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Daftar lingkungan yang dapat di-build untuk target ini, bukan yang didukung secara default.

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

Daftar {i>string<i}; tidak dapat dikonfigurasi; default adalah []

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

Bazel memodifikasi perilaku kode {i>sandbox<i}-nya jika menemukan hal berikut kata kunci dalam atribut tags dari pengujian apa pun atau genrule target, atau kunci execution_requirements untuk Starlark mana pun tindakan.

• Kata kunci no-sandbox menghasilkan tindakan atau pengujian, tidak pernah di-sandbox; aplikasi masih dapat di-cache atau dijalankan dari jarak jauh - gunakan no-cache atau no-remote untuk mencegah salah satu atau keduanya.
• Kata kunci no-cache menghasilkan tindakan atau pengujian, tidak pernah di-cache (dari jarak jauh atau lokal)
• Kata kunci no-remote-cache menghasilkan tindakan atau pengujian, tidak pernah di-cache dari jarak jauh (tetapi dapat di-cache secara lokal; juga dapat dijalankan dari jarak jauh). Catatan: untuk tujuan tag ini, cache disk dianggap sebagai cache lokal, sedangkan cache http dan gRPC dianggap jarak jauh. Jika kombinasi {i>cache disk<i} lokal dan {i>cache<i} jarak jauh digunakan (cache gabungan), Metode ini diperlakukan sebagai cache jarak jauh dan dinonaktifkan sepenuhnya, kecuali jika --incompatible_remote_results_ignore_disk diatur dalam hal ini komponen lokal akan digunakan.
• Kata kunci no-remote-exec menghasilkan tindakan atau pengujian, tidak pernah dijalankan dari jarak jauh (tetapi dapat {i>cache<i} dari jarak jauh).
• Kata kunci no-remote mencegah tindakan atau pengujian dijalankan dari jarak jauh atau yang 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 cache jarak jauh untuk spawn. proses ini tidak menonaktifkan eksekusi jarak jauh.
• Kata kunci local mencegah tindakan atau pengujian di-cache dari jarak jauh, dijalankan dari jarak jauh, atau dijalankan di dalam {i>sandbox<i}. Untuk genrules dan pengujian, menandai aturan dengan local = True memiliki efek yang sama.
• Kata kunci requires-network memungkinkan akses ke jaringan dari dalam sandbox. Tag ini hanya berpengaruh jika sandbox diaktifkan.
• block-network kata kunci memblokir akses ke aplikasi eksternal jaringan dari dalam sandbox. Dalam hal ini, hanya komunikasi dengan {i>localhost<i} diizinkan. Tag ini hanya berpengaruh jika sandboxing mengaktifkan pembuatan versi.
• requires-fakeroot menjalankan pengujian atau tindakan sebagai uid dan gid 0 (yaitu, root tertentu). Fitur ini hanya didukung di Linux. Tag ini lebih diprioritaskan daripada Opsi command line --sandbox_fake_username.

Tag pada pengujian umumnya digunakan untuk menganotasi 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 memodifikasi perilaku uji coba jika menemukan kata kunci berikut pada Atribut tags dari aturan pengujian:

• exclusive akan memaksa pengujian dijalankan dalam mode "eksklusif", yang memastikan tidak ada pengujian lain yang berjalan secara bersamaan. Pengujian tersebut akan dijalankan secara serial setelah semua build aktivitas dan pengujian non-eksklusif telah selesai. Eksekusi jarak jauh dinonaktifkan untuk pengujian tersebut karena Bazel tidak memiliki kontrol atas apa yang berjalan di komputer 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 kumpulan target tingkat atas untuk mem-build/menjalankan perintah build, test, dan coverage. Tidak memengaruhi karakter pengganti target atau ekspansi rangkaian pengujian 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, mungkin ingin mengecualikan target dari bazel test ... karena memerlukan Tanda Bazel, tetapi tetap disertakan dalam pra-pengiriman atau pengujian berkelanjutan yang dikonfigurasi dengan benar yang dijalankan.
• Kata kunci external akan memaksa pengujian tanpa syarat dieksekusi (terlepas dari --cache_test_results nilai).

Daftar label; default adalah []

Daftar constraint_values yang harus ada di platform target agar target ini dapat dipertimbangkan kompatibel. Hal ini merupakan tambahan dari batasan apa pun yang telah ditetapkan oleh jenis aturan. Jika platform target tidak memenuhi semua batasan yang tercantum, maka target dianggap tidak kompatibel. Target yang tidak kompatibel adalah dilewati untuk pembuatan dan pengujian saat pola target diperluas (misalnya, //..., :all). Bila ditetapkan secara eksplisit pada baris perintah, target yang tidak kompatibel akan menyebabkan Bazel mencetak {i>error<i} dan menyebabkan kegagalan build atau pengujian.

Target yang secara transitif bergantung pada target yang tidak kompatibel adalah target itu sendiri dianggap tidak kompatibel. Pengujian 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 fitur ini . Untuk beberapa aturan, atribut ini tidak memiliki pengaruh. Misalnya, menentukan target_compatible_with untuk cc_toolchain tidak berguna.

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

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

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

Setara dengan itu, aturan yang bukan testonly tidak diizinkan untuk bergantung pada aturan apa pun yaitu testonly.

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

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

Karena testonly diterapkan pada waktu build, bukan waktu run, dan disebarkan secara viral melalui hierarki dependensi, testonly harus diterapkan dengan cermat. Misalnya, stub dan palsu yang berguna untuk pengujian unit juga dapat berguna untuk pengujian integrasi yang melibatkan biner yang sama yang akan dirilis ke produksi, dan karenanya mungkin tidak boleh ditandai sebagai testonly. Sebaliknya, aturan yang berbahaya untuk ditautkan, mungkin karena mereka tanpa syarat mengabaikan perilaku normal, maka harus ditandai sebagai {i>testonly<i}.

Daftar label; tidak dapat dikonfigurasi; defaultnya adalah []

Kumpulan target yang Make variables-nya diizinkan untuk diakses oleh target ini. Target ini adalah instance aturan yang menyediakan TemplateVariableInfo atau target khusus untuk jenis toolchain yang di-build ke dalam Bazel. Hal ini mencakup:

• @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 implementasi aturan untuk konfigurasi yang bergantung pada platform. Anda tidak dapat menggunakan ini untuk menentukan cc_toolchain atau java_toolchain spesifik mana gunakan.

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

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

Daftar {i>string<i}; tunduk kepada $(location) dan Penggantian "Buat variabel", dan Tokenisasi shell Bourne; default-nya adalah []

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

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

Kamus {i>string<i}; nilai tersebut tunduk kepada $(location) dan Penggantian "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. Kebijakan ini tidak berlaku untuk Aturan pengujian yang ditentukan Starlark. Untuk aturan Starlark sendiri, Anda dapat menambahkan "env" dan menggunakannya untuk mengisi TestEnvironment Penyedia.

Daftar {i>string<i}; default-nya 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. Ini tidak berlaku untuk aturan pengujian yang ditentukan Starlark.

String "enormous", "large", "medium", atau "small"; tidak dapat dikonfigurasi; default adalah "medium"

Menentukan "ketebalan" target pengujian: berapa banyak waktu/resource yang perlu dijalankan.

Pengujian unit dianggap "kecil", pengujian integrasi "sedang", dan pengujian menyeluruh "besar" atau "sangat besar". Bazel menggunakan ukuran untuk menentukan waktu tunggu {i>default<i}, yang dapat diganti menggunakan Atribut timeout. Waktu tunggu berlaku 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 uji sesuai dengan waktu tunggu default berikut dan asumsi resource lokal puncak penggunaan:

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

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

Berapa lama pengujian diperkirakan akan berjalan sebelum kembali.

Atribut ukuran pengujian mengontrol estimasi resource, sedangkan waktu tunggu dapat disetel secara terpisah. Jika tidak ditentukan secara eksplisit, waktu tunggu didasarkan pada ukuran pengujian. Tes waktu tunggu dapat diganti dengan tanda --test_timeout, misalnya untuk yang berjalan dalam kondisi tertentu yang diketahui sebagai lambat. Nilai waktu tunggu pengujian sesuai dengan jangka waktu berikut:

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

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

Boolean; tidak dapat dikonfigurasi; default adalah False

Menandai pengujian sebagai tidak stabil.

Jika disetel, pengujian akan dijalankan hingga tiga kali, dan menandainya sebagai gagal hanya jika gagal setiap kali. Secara default, atribut ini disetel ke Salah (False) dan pengujian ditetapkan hanya dijalankan sekali. Perhatikan bahwa penggunaan atribut ini umumnya tidak disarankan - pengujian harus berhasil secara andal jika pernyataannya ditegakkan.

Bilangan bulat non-negatif yang lebih kecil atau sama dengan 50; default-nya adalah -1

Menentukan jumlah shard paralel yang akan digunakan untuk menjalankan pengujian.

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

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

Sharding memerlukan runner pengujian untuk mendukung protokol sharding pengujian. Jika tidak, kemungkinan besar ia akan menjalankan setiap pengujian di setiap shard, yang tidak sesuai dengan keinginan Anda.

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

Boolean; tidak dapat dikonfigurasi; defaultnya adalah False

Memaksa pengujian untuk dijalankan secara lokal, tanpa sandbox.

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

Daftar {i>string<i}; tunduk kepada $(location) dan Penggantian "Buat variabel", dan Tokenisasi shell Bourne; tidak dapat dikonfigurasi; default-nya adalah []

Argumen command line yang akan diteruskan Bazel ke target saat dieksekusi baik dengan perintah run atau sebagai pengujian. Argumen tersebut adalah diteruskan sebelum nilai yang ditentukan pada bazel run atau command line bazel test.

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

Kamus {i>string<i}; nilai tersebut tunduk kepada $(location) dan Penggantian "Buat variabel"; defaultnya adalah {}

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

Atribut ini hanya berlaku untuk aturan native, seperti cc_binary, py_binary, dan sh_binary. 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 mengeksekusi biner secara manual di bazel-bin/).

Daftar {i>string<i}; default-nya adalah []

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