Menulis Aturan di Windows

7/0.9/2.5. Lihat sumber Nightly {/3/}

Halaman ini berfokus pada penulisan aturan yang kompatibel dengan Windows, masalah umum dalam menulis aturan portabel, dan beberapa solusi.

Paths

Permasalahan:

  • Batas panjang: panjang jalur maksimum adalah 259 karakter.

    Meskipun Windows juga mendukung jalur yang lebih panjang (hingga 32.767 karakter), banyak program dibuat dengan batas bawah.

    Perhatikan hal ini tentang program yang Anda jalankan dalam tindakannya.

  • Direktori kerja: juga dibatasi hingga 259 karakter.

    Proses tidak boleh cd ke dalam direktori yang berisi lebih dari 259 karakter.

  • Kepekaan huruf besar/kecil: Jalur Windows tidak peka huruf besar/kecil, sedangkan jalur Unix peka huruf besar/kecil.

    Perhatikan hal ini saat membuat command line untuk tindakan.

  • Pemisah jalur: adalah garis miring terbalik (\`), not forward slash (/`).

    Bazel menyimpan jalur bergaya Unix dengan pemisah /. Meskipun beberapa program Windows mendukung jalur bergaya Unix, yang lain tidak. Beberapa perintah bawaan di {i>cmd.exe<i} mendukungnya, beberapa tidak.

    Sebaiknya selalu gunakan \` separators on Windows: replace/with` saat Anda membuat command line dan variabel lingkungan untuk tindakan.

  • Jalur absolut: jangan diawali dengan garis miring (/).

    Jalur absolut di Windows dimulai dengan huruf drive, seperti C:\foo\bar.txt. Tidak ada {i>root <i}sistem file tunggal.

    Perhatikan hal ini jika aturan Anda memeriksa apakah suatu jalur bersifat absolut. Jalur absolut harus dihindari karena sering kali non-portabel.

Solusi:

  • Pastikan jalan tetap pendek.

    Hindari nama direktori yang panjang, struktur direktori bertingkat dalam, nama file yang panjang, nama ruang kerja yang panjang, nama target yang panjang.

    Semua ini dapat menjadi komponen jalur file input tindakan, dan dapat menghabiskan batas panjang jalur.

  • Gunakan root output singkat.

    Gunakan tanda --output_user_root=<path> untuk menentukan jalur singkat untuk output Bazel. Sebaiknya sediakan drive (atau virtual drive) khusus untuk output Bazel (seperti file D:\`), and adding this line to your.bazelrc`:

    build --output_user_root=D:/

    atau

    build --output_user_root=C:/_bzl

  • Gunakan persimpangan.

    Persimpangan adalah [1], symlink direktori. Persimpangan mudah dibuat dan dapat mengarah ke direktori (di komputer yang sama) dengan jalur yang panjang. Jika tindakan build membuat persimpangan yang jalurnya pendek, tetapi targetnya panjang, alat dengan batas jalur pendek dapat mengakses file di direktori yang dihubungkan.

    Dalam file .bat atau cmd.exe, Anda dapat membuat sambungan seperti ini:

    mklink /J c:\path\to\junction c:\path\to\very\long\target\path

    [1]: Sebenarnya Junction bukanlah Link Simbolis, tetapi untuk tindakan build, Anda dapat menganggap Junction sebagai Symlink Direktori.

  • Ganti / dengan `` di jalur dalam actions / envvars.

    Saat Anda membuat command line atau variabel lingkungan untuk suatu tindakan, buat jalurnya bergaya Windows. Contoh:

    def as_path(p, is_windows):
    if is_windows:
        return p.replace("/", "\\")
    else:
        return p

Variabel lingkungan

Permasalahan:

  • Kepekaan huruf besar/kecil: Nama variabel lingkungan Windows tidak peka huruf besar/kecil.

    Misalnya, dalam Java, System.getenv("SystemRoot") dan System.getenv("SYSTEMROOT") memberikan hasil yang sama. (Hal ini juga berlaku untuk bahasa lain.)

  • Hermetisitas: tindakan harus menggunakan variabel lingkungan kustom sesedikit mungkin.

    Variabel lingkungan adalah bagian dari kunci cache tindakan. Jika tindakan menggunakan variabel lingkungan yang sering berubah, atau khusus untuk pengguna, aturan akan kurang dapat di-cache.

Solusi:

  • Hanya gunakan nama variabel lingkungan dalam huruf besar.

    Cara ini berfungsi di Windows, macOS, dan Linux.

  • Minimalkan lingkungan tindakan.

    Saat menggunakan ctx.actions.run, setel lingkungan ke ctx.configuration.default_shell_env. Jika tindakan tersebut memerlukan lebih banyak variabel lingkungan, masukkan semuanya dalam kamus dan teruskan ke tindakan. Contoh:

    load("@bazel_skylib//lib:dicts.bzl", "dicts")

def _make_env(ctx, output_file, is_windows):
    out_path = output_file.path
    if is_windows:
        out_path = out_path.replace("/", "\\")
    return dicts.add(ctx.configuration.default_shell_env, {"MY_OUTPUT": out_path})

Tindakan

Permasalahan:

  • Output yang dapat dieksekusi: Setiap file yang dapat dieksekusi harus memiliki ekstensi yang dapat dieksekusi.

    Ekstensi yang paling umum adalah .exe (file biner) dan .bat (skrip batch).

    Perlu diketahui bahwa skrip shell (.sh) TIDAK dapat dieksekusi di Windows; Anda tidak dapat menentukannya sebagai executable ctx.actions.run. Selain itu, tidak ada izin +x yang dapat dimiliki file, sehingga Anda tidak dapat mengeksekusi file arbitrer seperti di Linux.

  • Perintah Bash: Demi portabilitas, hindari menjalankan perintah Bash langsung dalam tindakan.

    {i>Bash<i} sudah tersebar luas di sistem yang mirip Unix, tetapi sering kali tidak tersedia di Windows. Bazel sendiri semakin jarang mengandalkan Bash (MSYS2), sehingga pada masa mendatang, pengguna cenderung tidak menginstal MSYS2 bersama dengan Bazel. Agar aturan lebih mudah digunakan di Windows, hindari menjalankan perintah Bash dalam cara kerja.

  • Akhiran baris: Windows menggunakan CRLF (\r\n), sistem seperti Unix menggunakan LF (\n).

    Perhatikan hal ini saat membandingkan file teks. Perhatikan setelan Git Anda, terutama akhir baris saat melakukan check out atau melakukan commit. (Lihat setelan core.autocrlf Git.)

Solusi:

  • Menggunakan aturan yang dibuat tanpa tujuan Bash.

    native.genrule() adalah wrapper untuk perintah Bash, dan sering digunakan untuk menyelesaikan masalah sederhana seperti menyalin file atau menulis file teks. Anda tidak perlu mengandalkan Bash (dan menciptakan kembali produknya): lihat apakah bazel-skylib memiliki aturan yang dibuat khusus untuk kebutuhan Anda. Tidak satu pun dari mereka yang bergantung pada Bash saat dibangun/diuji di Windows.

    Contoh aturan build:

    • copy_file() (sumber, dokumentasi): menyalin file di tempat lain, secara opsional membuatnya dapat dieksekusi

    • write_file() (sumber, dokumentasi): menulis file teks, dengan akhiran baris yang diinginkan (auto, unix, atau windows), secara opsional menjadikan file tersebut dapat dieksekusi (jika berupa skrip)

    • run_binary() (sumber, dokumentasi): menjalankan biner (atau aturan *_binary) dengan input tertentu dan output yang diharapkan sebagai tindakan build (ini adalah wrapper aturan build untuk ctx.actions.run)

    • native_binary() (sumber, dokumentasi): menggabungkan biner native dalam aturan *_binary, yang dapat Anda bazel run atau gunakan dalam atribut tool run_binary() atau atribut tools native.genrule()

    Contoh aturan pengujian:

    • diff_test() (sumber, dokumentasi): pengujian yang membandingkan konten dua file

    • native_test() (sumber, dokumentasi): menggabungkan biner native dalam aturan *_test, yang dapat Anda bazel test

  • Di Windows, sebaiknya gunakan skrip .bat untuk hal-hal yang sederhana.

    Sebagai ganti skrip .sh, Anda dapat menyelesaikan tugas sederhana dengan skrip .bat.

    Misalnya, jika Anda memerlukan skrip yang tidak melakukan apa pun, atau mencetak pesan, atau keluar dengan kode error yang sudah diperbaiki, file .bat sederhana sudah cukup. Jika aturan Anda menampilkan penyedia DefaultInfo(), kolom executable dapat merujuk ke file .bat tersebut di Windows.

    Dan karena ekstensi file tidak penting di macOS dan Linux, Anda selalu dapat menggunakan .bat sebagai ekstensi, bahkan untuk skrip shell.

    Perlu diketahui bahwa file .bat kosong tidak dapat dijalankan. Jika Anda memerlukan skrip kosong, tulis satu spasi di dalamnya.

  • Gunakan Bash dengan cara yang berprinsip.

    Dalam aturan build dan pengujian Starlark, gunakan ctx.actions.run_shell untuk menjalankan skrip Bash dan perintah Bash sebagai tindakan.

    Di makro Starlark, gabungkan skrip dan perintah Bash dalam native.sh_binary() atau native.genrule(). Bazel akan memeriksa apakah Bash tersedia dan menjalankan skrip atau perintah melalui Bash.

    Dalam aturan repositori Starlark, coba hindari Bash sama sekali. Bazel saat ini tidak menawarkan cara untuk menjalankan perintah Bash dengan cara berprinsip dalam aturan repositori.

Menghapus file

Permasalahan:

  • File tidak dapat dihapus saat dibuka.

    File yang terbuka tidak dapat dihapus (secara default), percobaan akan menghasilkan error "Akses Ditolak". Jika Anda tidak dapat menghapus file, mungkin proses yang sedang berjalan akan menahannya.

  • Direktori kerja dari proses yang sedang berjalan tidak dapat dihapus.

    Proses memiliki handle terbuka untuk direktori kerjanya, dan direktori tersebut tidak dapat dihapus sampai proses dihentikan.

Solusi:

  • Di kode Anda, cobalah menutup file dengan segera.

    Di Java, gunakan try-with-resources. Di Python, gunakan with open(...) as f:. Pada prinsipnya, cobalah menutup tuas sesegera mungkin.