Definisi umum

Daftar label; default-nya adalah []

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

Output default dan runfile target dalam 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 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 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.

Daftar label; default-nya adalah []

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 untuk 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.

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

Daftar string; 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 tidak digunakan lagi dan tidak digunakan lagi oleh Bazel. Jangan gunakan ini.

Daftar label; default-nya adalah []

File yang diproses atau disertakan oleh aturan ini. Umumnya 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; default-nya adalah []

Daftar lingkungan yang dapat digunakan untuk mem-build 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 bergantung satu sama lain. 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; default-nya adalah None

Pesan peringatan penjelasan yang terkait dengan target ini. Biasanya, ini digunakan untuk memberi tahu pengguna bahwa target sudah tidak digunakan lagi, atau telah diganti 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) sehingga seseorang dapat dengan mudah mengetahui perubahan yang diperlukan untuk menghindari pesan tersebut. Jika ada target baru yang dapat digunakan sebagai penggantian langsung, sebaiknya migrasikan semua pengguna target lama.

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

Dependensi intra-paket dikecualikan dari peringatan ini, sehingga, misalnya, mem-build pengujian aturan yang tidak digunakan lagi tidak akan mengalami 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; default 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 digunakan lagi oleh Bazel. Jangan gunakan ini.

Daftar label; tidak dapat dikonfigurasi; default-nya adalah []

Daftar constraint_values yang harus ada di platform eksekusi untuk target ini. Hal ini dilakukan selain batasan yang telah ditetapkan oleh jenis aturan. Batasan digunakan untuk membatasi daftar platform eksekusi yang tersedia. Untuk detail selengkapnya, lihat deskripsi 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 tingkat platform dan target, nilai akan diambil dari target.

Daftar string fitur; default-nya adalah []

Fitur adalah tag string yang dapat diaktifkan atau dinonaktifkan di target. Makna 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; default-nya adalah []

Daftar lingkungan yang dapat digunakan untuk mem-build 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; default adalah []

Tag dapat digunakan pada aturan apa pun. Tag pada aturan pengujian dan test_suite berguna untuk mengategorikan pengujian. Tag pada target non-pengujian digunakan untuk mengontrol eksekusi sandbox tindakan genrule dan Starlark, serta 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 apa pun.

• Kata kunci no-sandbox menyebabkan tindakan atau pengujian tidak pernah di-sandbox; tindakan atau pengujian tersebut 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 menyebabkan tindakan atau pengujian tidak pernah di-cache (secara lokal atau jarak jauh). Catatan: untuk tujuan tag ini, cache disk dianggap sebagai cache lokal, sedangkan cache HTTP dan gRPC dianggap sebagai cache jarak jauh. Cache lainnya, seperti Skyframe atau cache tindakan persisten, tidak terpengaruh.
• Kata kunci no-remote-cache menyebabkan 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 sebagai cache jarak jauh. Cache lainnya, seperti Skyframe atau cache tindakan persisten, tidak terpengaruh. 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 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 sandboxing 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 sandboxing diaktifkan.
• requires-fakeroot menjalankan pengujian atau tindakan sebagai uid dan gid 0 (yaitu, pengguna root). Fitur ini hanya didukung di Linux. Tag ini lebih diutamakan daripada opsi command line --sandbox_fake_username.

Tag pada pengujian biasanya 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 mengubah perilaku pengujian yang berjalan 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 secara bersamaan. Pengujian tersebut akan dijalankan secara serial 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 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. Hal ini tidak memengaruhi wildcard target atau perluasan 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, sebaiknya target dikecualikan dari bazel test ... karena memerlukan flag Bazel tertentu, tetapi tetap menyertakannya dalam pengujian presubmit atau berkelanjutan yang dikonfigurasi dengan benar.
• Kata kunci external akan memaksa pengujian dijalankan tanpa syarat (terlepas dari nilai --cache_test_results).

Daftar label; default-nya adalah []

Daftar constraint_value yang harus ada di platform target agar target ini dianggap kompatibel. Hal ini merupakan tambahan dari batasan apa pun yang telah ditetapkan oleh jenis aturan. Jika platform target tidak memenuhi semua batasan yang tercantum, target akan dianggap tidak kompatibel. Target yang tidak kompatibel akan dilewati untuk mem-build 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 secara transitif bergantung pada target yang tidak kompatibel juga dianggap tidak kompatibel. Pengujian ini 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 lewati 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.

Demikian pula, aturan yang bukan testonly tidak diizinkan untuk bergantung pada aturan apa pun yang merupakan testonly.

Pengujian (aturan *_test) dan rangkaian pengujian (aturan test_suite) adalah 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 bahkan berbahaya untuk ditautkan, mungkin karena aturan tersebut secara tidak bersyarat mengganti perilaku normal, harus ditandai sebagai testonly.

Daftar label; tidak dapat dikonfigurasi; default-nya adalah []

Kumpulan target yang Variabel Make-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:toolchain_type
• @rules_java//toolchains: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 atribut ini untuk menentukan cc_toolchain atau java_toolchain tertentu yang akan digunakan target.

Daftar label; tidak dapat dikonfigurasi; default bervariasi

Atribut visibility mengontrol apakah target dapat diandalkan oleh target di lokasi lain. Lihat dokumentasi untuk visibilitas.

Untuk target yang dideklarasikan langsung dalam file BUILD atau dalam makro lama yang dipanggil dari file BUILD, nilai default-nya adalah default_visibility paket jika ditentukan, atau ["//visibility:private"]. Untuk target yang dideklarasikan dalam satu atau beberapa makro simbolis, nilai defaultnya selalu ["//visibility:private"] (yang membuatnya hanya dapat digunakan dalam paket yang berisi kode makro).

Daftar string; tunduk pada penggantian $(location) dan "Make variable", serta 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 apa pun ditentukan di command line bazel test.

Kamus string; nilai tunduk pada penggantian $(location) dan "Make variable"; default-nya 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 TestEnvironment Provider.

Daftar string; 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. Hal ini tidak berlaku untuk aturan pengujian yang ditentukan Starlark.

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

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

Pengujian unit dianggap "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 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 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 membuat pengujian.

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

Berapa lama pengujian diperkirakan akan berjalan sebelum kembali.

Meskipun atribut ukuran pengujian mengontrol estimasi resource, waktu tunggu pengujian dapat ditetapkan secara independen. Jika tidak ditentukan secara eksplisit, waktu tunggu 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 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 membuat pengujian.

Boolean; tidak dapat dikonfigurasi; defaultnya adalah False

Menandai pengujian sebagai tidak stabil.

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

Bilangan bulat non-negatif yang kurang dari atau sama dengan 50; default-nya adalah -1

Menentukan jumlah shard paralel yang akan digunakan untuk menjalankan pengujian.

Jika ditetapkan, nilai ini akan mengganti heuristik apa pun 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 terlebih dahulu. Lihat juga: --test_sharding_strategy.

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

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

Lihat Menguji Sharding di Ensiklopedia Pengujian 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 "Make variable", serta tokenisasi shell Bourne; tidak dapat dikonfigurasi; default-nya adalah []

Argumen command line yang akan diteruskan Bazel ke target saat dijalankan 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 mengeksekusi biner secara manual di bazel-bin/).

Kamus string; nilai tunduk pada penggantian $(location) dan "Make variable"; default-nya 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. 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 mengeksekusi biner secara manual di bazel-bin/).

Daftar string; default-nya adalah []

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