ソフトな忘却力(14) ラズパイでgtest、CMakeLists.txt書くだけでOK

Joseph Halfmoon

GoogleTest(gtest)は、C++用の単体テストツールとして定番ですが、遥か昔にちょっと使ったキリでとんとご無沙汰、すっかり忘却。おぼげな記憶によるとセットアップがメンドかった記憶が？今回ラズパイ上でやってみたら、まったくメンドくないです。CMakeLists.txtにチョイと仕込みを入れるだけで速攻テスト可能。テスト自体は書かないとダメだけどね。

※ソフトな忘却力投稿順 index はこちら

今回 Raspberry Pi OS buster <32bit>上で GoogleTestをするにあたって参照させていただいたのは、GoogleTest User’s Guide 内の以下のページです。

Quickstart: Building with CMake

Quickstartには、CMake版以外にBazel版（Google様が推し？のビルドツール）もあるのですが、私はBazelよく分からない（CMakeも良く分からないのだけれど、Bazelよりはまだマシ？）のでCMakeの方を選択いたしました。「本シリーズ」は一応CMake指向ということで、ホントか？

さて、上記のQuickstartによるとGoogleTest(gtest)は、事前にgtestのライブラリなどインストールされていなくても、以下の５ステップで「可能」でした。

1. CMakeLists.txtを書く
2. 単体テストのソースコードを書く
3. “cmake -S . -B build” コマンドを走らせる
4. “cmake –build build” コマンドを走らせる
5. build ディレクトリ内に単体テストの実行ファイルできているので走らせる

ミソは１のところですね。CMakeLists.txt内に「仕込み」を入れておくだけで、必要なgtestのライブラリなどが全てセットアップされて使えるようになりました。便利。こんな楽だったの。

まあ、２は自分がテストしたい対象次第なのでどのくらいの分量になるかはお好み次第ですが、３，４，５は機械的な作業。

今回ターゲットの単体テストコード

sampleFuncなる、かなりベタなサンプル関数をテストする、というのが今回のターゲットです。ソースコード、sampleFunc_test.cc はこんな感じ。わざとNGになるテスト項目も入れてみましたぜ。

#include <gtest/gtest.h>

int sampleFunc(int a, int b) {
    return a + b;
}

TEST(sampleFuncTest, BasicTest) {
    EXPECT_EQ( sampleFunc(3, 4), 7); //GOOD
    EXPECT_EQ( sampleFunc(1, 1), 3); //NG!
}

どこにも main 関数が存在しないですが、これはデフォルトの gtest_mainなるライブラリとリンクして面倒見てもらっているので省略可みたいです。テスト書くのもお楽。

CMakeLists.txt

さて、肝心の「仕込み」の入ったCMakeLists.txt が以下に。これは上記のQuickstartの例を sampleFunc_test用に改造させていただいたもの。

FetchContent_Declare() こそ「仕込み」の本体であります。

cmake_minimum_required(VERSION 3.14)
project(gtestTrial)
set(CMAKE_CXX_STANDARD 11)

include(FetchContent)
FetchContent_Declare(
    googletest
    URL https://github.com/google/googletest/archive/609281088cfefc76f9d0ce82e1ff6c30cc3591e5.zip
)
set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
FetchContent_MakeAvailable(googletest)

enable_testing()

add_executable(
    sampleFunc_test
    sampleFunc_test.cc
)

target_link_libraries(
    sampleFunc_test
    gtest_main
)

include(GoogleTest)
gtest_discover_tests(sampleFunc_test)

CMakeのドキュメント FetchContent へのリンクはこちら。このドキュメントの中でも例にあがっているのが gtest なので CMakeで gtestのプロジェクトをビルドするならば「使わないではいられない」的なものみたいです。知らなかった。上記の記述を見れば分かるように、gtestの特定のバージョンを持ってきて使えるようにしてくれるみたい。これまたお楽。

cmakeする

テスト用のソースファイルと、CMakeLists.txtだけが入っているディレクトリでCmakeをかけます。 “-S .” はカレントディレクトリがプロジェクトルートだぞ、と。”-B build”は、ビルドディレクトリのお名前は “build”だぞ（無かったら作ってね）と。初回はいろいろやることがあるのでこんな感じで以下大量に出力されます。