Menemukan Perilaku Non-Hermetis dalam Aturan WORKSPACE

Laporkan masalah Lihat sumber {/18/}{/1/}

Dalam contoh berikut, mesin host adalah mesin tempat Bazel berjalan.

Saat menggunakan eksekusi jarak jauh, langkah build dan/atau pengujian yang sebenarnya tidak terjadi di mesin host, tetapi dikirim ke sistem eksekusi jarak jauh. Namun, langkah-langkah yang diperlukan untuk me-resolve 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 ketidakcocokan antarlingkungan.

Sebagai bagian dari penyesuaian 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 menimbulkan masalah menggunakan log ruang kerja.

Menemukan aturan non-hermetik

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

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

Hal-hal yang perlu diperhatikan:

  • log mencatat kejadian saat dieksekusi. Jika beberapa langkah di-cache, langkah tersebut tidak akan muncul di log. Jadi, untuk mendapatkan hasil penuh, jangan lupa untuk menjalankan bazel clean --expunge sebelumnya.

  • Terkadang fungsi dapat dijalankan ulang, 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 semua inisialisasi akan dijalankan ulang.

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

    Tindakan ini menghasilkan pesan listingan file proto biner dengan 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 workspacelog.

    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 menyertakan 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 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 ini dapat menyebabkan dependensi pada lingkungan host.

  • download, download_and_extract: untuk memastikan build Hermetic, pastikan sha256 telah ditentukan

  • file, template: kode ini tidak bersifat non-hermetik, tetapi dapat menjadi mekanisme untuk memasukkan dependensi pada lingkungan host ke dalam repositori. Pastikan Anda memahami asal input dan tidak bergantung pada lingkungan host.

  • os: ini tidak bersifat non-hermetik, tetapi merupakan cara mudah untuk mendapatkan dependensi pada lingkungan host. Bangunan hermetik umumnya tidak akan memanggilnya. Saat mengevaluasi apakah penggunaan Anda bersifat hermetik, perlu diingat bahwa proses ini berjalan di host, bukan pada pekerja. Mendapatkan spesifikasi lingkungan dari host umumnya bukan ide yang baik untuk build jarak jauh.

  • symlink: hal ini biasanya aman, tetapi perhatikan apakah ada masalah. Symlink apa pun yang berada 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 menimbulkan masalah.

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