CppUTest の使い方

おさらいとして、簡単に CppUTest の使い方を振り返っておこう。

test_group1.cpp というようなファイルを作って、次のように書く。

#include "CppUTest/CommandLineTestRunner.h"

TEST_GROUP(TestGroup1)
{
};

TEST(TestGroup1, Test1)
{
    int ret;
    ret = product_code();
    CHECK_EQUAL(0, ret);
}

• まず、テストハーネスを include する。
• 次に、テストグループ(TestGroup1)を定義する。
• 次にテスト(Test1)を定義する。
• テスト対象のコードを実行して期待値と比較する(CHECK_EQUAL)。

main 関数の方は定型的だ。

#include "CppUTest/CommandLineTestRunner.h"

int main(int ac, char** av)
{
    return CommandLineTestRunner::RunAllTests(ac, av);
}

これで、テストコード、プロダクトコード、main 関数をリンクすればテストが実行できる。

組み込みにおけるMocking

組み込みにおいて、ユニットテストの実行を困難にするのはハードウエアの存在だ。たとえばMCUのGPIOポートに外部のスイッチが接続されていて、スイッチの入力状態によってコードの動作が変わる。

一般的に、GPIOなどのペリフェラルにアクセスするには、特定のレジスタを読み書きする。最近のMCUの場合、それらは HAL層としてライブラリ化されてベンダーから供給されていることが多い。例えば ST社のSTM32シリーズの場合は CubeMX というツールを使ってGUIでペリフェラルの設定をして、その設定に必要なコードを自動生成し、さらにレジスタアクセスは HALライブラリとして提供される。

つまり、HALライブラリを置き換えてリンクしてやれば、実機を用いずにテストを実行できる。この置き換えライブラリを、Mock といい(モックアップとか言うでしょう)、Mockを作って置き換えることを Mocking という。

また、これをするために必要なコーディングルールとして「アプリケーションコードから直接レジスタをアクセスしない。レジスタをアクセスするときはかならず、HALライブラリを通す(ベンダーから提供されなければHALライブラリを自作する)。」

CppUTest において Mocking を支援するライブラリが CppUMockである。

Mockに求められる機能としては次のものがある。

• 本来のHALの機能を代替する(Test Dobuleともいう)。
• テストに適したウソの値を返す。
• 期待するHALの呼び出し方法を定め、それと違う呼ばれ方をすればエラーとする。

CppUMockの使い方

ウェブ上で日本語の CppUMock に関する情報は非常に少ない。それを補うのが本稿の目的である。

例としてキーの取り込みをする関数をテストすることを考える。まず、テストコードは次のようなものになるだろう。

#include "CppUTest/TestHarnes.h"

TEST_GROUP(TestGroup1)
{
    TEST_SETUP() {
    }
    TEST_TEARDOWN() {
        mock_c()->clear();
    }
};

TEST(TestGroup1, Test1)
{
    int ret;
    ret = check_key();  // キーが押されているかどうかをチェックする。
    CHECK_EQUAL(1, ret);
}

テスト対象となるプロダクションコードは次のようなものであろう。ここでは、単純にGPIOを使ってピンの状態を読むものを考える。GPIOにはスイッチが接続されているとしよう。

const int port=1;
const int pin =2;
int check_key()
{
    return HAL_GPIO_Read(port, pin);
}

実機で動作させるときには、HALライブラリをリンクさせる。HALライブラリでは、HAL_GPIO_Read はレジスタへのアクセスへと変換される。

テストの時はレジスタは無いので、HALライブラリをMocking しなければならない。Mock として HAL_GPIO_Read を定義して、HALライブラリの代わりにこちらをリンクする。

int return HAL_GPIO_Read(port, pin)
{
  return c_mock()
      ->actualCall("HAL_GPIO_Read")
      ->withIntParameters("port", port)
      ->withIntParameters("pin", pin)
      ->returnValue().value.intValue;
}

意味は次のとおりだ。

• HAL_GPIO_Readという関数だ(文字列として情報登録)
• 一つ目の引数はportという名前(文字列として情報登録)で、コード上では port という仮引数で与えられる。これは、テスト実行時に、exception(期待)として注入される。
• 二つ目の引数も同様。
• int の値を返す。これも、テスト実行時に、exception(期待)として注入される。

このような Mock版 HAL_GPIO_Read をリンクすれば、それが返す値を、テストコード側から設定できる。

#include "CppUTest/TestHarnes.h"
#include "CppUTestExt/MockSupport.h"

TEST_GROUP(TestGroup1)
{
};

TEST(TestGroup1, Test1)
{
    int ret;
    c_mock()
        ->expcetOneCall("HAL_GPIO_Read")
        ->withIntParameter("port", 1)
        ->withIntParameter("pin", 2)
        ->andReturnIntValue(1);
    ret = check_key();
    CHECK_EQUAL(1, ret);
}

c_mock() で始まる行は次の意味だ。

• これから、HAL_GPIO_Read という関数が呼ばれる。
• その引数は、port == 1、pin == 2のはずだ(期待)｡
• そして、HAL_GPIO_Readは1を返す。

引数が違うと、checkExpectations がエラーを発生する。つまり、check_key にバグがあって、期待したように HAL_GPIO_Read に引数を与えていないということだ。

引数が合っている場合、Mock化されたHAL_GPIO_Readはproduct_code に対して、上で指定した値を返す。check_key はHAL_GPIO_Readが返す値を正しく処理して値を返す。その値は ret で受けて CHECK_EQUAL で検査される。

引数の期待を表明するためには、型に応じて次のAPIがある。このへんはC++版の方がオーバーライドされていて分かりやすい。

• withBoolParameter
• withIntParameter
• withUnsignedIntParameter
• withLongIntParameter
• withUnsignedLongIntParameter
• withDoubleParameter
• withStringParameter
• withPointerParameter
• withConstPointerParameter
• withFunctionPointerParameter
• withMemoryBufferParameter
• withParameterParameter
• withOutputParameterParameter
• withOutputParameterOfTypeParameter

返り値についても同様だ。

• andReturnBoolValue
• andReturnIntValue
• andReturnUnsignedIntValue
• andReturnLongIntValue
• andReturnUnsignedLongIntValue
• andReturnDoubleValue
• andReturnStringValue
• andReturnPointerValue
• andReturnConstPointerValue
• andReturnFunctionPointerValue