🎳

Android実機またはエミュレータでUnitTest（C++, GoogleTest）を実行する

2022/06/23に公開

Android

Android C++ でもテストしたいけどどうしたらいいのかわからなくて、いろいろ試して落ち着いたので記事にしました。

この記事では、gradle+cmakeでのビルドでテスト用の実行ファイルを作成し、ctestコマンドで実機またはエミュレータでテストを実行できるところまでを目指します。

テストを実行できるようにするまでが目標なので、テスト手法などについては深くは触れません。

また、筆者はCI環境の構築などに精通しているわけではないので、この方法が必ずしも正しいとは限らないことをご了承ください。

本記事のプログラムはGitHubにて公開しています。

環境

筆者の動作環境です。

Windows11
Android Studio Chipmunk
Google Pixel 3（Android 12）
C++17
CMake 3.18.1

AndroidStudioで新規プロジェクト作成

今回は「NewProject」>「Native C++」からプロジェクトを作成しました。

プロジェクトの準備

build.gradleの変更

`defaultConfig`を変更する

CMakeLists.txtからC++のバージョン判定をしたいので、C++のバージョンをCMAKE_CXX_STANDARDで指定します。

app/build.gradle

defaultConfig {
    applicationId "com.suu_lab.cppunittestsample"
    minSdk 21
    targetSdk 32
    versionCode 1
    versionName "1.0"

    testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    externalNativeBuild {
        cmake {
-	    cppFlags '-std=c++17'
+           arguments += '-DCMAKE_CXX_STANDARD=17'
        }
    }
}

`buildType`にデバッグビルドタイプを追加

今回はデバッグを行わないので特に必要な操作ではないですが、一応追加しておきます。

app/build.gradle

 buildTypes {
     release {
         minifyEnabled false
         proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
     }
+    debug {
+        jniDebuggable true
+    }
 }

`android`にテスト用のフレーバーを追加

通常のアプリ用とテスト用でフレーバーを分けて宣言しておきます。
defaultConfigのブロックの次辺りに以下の記述を追加します。

app/build.gradle

flavorDimensions "target"
productFlavors {
    app {
        dimension "target"
        externalNativeBuild {
            cmake {
                arguments += '-DMY_LIB_BUILD_TEST=false'
            }
        }
    }
    appTest {
        dimension "target"
        externalNativeBuild {
            cmake {
                arguments += '-DMY_LIB_BUILD_TEST=true'
            }
        }
    }
}

ここまでで、BuildVariantがappTestDebugでビルドが通ることを確認します。

CMakeのログを見られるようにする

gradle.propertiesに以下を追加することでCMakeのログがビルドウィンドウで詳細に出力されるようになるので、設定しておくと便利です。

gradle.properties

android.native.buildOutput=verbose

テスト用のCMakeLists.txtを追加

app/src/testにcppフォルダを作成し、そのフォルダ内にCMakeLists.txtを作成します。

app/src/test/cpp/CMakeLists.txt

cmake_minimum_required(VERSION 3.18.1)

project(my_test LANGUAGES C CXX)

MY_LIB_BUILD_TESTがtrueの場合、テストを有効化します。

app/src/main/cpp/CMakeLists.txt

if (${MY_LIB_BUILD_TEST})
    enable_testing()
endif()

app/src/main/CMakeLists.txtからadd_subdirectory()で上で作成したCMakeLists.txtのあるディレクトリを追加します。

app/src/main/cpp/CMakeLists.txt

if (${MY_LIB_BUILD_TEST})
    add_subdirectory(../../test/cpp ${CMAKE_CURRENT_BINARY_DIR}/test)
endif()

もう一度ここまででビルドが通るか確認してみましょう。

GoogleTestを使えるようにする

テストコードを書くために、まずはGoogleTestを使えるようにします。
GoogleTestを使えるようにする方法はいくつかありますが、今回はNDKに含まれているソースからライブラリを作成して使用したいと思います。

app/src/test/cpp/CMakeLists.txt

include(GoogleTest)

# WindowsではANDROID_NDKをそのまま使用すると
# バックスラッシュがエスケープ文字と認識されてしまうので置き換える
if("${CMAKE_HOST_SYSTEM_NAME}" STREQUAL "Windows")
    string(
            REPLACE
            "\\"
            "/"
            NDK_DIR
            "${ANDROID_NDK}"
    )
endif()

set(GOOGLETEST_ROOT
        ${NDK_DIR}/sources/third_party/googletest
)

add_library(
        gtest_main
	
        STATIC
        ${GOOGLETEST_ROOT}/src/gtest_main.cc
        ${GOOGLETEST_ROOT}/src/gtest-all.cc
)

target_include_directories(
        gtest_main
	
        PRIVATE
        ${GOOGLETEST_ROOT}
)

target_include_directories(
        gtest_main
	
        PUBLIC
        ${GOOGLETEST_ROOT}/include
)

テスト用実行ファイルの作成

GoogleTestが使用できる状態になったので、テスト用の実行ファイルを生成するコードを足していきます。
app\src\test\cpp\CMakeLists.txtへ実行ファイルを生成するコードを追加しましょう。
GoogleTestを使えるようにした後へ追記していきます。

app\src\test\cpp\CMakeLists.txt

# テスト用の実行可能ターゲット
add_executable(
    my_test
    my_test.cpp
)

実行可能ターゲットなのでmain()関数が必要になります。
上で追加したgtest_mainライブラリに含まれるのでリンクしておきましょう。

app\src\test\cpp\CMakeLists.txt

# ライブラリのリンク
target_link_libraries(
    my_test
    
    PRIVATE
    gtest_main
)

この状態だとapp\src\test\cpp\my_test.cppが無いので、GradleSyncするとエラーが出ます。

app\src\test\cppへmy_test.cppを作成します。
この状態でもう一度GradleSyncするとエラーが消えていると思います。

ここまででビルドできることを確認して次へ進みます。

テストを追加する

上でテスト用のソースファイルの追加ができたので、簡単なテストを書いておきます。

app\src\test\cpp\my_test.cpp

#include <gtest/gtest.h>

TEST(MyTest, Sample)
{
    EXPECT_EQ(1, 0);
}

定数同士の比較で全く意味がないですが、テストが実行できているか確認するには十分なのでOKとします。

またまたビルドできることを確認して次へ進みます。

ctestに対応する

ctestはトップディレクトリから追加されたテストを認識してフィルタリングしたり並列実行したりできるので、対応したいと思います。

テストの追加にはgtest_discover_tests()コマンドを使用します。
ただ、ctestは実行ファイルを探し出して実行しているに過ぎず、Android実機で実行するには少し手を加えてやる必要があります。

However, it requires that CROSSCOMPILING_EMULATOR is properly set in order to function in a cross-compiling environment.

クロスコンパイルするときはCROSSCOMPILING_EMULATORプロパティを適切に設定してくださいと書いてあります。
このプロパティはadd_executable()で作成するターゲットに対して指定しておく必要があります。
CROSSCOMPILING_EMULATORプロパティに指定した値を実行可能ファイルとして、引数にadd_executable()の成果物のパスが渡されます。

app\src\test\cpp\CMakeLists.txt

# CROSSCOMPILING_EMULATOR プロパティを設定
# ここで設定したスクリプトは「テストのリストアップ」、「テストの実行」時に使用される
if(${CMAKE_HOST_SYSTEM_NAME} STREQUAL "Windows")
    set(MY_TEST_RUNNER
            ${CMAKE_SOURCE_DIR}/../../scripts/test_runner.bat #実機テスト実行用スクリプト
            )
else()
    set(MY_TEST_RUNNER
            ${CMAKE_SOURCE_DIR}/../../scripts/test_runner.sh #実機テスト実行用スクリプト
            )
endif()

set_target_properties(
        my_test
        PROPERTIES
        CROSSCOMPILING_EMULATOR
        ${MY_TEST_RUNNER}
)

CROSSCOMPILING_EMULATORに指定したtest_runner.batで実機への転送と実行を行います。
UNIX系の場合はシェルスクリプトを指定すればOKです。（別途作る必要があります）

gtest_discover_tests()でテスト追加します。

app/src/test/cpp/CMakeLists.txt

# テストの登録
gtest_discover_tests(
        my_test
        DISCOVERY_TIMEOUT 20
        DISCOVERY_MODE PRE_TEST
)

gtest_discover_tests()でDISCOVERY_MODE PRE_TESTを指定しているのは、テスト直前までテストのリストアップを遅らせる目的があります。
何も指定しないとビルド時にリストアップされますが、Androidの場合adbコマンドを使用する必要があり、ビルドの段階ではそのことは意識したくないので遅らせています。

ビルドできることを確認して次へ進みます。

テストを実行するスクリプトを作る

ctestから実行されるスクリプトを作ります。

ctest実行時に渡される引数はこんな感じでした。

'実行ファイルパス' --gtest_filter Runtime.EngineName --gtest_also_run_disabled_tests

これを実機で動作するようにしていきます。
ざっくりとした手順はこんな感じです。

引数で渡された実行ファイルを端末にコピー
端末上で渡された引数とともに実行ファイルを起動
テスト結果に合わせてスクリプトの終了コードを変更

スクリプトの初めに必要な変数をこんな感じで用意しておきます。（ついでにスクリプトのあるフォルダへ移動しています）