Aturan Repositori

Halaman ini membahas cara membuat aturan repositori dan memberikan contoh untuk mengetahui detail selengkapnya.

Repositori eksternal adalah aturan yang hanya dapat digunakan dalam file WORKSPACE dan memungkinkan operasi non-hermetik pada fase pemuatan Bazel. Setiap aturan repositori eksternal membuat ruang kerjanya sendiri, dengan file dan artefak BUILD-nya sendiri. File ini dapat digunakan untuk bergantung pada library pihak ketiga (seperti library yang dikemas Maven), tetapi juga untuk membuat file BUILD khusus untuk host tempat Bazel berjalan.

Pembuatan aturan repositori

Dalam file .bzl, gunakan fungsi repository_rule untuk membuat aturan repositori baru dan menyimpannya dalam variabel global.

Aturan repositori kustom dapat digunakan seperti aturan repositori bawaan. Memiliki atribut name wajib dan setiap target yang ada dalam file build-nya dapat dirujuk sebagai @<name>//package:target dengan <name> adalah nilai atribut name.

Aturan dimuat saat Anda membangunnya secara eksplisit, atau jika merupakan dependensi build. Dalam hal ini, Bazel akan menjalankan fungsi implementation-nya. Fungsi ini menjelaskan cara membuat repositori, kontennya, dan file BUILD.

Atribut

Atribut adalah argumen aturan, seperti url atau sha256. Anda harus mencantumkan atribut dan jenisnya saat menentukan aturan repositori.

local_repository = repository_rule(
    implementation=_impl,
    local=True,
    attrs={"path": attr.string(mandatory=True)})

Untuk mengakses atribut, gunakan repository_ctx.attr.<attribute_name>.

Semua repository_rule memiliki atribut yang ditentukan secara implisit (seperti aturan build). Dua atribut implisit adalah name (sama seperti untuk aturan pembuatan) dan repo_mapping. Nama aturan repositori dapat diakses dengan repository_ctx.name. Arti repo_mapping sama dengan arti untuk aturan repositori native local_repository dan new_local_repository.

Jika nama atribut diawali dengan _, atribut tersebut bersifat pribadi dan pengguna tidak dapat menyetelnya.

Fungsi penerapan

Setiap aturan repositori memerlukan fungsi implementation. Bagian ini berisi logika sebenarnya dari aturan dan dijalankan secara ketat dalam Fase Pemuatan.

Fungsi ini memiliki tepat satu parameter input, repository_ctx. Fungsi menampilkan None untuk menandakan bahwa aturan dapat direproduksi dengan parameter yang ditentukan, atau dict dengan serangkaian parameter untuk aturan tersebut yang akan mengubah aturan tersebut menjadi aturan yang dapat direproduksi yang menghasilkan repositori yang sama. Misalnya, untuk aturan yang melacak repositori git, hal itu berarti menampilkan ID commit tertentu, bukan cabang mengambang yang awalnya ditentukan.

Parameter input repository_ctx dapat digunakan untuk mengakses nilai atribut, dan fungsi non-hermetik (menemukan biner, mengeksekusi biner, membuat file di repositori, atau mendownload file dari Internet). Lihat library untuk mengetahui konteks selengkapnya. Contoh:

def _impl(repository_ctx):
  repository_ctx.symlink(repository_ctx.attr.path, "")

local_repository = repository_rule(
    implementation=_impl,
    ...)

Kapan fungsi penerapan dieksekusi?

Jika repositori dideklarasikan sebagai local, perubahan dalam dependensi di grafik dependensi (termasuk file WORKSPACE itu sendiri) akan menyebabkan eksekusi fungsi implementasi.

Fungsi penerapan dapat dimulai ulang jika dependensi yang dimintanya tidak ada. Awal fungsi penerapan akan dieksekusi ulang setelah dependensi diselesaikan. Untuk menghindari restart yang tidak perlu (yang mahal, karena akses jaringan mungkin harus diulang), argumen label akan diambil sebelumnya, asalkan semua argumen label dapat diselesaikan ke file yang ada. Perhatikan bahwa menyelesaikan jalur dari string atau label yang dibuat hanya selama eksekusi fungsi masih dapat menyebabkan mulai ulang.

Terakhir, untuk repositori non-local, hanya perubahan pada dependensi berikut yang dapat menyebabkan mulai ulang:

• File .bzl yang diperlukan untuk menentukan aturan repositori.
• Deklarasi aturan repositori dalam file WORKSPACE.
• Nilai variabel lingkungan apa pun yang dideklarasikan dengan atribut environ dari fungsi repository_rule. Nilai variabel lingkungan tersebut dapat diterapkan dari command line dengan tanda --action_env (tetapi tanda ini akan membatalkan setiap tindakan build).
• Konten file apa pun yang digunakan dan dirujuk oleh label (misalnya, //mypkg:label.txt bukan mypkg/label.txt).

Memaksa pengambilan ulang repositori eksternal

Terkadang, repositori eksternal dapat menjadi tidak berlaku tanpa adanya perubahan pada definisi atau dependensinya. Misalnya, repositori yang mengambil sumber mungkin mengikuti cabang tertentu dari repositori pihak ketiga, dan commit baru tersedia di cabang tersebut. Dalam hal ini, Anda dapat meminta bazel untuk mengambil ulang semua repositori eksternal tanpa syarat dengan memanggil bazel sync.

Selain itu, beberapa aturan memeriksa komputer lokal dan mungkin menjadi tidak berlaku jika komputer lokal diupgrade. Di sini Anda dapat meminta bazel untuk hanya mengambil ulang repositori eksternal yang definisi repository_rule-nya telah menetapkan atribut configure, menggunakan bazel sync --configure.

Contoh

• Toolchain yang dikonfigurasi otomatis C++: menggunakan aturan repositori untuk membuat file konfigurasi C++ secara otomatis untuk Bazel dengan mencari compiler C++ lokal, lingkungan, dan flag yang didukung compiler C++.

• Repositori Go menggunakan beberapa repository_rule untuk menentukan daftar dependensi yang diperlukan untuk menggunakan aturan Go.

• rules_jvm_external membuat repositori eksternal bernama @maven secara default yang menghasilkan target build untuk setiap artefak Maven dalam hierarki dependensi transitif.