一般的な C++ ビルドのユースケース

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

ここでは、Bazel を使用して C++ プロジェクトをビルドする一般的なユースケースをいくつか紹介します。まだ行っていない場合は、Bazel の概要: C++ プロジェクトをビルドするチュートリアルを完了して、Bazel で C++ プロジェクトのビルドを開始します。

cc_library ヘッダー ファイルと hdrs ヘッダー ファイルの詳細については、cc_library をご覧ください。

ターゲットに複数のファイルを含める

glob を使用して、1 つのターゲットに複数のファイルを含めることができます。次に例を示します。

cc_library(
    name = "build-all-the-files",
    srcs = glob(["*.cc"]),
    hdrs = glob(["*.h"]),
)

このターゲットを使用すると、Bazel は、このターゲットを含む BUILD ファイルと同じディレクトリ(サブディレクトリを除く)で見つかったすべての .cc ファイルと .h ファイルをビルドします。

伝播インクルードの使用

ファイルにヘッダーが含まれている場合、そのファイルをソースとするルール(つまり、srcshdrs、または textual_hdrs 属性にそのファイルが含まれているルール)は、含まれているヘッダーのライブラリ ルールに依存する必要があります。逆に、直接依存関係のみを依存関係として指定する必要があります。たとえば、sandwich.hbread.h が含まれ、bread.hflour.h が含まれているとします。sandwich.h には flour.h が含まれていません(サンドイッチに小麦粉を入れたい人はいないでしょう)。そのため、BUILD ファイルは次のようになります。

cc_library(
    name = "sandwich",
    srcs = ["sandwich.cc"],
    hdrs = ["sandwich.h"],
    deps = [":bread"],
)

cc_library(
    name = "bread",
    srcs = ["bread.cc"],
    hdrs = ["bread.h"],
    deps = [":flour"],
)

cc_library(
    name = "flour",
    srcs = ["flour.cc"],
    hdrs = ["flour.h"],
)

ここで、sandwich ライブラリは bread ライブラリに依存し、bread ライブラリは flour ライブラリに依存しています。

インクルード パスの追加

ワークスペースのルートでインクルードパスをルート化できない(またはルート化したくない)場合があります。既存のライブラリには、ワークスペース内のパスと一致しないインクルード ディレクトリがすでに存在している場合があります。たとえば、ディレクトリ構造が次のとおりであるとします。

└── my-project
    ├── legacy
       └── some_lib
           ├── BUILD
           ├── include
              └── some_lib.h
           └── some_lib.cc
    └── MODULE.bazel

Bazel は some_lib.hlegacy/some_lib/include/some_lib.h として含まれていることを想定していますが、some_lib.cc"some_lib.h" が含まれているとします。このインクルードパスを有効にするには、legacy/some_lib/BUILDsome_lib/include ディレクトリがインクルード ディレクトリであることを指定する必要があります。

cc_library(
    name = "some_lib",
    srcs = ["some_lib.cc"],
    hdrs = ["include/some_lib.h"],
    copts = ["-Ilegacy/some_lib/include"],
)

これは、ヘッダー ファイルに / 接頭辞を付けて含める必要がある外部依存関係に特に便利です。

外部ライブラリを追加する

Google Test {: .external} を使用しているとします。MODULE.bazel ファイルに依存関係を追加して、Google Test をダウンロードし、リポジトリで利用できるようにすることができます。

bazel_dep(name = "googletest", version = "1.15.2")

C++ テストの作成と実行

たとえば、次のようなテスト用の ./test/hello-test.cc を作成できます。

#include "gtest/gtest.h"
#include "main/hello-greet.h"

TEST(HelloTest, GetGreet) {
  EXPECT_EQ(get_greet("Bazel"), "Hello Bazel");
}

次に、テスト用の ./test/BUILD ファイルを作成します。

cc_test(
    name = "hello-test",
    srcs = ["hello-test.cc"],
    copts = [
      "-Iexternal/gtest/googletest/include",
      "-Iexternal/gtest/googletest",
    ],
    deps = [
        "@googletest//:main",
        "//main:hello-greet",
    ],
)

hello-greethello-test に表示するには、./main/BUILDvisibility 属性に "//test:__pkg__", を追加する必要があります。

これで、bazel test を使用してテストを実行できます。

bazel test test:hello-test

出力は次のようになります。

INFO: Found 1 test target...
Target //test:hello-test up-to-date:
  bazel-bin/test/hello-test
INFO: Elapsed time: 4.497s, Critical Path: 2.53s
//test:hello-test PASSED in 0.3s

Executed 1 out of 1 tests: 1 test passes.

事前コンパイル済みライブラリの依存関係を追加する

コンパイル済みバージョンのみのライブラリ(ヘッダーや .so ファイルなど)を使用する場合は、それを cc_library ルールでラップします。

cc_library(
    name = "mylib",
    srcs = ["mylib.so"],
    hdrs = ["mylib.h"],
)

これにより、ワークスペース内の他の C++ ターゲットがこのルールに依存できるようになります。