Menemukan Perilaku Non-Hermetik di Aturan WORKSPACE

Laporkan masalah Lihat sumber

Berikut ini, mesin host adalah mesin tempat Bazel berjalan.

Saat menggunakan eksekusi jarak jauh, langkah-langkah build dan/atau pengujian yang sebenarnya tidak terjadi pada mesin host, tetapi dikirim ke sistem eksekusi jarak jauh. Namun, langkah-langkah yang terlibat dalam penyelesaian aturan ruang kerja terjadi di mesin host. Jika aturan ruang kerja Anda mengakses informasi tentang mesin host untuk digunakan selama eksekusi, build Anda kemungkinan akan rusak karena tidak kompatibel antarlingkungan.

Sebagai bagian dari adaptasikan aturan Bazel untuk eksekusi jarak jauh, Anda perlu menemukan aturan ruang kerja tersebut dan memperbaikinya. Halaman ini menjelaskan cara menemukan aturan ruang kerja yang berpotensi bermasalah menggunakan log ruang kerja.

Menemukan aturan non-hermetic

Aturan Workspace memungkinkan developer menambahkan dependensi ke ruang kerja eksternal, tetapi aturan tersebut cukup kaya untuk memungkinkan pemrosesan arbitrer terjadi dalam proses. Semua perintah terkait terjadi secara lokal dan dapat menjadi sumber potensi non-hermeticity. Biasanya perilaku non-hermetic diperkenalkan melalui repository_ctx yang memungkinkan interaksi dengan mesin host.

Mulai Bazel 0.18, Anda bisa mendapatkan log dari beberapa tindakan yang berpotensi non-hermetic dengan menambahkan flag --experimental_workspace_rules_log_file=[PATH] ke perintah Bazel. Di sini, [PATH] adalah nama file yang akan digunakan untuk membuat log.

Hal-hal yang perlu diperhatikan:

  • log menangkap peristiwa saat dieksekusi. Jika beberapa langkah di-cache, langkah tersebut tidak akan muncul di log, sehingga untuk mendapatkan hasil lengkap, jangan lupa untuk menjalankan bazel clean --expunge sebelumnya.

  • Terkadang fungsi dapat dijalankan kembali, sehingga peristiwa terkait akan muncul di log beberapa kali.

  • Aturan Workspace saat ini hanya mencatat peristiwa Starlark ke dalam log.

Untuk menemukan apa yang dieksekusi selama inisialisasi ruang kerja:

  1. Jalankan bazel clean --expunge. Perintah ini akan membersihkan cache lokal dan repositori yang di-cache, sehingga memastikan bahwa semua inisialisasi akan dijalankan kembali.

  2. Tambahkan --experimental_workspace_rules_log_file=/tmp/workspacelog ke perintah Bazel dan jalankan build.

    Ini menghasilkan file proto biner yang mencantumkan pesan jenis WorkspaceEvent

  3. Download kode sumber Bazel dan buka folder Bazel dengan menggunakan perintah di bawah ini. Anda memerlukan kode sumber agar dapat mengurai log ruang kerja dengan Parser log ruang kerja.

    git clone https://github.com/bazelbuild/bazel.git
cd bazel

  4. Di repo kode sumber Bazel, konversikan seluruh log ruang kerja menjadi teks.

    bazel build src/tools/workspacelog:parser
bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog > /tmp/workspacelog.txt

  5. Outputnya mungkin cukup panjang dan mencakup output dari aturan bazel bawaan.

    Untuk mengecualikan aturan tertentu dari output, gunakan opsi --exclude_rule. Contoh:

    bazel build src/tools/workspacelog:parser
bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog \
    --exclude_rule "//external:local_config_cc" \
    --exclude_rule "//external:dep" > /tmp/workspacelog.txt

  6. Buka /tmp/workspacelog.txt dan periksa apakah ada operasi yang tidak aman.

Log ini terdiri dari pesan WorkspaceEvent yang menguraikan tindakan tertentu yang berpotensi non-hermetik yang dilakukan pada repository_ctx.

Tindakan yang telah ditandai sebagai berpotensi non-hermetik adalah sebagai berikut:

  • execute: menjalankan perintah arbitrer di lingkungan host. Periksa apakah hal ini dapat menimbulkan dependensi pada lingkungan host.

  • download, download_and_extract: untuk memastikan build hermetic, pastikan sha256 ditentukan

  • file, template: ini bukan hermetik itu sendiri, tetapi mungkin merupakan mekanisme untuk memperkenalkan dependensi pada lingkungan host ke dalam repositori. Pastikan bahwa Anda memahami asal input, dan bahwa input tersebut tidak bergantung pada lingkungan host.

  • os: metode ini tidak bersifat non-hermetic, tetapi merupakan cara mudah untuk mendapatkan dependensi pada lingkungan host. Build hermetik umumnya tidak akan menyebutnya. Saat mengevaluasi apakah penggunaan Anda bersifat hermetik, perlu diingat bahwa ini berjalan di host, bukan di pekerja. Mendapatkan detail lingkungan dari host umumnya bukan ide yang bagus untuk build jarak jauh.

  • symlink: ini biasanya aman, tetapi cari tanda merah. Setiap symlink ke di luar repositori atau ke jalur absolut akan menyebabkan masalah pada pekerja jarak jauh. Jika symlink dibuat berdasarkan properti mesin host, symlink mungkin juga akan bermasalah.

  • which: memeriksa program yang diinstal di host biasanya bermasalah karena pekerja mungkin memiliki konfigurasi yang berbeda.