Menulis Aturan di Windows

Laporkan masalah Lihat sumber 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

Jalur

Masalah:

  • Batas panjang: panjang jalur maksimum adalah 259 karakter.

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

    Perhatikan hal ini tentang program yang Anda jalankan dalam tindakan.

  • Direktori kerja: juga dibatasi hingga 259 karakter.

    Proses tidak dapat cd ke direktori yang 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, program lainnya tidak. Beberapa perintah bawaan di cmd.exe 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 root sistem file tunggal.

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

Solusi:

  • Buat jalur tetap singkat.

    Hindari nama direktori yang panjang, struktur direktori bertingkat yang 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 yang singkat.

    Gunakan flag --output_user_root=<path> untuk menentukan jalur singkat bagi output Bazel. Sebaiknya miliki drive (atau drive virtual) hanya 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 symlink direktori, secara longgar[1]. Persimpangan mudah dibuat dan dapat mengarah ke direktori (di komputer yang sama) dengan jalur yang panjang. Jika tindakan build membuat jalur yang 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]: Secara umum, Junction bukan Link Simbolik, tetapi untuk tindakan build, Anda dapat menganggap Junction sebagai Link Simbolik Direktori.

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

    Saat Anda membuat command line atau variabel lingkungan untuk tindakan, buat jalur 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, di Java, System.getenv("SystemRoot") dan System.getenv("SYSTEMROOT") menghasilkan hasil yang sama. (Hal ini juga berlaku untuk bahasa lain.)

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

    Variabel lingkungan adalah bagian dari kunci cache tindakan. Jika tindakan menggunakan variabel lingkungan yang sering berubah, atau disesuaikan untuk pengguna, aturan tersebut akan lebih sulit di-cache.

Solusi:

  • Hanya gunakan nama variabel lingkungan dalam huruf besar.

    Fitur ini berfungsi di Windows, macOS, dan Linux.

  • Minimalkan lingkungan tindakan.

    Saat menggunakan ctx.actions.run, tetapkan lingkungan ke ctx.configuration.default_shell_env. Jika tindakan memerlukan lebih banyak variabel lingkungan, masukkan semuanya ke 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

Masalah:

  • 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).

    Perhatikan bahwa skrip shell (.sh) TIDAK dapat dieksekusi di Windows; Anda tidak dapat menentukannya sebagai executable ctx.actions.run. Tidak ada juga 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.

    Bash tersebar luas di sistem seperti Unix, tetapi sering kali tidak tersedia di Windows. Bazel itu sendiri semakin tidak bergantung pada Bash (MSYS2), sehingga pada masa mendatang, pengguna kemungkinan besar tidak akan menginstal MSYS2 bersama dengan Bazel. Agar aturan lebih mudah digunakan di Windows, hindari menjalankan perintah Bash dalam praktik.

  • Akhir 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 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 memecahkan masalah sederhana seperti menyalin file atau menulis file teks. Anda dapat menghindari penggunaan Bash (dan membuat ulang roda): lihat apakah bazel-skylib memiliki aturan khusus untuk kebutuhan Anda. Tidak satu pun yang bergantung pada Bash saat di-build/diuji di Windows.

    Contoh aturan build:

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

    • write_file() (source, documentation): menulis file teks, dengan akhiran baris yang diinginkan (auto, unix, atau windows), secara opsional membuatnya 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, pertimbangkan untuk menggunakan skrip .bat untuk hal-hal yang tidak penting.

    Alih-alih 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 tetap, file .bat sederhana akan cukup. Jika aturan Anda menampilkan penyedia DefaultInfo(), kolom executable dapat merujuk ke file .bat tersebut di Windows.

    Selain itu, 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 dieksekusi. 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.

    Dalam 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 yang prinsipil dalam aturan repositori.

Menghapus file

Masalah:

  • File tidak dapat dihapus saat terbuka.

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

  • Direktori kerja proses yang sedang berjalan tidak dapat dihapus.

    Proses memiliki handle terbuka ke direktori kerjanya, dan direktori tidak dapat dihapus hingga proses berakhir.

Solusi:

  • Dalam kode Anda, coba tutup file dengan cepat.

    Di Java, gunakan try-with-resources. Di Python, gunakan with open(...) as f:. Pada prinsipnya, coba tutup nama sebutan channel sesegera mungkin.