Menggunakan Dependensi Eksternal

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.
Laporkan masalah Lihat sumber

Bazel dapat bergantung pada target dari project lain. Dependensi dari project lain ini disebut dependensi eksternal.

File WORKSPACE (atau file WORKSPACE.bazel) di direktori ruang kerja memberi tahu Bazel cara mendapatkan sumber project lain. Project lain ini dapat berisi satu atau beberapa file BUILD dengan targetnya sendiri. File BUILD dalam project utama dapat bergantung pada target eksternal ini dengan menggunakan namanya dari file WORKSPACE.

Misalnya, ada dua project di sistem:

/
  home/
    user/
      project1/
        WORKSPACE
        BUILD
        srcs/
          ...
      project2/
        WORKSPACE
        BUILD
        my-libs/

Jika project1 ingin bergantung pada target, :foo, yang ditentukan di /home/user/project2/BUILD, dapat ditentukan bahwa repositori bernama project2 dapat ditemukan di /home/user/project2. Target pada /home/user/project1/BUILD dapat bergantung pada @project2//:foo.

File WORKSPACE memungkinkan pengguna bergantung pada target dari bagian lain sistem file atau didownload dari internet. Metode ini menggunakan sintaksis yang sama dengan file BUILD, tetapi memungkinkan serangkaian aturan berbeda yang disebut aturan repositori (terkadang juga dikenal sebagai aturan ruang kerja). Bazel dilengkapi beberapa aturan repositori bawaan dan serangkaian aturan repositori Starlark tersemat. Pengguna juga dapat menulis aturan repositori kustom untuk mendapatkan perilaku yang lebih kompleks.

Jenis dependensi eksternal yang didukung

Beberapa jenis dependensi eksternal dasar dapat digunakan:

Bergantung pada project Bazel lainnya

Jika ingin menggunakan target dari project Bazel kedua, Anda dapat menggunakan local_repository, git_repository atau http_archive untuk membuat symlink dari sistem file lokal, merujuk ke repositori git, atau mendownloadnya (masing-masing).

Misalnya, Anda mengerjakan project, my-project/, dan Anda ingin bergantung pada target dari project rekan kerja Anda, coworkers-project/. Kedua project menggunakan Bazel, sehingga Anda dapat menambahkan project rekan kerja sebagai dependensi eksternal, lalu menggunakan target apa pun yang telah ditetapkan oleh rekan kerja dari file BUILD Anda sendiri. Anda akan menambahkan kode berikut ke my_project/WORKSPACE:

local_repository(
    name = "coworkers_project",
    path = "/path/to/coworkers-project",
)

Jika rekan kerja Anda memiliki //foo:bar target, project Anda dapat menyebutnya sebagai @coworkers_project//foo:bar. Nama project eksternal harus berupa nama ruang kerja yang valid.

Bergantung pada project non-Bazel

Aturan yang diawali dengan new_, seperti new_local_repository, memungkinkan Anda membuat target dari project yang tidak menggunakan Bazel.

Misalnya, Anda mengerjakan project, my-project/, dan Anda ingin bergantung pada project rekan kerja Anda, coworkers-project/. Project rekan kerja Anda menggunakan make untuk mem-build, tetapi Anda ingin bergantung pada salah satu file .so yang dihasilkannya. Untuk melakukannya, tambahkan kode berikut ke my_project/WORKSPACE:

new_local_repository(
    name = "coworkers_project",
    path = "/path/to/coworkers-project",
    build_file = "coworker.BUILD",
)

build_file menentukan file BUILD yang akan ditempatkan di project yang ada, misalnya:

cc_library(
    name = "some-lib",
    srcs = glob(["**"]),
    visibility = ["//visibility:public"],
)

Selanjutnya, Anda dapat bergantung pada @coworkers_project//:some-lib dari file BUILD project Anda.

Bergantung pada paket eksternal

Artefak dan repositori Maven

Gunakan kumpulan aturan rules_jvm_external untuk mendownload artefak dari repositori Maven dan menyediakannya sebagai dependensi Java.

Mengambil dependensi

Secara default, dependensi eksternal diambil sesuai kebutuhan selama bazel build. Jika Anda ingin mengambil data dependensi yang diperlukan untuk sekumpulan target tertentu, gunakan bazel fetch. Untuk mengambil semua dependensi eksternal tanpa syarat, gunakan bazel sync. Karena repositori yang diambil disimpan dalam basis output, pengambilan yang terjadi per ruang kerja.

Bayangan bayangan

Jika memungkinkan, sebaiknya Anda memiliki satu kebijakan versi dalam project Anda. Hal ini diperlukan untuk dependensi yang Anda kompilasi dan berakhir dalam biner akhir Anda. Namun, untuk kasus yang tidak benar, Anda dapat membayangi dependensi. Pertimbangkan skenario berikut:

projectsaya/WORKSPACE

workspace(name = "myproject")

local_repository(
    name = "A",
    path = "../A",
)
local_repository(
    name = "B",
    path = "../B",
)

A/WORKSPACE

workspace(name = "A")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "...",
)

B/WORKSPACE

workspace(name = "B")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)

Dependensi A dan B bergantung pada testrunner, tetapi bergantung pada versi testrunner yang berbeda. Tidak ada alasan bagi runner pengujian ini untuk tidak berdampingan secara damai dalam myproject, tetapi keduanya akan bentrok satu sama lain karena mereka memiliki nama yang sama. Untuk mendeklarasikan kedua dependensi, update myproject/WORKSPACE:

workspace(name = "myproject")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "testrunner-v1",
    urls = ["https://github.com/testrunner/v1.zip"],
    sha256 = "..."
)
http_archive(
    name = "testrunner-v2",
    urls = ["https://github.com/testrunner/v2.zip"],
    sha256 = "..."
)
local_repository(
    name = "A",
    path = "../A",
    repo_mapping = {"@testrunner" : "@testrunner-v1"}
)
local_repository(
    name = "B",
    path = "../B",
    repo_mapping = {"@testrunner" : "@testrunner-v2"}
)

Mekanisme ini juga dapat digunakan untuk menggabungkan berlian. Misalnya, jika A dan B memiliki dependensi yang sama, tetapi memanggilnya dengan nama yang berbeda, dependensi tersebut dapat bergabung di myproject/WORKSPACE.

Mengganti repositori dari command line

Untuk mengganti repositori yang dideklarasikan dengan repositori lokal dari command line, gunakan tanda --override_repository. Penggunaan flag ini akan mengubah konten repositori eksternal tanpa mengubah kode sumber Anda.

Misalnya, untuk mengganti @foo ke direktori lokal /path/to/local/foo, teruskan tanda --override_repository=foo=/path/to/local/foo.

Beberapa kasus penggunaan mencakup:

  • Men-debug masalah. Misalnya, Anda dapat mengganti repositori http_archive ke direktori lokal tempat Anda dapat membuat perubahan dengan lebih mudah.
  • Vendor. Jika Anda berada di lingkungan yang tidak memungkinkan Anda melakukan panggilan jaringan, ganti aturan repositori berbasis jaringan agar mengarah ke direktori lokal.

Menggunakan proxy

Bazel akan mengambil alamat proxy dari variabel lingkungan HTTPS_PROXY dan HTTP_PROXY serta menggunakannya untuk mendownload file HTTP/HTTPS (jika ditentukan).

Dukungan untuk IPv6

Pada mesin khusus IPv6, Bazel akan dapat mendownload dependensi tanpa perubahan. Namun, pada mesin IPv4/IPv6 stack ganda, Bazel mengikuti konvensi yang sama seperti Java: jika IPv4 diaktifkan, IPv4 akan dipilih. Dalam beberapa situasi, misalnya saat jaringan IPv4 tidak dapat me-resolve/mencapai alamat eksternal, hal ini dapat menyebabkan pengecualian Network unreachable dan kegagalan build. Dalam hal ini, Anda dapat mengganti perilaku Bazel untuk memilih IPv6 dengan menggunakan properti sistem java.net.preferIPv6Addresses=true. Khususnya:

  • Gunakan --host_jvm_args=-Djava.net.preferIPv6Addresses=trueopsi startup, misalnya dengan menambahkan baris berikut dalam file .bazelrc:

    startup --host_jvm_args=-Djava.net.preferIPv6Addresses=true

  • Jika Anda menjalankan target build Java yang juga perlu terhubung ke internet (pengujian integrasi terkadang memerlukannya), gunakan flag alat --jvmopt=-Djava.net.preferIPv6Addresses=true, misalnya dengan memiliki baris berikut di file .bazelrc Anda:

    build --jvmopt=-Djava.net.preferIPv6Addresses

  • Jika Anda menggunakan rules_jvm_external, misalnya, untuk resolusi versi dependensi, tambahkan juga -Djava.net.preferIPv6Addresses=true ke variabel lingkungan COURSIER_OPTS untuk menyediakan opsi JVM untuk Coursier

Dependensi transitif

Bazel hanya membaca dependensi yang tercantum dalam file WORKSPACE Anda. Jika project Anda (A) bergantung pada project lain (B) yang mencantumkan dependensi pada project ketiga (C) dalam file WORKSPACE-nya, Anda harus menambahkan B dan C ke file WORKSPACE project Anda. Persyaratan ini dapat menetapkan ukuran file WORKSPACE, tetapi membatasi kemungkinan memiliki satu library menyertakan C pada versi 1.0 dan yang lainnya menyertakan C pada versi 2.0.

Menyimpan ke cache dependensi eksternal

Secara default, Bazel hanya akan mendownload ulang dependensi eksternal jika definisinya berubah. Perubahan pada file yang dirujuk dalam definisi (seperti patch atau file BUILD) juga diperhitungkan oleh bazel.

Untuk memaksa download ulang, gunakan bazel sync.

Tata letak

Semua dependensi eksternal didownload ke direktori pada subdirektori external di base output. Untuk repositori lokal, symlink akan dibuat di sana, bukan membuat direktori baru. Anda dapat melihat direktori external dengan menjalankan:

ls $(bazel info output_base)/external

Perhatikan bahwa menjalankan bazel clean tidak akan menghapus direktori eksternal. Untuk menghapus semua artefak eksternal, gunakan bazel clean --expunge.

Build offline

Terkadang diinginkan atau perlu untuk menjalankan build secara offline. Untuk kasus penggunaan sederhana, seperti bepergian di pesawat, pengambilan data repositori yang diperlukan dengan bazel fetch atau bazel sync sudah cukup; selain itu, menggunakan opsi --nofetch, pengambilan repositori lebih lanjut dapat dinonaktifkan selama build.

Untuk build offline sebenarnya, dengan penyediaan file yang diperlukan dilakukan oleh entity yang berbeda dari bazel, bazel mendukung opsi --distdir. Setiap kali aturan repositori meminta bazel untuk mengambil file melalui ctx.download atau ctx.download_and_extract dan menyediakan jumlah hash dari file yang diperlukan, bazel akan melihat terlebih dahulu direktori yang ditentukan oleh opsi tersebut untuk file yang cocok dengan nama dasar URL pertama yang diberikan, dan menggunakan salinan lokal tersebut jika hash-nya cocok.

Bazel sendiri menggunakan teknik ini untuk melakukan bootstrap secara offline dari artefak distribusi. Hal ini dilakukan dengan mengumpulkan semua dependensi eksternal yang diperlukan dalam distdir_tar internal.

Namun, bazel memungkinkan eksekusi perintah arbitrer dalam aturan repositori, tanpa mengetahui apakah perintah tersebut memanggil jaringan. Oleh karena itu, Bazel tidak memiliki opsi untuk menerapkan build yang sepenuhnya offline. Jadi, menguji apakah build berfungsi dengan benar secara offline memerlukan pemblokiran eksternal jaringan, seperti yang dilakukan bazel dalam pengujian bootstrap.

Praktik terbaik

Aturan repositori

Aturan repositori biasanya harus bertanggung jawab untuk:

  • Mendeteksi setelan sistem dan menulisnya ke file.
  • Menemukan resource di tempat lain pada sistem.
  • Mendownload resource dari URL.
  • Membuat atau menautkan file BUILD ke direktori repositori eksternal.

Sebisa mungkin hindari penggunaan repository_ctx.execute. Misalnya, saat menggunakan library C++ non-Bazel yang memiliki build menggunakan Make, sebaiknya gunakan repository_ctx.download(), lalu tulis file BUILD yang mem-build-nya, daripada menjalankan ctx.execute(["make"]).

Pilih http_archive daripada git_repository dan new_git_repository. Alasannya adalah:

  • Aturan repositori Git bergantung pada sistem git(1), sedangkan downloader HTTP disertakan ke dalam Bazel dan tidak memiliki dependensi sistem.
  • http_archive mendukung daftar urls sebagai cermin, dan git_repository hanya mendukung satu remote.
  • http_archive berfungsi dengan cache repositori, tetapi tidak dengan git_repository. Lihat #5116 untuk informasi selengkapnya.

Jangan gunakan bind(). Lihat "Pertimbangkan untuk menghapus pengikat" untuk diskusi lama tentang masalah dan alternatifnya.