クエリのクイックスタート

このチュートリアルでは、作成済みの Bazel プロジェクトを使用して、Bazel とコード内の依存関係をトレースする方法について説明します。

言語と --output フラグの詳細については、Bazel クエリ リファレンスと Bazel cquery リファレンス マニュアルをご覧ください。IDE でヘルプを表示するには、コマンドラインで bazel help query または bazel help cquery と入力します。

目的

このガイドでは、プロジェクトのファイルの依存関係を詳しく調べるために使用できる基本的なクエリを紹介します。このドキュメントは、Bazel と BUILD ファイルの仕組みに関する基本的な知識を持つ Bazel デベロッパーを対象としています。

前提条件

まず、Bazel をインストールします（まだインストールしていない場合）。このチュートリアルではソース管理に Git を使用するため、Git もインストールすることをおすすめします。

依存関係グラフを可視化するために、Graphviz というツールを使用します。このツールは、ダウンロードして理解することができます。

サンプル プロジェクトを取得する

次に、任意のコマンドライン ツールで次のコマンドを実行して、Bazel の Examples リポジトリからサンプルアプリを取得します。

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

このチュートリアルのサンプル プロジェクトは、examples/query-quickstart ディレクトリにあります。

ご利用にあたって

Bazel クエリとは

クエリを使用すると、BUILD ファイル間の関係を分析し、結果の出力を調べて有用な情報を得ることで、Bazel コードベースについて学習できます。このガイドでは、基本的なクエリ関数をプレビューしていますが、その他のオプションについては、クエリガイドをご覧ください。クエリを使用すると、BUILD ファイルを手動で操作することなく、大規模なプロジェクトの依存関係を把握できます。

クエリを実行するには、コマンドライン ターミナルを開いて次のように入力します。

bazel query 'query_function'

シナリオ

Cafe Bazel とそのシェフの関係を掘り下げたシナリオを考えてみます。ピザ、マック &チーズのみを販売するカフェ。プロジェクトの構造は次のとおりです。

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

このチュートリアルを通じて、特に指示がない限り、必要な情報を見つけるために BUILD ファイルを探すことはせず、クエリ関数のみを使用してください。

プロジェクトは、カフェを構成するさまざまなパッケージで構成されます。これらは、restaurant、ingredients、dishes、customers、reviews に分けられます。これらのパッケージ内のルールは、さまざまなタグや依存関係を使用して、Cafe のさまざまなコンポーネントを定義します。

ビルドの実行

このプロジェクトには、カフェのメニューを出力するために実行できるメインメソッドが Runner.java 内に含まれています。bazel build コマンドで Bazel を使用してプロジェクトをビルドし、: を使用してターゲットの名前が runner であることを通知します。ターゲットを参照する方法については、ターゲット名をご覧ください。

このプロジェクトをビルドするには、次のコマンドをターミナルに貼り付けます。

bazel build :runner

ビルドが成功すると、出力は次のようになります。

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

正常にビルドされたら、次のコマンドを貼り付けてアプリケーションを実行します。

bazel-bin/runner

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

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

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

メニュー項目のリストと簡単な説明が表示されます。

標的の探索

このプロジェクトでは、食材や料理を個別のパッケージに記載します。クエリを使用してパッケージのルールを表示するには、bazel query package/… コマンドを実行します。

この場合、これを使用して次のコマンドを実行すると、この Cafe にある食材や料理を調べることができます。

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

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

食材パッケージのターゲットをクエリすると、出力は次のようになります。

//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

依存関係を見つける

ランナーはどのようなターゲットに依存して走るか？

ファイル システムを深く掘り下げることなく、プロジェクトの構造をより深く掘り下げたいとします（大規模なプロジェクトでは難しい場合があります）。Cafe Bazel ではどのようなルールが使用されますか？

この例のように、ランナーのターゲットが runner の場合、次のコマンドを実行して、ターゲットの基盤となる依存関係を検出します。

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

特定のターゲットの個々の出力依存関係を確認するには、クエリ関数 deps() を使用します。

依存関係グラフの可視化（省略可）

このセクションでは、特定のクエリの依存関係パスを可視化する方法について説明します。Graphviz は、パスをフラット化されたリストではなく、有向非巡回グラフの画像として表示できます。さまざまな --output コマンドライン オプションを使用して、Bazel クエリグラフの表示を変更できます。オプションについては、出力形式をご覧ください。

まず目的のクエリを実行し、--noimplicit_deps フラグを追加して、過剰なツールの依存関係を削除します。次に、output フラグを使用してクエリに従い、グラフを graph.in というファイルに保存して、グラフのテキスト表現を作成します。

ターゲット :runner のすべての依存関係を検索し、出力をグラフとしてフォーマットするには、次のコマンドを実行します。

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

これにより、graph.in というファイルが作成されます。これは、ビルドグラフのテキスト表現です。Graphviz は、テキストを可視化して表示するツール dot を使用して、PNG を作成します。

dot -Tpng < graph.in > graph.png

graph.png を開くと、次のように表示されます。以下のグラフは、基本的なパスの詳細をより明確にするために簡略化されています。

これは、このガイド全体でさまざまなクエリ関数の出力を確認する場合に役立ちます。

逆依存関係を見つける

他のターゲットで使用されているターゲットを分析する場合は、クエリを使用して、特定のルールに依存するターゲットを調べることができます。これは「逆依存関係」と呼ばれます。rdeps() は、よく知らないコードベースのファイルを編集する場合に便利です。また、それに依存していた他のファイルを知らないうちに破損するのを防ぐことができます。

たとえば、材料 cheese を編集するとします。Cafe Bazel で問題が発生しないようにするには、cheese に依存する料理を確認する必要があります。

特定のターゲットまたはパッケージに依存するターゲットを確認するには、rdeps(universe_scope, target) を使用します。rdeps() クエリ関数は、universe_scope（関連ディレクトリ）と target の 2 つ以上の引数を取ります。Bazel は、指定された universe_scope 内でターゲットの逆依存関係を検索します。rdeps() 演算子は、オプションの 3 番目の引数を受け入れます。検索深度の上限を指定する整数リテラルです。

プロジェクト「//...」全体のスコープ内で、ターゲット cheese の逆依存関係を検索するには、次のコマンドを実行します。

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

このクエリが返されると、チーズはピザと macAndCheese の両方に依存していることがわかります。なんとすごい！

タグに基づいてターゲットを見つける

Bazel Cafe には Amir と Jenny の 2 人の顧客が入ります。名前以外は何も知られていない。幸いなことに、「customers」の BUILD ファイルで注文がタグ付けされています。このタグにアクセスするには

デベロッパーは、多くの場合、テスト目的で、Bazel ターゲットに異なる識別子をタグ付けできます。たとえば、テストのタグで、デバッグとリリースのプロセスにおけるテストの役割にアノテーションを付けることができます。特に C++ と Python のテストでは、実行時のアノテーション機能がありません。タグとサイズ要素を使用すると、コードベースのチェックイン ポリシーに基づいて一連のテストを柔軟に組み立てることができます。

この例では、タグは pizza または macAndCheese のいずれかで、メニュー項目を表します。このコマンドは、特定のパッケージ内の ID と一致するタグを持つターゲットをクエリします。

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

このクエリは、「customers」パッケージ内で「ピザ」タグを持つすべてのターゲットを返します。

自分をテストする

このクエリを使用して、Jenny が注文したい商品を確認します。

新しい依存関係の追加

Cafe Bazel はスムージーを注文できるようになりました。このスムージーは Strawberry と Banana でできています。

まず、スムージーに必要な材料 Strawberry.java と Banana.java を追加します。空の Java クラスを追加します。

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 {

}

次に、Smoothie.java を適切なディレクトリ 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";
}

最後に、これらのファイルを適切な BUILD ファイルにルールとして追加します。新しい材料ごとに、名前、公開設定、新しく作成された「src」ファイルなどの新しい Java ライブラリを作成します。これで、この更新された BUILD ファイルが作成されます。

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"],
)

料理の BUILD ファイルに、Smoothie に関する新しいルールを追加します。これにより、Smoothie 用に作成された Java ファイルが「src」ファイルとして作成され、スムージーの各材料用に作成した新しいルールが含まれます。

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",
    ],
)

最後に、スムージーを依存関係として Chef の BUILD ファイルに含めます。

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",
    ],
)

cafe を再度ビルドして、エラーがないことを確認します。正常にビルドされたら、ここでは、「Cafe」に新しい依存関係を追加しました。そうでない場合は、スペルミスとパッケージの命名に注意してください。BUILD ファイルの作成方法の詳細については、BUILD スタイルガイドをご覧ください。

次に、Smoothie を追加して新しい依存関係グラフを可視化し、前の依存関係グラフと比較します。わかりやすくするために、グラフ入力の名前を graph2.in と graph2.png とします。

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

dot -Tpng < graph2.in > graph2.png

graph2.png を見ると、Smoothie は他のディッシュとの依存関係を共有していませんが、Chef が依存するもう一つのターゲットであることがわかります。

somepath() と allpaths()

あるパッケージが別のパッケージに依存している理由を照会するにはどうすればよいでしょうか。両者間の依存関係パスを表示することで答えが得られます。

依存関係パスを見つけるには、somepath() と allpaths() の 2 つの関数が役立ちます。始点 S と終点 E から、somepath(S,E) を使って S と E を結ぶ経路を見つけます。

「Chef」ターゲットと「Cheese」ターゲットの関係を見て、これら 2 つの機能の違いを調べます。ターゲット間では次のようなさまざまなパスが考えられます。

• シェフ → マッアンドチーズ → チーズ
• シェフ → ピザ → チーズ

somepath() は 2 つのオプションのうちの 1 つのパスを提供しますが、「allpaths()」は可能性のあるすべてのパスを出力します。

Cafe Bazel を例として、次のコマンドを実行します。

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

出力は、Cafe → Chef → MacAndCheese → Cheese という最初のパスをたどっています。代わりに allpaths() を使用すると、次のようになります。

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

allpaths() の出力は、依存関係がフラット化されたリストであるため、若干読みにくくなっています。Graphviz を使用してこのグラフを可視化すると、関係がわかりやすくなります。

自分をテストする

Cafe Bazel の顧客が、このレストランに最初のクチコミを投稿しました。残念ながら、クチコミには投稿者の身元や参照している料理など、詳しい情報が欠けています。その情報には Bazel でアクセスできます。reviews パッケージには、不明なユーザーのレビューを出力するプログラムが含まれています。次のコマンドでビルドして実行します。

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

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

Bazel クエリだけから脱線して、誰がレビューを書いたのか、どのような料理について書いたのかを突き止めてください。

まとめ

これで完了です。いくつかの基本的なクエリを実行できました。これらのクエリは、独自のプロジェクトで試すことができます。クエリ言語の構文の詳細については、クエリのリファレンス ページをご覧ください。より高度なクエリが必要な場合は、クエリガイドには、このガイドで扱っていないユースケースの詳細なリストが記載されています。