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

問題を報告 ソースを表示 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

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

目標

このガイドでは、プロジェクトのファイルの依存関係の詳細を確認するために使用できる一連の基本的なクエリについて説明します。Bazel ファイルと BUILD ファイルの仕組みについて基本的な知識をお持ちの Bazel デベロッパーを対象としています。

前提条件

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

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

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

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

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 ファイルを探すのではなく、クエリ関数のみを使用してください。

プロジェクトは、Cafe を構成するさまざまなパッケージで構成されています。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/...

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

注: --noimplicit_deps フラグを追加すると、構成と潜在的なツールチェーンが削除され、リストを簡略化できます。このフラグを省略すると、Bazel は BUILD ファイルに指定されていない暗黙的な依存関係を返すため、出力が乱雑になります。

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

依存関係グラフを可視化する（省略可）

注: このセクションでは Graphviz を使用します。このセクションを進めるには、必ず Graphviz をダウンロードしてください。

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

まず、目的のクエリを実行し、フラグ --noimplicit_deps を追加して過剰なツールの依存関係を削除します。次に、出力フラグを指定してクエリに従い、グラフを 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 に依存しているかを確認する必要があります。

注意: ingredients は独自のパッケージであるため、ターゲット cheese には //package:target という形式の別の命名規則を使用する必要があります。参照ターゲット（ラベル）の詳細については、こちらをご覧ください。

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

ヒント: プロジェクトのスコープ全体で検索するには、universe_scope を //... に設定します。

プロジェクト全体「//...」のスコープ内でターゲット 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

クエリの結果から、チーズは pizza と macAndCheese の両方で使用されていることがわかります。なんていうことだろう！

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

2 人のお客様が Bazel Cafe に入ります。Amir と Jenny です。名前以外は何もわかっていません。幸い、注文は「customers」BUILD ファイルにタグ付けされています。このタグにアクセスするにはどうすればよいですか？

デベロッパーは多くの場合、テスト目的で、さまざまな識別子で Bazel ターゲットにタグを付けることができます。たとえば、テストのタグを使用して、デバッグ プロセスとリリース プロセスにおけるテストの役割をアノテーションできます。特に、ランタイム アノテーション機能のない C++ テストや Python テストでは、この方法が有効です。タグとサイズ要素を使用すると、コードベースのチェックイン ポリシーに基づいてテストスイートを柔軟に組み合わせることができます。

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

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

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

セルフテスト

このクエリを使用して、ジェニーさんが注文したい商品を確認します。

回答

マカロニチーズ

新しい依存関係の追加

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 {

}

次に、適切なディレクトリ（dishes）に Smoothie.java を追加します。

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 ファイルにルールとして追加します。新しいコンポーネントごとに新しい Java ライブラリを作成します。名前、公開設定、新しく作成された「src」ファイルが含まれます。更新された 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",
    ],
)

最後に、シェフの 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()

あるパッケージが別のパッケージに依存している理由をクエリする場合はどうすればよいですか。2 つの依存関係パスを表示すると、答えがわかります。

依存関係パスを見つけるには、somepath() と allpaths() の 2 つの関数を使用します。開始ターゲット S と終了点 E が与えられた場合、somepath(S,E) を使用して S と E 間の経路を求めます。

「シェフ」ターゲットと「チーズ」ターゲットの関係を見て、これら 2 つの機能の違いを探ります。あるターゲットから別のターゲットに移動するには、次のようなさまざまなパスが考えられます。

• シェフ → MacAndCheese → チーズ
• シェフ → ピザ → チーズ

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 クエリからのみ、レビューを書いた人と、その人が説明していた料理を探してみてください。

ヒント

タグと依存関係で有用な情報を確認します。

回答

このレビューはピザについてのものであり、レビューしたユーザーは Amir でした。このルールで bazel query --noimplicit\_deps 'deps(//src/main/java/com/example/reviews:review)' を使用していた依存関係を確認すると、このコマンドの結果から、審査担当者は Amir であることがわかります。次に、レビュー担当者が Amir であることを知っているので、クエリ関数を使用して Amir が「BUILD」ファイルにどのタグを持っているかを確認し、そこにどのような料理が含まれているかを確認できます。コマンド bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)' は、Amir がピザを注文した唯一の顧客であり、回答を提供するレビュアーであることを示しています。

まとめ

これで、これで、いくつかの基本的なクエリを実行しました。これらのクエリは、ご自身のプロジェクトで試すことができます。クエリ言語の構文について詳しくは、クエリのリファレンス ページをご覧ください。より高度なクエリを実行したい場合は、クエリガイドでは、このガイドで取り上げているユースケース以外にも、詳細なユースケースのリストを紹介しています。