Hermetik

Halaman ini membahas hermetisitas, manfaat penggunaan build hermetic, dan strategi untuk mengidentifikasi perilaku non-hermetic dalam build Anda.

Ringkasan

Jika diberi kode sumber input dan konfigurasi produk yang sama, sistem build hermetic selalu menampilkan output yang sama dengan mengisolasi build dari perubahan pada sistem host.

Untuk mengisolasi build, build hermetic tidak sensitif terhadap library dan software lain yang diinstal pada mesin host lokal atau jarak jauh. Library ini bergantung pada versi alat build tertentu, seperti compiler, dan dependensi, seperti library. Hal ini membuat proses build bersifat mandiri karena tidak bergantung pada layanan di luar lingkungan build.

Dua aspek penting dari hermetisitas adalah:

  • Isolasi: Sistem build yang hermetis memperlakukan alat sebagai kode sumber. Mereka mendownload salinan alat dan mengelola penyimpanannya serta menggunakannya di dalam hierarki file yang terkelola. Hal ini akan menciptakan isolasi antara mesin host dan pengguna lokal, termasuk versi bahasa yang diinstal.
  • Identitas sumber: Sistem build hermetic mencoba memastikan kesamaan input. Repositori kode, seperti Git, mengidentifikasi kumpulan mutasi kode dengan kode hash yang unik. Sistem build yang hermetis menggunakan hash ini untuk mengidentifikasi perubahan pada input build.

Manfaat

Manfaat utama build hermetic adalah:

  • Kecepatan: Output tindakan dapat di-cache, dan tindakan tidak perlu dijalankan lagi kecuali jika input berubah.
  • Eksekusi paralel: Untuk input dan output tertentu, sistem build dapat membuat grafik semua tindakan untuk menghitung eksekusi yang efisien dan paralel. Sistem build akan memuat aturan dan menghitung grafik tindakan dan input hash untuk dicari di cache.
  • Beberapa build: Anda dapat mem-build beberapa build hermetic pada mesin yang sama, yang masing-masing build menggunakan alat dan versi yang berbeda.
  • Reproduksi: Build yang hermetis cocok untuk memecahkan masalah karena Anda mengetahui kondisi persis yang menghasilkan build.

Mengidentifikasi non-hermetisitas

Jika Anda bersiap untuk beralih ke Bazel, migrasi akan lebih mudah jika Anda meningkatkan hermetisitas build yang ada terlebih dahulu. Beberapa sumber umum non-hermetisitas dalam build adalah:

  • Pemrosesan arbitrer dalam .mk file
  • Tindakan atau alat yang membuat file secara tidak dapat ditentukan, biasanya melibatkan ID build atau stempel waktu
  • Biner sistem yang berbeda-beda di seluruh host (seperti biner /usr/bin, jalur absolut, compiler C++ sistem untuk konfigurasi otomatis aturan C++ native)
  • Menulis ke hierarki sumber selama build. Hal ini mencegah pohon sumber yang sama digunakan untuk target lain. Build pertama menulis ke hierarki sumber, yang memperbaiki hierarki sumber untuk target A. Kemudian, mencoba membuat target B mungkin akan gagal.

Memecahkan masalah build non-hermetic

Mulai dari eksekusi lokal, masalah yang memengaruhi hit cache lokal mengungkapkan tindakan non-hermetic.

  • Pastikan build berurutan null: Jika Anda menjalankan make dan mendapatkan build yang berhasil, menjalankan kembali build tidak boleh mem-build ulang target apa pun. Jika Anda menjalankan setiap langkah build dua kali atau pada sistem yang berbeda, bandingkan hash konten file dan dapatkan hasil yang berbeda, build tersebut tidak dapat direproduksi.
  • Jalankan langkah-langkah untuk men-debug hit cache lokal dari berbagai komputer klien potensial guna memastikan bahwa Anda menangkap setiap kasus kebocoran kasus lingkungan klien yang terjadi pada tindakan.
  • Jalankan build dalam container docker yang hanya berisi hierarki sumber yang dicentang dan daftar eksplisit alat host. Kerusakan build dan pesan error akan menangkap dependensi sistem implisit.
  • Temukan dan perbaiki masalah hermetisitas menggunakan aturan eksekusi jarak jauh.
  • Aktifkan sandbox yang ketat pada tingkat per tindakan, karena tindakan dalam build dapat bersifat stateful dan memengaruhi build atau output.
  • Aturan Workspace memungkinkan developer menambahkan dependensi ke ruang kerja eksternal, tetapi aturan tersebut cukup kaya untuk memungkinkan pemrosesan arbitrer terjadi dalam proses. Anda bisa mendapatkan log beberapa tindakan yang berpotensi non-hermetic di aturan ruang kerja Bazel dengan menambahkan flag --experimental_workspace_rules_log_file=PATH ke perintah Bazel Anda.

Hermetisitas dengan Bazel

Untuk informasi selengkapnya tentang kesuksesan project lain menggunakan build hermetic dengan Bazel, lihat diskusi BazelCon berikut ini: