Panduan memulai kueri

Tutorial ini membahas cara menggunakan Bazel untuk melacak dependensi dalam kode Anda menggunakan project Bazel yang sudah dibuat.

Untuk mengetahui detail bahasa dan flag --output, lihat manual referensi kueri Bazel dan referensi cquery Bazel. Dapatkan bantuan di IDE Anda dengan mengetik bazel help query atau bazel help cquery di command line.

Tujuan

Panduan ini akan memandu Anda melalui serangkaian kueri dasar yang dapat digunakan untuk mempelajari dependensi file project lebih lanjut. Tutorial ini ditujukan untuk developer Bazel baru dengan pengetahuan dasar tentang cara kerja file Bazel dan BUILD.

Prasyarat

Mulai dengan menginstal Bazel, jika Anda belum melakukannya. Tutorial ini menggunakan Git untuk kontrol sumber, jadi untuk hasil terbaik, instal juga Git.

Untuk memvisualisasikan grafik dependensi, alat yang disebut Graphviz digunakan, yang dapat Anda download untuk mengikutinya.

Mendapatkan project contoh

Selanjutnya, ambil aplikasi contoh dari repositori Contoh Bazel dengan menjalankan perintah berikut di alat command line pilihan Anda:

git clone https://github.com/bazelbuild/examples.git

Project contoh untuk tutorial ini ada di direktori examples/query-quickstart.

Memulai

Apa yang dimaksud dengan kueri Bazel?

Kueri membantu Anda mempelajari codebase Bazel dengan menganalisis hubungan antara file BUILD dan memeriksa output yang dihasilkan untuk mendapatkan informasi yang berguna. Panduan ini menampilkan pratinjau beberapa fungsi kueri dasar, tetapi untuk opsi lainnya, lihat panduan kueri. Kueri membantu Anda mempelajari dependensi dalam project skala besar tanpa menjelajahi file BUILD secara manual.

Untuk menjalankan kueri, buka terminal command line dan masukkan:

bazel query 'query_function'

Skenario

Bayangkan skenario yang membahas hubungan antara Cafe Bazel dan kokinya. Kafe ini secara eksklusif menjual pizza dan makaroni & keju. Lihat di bawah ini cara project disusun:

bazelqueryguide
├── BUILD
├── src
│   └── main
│       └── java
│           └── com
│               └── example
│                   ├── customers
│                   │   ├── Jenny.java
│                   │   ├── Amir.java
│                   │   └── BUILD
│                   ├── dishes
│                   │   ├── Pizza.java
│                   │   ├── MacAndCheese.java
│                   │   └── BUILD
│                   ├── ingredients
│                   │   ├── Cheese.java
│                   │   ├── Tomatoes.java
│                   │   ├── Dough.java
│                   │   ├── Macaroni.java
│                   │   └── BUILD
│                   ├── restaurant
│                   │   ├── Cafe.java
│                   │   ├── Chef.java
│                   │   └── BUILD
│                   ├── reviews
│                   │   ├── Review.java
│                   │   └── BUILD
│                   └── Runner.java
└── WORKSPACE

Selama tutorial ini, kecuali jika diarahkan sebaliknya, cobalah untuk tidak mencari di file BUILD untuk menemukan informasi yang Anda butuhkan, dan sebagai gantinya, gunakan fungsi kueri saja.

Project terdiri dari berbagai paket yang membentuk Cafe. Kelas ini dibagi menjadi: restaurant, ingredients, dishes, customers, dan reviews. Aturan dalam paket ini menentukan berbagai komponen Cafe dengan berbagai tag dan dependensi.

Menjalankan build

Project ini berisi metode utama di dalam Runner.java yang dapat Anda jalankan untuk mencetak menu Kafe. Build project menggunakan Bazel dengan perintah bazel build dan gunakan : untuk memberi sinyal bahwa target bernama runner. Lihat nama target untuk mempelajari cara mereferensikan target.

Untuk mem-build project ini, tempel perintah ini ke terminal:

bazel build :runner

Output Anda akan terlihat seperti ini jika build berhasil.

INFO: Analyzed target //:runner (49 packages loaded, 784 targets configured).
INFO: Found 1 target...
Target //:runner up-to-date:
  bazel-bin/runner.jar
  bazel-bin/runner
INFO: Elapsed time: 16.593s, Critical Path: 4.32s
INFO: 23 processes: 4 internal, 10 darwin-sandbox, 9 worker.
INFO: Build completed successfully, 23 total actions

Setelah berhasil di-build, jalankan aplikasi dengan menempelkan perintah ini:

bazel-bin/runner

--------------------- MENU -------------------------

Pizza - Cheesy Delicious Goodness
Macaroni & Cheese - Kid-approved Dinner

----------------------------------------------------

Tindakan ini akan menampilkan daftar item menu yang diberikan beserta deskripsi singkat.

Menjelajahi target

Project ini mencantumkan bahan dan hidangan dalam paketnya sendiri. Untuk menggunakan kueri guna melihat aturan paket, jalankan perintah bazel query package/…

Dalam hal ini, Anda dapat menggunakannya untuk melihat bahan dan hidangan yang dimiliki Kafe ini dengan menjalankan:

bazel query //src/main/java/com/example/dishes/...

bazel query //src/main/java/com/example/ingredients/...

Jika Anda membuat kueri untuk target paket bahan, output-nya akan terlihat seperti:

//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato

Menemukan dependensi

Target apa yang digunakan pelari Anda untuk berlari?

Misalnya, Anda ingin mempelajari struktur project lebih dalam tanpa perlu melihat sistem file (yang mungkin tidak dapat dilakukan untuk project besar). Aturan apa yang digunakan Cafe Bazel?

Jika, seperti dalam contoh ini, target untuk runner Anda adalah runner, temukan dependensi yang mendasari target dengan menjalankan perintah:

bazel query --noimplicit_deps "deps(target)"

bazel query --noimplicit_deps "deps(:runner)"

//:runner
//:src/main/java/com/example/Runner.java
//src/main/java/com/example/dishes:MacAndCheese.java
//src/main/java/com/example/dishes:Pizza.java
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:Cheese.java
//src/main/java/com/example/ingredients:Dough.java
//src/main/java/com/example/ingredients:Macaroni.java
//src/main/java/com/example/ingredients:Tomato.java
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato
//src/main/java/com/example/restaurant:Cafe.java
//src/main/java/com/example/restaurant:Chef.java
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

Dalam sebagian besar kasus, gunakan fungsi kueri deps() untuk melihat setiap dependensi output dari target tertentu.

Memvisualisasikan grafik dependensi (opsional)

Bagian ini menjelaskan cara memvisualisasikan jalur dependensi untuk kueri tertentu. Graphviz membantu melihat jalur sebagai gambar grafik acyclic terarah, bukan daftar yang diratakan. Anda dapat mengubah tampilan grafik kueri Bazel menggunakan berbagai opsi command line --output. Lihat Format Output untuk mengetahui opsi.

Mulai dengan menjalankan kueri yang diinginkan dan tambahkan flag --noimplicit_deps untuk menghapus dependensi alat yang berlebihan. Kemudian, ikuti kueri dengan flag output dan simpan grafik ke dalam file bernama graph.in untuk membuat representasi teks grafik.

Untuk menelusuri semua dependensi :runner target dan memformat output sebagai grafik:

bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph.in

Tindakan ini akan membuat file bernama graph.in, yang merupakan representasi teks dari grafik build. Graphviz menggunakan dot – alat yang memproses teks menjadi visualisasi — untuk membuat png:

dot -Tpng < graph.in > graph.png

Jika membuka graph.png, Anda akan melihat tampilan seperti ini. Grafik di bawah telah disederhanakan untuk memperjelas detail jalur yang penting dalam panduan ini.

Hal ini berguna saat Anda ingin melihat output dari berbagai fungsi kueri di seluruh panduan ini.

Menemukan dependensi terbalik

Jika Anda memiliki target yang ingin dianalisis target lain yang menggunakannya, Anda dapat menggunakan kueri untuk memeriksa target yang bergantung pada aturan tertentu. Hal ini disebut “dependensi terbalik”. Menggunakan rdeps() dapat berguna saat mengedit file dalam codebase yang tidak Anda kenal, dan dapat menyelamatkan Anda dari kerusakan file lain yang bergantung padanya tanpa disadari.

Misalnya, Anda ingin melakukan beberapa pengeditan pada bahan cheese. Untuk menghindari masalah pada Cafe Bazel, Anda perlu memeriksa hidangan yang mengandalkan cheese.

Untuk melihat target yang bergantung pada target/paket tertentu, Anda dapat menggunakan rdeps(universe_scope, target). Fungsi kueri rdeps() menggunakan minimal dua argumen: universe_scope — direktori yang relevan — dan target. Bazel menelusuri dependensi terbalik target dalam universe_scope yang disediakan. Operator rdeps() menerima argumen ketiga opsional: literal bilangan bulat yang menentukan batas atas kedalaman penelusuran.

Untuk mencari dependensi terbalik dari target cheese dalam cakupan seluruh project '//…', jalankan perintah:

bazel query "rdeps(universe_scope, target)"

ex) bazel query "rdeps(//... , //src/main/java/com/example/ingredients:cheese)"

//:runner
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

Hasil kueri menunjukkan bahwa keju digunakan oleh pizza dan macAndCheese. Wow, ini dia!

Menemukan target berdasarkan tag

Dua pelanggan masuk ke Bazel Cafe: Amir dan Jenny. Tidak ada yang diketahui tentang mereka kecuali namanya. Untungnya, mereka memiliki pesanan yang diberi tag di file BUILD 'pelanggan'. Bagaimana cara mengakses tag ini?

Developer dapat memberi tag pada target Bazel dengan ID yang berbeda, sering kali untuk tujuan pengujian. Misalnya, tag pada pengujian dapat menganotasi peran pengujian dalam proses debug dan rilis, terutama untuk pengujian C++ dan Python, yang tidak memiliki kemampuan anotasi runtime. Penggunaan tag dan elemen ukuran memberikan fleksibilitas dalam menyusun rangkaian pengujian berdasarkan kebijakan check-in codebase.

Dalam contoh ini, tag adalah salah satu dari pizza atau macAndCheese untuk mewakili item menu. Perintah ini membuat kueri untuk target yang memiliki tag yang cocok dengan ID Anda dalam paket tertentu.

bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'

Kueri ini menampilkan semua target dalam paket 'customers' yang memiliki tag "pizza".

Uji diri Anda

Gunakan kueri ini untuk mempelajari apa yang ingin dipesan Jenny.

Menambahkan dependensi baru

Cafe Bazel telah memperluas menunya — pelanggan kini dapat memesan Smoothie. Smoothie khusus ini terdiri dari bahan Strawberry dan Banana.

Pertama, tambahkan bahan yang menjadi dependensi smoothie: Strawberry.java dan Banana.java. Tambahkan class Java kosong.

src/main/java/com/example/ingredients/Strawberry.java

package com.example.ingredients;

public class Strawberry {

}

src/main/java/com/example/ingredients/Banana.java

package com.example.ingredients;

public class Banana {

}

Selanjutnya, tambahkan Smoothie.java ke direktori yang sesuai: dishes.

src/main/java/com/example/dishes/Smoothie.java

package com.example.dishes;

public class Smoothie {
    public static final String DISH_NAME = "Smoothie";
    public static final String DESCRIPTION = "Yummy and Refreshing";
}

Terakhir, tambahkan file ini sebagai aturan dalam file BUILD yang sesuai. Buat library java baru untuk setiap bahan baru, termasuk namanya, visibilitas publik, dan file 'src' yang baru dibuat. Anda akan mendapatkan file BUILD yang diperbarui ini:

src/main/java/com/example/ingredients/BUILD

java_library(
    name = "cheese",
    visibility = ["//visibility:public"],
    srcs = ["Cheese.java"],
)

java_library(
    name = "dough",
    visibility = ["//visibility:public"],
    srcs = ["Dough.java"],
)

java_library(
    name = "macaroni",
    visibility = ["//visibility:public"],
    srcs = ["Macaroni.java"],
)

java_library(
    name = "tomato",
    visibility = ["//visibility:public"],
    srcs = ["Tomato.java"],
)

java_library(
    name = "strawberry",
    visibility = ["//visibility:public"],
    srcs = ["Strawberry.java"],
)

java_library(
    name = "banana",
    visibility = ["//visibility:public"],
    srcs = ["Banana.java"],
)

Dalam file BUILD untuk hidangan, Anda ingin menambahkan aturan baru untuk Smoothie. Tindakan ini akan menyertakan file Java yang dibuat untuk Smoothie sebagai file 'src', dan aturan baru yang Anda buat untuk setiap bahan smoothie.

src/main/java/com/example/dishes/BUILD

java_library(
    name = "macAndCheese",
    visibility = ["//visibility:public"],
    srcs = ["MacAndCheese.java"],
    deps = [
        "//src/main/java/com/example/ingredients:cheese",
        "//src/main/java/com/example/ingredients:macaroni",
    ],
)

java_library(
    name = "pizza",
    visibility = ["//visibility:public"],
    srcs = ["Pizza.java"],
    deps = [
        "//src/main/java/com/example/ingredients:cheese",
        "//src/main/java/com/example/ingredients:dough",
        "//src/main/java/com/example/ingredients:tomato",
    ],
)

java_library(
    name = "smoothie",
    visibility = ["//visibility:public"],
    srcs = ["Smoothie.java"],
    deps = [
        "//src/main/java/com/example/ingredients:strawberry",
        "//src/main/java/com/example/ingredients:banana",
    ],
)

Terakhir, Anda ingin menyertakan smoothie sebagai dependensi dalam file BUILD Chef.

src/main/java/com/example/restaurant/BUILD

java\_library(
    name = "chef",
    visibility = ["//visibility:public"],
    srcs = [
        "Chef.java",
    ],

    deps = [
        "//src/main/java/com/example/dishes:macAndCheese",
        "//src/main/java/com/example/dishes:pizza",
        "//src/main/java/com/example/dishes:smoothie",
    ],
)

java\_library(
    name = "cafe",
    visibility = ["//visibility:public"],
    srcs = [
        "Cafe.java",
    ],
    deps = [
        ":chef",
    ],
)

Build cafe lagi untuk mengonfirmasi bahwa tidak ada error. Jika berhasil di-build, selamat! Anda telah menambahkan dependensi baru untuk 'Cafe'. Jika tidak, perhatikan kesalahan ejaan dan penamaan paket. Untuk informasi selengkapnya tentang cara menulis file BUILD, lihat Panduan Gaya BUILD.

Sekarang, visualisasikan grafik dependensi baru dengan penambahan Smoothie untuk dibandingkan dengan yang sebelumnya. Agar lebih jelas, beri nama input grafik sebagai graph2.in dan graph2.png.

bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph2.in

dot -Tpng < graph2.in > graph2.png

Melihat graph2.png, Anda dapat melihat bahwa Smoothie tidak memiliki dependensi bersama dengan hidangan lain, tetapi hanya target lain yang diandalkan Chef.

somepath() dan allpaths()

Bagaimana jika Anda ingin membuat kueri mengapa satu paket bergantung pada paket lain? Menampilkan jalur dependensi di antara keduanya akan memberikan jawaban.

Dua fungsi dapat membantu Anda menemukan jalur dependensi: somepath() dan allpaths(). Dengan target awal S dan titik akhir E, temukan jalur antara S dan E menggunakan somepath(S,E).

Pelajari perbedaan antara kedua fungsi ini dengan melihat hubungan antara target 'Chef' dan 'Cheese'. Ada berbagai kemungkinan jalur untuk berpindah dari satu target ke target lainnya:

• Chef → MacAndCheese → Cheese
• Chef → Pizza → Keju

somepath() memberi Anda satu jalur dari dua opsi, sedangkan 'allpaths()' menghasilkan setiap jalur yang mungkin.

Dengan menggunakan Cafe Bazel sebagai contoh, jalankan perintah berikut:

bazel query "somepath(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"

//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/ingredients:cheese

Output mengikuti jalur pertama Cafe → Chef → MacAndCheese → Cheese. Jika Anda menggunakan allpaths(), Anda akan mendapatkan:

bazel query "allpaths(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"

//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

Output allpaths() sedikit lebih sulit dibaca karena merupakan daftar dependensi yang diratakan. Memvisualisasikan grafik ini menggunakan Graphviz akan memperjelas hubungannya.

Uji diri Anda

Salah satu pelanggan Cafe Bazel memberikan ulasan pertama untuk restoran tersebut. Sayangnya, ulasan tersebut tidak memiliki beberapa detail seperti identitas pengulas dan hidangan yang dirujuk. Untungnya, Anda dapat mengakses informasi ini dengan Bazel. Paket reviews berisi program yang mencetak ulasan dari pelanggan misterius. Build dan jalankan dengan:

bazel build //src/main/java/com/example/reviews:review

bazel-bin/src/main/java/com/example/reviews/review

Hanya berdasarkan kueri Bazel, coba cari tahu siapa yang menulis ulasan, dan hidangan apa yang mereka jelaskan.

Menyelesaikan

Selamat! Sekarang Anda telah menjalankan beberapa kueri dasar, yang dapat Anda coba di project Anda sendiri. Untuk mempelajari sintaksis bahasa kueri lebih lanjut, lihat halaman referensi Kueri. Ingin kueri lanjutan lainnya? Panduan kueri menampilkan daftar mendalam tentang lebih banyak kasus penggunaan daripada yang dibahas dalam panduan ini.