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

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
問題を報告する ソースを表示

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.hflour.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 ライブラリは flour ライブラリに依存する bread ライブラリに依存しています。

インクルード パスの追加

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

└── my-project
    ├── legacy
    │   └── some_lib
    │       ├── BUILD
    │       ├── include
    │       │   └── some_lib.h
    │       └── some_lib.cc
    └── WORKSPACE

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 を使用しているとします。WORKSPACE ファイルのリポジトリ機能のいずれかを使用して、Google Test をダウンロードし、リポジトリで使用できます。

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "gtest",
    url = "https://github.com/google/googletest/archive/release-1.10.0.zip",
    sha256 = "94c634d499558a76fa649edb13721dce6e98fb1e7018dfaeba3cd7a083945e91",
    build_file = "@//:gtest.BUILD",
)

次に、Google Test のコンパイルに使用する BUILD ファイルである gtest.BUILD を作成します。 Google テストには、cc_library ルールを複雑にする「特殊な」要件がいくつかあります。

  • googletest-release-1.10.0/src/gtest-all.cc: googletest-release-1.10.0/src/ の他のすべてのファイルを #include して、シンボルの重複によるリンクエラーを防ぐために、コンパイルから除外します。

  • googletest-release-1.10.0/include/ ディレクトリからの相対ヘッダー ファイル("gtest/gtest.h")を使用するため、そのディレクトリをインクルード パスに追加する必要があります。

  • pthread でリンクする必要があるので、linkopt として追加します。

最終的なルールは次のようになります。

cc_library(
    name = "main",
    srcs = glob(
        ["googletest-release-1.10.0/src/*.cc"],
        exclude = ["googletest-release-1.10.0/src/gtest-all.cc"]
    ),
    hdrs = glob([
        "googletest-release-1.10.0/include/**/*.h",
        "googletest-release-1.10.0/src/*.h"
    ]),
    copts = [
        "-Iexternal/gtest/googletest-release-1.10.0/include",
        "-Iexternal/gtest/googletest-release-1.10.0"
    ],
    linkopts = ["-pthread"],
    visibility = ["//visibility:public"],
)

これはやや混乱です。アーカイブの構造の副産物として、すべてに googletest-release-1.10.0 という接頭辞が付いています。http_archive でこの接頭辞を削除するには、strip_prefix 属性を追加します。

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "gtest",
    url = "https://github.com/google/googletest/archive/release-1.10.0.zip",
    sha256 = "94c634d499558a76fa649edb13721dce6e98fb1e7018dfaeba3cd7a083945e91",
    build_file = "@//:gtest.BUILD",
    strip_prefix = "googletest-release-1.10.0",
)

gtest.BUILD は次のようになります。

cc_library(
    name = "main",
    srcs = glob(
        ["src/*.cc"],
        exclude = ["src/gtest-all.cc"]
    ),
    hdrs = glob([
        "include/**/*.h",
        "src/*.h"
    ]),
    copts = ["-Iexternal/gtest/include"],
    linkopts = ["-pthread"],
    visibility = ["//visibility:public"],
)

cc_ ルールは @gtest//:main に依存するようになりました。

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/include"],
    deps = [
        "@gtest//:main",
        "//main:hello-greet",
    ],
)

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

これで、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++ ターゲットはこのルールに依存できます。