Halaman ini membahas cara membuat program dengan Bazel, sintaksis perintah build, dan sintaksis pola target.
Panduan memulai
Untuk menjalankan Bazel, buka direktori workspace dasar Anda
atau subdirektorinya, lalu ketik bazel
. Lihat build jika Anda
perlu membuat ruang kerja baru.
bazel help
[Bazel release bazel version]
Usage: bazel command options ...
Perintah yang tersedia
analyze-profile
: Menganalisis data profil build.aquery
: Menjalankan kueri pada grafik tindakan pascaanalisis.build
: Mem-build target yang ditentukan.canonicalize-flags
: Melakukan kanonikalisasi flag Bazel.clean
: Menghapus file output dan secara opsional menghentikan server.cquery
: Menjalankan kueri grafik dependensi pascaanalisis.dump
: Mengeluarkan status internal proses server Bazel.help
: Mencetak bantuan untuk perintah, atau indeks.info
: Menampilkan info runtime tentang server bazel.fetch
: Mengambil semua dependensi eksternal target.mobile-install
: Menginstal aplikasi di perangkat seluler.query
: Menjalankan kueri grafik dependensi.run
: Menjalankan target yang ditentukan.shutdown
: Menghentikan server Bazel.test
: Membangun dan menjalankan target pengujian yang ditentukan.version
: Mencetak informasi versi untuk Bazel.
Mendapatkan bantuan
bazel help command
: Mencetak bantuan dan opsi untukcommand
.bazel help
startup_options
: Opsi untuk Bazel yang menghosting JVM.bazel help
target-syntax
: Menjelaskan sintaksis untuk menentukan target.bazel help info-keys
: Menampilkan daftar kunci yang digunakan oleh perintah info.
Alat bazel
menjalankan banyak fungsi yang disebut perintah. Yang paling sering
digunakan adalah bazel build
dan bazel test
. Anda dapat menjelajahi pesan bantuan
online menggunakan bazel help
.
Membuat satu target
Sebelum dapat memulai build, Anda memerlukan ruang kerja. Ruang kerja adalah hierarki direktori yang berisi semua file sumber yang diperlukan untuk membangun aplikasi Anda. Bazel memungkinkan Anda menjalankan build dari volume yang sepenuhnya hanya baca.
Untuk membuat program dengan Bazel, ketik bazel build
, diikuti dengan
target yang ingin Anda buat.
bazel build //foo
Setelah mengeluarkan perintah untuk mem-build //foo
, Anda akan melihat output yang mirip dengan ini:
INFO: Analyzed target //foo:foo (14 packages loaded, 48 targets configured).
INFO: Found 1 target...
Target //foo:foo up-to-date:
bazel-bin/foo/foo
INFO: Elapsed time: 9.905s, Critical Path: 3.25s
INFO: Build completed successfully, 6 total actions
Pertama, Bazel memuat semua paket dalam grafik dependensi target Anda. Ini
termasuk dependensi yang dideklarasikan, file yang tercantum langsung dalam file BUILD
target, dan dependensi transitif, file yang tercantum dalam file BUILD
dependensi
target Anda. Setelah mengidentifikasi semua dependensi, Bazel menganalisis
dependensinya dan membuat tindakan build. Terakhir, Bazel mengeksekusi
compiler dan alat build lainnya.
Selama fase eksekusi build, Bazel akan mencetak pesan progres. Pesan progres mencakup langkah build saat ini (seperti, compiler atau linker) saat dimulai, dan jumlah yang diselesaikan dari total jumlah tindakan build. Saat build dimulai, jumlah total tindakan sering kali meningkat saat Bazel menemukan seluruh grafik tindakan, tetapi jumlahnya stabil dalam beberapa detik.
Pada akhir build, Bazel akan mencetak target yang diminta, entah
berhasil atau tidak, dan jika ya, tempat file output dapat
ditemukan. Skrip yang menjalankan build dapat mengurai output ini dengan andal. Lihat
--show_result
untuk detail selengkapnya.
Jika Anda mengetik kembali perintah yang sama, build akan selesai jauh lebih cepat.
bazel build //foo
INFO: Analyzed target //foo:foo (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
Target //foo:foo up-to-date:
bazel-bin/foo/foo
INFO: Elapsed time: 0.144s, Critical Path: 0.00s
INFO: Build completed successfully, 1 total action
Ini adalah null build. Karena tidak ada yang berubah, tidak ada paket untuk dimuat ulang dan tidak ada langkah build untuk dijalankan. Jika ada sesuatu yang berubah di 'foo' atau dependensinya, Bazel akan mengeksekusi kembali beberapa tindakan build, atau menyelesaikan build inkremental.
Membuat beberapa target
Bazel memungkinkan sejumlah cara untuk menentukan target yang akan dibuat. Secara keseluruhan,
pola ini dikenal sebagai pola target. Sintaksis ini digunakan dalam perintah seperti build
, test
, atau query
.
Sementara label digunakan untuk menentukan target individual, misalnya untuk mendeklarasikan dependensi dalam file BUILD
, pola target
Bazel akan menentukan beberapa target. Pola target adalah generalisasi sintaksis label untuk kumpulan target, menggunakan karakter pengganti. Dalam kasus yang paling sederhana, label yang valid juga merupakan pola target yang valid, yang mengidentifikasi satu set yang berisi persis satu target.
Semua pola target yang dimulai dengan //
di-resolve secara relatif terhadap ruang kerja
saat ini.
//foo/bar:wiz |
Hanya satu target //foo/bar:wiz . |
//foo/bar |
Setara dengan //foo/bar:bar . |
//foo/bar:all |
Semua target aturan dalam paket foo/bar . |
//foo/... |
Semua aturan menargetkan di semua paket di bawah direktori foo . |
//foo/...:all |
Semua aturan menargetkan di semua paket di bawah direktori foo . |
//foo/...:* |
Semua target (aturan dan file) di semua paket di bawah direktori foo . |
//foo/...:all-targets |
Semua target (aturan dan file) di semua paket di bawah direktori foo . |
//... |
Semua target dalam paket di ruang kerja. Ini tidak termasuk target dari repositori eksternal. |
//:all |
Semua target dalam paket level atas, jika ada file `BUILD` di root ruang kerja. |
Pola target yang tidak dimulai dengan //
akan diselesaikan secara relatif terhadap direktori kerja saat ini. Contoh ini mengasumsikan direktori kerja foo
:
:foo |
Setara dengan //foo:foo . |
bar:wiz |
Setara dengan //foo/bar:wiz . |
bar/wiz |
Setara dengan:
|
bar:all |
Setara dengan //foo/bar:all . |
:all |
Setara dengan //foo:all . |
...:all |
Setara dengan //foo/...:all . |
... |
Setara dengan //foo/...:all . |
bar/...:all |
Setara dengan //foo/bar/...:all . |
Secara default, symlink direktori diikuti untuk pola target rekursif, kecuali yang mengarah ke bawah basis output, seperti symlink praktis yang dibuat di direktori utama ruang kerja.
Selain itu, Bazel tidak mengikuti symlink saat mengevaluasi pola target
rekursif di direktori mana pun yang berisi file bernama berikut:
DONT_FOLLOW_SYMLINKS_WHEN_TRAVERSING_THIS_DIRECTORY_VIA_A_RECURSIVE_TARGET_PATTERN
foo/...
adalah karakter pengganti pada paket, yang menunjukkan semua paket secara berulang
di bawah direktori foo
(untuk semua root jalur paket). :all
adalah karakter pengganti pada target, yang cocok dengan semua aturan dalam paket. Keduanya dapat
digabungkan, seperti dalam foo/...:all
, dan saat kedua karakter pengganti digunakan, karakter pengganti ini dapat
disingkat menjadi foo/...
.
Selain itu, :*
(atau :all-targets
) adalah karakter pengganti yang cocok dengan setiap target dalam paket yang cocok, termasuk file yang biasanya tidak dibuat oleh aturan apa pun, seperti file _deploy.jar
yang terkait dengan aturan java_binary
.
Hal ini menyiratkan bahwa :*
menunjukkan superset dari :all
; meskipun berpotensi
membingungkan, sintaksis ini memungkinkan karakter pengganti :all
yang sudah dikenal digunakan untuk
build standar, saat target build seperti _deploy.jar
tidak diinginkan.
Selain itu, Bazel mengizinkan penggunaan garis miring sebagai ganti titik dua yang diperlukan oleh
sintaksis label; ini sering kali praktis saat menggunakan ekspansi nama file Bash.
Misalnya, foo/bar/wiz
setara dengan //foo/bar:wiz
(jika ada
paket foo/bar
) atau //foo:bar/wiz
(jika ada paket foo
).
Banyak perintah Bazel menerima daftar pola target sebagai argumen, dan semuanya
mengikuti operator negasi awalan -
. Argumen ini dapat digunakan untuk mengurangi kumpulan target dari kumpulan yang ditentukan oleh argumen sebelumnya. Perhatikan bahwa ini berarti
urutan itu penting. Misalnya,
bazel build foo/... bar/...
berarti "build semua target di bawah foo
dan semua target di bawah bar
", sedangkan
bazel build -- foo/... -foo/bar/...
berarti "bangun semua target di bawah foo
kecuali yang berada di bawah foo/bar
". (Argumen
--
diperlukan untuk mencegah argumen berikutnya yang dimulai dengan -
diinterpretasikan sebagai opsi tambahan.)
Namun, perlu diperhatikan bahwa mengurangi target dengan cara ini tidak akan
menjamin bahwa target tidak dibuat, karena mungkin merupakan dependensi target
yang tidak dikurangi. Misalnya, jika ada //foo:all-apis
target
yang antara lain bergantung pada //foo/bar:api
, target yang terakhir akan dibuat sebagai
bagian dari build yang pertama.
Target dengan tags = ["manual"]
tidak disertakan dalam pola target karakter pengganti (...
, :*
, :all
, dll.) jika ditentukan dalam perintah seperti bazel build
dan bazel test
(tetapi target tersebut disertakan dalam pola target karakter pengganti negatif, yaitu akan dikurangi). Anda harus
menentukan target pengujian tersebut dengan pola target eksplisit pada command line jika
ingin Bazel mem-build/mengujinya. Sebaliknya, bazel query
tidak melakukan
pemfilteran tersebut secara otomatis (sehingga akan menggagalkan tujuan
bazel query
).
Mengambil dependensi eksternal
Secara default, Bazel akan mendownload dan membuat symlink dependensi eksternal selama
build. Namun, hal ini mungkin tidak diinginkan, baik karena Anda ingin mengetahui kapan dependensi eksternal baru ditambahkan atau karena Anda ingin "mengambil data" dependensi (misalnya, sebelum penerbangan saat Anda akan offline). Jika Anda
ingin mencegah dependensi baru ditambahkan selama proses build, Anda
dapat menentukan flag --fetch=false
. Perlu diperhatikan bahwa flag ini hanya berlaku untuk aturan repositori yang tidak mengarah ke direktori dalam sistem file lokal. Perubahan, misalnya, pada local_repository
,
new_local_repository
, serta aturan repositori Android SDK dan NDK
akan selalu diterapkan, terlepas dari nilai --fetch
.
Jika Anda tidak mengizinkan pengambilan selama build dan Bazel menemukan dependensi eksternal baru, build Anda akan gagal.
Anda dapat mengambil dependensi secara manual dengan menjalankan bazel fetch
. Jika
tidak mengizinkan pengambilan selama build, Anda harus menjalankan bazel fetch
:
- Sebelum Anda membangun untuk pertama kalinya.
- Setelah Anda menambahkan dependensi eksternal baru.
Setelah dijalankan, Anda tidak perlu menjalankannya lagi sampai file WORKSPACE berubah.
fetch
mengambil daftar target yang dependensinya akan diambil. Misalnya, tindakan ini akan mengambil dependensi yang diperlukan untuk membangun //foo:bar
dan //bar:baz
:
bazel fetch //foo:bar //bar:baz
Untuk mengambil semua dependensi eksternal untuk ruang kerja, jalankan:
bazel fetch //...
Pada Bazel 7.1 atau yang lebih baru, jika mengaktifkan Bzlmod, Anda juga dapat mengambil semua dependensi eksternal dengan menjalankan
bazel fetch
Anda sama sekali tidak perlu menjalankan pengambilan bazel jika memiliki semua alat yang
digunakan (mulai dari container library hingga JDK itu sendiri) di root Workspace.
Namun, jika Anda menggunakan apa pun di luar direktori ruang kerja, Bazel
akan otomatis menjalankan bazel fetch
sebelum menjalankan
bazel build
.
Cache repositori
Bazel mencoba menghindari pengambilan file yang sama beberapa kali, meskipun file
yang sama diperlukan di ruang kerja yang berbeda, atau jika definisi repositori
eksternal berubah, tetapi masih memerlukan file yang sama untuk didownload. Untuk melakukannya,
bazel akan meng-cache semua file yang didownload di cache repositori yang, secara default,
berada di ~/.cache/bazel/_bazel_$USER/cache/repos/v1/
. Lokasi
dapat diubah dengan opsi --repository_cache
. Cache
dibagikan antara semua ruang kerja dan versi bazel yang diinstal.
Entri diambil dari cache jika Bazel mengetahui dengan pasti bahwa entri tersebut memiliki salinan file yang benar. Artinya, jika permintaan download memiliki jumlah SHA256 dari file yang ditentukan dan file dengan hash tersebut ada dalam cache. Jadi, menentukan hash untuk setiap file eksternal
bukan hanya merupakan ide yang bagus dari sudut pandang keamanan, tetapi juga membantu menghindari
download yang tidak diperlukan.
Setelah setiap cache ditemukan, waktu modifikasi file dalam cache akan diperbarui. Dengan cara ini, penggunaan terakhir file dalam direktori cache dapat ditentukan dengan mudah, misalnya untuk membersihkan cache secara manual. Cache tidak pernah dibersihkan secara otomatis, karena mungkin berisi salinan file yang tidak lagi tersedia di upstream.
Direktori file distribusi
Direktori distribusi adalah mekanisme Bazel lain untuk menghindari download yang tidak perlu. Bazel menelusuri direktori distribusi sebelum cache repositori. Perbedaan utamanya adalah direktori distribusi memerlukan persiapan manual.
Dengan opsi --distdir=/path/to-directory
, Anda dapat menentukan direktori hanya baca tambahan untuk mencari file, bukan mengambilnya. File diambil dari direktori tersebut jika nama file
sama dengan nama dasar URL, dan juga hash file
sama dengan yang ditentukan dalam permintaan download. Ini hanya berfungsi jika hash file ditentukan dalam deklarasi WORKSPACE.
Meskipun kondisi pada nama file tidak diperlukan untuk ketepatan, kondisi ini akan mengurangi jumlah file kandidat menjadi satu per direktori yang ditentukan. Dengan cara ini, menentukan direktori file distribusi tetap efisien, bahkan jika jumlah file dalam direktori tersebut bertambah besar.
Menjalankan Bazel di lingkungan dengan air gap
Agar ukuran biner Bazel tetap kecil, dependensi implisit Bazel diambil melalui jaringan saat dijalankan untuk pertama kalinya. Dependensi implisit ini berisi toolchain dan aturan yang mungkin tidak diperlukan bagi semua orang. Misalnya, alat Android tidak dipaketkan dan diambil hanya saat mem-build project Android.
Namun, dependensi implisit ini dapat menyebabkan masalah saat menjalankan Bazel di lingkungan airgap, meskipun Anda telah mem-vendor semua dependensi WORKSPACE Anda. Untuk mengatasi hal itu, Anda dapat menyiapkan direktori distribusi yang berisi dependensi ini di mesin yang memiliki akses jaringan, lalu memindahkannya ke lingkungan airgap dengan pendekatan offline.
Untuk menyiapkan direktori distribusi, gunakan flag --distdir
. Anda harus melakukan ini sekali untuk setiap versi biner Bazel baru, karena
dependensi implisit dapat berbeda untuk setiap rilis.
Untuk mem-build dependensi ini di luar lingkungan airgapped, pertama periksa hierarki sumber Bazel di versi yang tepat:
git clone https://github.com/bazelbuild/bazel "$BAZEL_DIR"
cd "$BAZEL_DIR"
git checkout "$BAZEL_VERSION"
Kemudian, build tarball yang berisi dependensi runtime implisit untuk versi Bazel spesifik tersebut:
bazel build @additional_distfiles//:archives.tar
Ekspor tarball ini ke direktori yang dapat disalin ke lingkungan airgap Anda. Perhatikan flag --strip-components
, karena --distdir
bisa sangat rumit dengan tingkat penyusunan direktori:
tar xvf bazel-bin/external/additional_distfiles/archives.tar \
-C "$NEW_DIRECTORY" --strip-components=3
Terakhir, saat Anda menggunakan Bazel di lingkungan dengan airgap, teruskan flag --distdir
yang mengarah ke direktori. Untuk memudahkan, Anda dapat menambahkannya sebagai entri
.bazelrc
:
build --distdir=path/to/directory
Mem-build konfigurasi dan kompilasi silang
Semua input yang menentukan perilaku dan hasil build tertentu dapat
dibagi menjadi dua kategori yang berbeda. Jenis pertama adalah informasi intrinsik yang disimpan dalam file BUILD
project Anda: aturan build, nilai atributnya, dan kumpulan lengkap dependensi transitifnya.
Jenis kedua adalah data eksternal atau lingkungan, yang disediakan oleh pengguna atau
alat build: pilihan arsitektur target, opsi kompilasi dan penautan, serta opsi konfigurasi toolchain lainnya. Kami menyebut kumpulan lengkap data lingkungan sebagai konfigurasi.
Pada build apa pun, mungkin ada lebih dari satu konfigurasi. Pertimbangkan
kompilasi silang, tempat Anda mem-build file //foo:bin
yang dapat dieksekusi untuk arsitektur
64-bit, tetapi workstation Anda adalah mesin 32-bit. Jelas, build akan
memerlukan pembuatan //foo:bin
menggunakan toolchain yang mampu membuat file
executable 64-bit, tetapi sistem build juga harus membangun berbagai alat yang digunakan selama
build itu sendiri—misalnya alat yang di-build dari sumber, lalu kemudian
digunakan dalam, misalnya, genrule—dan alat ini harus di-build agar berjalan di workstation Anda. Dengan demikian, kita dapat mengidentifikasi dua konfigurasi: konfigurasi eksekutif, yang digunakan untuk mem-build alat yang berjalan selama build, dan konfigurasi target (atau konfigurasi permintaan, tetapi kita lebih sering mengatakan "konfigurasi target" meskipun kata tersebut sudah memiliki banyak arti), yang digunakan untuk membuat biner yang pada akhirnya Anda minta.
Biasanya, ada banyak library yang merupakan prasyarat dari target build
yang diminta (//foo:bin
) dan satu atau beberapa alat eksekutif, misalnya beberapa
library dasar. Library tersebut harus di-build dua kali, sekali untuk konfigurasi
exec, dan sekali untuk konfigurasi target. Bazel akan
memastikan bahwa kedua varian telah dibuat, dan file turunan disimpan
secara terpisah untuk menghindari gangguan; biasanya target tersebut dapat dibuat secara bersamaan,
karena tidak saling bergantung. Jika Anda melihat pesan progres
yang menunjukkan bahwa target tertentu sedang di-build dua kali, kemungkinan besar
ini adalah penjelasannya.
Konfigurasi exec berasal dari konfigurasi target sebagai berikut:
- Gunakan versi Crosstool yang sama (
--crosstool_top
) seperti yang ditentukan dalam konfigurasi permintaan, kecuali jika--host_crosstool_top
ditentukan. - Gunakan nilai
--host_cpu
untuk--cpu
(default:k8
). - Gunakan nilai yang sama dari opsi ini seperti yang ditentukan dalam konfigurasi
permintaan:
--compiler
,--use_ijars
, dan jika--host_crosstool_top
digunakan, nilai--host_cpu
akan digunakan untuk mencaridefault_toolchain
di Crosstool (mengabaikan--compiler
) untuk konfigurasi eksekusi. - Gunakan nilai
--host_javabase
untuk--javabase
- Gunakan nilai
--host_java_toolchain
untuk--java_toolchain
- Menggunakan build yang dioptimalkan untuk kode C++ (
-c opt
). - Tidak membuat informasi proses debug (
--copt=-g0
). - Menghapus informasi debug dari library bersama dan file yang dapat dieksekusi
(
--strip=always
). - Tempatkan semua file turunan di lokasi khusus, yang berbeda dengan yang digunakan oleh konfigurasi permintaan yang memungkinkan.
- Menyembunyikan penandaan biner dengan data build (lihat opsi
--embed_*
). - Semua nilai lainnya tetap dalam setelan default.
Ada banyak alasan mengapa lebih baik memilih konfigurasi eksekusi yang berbeda dari konfigurasi permintaan. Yang paling penting:
Pertama, dengan menggunakan biner yang dioptimalkan dan dihilangkan, Anda mengurangi waktu yang dihabiskan untuk menautkan dan mengeksekusi alat, ruang disk yang digunakan oleh alat, dan waktu I/O jaringan dalam build terdistribusi.
Kedua, dengan memisahkan konfigurasi exec dan request di semua build, Anda akan menghindari build ulang yang sangat mahal yang akan disebabkan oleh perubahan kecil pada konfigurasi permintaan (seperti mengubah opsi linker), seperti yang dijelaskan sebelumnya.
Rebuild inkremental yang benar
Salah satu tujuan utama project Bazel adalah memastikan build ulang inkremental yang benar. Alat build sebelumnya, terutama yang berbasis di Make, membuat beberapa asumsi yang tidak valid dalam implementasi build inkremental mereka.
Pertama, stempel waktu file meningkat secara monoton. Meskipun ini adalah kasus umum, sangat mudah untuk mengabaikan asumsi ini; menyinkronkan ke revisi file yang lebih lama menyebabkan berkurangnya waktu modifikasi file; Sistem berbasis Make tidak akan dibuat ulang.
Secara lebih umum, meskipun Make mendeteksi perubahan pada file, Make tidak mendeteksi perubahan
pada perintah. Jika Anda mengubah opsi yang diteruskan ke compiler dalam langkah build
tertentu, Make tidak akan menjalankan ulang compiler, dan Anda perlu menghapus
output yang tidak valid dari build sebelumnya secara manual menggunakan make clean
.
Selain itu, Make tidak andal terhadap kegagalan penghentian salah satu subprosesnya setelah subproses tersebut mulai menulis ke file outputnya. Meskipun eksekusi Make saat ini akan gagal, pemanggilan Make selanjutnya akan mengasumsikan bahwa file output yang terpotong tersebut valid (karena lebih baru daripada inputnya), dan tidak akan dibuat ulang. Demikian pula, jika proses {i>Make<i} dimatikan, situasi serupa dapat terjadi.
Bazel menghindari asumsi ini, dan lain-lain. Bazel mempertahankan database dari semua pekerjaan yang telah dilakukan sebelumnya, dan hanya akan menghilangkan langkah build jika menemukan bahwa kumpulan file input (dan stempel waktu-nya) ke langkah build tersebut, dan perintah kompilasi untuk langkah build tersebut, sama persis dengan yang ada dalam database, dan bahwa kumpulan file output (dan stempel waktu) untuk entri database sama persis dengan stempel waktu file di disk. Setiap perubahan pada file input atau file output, atau pada perintah itu sendiri, akan menyebabkan eksekusi ulang langkah build.
Manfaat bagi pengguna build inkremental yang benar adalah: lebih sedikit waktu yang terbuang karena kebingungan. (Selain itu, lebih sedikit waktu yang diperlukan untuk menunggu build ulang yang disebabkan oleh penggunaan make
clean
, baik diperlukan maupun preemtif.)
Membangun konsistensi dan build inkremental
Secara formal, kami menentukan status build sebagai konsisten ketika semua file output yang diharapkan ada, dan kontennya benar, seperti yang ditentukan oleh langkah-langkah atau aturan yang diperlukan untuk membuatnya. Saat Anda mengedit file sumber, status build dikatakan tidak konsisten, dan tetap tidak konsisten hingga Anda menjalankan alat build berikutnya hingga berhasil diselesaikan. Kami menjelaskan situasi ini sebagai inkonsistensi yang tidak stabil, karena hanya bersifat sementara, dan konsistensi dipulihkan dengan menjalankan alat build.
Ada jenis inkonsistensi lain yang berbahaya: inkonsistensi
stabil. Jika build mencapai status tidak konsisten yang stabil, pemanggilan alat build
yang berhasil berulang tidak akan memulihkan konsistensi: build
telah "terhenti", dan output-nya tetap salah. Status tidak konsisten yang stabil
adalah alasan utama pengguna Make (dan alat build lainnya) berjenis make clean
.
Mengetahui bahwa alat build gagal dengan cara ini (lalu memulihkannya
) dapat memakan waktu dan sangat menjengkelkan.
Secara konseptual, cara paling sederhana untuk mencapai build yang konsisten adalah dengan membuang semua output build sebelumnya dan memulai lagi: membuat setiap build menjadi build yang bersih. Pendekatan ini jelas terlalu memakan waktu untuk menjadi praktis (kecuali mungkin bagi engineer rilis). Oleh karena itu, agar berguna, alat build harus dapat melakukan build inkremental tanpa mengorbankan konsistensi.
Analisis dependensi inkremental yang benar sulit dilakukan, dan seperti dijelaskan di atas, banyak alat build lain tidak berfungsi dengan baik untuk menghindari status tidak konsisten yang stabil selama build inkremental. Sebaliknya, Bazel menawarkan jaminan berikut: setelah pemanggilan alat build berhasil, saat Anda tidak melakukan pengeditan, build akan berada dalam status konsisten. (Jika Anda mengedit file sumber selama build, Bazel tidak menjamin konsistensi hasil build saat ini. Namun, hal ini menjamin bahwa hasil build next akan memulihkan konsistensi.)
Seperti semua jaminan lainnya, ada beberapa petunjuk sederhana: ada beberapa cara yang diketahui untuk mendapatkan status tidak konsisten yang stabil dengan Bazel. Kami tidak akan menjamin untuk menyelidiki masalah yang timbul dari upaya yang disengaja untuk menemukan bug dalam analisis dependensi inkremental, tetapi kami akan menyelidiki dan melakukan yang terbaik untuk memperbaiki semua status tidak konsisten yang muncul dari penggunaan alat build yang normal atau "masuk akal".
Jika Anda mendeteksi status tidak konsisten yang stabil dengan Bazel, laporkan bug.
Eksekusi dengan sandbox
Bazel menggunakan sandbox untuk menjamin bahwa tindakan berjalan secara hermetis dan
benar. Bazel menjalankan spawns (secara longgar: tindakan) di sandbox yang
hanya berisi kumpulan file minimal yang diperlukan alat untuk melakukan tugasnya. Saat ini, sandboxing berfungsi di Linux 3.12 atau yang lebih baru dengan opsi CONFIG_USER_NS
diaktifkan, dan juga di macOS 10.11 atau yang lebih baru.
Bazel akan mencetak peringatan jika sistem Anda tidak mendukung sandbox untuk memberi tahu
Anda bahwa build tidak dijamin aman dan dapat memengaruhi
sistem host dengan cara yang tidak diketahui. Untuk menonaktifkan peringatan ini, Anda dapat meneruskan
flag --ignore_unsupported_sandboxing
ke Bazel.
Di beberapa platform seperti node cluster Google Kubernetes
Engine atau Debian,
namespace pengguna dinonaktifkan secara default karena masalah
keamanan. Ini dapat diperiksa dengan melihat file
/proc/sys/kernel/unprivileged_userns_clone
: jika ada dan berisi 0,
namespace pengguna dapat diaktifkan dengan
sudo sysctl kernel.unprivileged_userns_clone=1
.
Dalam beberapa kasus, sandbox Bazel gagal mengeksekusi aturan karena penyiapan
sistem. Gejalanya umumnya kegagalan yang menampilkan pesan yang mirip dengan namespace-sandbox.c:633: execvp(argv[0], argv): No such file or directory
.
Dalam hal ini, coba nonaktifkan sandbox untuk genrules dengan --strategy=Genrule=standalone
dan untuk aturan lain dengan --spawn_strategy=standalone
. Selain itu, laporkan bug di
issue tracker kami dan sebutkan distribusi Linux yang Anda gunakan agar kami dapat
menyelidiki dan memberikan perbaikan dalam rilis berikutnya.
Fase build
Di Bazel, build terjadi dalam tiga fase yang berbeda; sebagai pengguna, dengan memahami perbedaan di antara keduanya akan memberikan insight tentang opsi yang mengontrol build (lihat di bawah).
Fase pemuatan
Yang pertama adalah memuat semua file BUILD yang diperlukan untuk target awal, dan penutupan dependensi transitifnya, akan dimuat, diurai, dievaluasi, dan di-cache.
Untuk build pertama setelah server Bazel dimulai, fase pemuatan biasanya memerlukan waktu beberapa detik karena jumlah file BUILD yang dimuat dari sistem file. Pada build berikutnya, terutama jika tidak ada file BUILD yang berubah, pemuatan akan terjadi dengan sangat cepat.
Error yang dilaporkan selama fase ini meliputi: paket tidak ditemukan, target tidak ditemukan, error leksikal dan tata bahasa dalam file BUILD, serta error evaluasi.
Fase analisis
Fase kedua, analisis, melibatkan analisis semantik dan validasi setiap aturan build, konstruksi grafik dependensi build, dan penentuan dengan tepat pekerjaan apa yang harus dilakukan di setiap langkah build.
Seperti pemuatan, analisis juga membutuhkan waktu beberapa detik jika dihitung secara keseluruhan. Namun, Bazel menyimpan grafik dependensi di cache dari satu build ke build berikutnya dan hanya menganalisis ulang apa yang diperlukannya, yang dapat membuat build inkremental menjadi sangat cepat jika paket belum berubah sejak build sebelumnya.
Error yang dilaporkan pada tahap ini mencakup: dependensi yang tidak sesuai, input yang tidak valid ke aturan, dan semua pesan error khusus aturan.
Fase pemuatan dan analisis berlangsung cepat karena Bazel menghindari I/O file yang tidak perlu pada tahap ini, sehingga hanya membaca BUILD file untuk menentukan pekerjaan yang akan dilakukan. Hal ini memang didesain, dan menjadikan Bazel sebagai fondasi yang baik untuk alat analisis, seperti perintah query Bazel, yang diimplementasikan di atas fase pemuatan.
Fase eksekusi
Fase ketiga dan terakhir build adalah eksekusi. Fase ini memastikan bahwa output setiap langkah dalam build konsisten dengan inputnya, menjalankan kembali alat kompilasi/penautan/dll. jika diperlukan. Pada langkah inilah build menghabiskan sebagian besar waktunya, mulai dari beberapa detik hingga lebih dari satu jam untuk build besar. Error yang dilaporkan selama fase ini meliputi: file sumber tidak ada, error pada alat yang dieksekusi oleh beberapa tindakan build, atau kegagalan alat untuk menghasilkan serangkaian output yang diharapkan.