Overview

HTTPS SSH

<title>PCUnit - Portable C Unit Testing Framework</title>

PCUnit - Portable C Unit Testing Framework

概要

PCUnitはC言語/C++言語でテスト駆動開発(Test-Driven Development; TDD)や単体テストをするための ポータブルでコンパクトなユニットテストフレームワークです。

PCUnitは以下のような特長があります。

  • 機能

    • CUnitライクなアサートマクロをサポートします。
    • アサートマクロで失敗した内容を表示できます。さらにprintf形式で追加メッセージを表示できます。
    • テストフィクスチャ(setup, teardown, initialize, cleanup)をサポートします。
    • 1つのテストを繰り返し行うRepeatedTestをサポートします。これを利用して、データ駆動テストを行うこともできます。
    • ディスプレイやキーボードがないターゲット上でテストするために、ユーザー定義の入出力関数を設定できます。
    • 実行するテストをインタラクティブに選択できるコンソールモードをサポートします。
    • ターミナルが対応していればテスト結果のカラー表示ができます。
    • テスト関数の雛形生成や自動登録ができます。
    • テスト結果をXMLファイルで出力することができます。
    • モックオブジェクトを使用することができます。
  • 移植性

    • プラットフォーム非依存な実装なので、大抵のPC向けまたは組み込み向けのC/C++コンパイラでビルドすることができます。 つまり、ホスト環境とターゲット環境の両方で動作する共通のテストコードを実装することができます。
    • たとえ標準Cライブラリが使えない環境でも使用可能です。

リポジトリ

ビルド方法

GNU開発環境の場合は、PCUnitディレクトリでmakeを実行してください。makeを実行するとlibpcunit.aが生成されるので それをテストプロジェクトに静的リンクしてください。デフォルトのコンパイラはgccですが、 適宜Makefileを修正してターゲット用のクロスコンパイラやコンパイラオプションを指定してください。 ホスト環境にインストールしたい場合は、make installを実行してください。 make installを実行すると/usr/local/libにlibpcunit.aを、/usr/local/include/PCUnitにヘッダファイルを、 /usr/local/binにユーティリティをインストールします。 make uninstallを実行するとアンインストールします。 インストール先ディレクトリを/usr/localから変更してインストールする場合は、 make install INSTALLDIR=/foo/barのようにINSTALLDIRに任意のインストール先ディレクトリを指定してください。 同様にアンインストールする場合は、make uninstall INSTALLDIR=/foo/barを実行してください。

GNU開発環境でない場合は、PCUnitディレクトリ以下のソースファイルとヘッダファイルをテストプロジェクトに追加して テストコードと共にビルドしてください。あるいはPCUnitの静的ライブラリをビルドするプロジェクトを作成し、 ビルドしたライブラリをテストプロジェクトに静的リンクしてください。

ビルド設定

PCUnitはコンパイラオプションのマクロ定義で以下の設定をすることができます。 PCUnitのビルドが失敗する場合は、適宜PCU_NO_*マクロを定義することでビルド可能になります。 ただし、PCUnitをビルドするためには最低限<stddef.h><limits.h>が必要です。

  • vsprintfが使用できないためにビルドが失敗する場合は、PCU_NO_VSPRINTFマクロを定義してください。
  • setjmp/longjmpが使用できないためにビルドが失敗する場合は、PCU_NO_SETJMPマクロを定義してください。
  • <string.h><stdlib.h>の関数が使用できないためにビルドが失敗する場合は、 PCU_NO_LIBCマクロを定義してください。 このマクロを定義した場合はPCU_NO_VSPRINTFPCU_NO_SETJMPを定義する必要はありません。
  • <stdarg.h>がないためにビルドが失敗する場合は、PCU_NO_STDARGマクロを定義してください。
  • プロセッサにFPUがなく、ソフトウェア浮動小数点ライブラリも使用できないためにビルドが失敗する場合は、 PCU_NO_FLOATINGPOINTマクロを定義してください。
  • 32ビットの除算ができないためにビルドが失敗する(例えばgccで___divsi3などのリンクエラーが発生する)場合は、 PCU_NO_DIV32マクロを定義してください。
  • コンソールモードが不要な場合は、PCU_NO_CONSOLE_RUNマクロを定義してください。 PCU_console_runが使用できなくなりますが、コードサイズが少し小さくなります。
  • ワイド文字列をチェックするアサートマクロを使用したい場合は、PCU_USE_WCHARマクロを定義してください。 _UNICODEマクロまたはUNICODEマクロが定義済みならば、PCU_USE_WCHARマクロは自動的に定義済みになります。
  • PCU_format/PCU_formatWで使用する静的領域のサイズを変更したい場合は、 PCU_FORMAT_BUFSIZEマクロの値を定義してください。

テスト構成

PCUnitのテストはこのような構成になっています。

  • テスト実行関数
    • スイートメソッド 1
      • テストスイート 1
        • テストケース 1-1
        • テストケース 1-2
        • ・・・
    • スイートメソッド 2
      • テストスイート 2
        • テストケース 2-1
        • テストケース 2-2
        • ・・・
    • スイートメソッド 3
      • テストスイート 3
        • テストケース 3-1
        • テストケース 3-2
        • ・・・
    • ・・・

テストケース

テストケース は1つのテスト関数を実行するためのデータ構造です。 テストケースはPCU_Testという構造体で次のように型定義されています。

typedef struct {
    const char *name;      /* テストケース名 */
    void (*test)(void);    /* テスト関数 */
    int ntimes;            /* テスト関数を実行する回数 */
    ...                    /* 以下、非公開メンバ */
} PCU_Test;

ntimesによる繰り返しはsetup, teardownの実行も含みます。 ntimesが0の場合は1を指定したと見なします。また、負の数ならばそのテストケースはスキップされます。

テストスイート

テストスイート は複数のテストケースを管理するためのデータ構造です。 テストスイートはPCU_Suiteという構造体で次のように型定義されています。

typedef struct {
    const char *name;        /* テストスイート名 */
    PCU_Test *tests;         /* テストケースの配列 */
    int ntests;              /* testsの要素数 */
    int (*setup)(void);      /* testsの各テスト関数の実行前に呼ばれる関数 */
    int (*teardown)(void);   /* testsの各テスト関数の実行後に呼ばれる関数 */
    int (*initialize)(void); /* testsの最初のテストの実行前に呼ばれる関数 */
    int (*cleanup)(void);    /* testsの最後のテストの実行後に呼ばれる関数 */
    ...                      /* 以下、非公開メンバ */
} PCU_Suite;

setupとteardownの戻り値は、0ならば正常、非0ならば異常です。 setupが異常の場合、テスト関数とteardownは実行されません。

initializeとcleanupの戻り値は、0ならば正常、非0ならば異常です。 initializeが異常の場合、testsの全てのテストとcleanupは実行されません。

setup, teardown, initialize, cleanupは、0が指定された場合は呼ばれません。

スイートメソッド

スイートメソッド はテスト実行関数からテストスイートにアクセスするためのインターフェイスです。 スイートメソッドの詳細については後述します。

簡単な使い方

テスト対象関数

簡単な例として、add関数とsub関数をテスト対象関数とします。

add関数は引数aと引数bを足した値を返し、sub関数は引数aから引数bを引いた値を返す関数です。 プロトタイプ宣言をしたヘッダファイルAddSub.hを作成します。

[AddSub.h]
 1 #ifndef ADDSUB_H_INCLUDED
 2 #define ADDSUB_H_INCLUDED
 3 int add(int a, int b);
 4 int sub(int a, int b);
 5 #endif

テスト関数

add関数とsub関数を実装する前に、テスト関数を先に実装します。 テスト関数を実装するソースファイル名は任意ですが、テスト対象のソースファイル名にTestを付けた名前にするとよいでしょう。 次のように実装します。

[AddSubTest.c]
 1 #include "PCUnit/PCUnit.h"
 2 #include "AddSub.h"
 3
 4 static void test_add(void)
 5 {
 6     PCU_ASSERT_EQUAL(3, add(2, 1));
 7     PCU_ASSERT_EQUAL(0, add(0, 0));
 8     PCU_ASSERT_EQUAL(1, add(-1, 2));
 9 }
10
11 static void test_sub(void)
12 {
13     PCU_ASSERT_EQUAL(1, sub(2, 1));
14     PCU_ASSERT_EQUAL(0, sub(0, 0));
15     PCU_ASSERT_EQUAL(-3, sub(-1, 2));
16 }
17

PCUnitを使うためにはPCUnit.hをインクルードする必要があります。 PCUnit.hのインクルードパスは適宜テストプロジェクトで指定してください。

テスト関数は引数・戻り値が共にvoidの関数です。テスト関数名は任意ですが、testを付けた名前にするとよいでしょう。 他のソースファイルから呼び出さないならばstatic関数にしてください。

ここではPCU_ASSERT_EQUALマクロを使用してテスト対象関数の戻り値が仕様どおりかチェックしています。 PCU_ASSERT_EQUALマクロの2つの引数が等しければOKで、異なっていたらテスト失敗です。 最初の引数に予測される値を指定し、2番目の引数に実際の値を指定します。

スイートメソッド

次に、スイートメソッドを定義します。 スイートメソッドは staticPCU_Suiteの変数へのポインタを返すグローバル関数です。 スイートメソッドはPCU_Suiteのメンバのtestsやsetup関数等のスコープを小さくする役割を果たします。 関数名は任意ですが、テストスイート名_suite()と付けるとよいでしょう。 次のように定義します。

[AddSubTest.c]
18 PCU_Suite *AddSubTest_suite(void)
19 {
20     static PCU_Test tests[] = {
21         { "test_add", test_add },
22         { "test_sub", test_sub },
23     };
24     static PCU_Suite suite = { "AddSubTest", tests, sizeof tests / sizeof tests[0] };
25     return &suite;
26 }

スイートメソッドは引数がvoid、戻り値がPCU_Suite *の関数です。

スイートメソッドではまず、PCU_Test構造体の配列testsを static で定義と同時に初期化します。 PCU_Test構造体の最初のメンバnameには任意のテストケース名を指定します。 2番目のメンバtestには先に定義したテスト関数を指定します。 3番目のメンバはntimesですが、この例では省略されているので0で初期化され、テスト関数は1回実行されます。 繰り返しが必要な場合はntimesに回数を指定してください。 後で新しいテストケースを追加したい場合は、新しいテスト関数を定義してこの配列の初期化に追加してください。 (pcunit_register.rbユーティリティを使用すればテストケース登録を自動化できます。)

次に、PCU_Suite構造体の変数suiteを static で定義と同時に初期化します。 PCU_Suite構造体の最初のメンバnameには任意のテストスイート名を指定します。 2番目のメンバtestsにはPCU_Testの配列testsを指定します。 3番目のメンバntestsにはtestsの要素数を指定します。 4番目以下のメンバsetup, teardown, initialize, cleanupはこの例では省略されているのでそれぞれ0で初期化されます。 setup, teardown, initialize, cleanupが必要な場合はそれぞれの関数を定義し指定してください。

この関数の最後でsuiteのアドレスを返します。

main関数

main関数は次のように定義します。

[main.c]
 1 #include "PCUnit/PCUnit.h"
 2 #include <stdio.h> /* for putchar */
 3
 4 PCU_Suite *AddSubTest_suite(void);
 5
 6 int main(void)
 7 {
 8     const PCU_SuiteMethod suites[] = {
 9         AddSubTest_suite,
10     };
11     PCU_set_putchar(putchar);
12     return PCU_run(suites, sizeof suites / sizeof suites[0]);
13 }

main関数がテストを実装したソースと別ファイルの場合はスイートメソッドのプロトタイプ宣言をしてください。

main関数ではまず、PCU_SuiteMethod型の配列を宣言します。 PCU_SuiteMethod型はスイートメソッドへのポインタ型で、次のように型定義されています。

typedef PCU_Suite *(*PCU_SuiteMethod)(void);

ここではAddSubTest_suiteだけで初期化しています。 後で新しいテストスイートを追加したい場合は、新しいテストスイートに対応するスイートメソッドをこの配列の初期化に追加してください。 (pcunit_register.rbユーティリティを使用すればスイートメソッド登録を自動化できます。)

次に、PCU_set_putchar関数でテスト結果の出力関数をputcharに設定しています。 この関数ではユーザー定義のputchar相当の関数を用意することでテスト結果の出力先を変更することができます。 例えばターゲット上で動作させる時はシリアル出力関数などを指定するとよいでしょう。

最後に、テスト実行関数であるPCU_run関数を呼び出します。 PCU_runの最初の引数はPCU_SuiteMethod型の配列で、2番目の引数はその配列の要素数です。 PCU_runの戻り値は、失敗がなければ0、1つでも失敗があれば非0です。

これでテストコードの準備は整いました。

ビルド、実行、修正の繰り返し

ビルドするとadd関数とsub関数の実装がないため、リンクエラーになります。

ここで、AddSub.cを作成し、add関数とsub関数の実装をします。

[AddSub.c]
 1 #include "AddSub.h"
 2 int add(int a, int b) { return 0; }
 3 int sub(int a, int b) { return 0; }

単純な関数ですが、わざとテストに失敗させるために0を返すようにしておきます。

再度ビルドして実行すると、テストに失敗します。 このように出力されます。

Suite: AddSubTest

Test: test_add
 AddSubTest.c:6: PCU_ASSERT_EQUAL(3, add(2, 1))
  expected : 0x00000003 (3)
  actual   : 0x00000000 (0)

Test: test_sub
 AddSubTest.c:13: PCU_ASSERT_EQUAL(1, sub(2, 1))
  expected : 0x00000001 (1)
  actual   : 0x00000000 (0)

2 Tests, 2 Failures, 0 Skipped

失敗したテストスイート名、テストケース名、ファイル名、行番号、アサートマクロ、アサートマクロの引数の値が表示されます。 その後、そのテストスイートに登録されている全テストケース数、実行して失敗したテストケース数、 スキップされたテストケース数が表示されます。

テストにパスするために、add関数とsub関数を修正します。

[AddSub.c]
- int add(int a, int b) { return 0; }
- int sub(int a, int b) { return 0; }
+ int add(int a, int b) { return a + b; }
+ int sub(int a, int b) { return a - b; }

修正したらビルドして実行します。 このように出力されます。

Suite: AddSubTest

2 Tests, 0 Failures, 0 Skipped
OK

全てのテストにパスすると、OKのメッセージが表示されます。 PCU_set_verboseで出力が冗長モードになっていなければ、パスしたテストケースの情報は表示されません。

OKのメッセージは1つのテストスイートにつき1つ表示されます。 この例ではテストスイートは1つでしたが、テストスイートが複数の場合、 全てのテストスイートにOKが表示されるまで修正を繰り返してください。

アサートマクロ

アサートマクロはテスト関数内で使用可能です。 各アサートマクロの引数は2回以上評価されないので、マクロ展開による副作用を気にする必要はありません。

アサーション失敗時はlongjmpによってテスト関数から抜けます。 ただし、PCUnitがPCU_NO_SETJMPマクロまたはPCU_NO_LIBCマクロが定義済みでビルドされている場合は、 longjmpの代わりにreturnによってテスト関数から抜けます。 この場合、スタブ等のテスト関数内で呼び出される関数から一気に抜けることはできなくなります。

以下にPCUnitが提供するアサートマクロを示します。

  • PCU_ASSERT(expr)

    任意の式exprが真かどうかチェックします。 偽ならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_TRUE(expr)

    任意の式exprが真かどうかチェックします。 偽ならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_FALSE(expr)

    任意の式exprが偽かどうかチェックします。 真ならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_EQUAL(expected, actual)

    expectedとactualが整数である前提で、expectedとactualが等しいかどうかチェックします。 等しくないならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_NOT_EQUAL(value1, value2)

    value1とvalue2が整数である前提で、value1とvalue2が等しくないかどうかチェックします。 等しいならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_PTR_EQUAL(expected, actual)

    expectedとactualがポインタである前提で、expectedとactualのポインタの値が等しいかどうかチェックします。 等しくないならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_PTR_NOT_EQUAL(value1, value2)

    value1とvalue2がポインタである前提で、value1とvalue2のポインタの値が等しくないかどうかチェックします。 等しいならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_PTR_NULL(value)

    valueがポインタである前提で、valueがNULLかどうかチェックします。 NULLでないならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_PTR_NOT_NULL(value)

    valueがポインタである前提で、valueがNULLでないかどうかチェックします。 NULLならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_STRING_EQUAL(expected, actual)

    expectedとactualが文字列(const char *)である前提で、expectedとactualの文字列が等しいかどうかチェックします。 等しくないならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_STRING_NOT_EQUAL(value1, value2)

    value1とvalue2が文字列(const char *)である前提で、value1とvalue2の文字列が等しくないかどうかチェックします。 等しいならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_NSTRING_EQUAL(expected, actual, n)

    expectedとactualが文字列(const char *)である前提で、expectedとactualの文字列の先頭からn文字が等しいかどうかチェックします。 等しくないならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_NSTRING_NOT_EQUAL(value1, value2, n)

    value1とvalue2が文字列(const char *)である前提で、value1とvalue2の文字列の先頭からn文字が等しくないかどうかチェックします。 等しいならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_STRINGW_EQUAL(expected, actual)

    expectedとactualがワイド文字列(const wchar_t *)である前提で、expectedとactualのワイド文字列が等しいかどうかチェックします。 等しくないならば失敗を出力し、テスト関数から抜けます。 失敗時の引数の文字列表示は、現在のロケールのLC_CTYPEカテゴリに依存します。 なお、このマクロを使用するためにはPCUnitがPCU_USE_WCHARマクロが定義済みでビルドされている必要があります。

  • PCU_ASSERT_STRINGW_NOT_EQUAL(value1, value2)

    value1とvalue2がワイド文字列(const wchar_t *)である前提で、value1とvalue2のワイド文字列が等しくないかどうかチェックします。 等しいならば失敗を出力し、テスト関数から抜けます。 失敗時の引数の文字列表示は、現在のロケールのLC_CTYPEカテゴリに依存します。 なお、このマクロを使用するためにはPCUnitがPCU_USE_WCHARマクロが定義済みでビルドされている必要があります。

  • PCU_ASSERT_NSTRINGW_EQUAL(expected, actual, n)

    expectedとactualがワイド文字列(const wchar_t *)である前提で、expectedとactualのワイド文字列の先頭からn文字が等しいかどうかチェックします。 等しくないならば失敗を出力し、テスト関数から抜けます。 失敗時の引数の文字列表示は、現在のロケールのLC_CTYPEカテゴリに依存します。 なお、このマクロを使用するためにはPCUnitがPCU_USE_WCHARマクロが定義済みでビルドされている必要があります。

  • PCU_ASSERT_NSTRINGW_NOT_EQUAL(value1, value2, n)

    value1とvalue2がワイド文字列(const wchar_t *)である前提で、value1とvalue2のワイド文字列の先頭からn文字が等しくないかどうかチェックします。 等しいならば失敗を出力し、テスト関数から抜けます。 失敗時の引数の文字列表示は、現在のロケールのLC_CTYPEカテゴリに依存します。 なお、このマクロを使用するためにはPCUnitがPCU_USE_WCHARマクロが定義済みでビルドされている必要があります。

  • PCU_ASSERT_STRINGT_EQUAL(expected, actual)

    _UNICODEマクロまたはUNICODEマクロが定義されている場合はPCU_ASSERT_STRINGW_EQUALに展開され、 そうでない場合はPCU_ASSERT_STRING_EQUALに展開されます。

  • PCU_ASSERT_STRINGT_NOT_EQUAL(value1, value2)

    _UNICODEマクロまたはUNICODEマクロが定義されている場合はPCU_ASSERT_STRINGW_NOT_EQUALに展開され、 そうでない場合はPCU_ASSERT_STRING_NOT_EQUALに展開されます。

  • PCU_ASSERT_NSTRINGT_EQUAL(expected, actual, n)

    _UNICODEマクロまたはUNICODEマクロが定義されている場合はPCU_ASSERT_NSTRINGW_EQUALに展開され、 そうでない場合はPCU_ASSERT_NSTRING_EQUALに展開されます。

  • PCU_ASSERT_NSTRINGT_NOT_EQUAL(value1, value2, n)

    _UNICODEマクロまたはUNICODEマクロが定義されている場合はPCU_ASSERT_NSTRINGW_NOT_EQUALに展開され、 そうでない場合はPCU_ASSERT_NSTRING_NOT_EQUALに展開されます。

  • PCU_ASSERT_MEMORY_EQUAL(expected, actual, size, n)

    expectedとactualがsizeバイトの型のポインタである前提で、expectedとactualの先頭からn個が等しいかどうかチェックします。 等しくないならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_MEMORY_NOT_EQUAL(value1, value2, size, n)

    value1とvalue2がsizeバイトの型のポインタである前提で、value1とvalue2の先頭からn個が等しくないかどうかチェックします。 等しいならば失敗を出力し、テスト関数から抜けます。

  • PCU_ASSERT_DOUBLE_EQUAL(value1, value2, delta)

    value1とvalue2とdeltaが浮動小数点数である前提で、|value1 - value2| <= |delta|が真かどうかチェックします。 偽ならば失敗を出力し、テスト関数から抜けます。 なお、PCUnitがPCU_NO_FLOATINGPOINTマクロが定義済みでビルドされている場合は使用できません。

  • PCU_ASSERT_DOUBLE_NOT_EQUAL(value1, value2, delta)

    value1とvalue2とdeltaが浮動小数点数である前提で、|value1 - value2| > |delta|が真かどうかチェックします。 偽ならば失敗を出力し、テスト関数から抜けます。 なお、PCUnitがPCU_NO_FLOATINGPOINTマクロが定義済みでビルドされている場合は使用できません。

  • PCU_ASSERT_OPERATOR(value1, op, value2)

    value1とvalue2が符号無し整数を返す任意の式でopが代入以外の任意の二項演算子である前提で、((value1) op (value2)) が真かどうかチェックします。 偽ならば失敗を出力し、テスト関数から抜けます。

    例: PCU_ASSERT_OPERATOR(x < 0, ||, 100 <= x); xが0未満または100以上かチェック PCU_ASSERT_OPERATOR(x, &, 0x01); xの最下位ビットが立っているかチェック

  • PCU_ASSERT_OPERATOR_INT(value1, op, value2)

    value1とvalue2が符号付き整数を返す任意の式でopが代入以外の任意の二項演算子である前提で、((value1) op (value2)) が真かどうかチェックします。 偽ならば失敗を出力し、テスト関数から抜けます。

    例: * PCU_ASSERT_OPERATOR_INT(x, <, -1); xが-1より小さい値かチェック

  • PCU_ASSERT_OPERATOR_DOUBLE(value1, op, value2)

    value1とvalue2が浮動小数点数を返す任意の式でopが比較演算子である前提で、((value1) op (value2)) が真かどうかチェックします。 偽ならば失敗を出力し、テスト関数から抜けます。 なお、PCUnitがPCU_NO_FLOATINGPOINTマクロが定義済みでビルドされている場合は使用できません。

    例: * PCU_ASSERT_OPERATOR_DOUBLE(x, >=, 1.0); xが1.0以上の値かチェック

  • PCU_ASSERT*_MESSAGE(*, msg)

    上記の各アサートマクロには、最後の引数にmsgを追加した、マクロ名の末尾に_MESSAGEが付いたバージョンがあります。 アサーション失敗時にmsgで指定したメッセージを追加表示できること以外は各アサートマクロと同じです。 msgの型はconst char *です。 なお、PCU_format/PCU_formatWを使用すればprintf/wprintfと同じ形式の文字列を指定することができます。

    例: PCU_ASSERT_MESSAGE(x, "x is false"); PCU_ASSERT_EQUAL_MESSAGE(x, y, PCU_format("a:%s, b:%x, c:%d", a, b, c));

  • PCU_FAIL(msg)

    無条件に失敗を出力し、テスト関数から抜けます。 失敗表示の際にmsgで指定したメッセージを表示します。 msgの型はconst char *です。 なお、PCU_format/PCU_formatWを使用すればprintf/wprintfと同じ形式の文字列を指定することができます。

  • PCU_MESSAGE(msg)

    合否チェックを行わず、msgで指定したメッセージを表示します。 このマクロはテスト関数から抜けません。 msgの型はconst char *です。 なお、PCU_format/PCU_formatWを使用すればprintf/wprintfと同じ形式の文字列を指定することができます。

API

  • int PCU_run(const PCU_SuiteMethod *suite_methods, int num)

    PCU_SuiteMethodの配列suite_methodsから導かれる全テストを実行します。 numにはsuite_methodsの要素数を指定します。 全テストを実行した結果、失敗がなければ0を、1つでも失敗があれば非0を返します。

  • int PCU_console_run(const PCU_SuiteMethod *suite_methods, int num)

    コンソールモードでテストを実行します。 実行するテストを対話的に選択したい場合、PCU_runの代わりにこちらを使います。 引数はPCU_runと同じです。 テストを実行した結果、失敗がなければ0を、1つでも失敗があれば非0を返します。 なお、PCUnitがPCU_NO_CONSOLE_RUNマクロが定義済みでビルドされている場合は使用できません。

  • void PCU_set_putchar(PCU_Putchar func)

    1文字出力する関数を設定します。 PCU_Putchar型はputcharと同じ型の関数へのポインタ型で、typedef int (*PCU_Putchar)(int);と型定義されています。 PCU_runまたはPCU_console_runの前に必ず設定してください。

  • void PCU_set_getchar(PCU_Getchar func)

    入力した1文字を取得する関数を設定します。 PCU_Getchar型はgetcharと同じ型の関数へのポインタ型で、typedef int (*PCU_Getchar)(void);と型定義されています。 PCU_console_runの前に必ず設定してください。

  • void PCU_set_verbose(int verbose_flag)

    verbose_flagが非0なら、パスしたテストやスキップしたテストもテスト結果に出力する冗長モードに移行します。 verbose_flagが0なら、出力を通常モードに戻します。

  • void PCU_enable_color(void)

    ターミナルがカラー表示に対応していれば、テスト結果のカラー表示を有効にします。

  • void PCU_disable_color(void)

    テスト結果のカラー表示を無効にします。

  • const char *PCU_suite_name(void)

    現在実行中のテストスイート名を返します。 テスト関数、setup関数、teardown関数、initialize関数、cleanup関数内で使用可能です。

  • const char *PCU_test_name(void)

    現在実行中のテストケース名を返します。 テスト関数、setup関数、teardown関数内で使用可能です。

  • int PCU_repeat_counter(void)

    テストケースの実行が、現在何回目(0オリジン)であるかを返します。

    • PCU_Testのntimesが0の場合は常に0を返します。
    • ntimesが0より大きい場合は0 ~ ntimes - 1の値を返します。

    テスト関数、setup関数、teardown関数内で使用可能です。

    例えば、データ駆動テストにおけるテストデータのテーブルから要素を取得するためのインデックスに利用できます。 PCU_Testのntimesにはテストデータの要素数を指定してください。

  • const char *PCU_format(const char *format, ...)

    引数に指定したprintf形式の文字列を静的領域に展開し、その領域のポインタを返します。 PCU_ASSERT*_MESSAGEPCU_FAILPCU_MESSAGEのメッセージをprintf形式にしたい場合に利用できます。 静的領域のサイズはPCUnitのビルド時にPCU_FORMAT_BUFSIZEマクロの値で定義できます。定義しない場合のデフォルト値は512です。 内部でvsprintfを使用しているので文字列展開後のサイズがPCU_FORMAT_BUFSIZEを超えないように注意してください。

    例: * PCU_ASSERT_EQUAL_MESSAGE(x, y, PCU_format("a:%s, b:%x, c:%d", a, b, c));

    なお、PCUnitがPCU_NO_STDARGマクロが定義済みでビルドされている場合は使用できません。 PCU_NO_STDARGマクロが定義済みの場合は、代わりにPCU_format0PCU_format9(0~9は引数formatより後の引数の個数)を使用してください。

    例: * PCU_ASSERT_EQUAL_MESSAGE(x, y, PCU_format3("a:%s, b:%x, c:%d", a, b, c));

  • const char *PCU_formatW(const wchar_t *format, ...)

    引数に指定したwprintf形式のワイド文字列をマルチバイト文字列に変換して静的領域に展開し、その領域のポインタを返します。 PCU_ASSERT*_MESSAGEPCU_FAILPCU_MESSAGEのメッセージをwprintf形式にしたい場合に利用できます。 静的領域のサイズはPCUnitのビルド時にPCU_FORMAT_BUFSIZEマクロの値で定義できます。定義しない場合のデフォルト値は512です。 内部でvsprintfを使用しているので文字列展開後のサイズがPCU_FORMAT_BUFSIZEを超えないように注意してください。 なお、この関数を使用するためにはPCUnitがPCU_USE_WCHARマクロが定義済みでビルドされている必要があります。

    例: * PCU_ASSERT_EQUAL_MESSAGE(x, y, PCU_formatW(L"a:%s, b:%x, c:%d", a, b, c));

  • const char *PCU_formatT(const TCHAR *format, ...)

    PCU_formatTはマクロです。 _UNICODEマクロまたはUNICODEマクロが定義されている場合はPCU_formatWに展開され、 そうでない場合はPCU_formatに展開されます。

ヘルパーマクロ

PCU_Testの配列初期化の際に、テストケース名とテスト関数を同じ名前にする場合、ヘルパーマクロが利用できます。 ヘルパーマクロは次のように定義されています。

#define PCU_TEST(func)                  { #func, func }
#define PCU_TEST_REPEATED(func, ntimes) { #func, func, ntimes }
#define PCU_TEST_SKIPPED(func)          { #func, func, -1 }

static PCU_Test tests[] = {
    PCU_TEST(test_hoge),            /* test_hoge関数を登録 */
    PCU_TEST(test_piyo),            /* test_piyo関数を登録 */
    PCU_TEST_REPEATED(test_foo, 5), /* test_foo関数を登録(5回実行) */
    PCU_TEST_SKIPPED(test_bar),     /* test_bar関数を登録(スキップ) */
};

ユーティリティ

pcunit_template.rb

pcunit_template.rbはPCUnit用のソースファイルの雛形を生成するRubyスクリプトです。 書式は次の通りです。

pcunit_template.rb [suite_name ...] [-d DIR] [-p [EXT]] [-m [FILE]] [-M [FILE] [-i]] [-o]

suite_nameに1つ以上のテストスイート名を指定すると、テストスイート名.cというファイルを生成します。 生成されたファイルにはあらかじめテストスイート名_suite()という名前のスイートメソッドや、 setup関数・テスト関数等の雛形が定義されています。 適宜このファイルを編集して使用してください。 また、main関数やMakefileの雛形を生成することもできます。

オプション

  • -d DIR

    DIRにファイルを生成するディレクトリを指定してください。 このオプションを省略した場合、カレントディレクトリを指定したと見なします。

  • -p [EXT]

    生成するファイルをC++にします。 EXTにC++の拡張子(cpp, cc, cxx等)を指定してください。EXTを省略した場合、拡張子はcppになります。

  • -m [FILE]

    PCU_runを呼び出すmain関数を定義したファイルを生成します。 FILEにファイル名を指定してください。 FILEを省略した場合、ファイル名はmain.c(-p指定の場合はmain.cpp)になります。

  • -M [FILE] [-i]

    テストプロジェクトのMakefileの雛型を生成します。 FILEにファイル名を指定してください。 FILEを省略した場合、ファイル名はMakefileになります。 -iを指定した場合、libpcunit.aが既にインストールされている前提のMakefileを生成します。 -iを省略した場合、テストコードとPCUnitを共にビルドするMakefileを生成します。

  • -o

    生成するファイルと同じ名前のファイルが既に存在している場合でも上書きします。

pcunit_register.rb

pcunit_register.rbはテスト関数を自動登録するRubyスクリプトです。 書式は次の通りです。

pcunit_register.rb [-d DIR] [-e PATTERN] [-n]

pcunit_register.rbは、あるディレクトリ以下の全てのソースファイルを再帰的に検索し、 testで始まるテスト関数の中で、PCU_Testのstatic配列の初期化に登録されていない関数を自動的に登録します。 また、PCU_runの引数になるPCU_SuiteMethodの配列の初期化の登録も行います。

ソースファイルを更新するので、更新前のファイルはファイル名に.bakを付けてバックアップします。 更新する必要がないファイルには何もしません。

PCU_Testの配列初期化を以下のようにしておくと、テスト関数の登録を.pcutestsファイルに追い出すことができます。.pcutestsファイルは自動的に生成されるので、手動で作成する必要はありません。

static PCU_Test tests[] = {
#include "FooTest.pcutests"
};

使用するビルドツールにて、テストプロジェクトのビルド時にこのスクリプトを実行するように設定しておけば、 テスト関数を手動で登録をする必要がなくなります。 例えばMakefileならばallターゲットを次のように修正するとよいでしょう。

- all: $(TARGET)
+ all: pcunit_register $(TARGET)
+ 
+ pcunit_register:
+     pcunit_register.rb

オプション

  • -d DIR

    DIRにテストプロジェクトのソースファイルのディレクトリを指定してください。 このオプションは複数指定できます。 このオプションを省略した場合、カレントディレクトリを指定したと見なします。

  • -e PATTERN

    PATTERNに検索対象から除外するディレクトリ名/ファイル名の正規表現パターンを指定してください。 このオプションは複数指定できます。

  • -n

    更新前ファイルのバックアップをしなくなります。

pcunit_xml_output.rb

pcunit_xml_output.rbはテスト結果をXMLファイルで出力するRubyスクリプトです。 書式は次の通りです。

pcunit_xml_output.rb [output_file] [-e] [-n]

pcunit_xml_output.rbは、テストプログラムが標準出力へ出力したテスト結果を標準入力から読み取り、XMLファイルに変換して出力します。 また、標準入力をそのまま標準出力にも出力します。 output_fileに出力するXMLファイル名を指定します。 output_fileを省略した場合、XMLファイル名はtest_results.xmlになります。

全てのテスト結果を集計したい場合は、テストプログラムの出力をPCU_set_verboseで冗長モードにしてください。

次のようにパイプを利用して、テストプログラムの標準出力を入力として使用します。

$ ./alltests | pcunit_xml_output.rb

既にテキストファイルに保存したテスト結果をリダイレクトを利用して変換することもできます。

$ pcunit_xml_output.rb < test_results.txt

オプション

  • -e

    1つでもテスト結果に失敗があれば非0を終了コードとして返すようになります。

  • -n

    テスト結果を標準出力に出力しなくなります。

pcunit_mock.rb

pcunit_mock.rbはモックのソースファイルを生成するRubyスクリプトです。 書式は次の通りです。

pcunit_mock.rb header_file ... [OPTIONS]

header_fileに指定したヘッダファイルでプロトタイプ宣言されているグローバル関数のモックのソースファイルを生成します。 header_fileは複数指定またはワイルドカードが使用できます。

オプション

  • -d DIR

    DIRにファイルを生成するディレクトリを指定してください。 このオプションを省略した場合、カレントディレクトリを指定したと見なします。

  • -e PATTERN

    header_fileにワイルドカードで指定した場合、PATTERNに除外するディレクトリ名/ファイル名の正規表現パターンを指定してください。 このオプションは複数指定できます。

  • -s [SRC_DIR]

    header_fileで宣言されているオリジナルの関数をテストで使用したい場合、関数の定義のあるソースファイルのディレクトリをSRC_DIRに指定してください。 SRC_DIRを省略した場合、header_fileと同じディレクトリを指定したと見なします。

  • -p PREFIX

    PREFIXにファイルを生成するモックのソースファイルのプレフィックスを指定してください。 このオプションを省略した場合、mock_を指定したと見なします。

  • --include FILE

    生成するモックに、FILEで指定したファイルのインクルードを追加します。 このオプションは複数指定できます。

  • --type-int TYPE / --type-float TYPE / --type-string TYPE / --type-wstring TYPE / --type-tstring TYPE / --type-ptr TYPE

    これらのオプションは、それぞれTYPEにユーザー定義の整数型、浮動小数点数型、文字列型、ワイド文字列型、TCHARの文字列型、ポインタ型を指定します。 プロトタイプ宣言の引数の型が、整数型等のtypedefの場合に使用してください。 これらのオプションは複数指定できます。

  • --others

    生成するモックのソースファイルを、PCUnit以外のユニットテストフレームワークで使用できるようになります。 このオプションを使う場合は、テストコードのどこか1箇所でvoid PCU_mock_fail(const char *msg)関数を定義する必要があります。 PCU_mock_fail()関数では、メッセージを表示してテストを失敗するマクロ(PCU_FAILに相当)を呼んでください。 また、C++のテストコードでモックを使う場合は、モックのヘッダファイルのインクルードとPCU_mock_fail()の定義をextern "C" {}で囲んでください。

    例: CppUTestの場合

    extern "C" {
        #include "mock_Foo.h"
        void PCU_mock_fail(const char *msg)
        {
            FAIL(msg);
        }
    }
    

    例: GoogleTestの場合

    extern "C" {
        #include "mock_Foo.h"
        void PCU_mock_fail(const char *msg)
        {
            FAIL() << msg;
        }
    }
    

    例: Unityの場合

    void PCU_mock_fail(const char *msg)
    {
        TEST_FAIL_MESSAGE(msg);
    }
    

モックのAPI

例として、Foo.h というヘッダファイルに

int func(int a, const char *str);

というプロトタイプ宣言があるとします。 このヘッダファイルに対してpcunit_mock.rbを実行すると、mock_Foo.hmock_Foo.c が生成されます。 mock_Foo.c にはテストダブル関数func()が定義されます。 生成されたモックのAPIを以下に示します。

注: 適宜、Foofunc を実際に使用するヘッダファイル名と関数名に読み替えてください。 プロトタイプ宣言が複数ある場合は、その数だけ*_expect(), *_set_callback(), *_num_calls()が生成されます。

  • void mock_Foo_init(void)

    モックを初期化します。 モックを使用するテストコードのsetup()で呼んでください。

  • void mock_Foo_verify(void)

    *_expect() または *_set_callback() を使って設定された全てのエクスペクテーションを満たしたかどうかチェックします。 1つでも満たさないエクスペクテーションがあった場合はテスト失敗を出力します。 モックを使用するテストコードのteardown()で呼んでください。

  • void func_expect(const func_Expectation *expectations, int num)

    テストダブル関数func()のエクスペクテーション(期待される引数の値、戻り値、呼び出し回数)を設定します。 expectationsfunc_Expectation型の配列を指定し、numにはexpectationsの要素数を指定します。 numは期待されるfunc()の呼び出し回数になります。

    func_Expectation型は次のように型定義されています。

    typedef struct {
        int retval; /* テストダブル関数の戻り値を設定 */
        struct {
            int a;           /* 期待される引数aの値を設定 */
            const char *str; /* 期待される引数strの値を設定 */
        } expected;
        struct {
            unsigned int a:1;   /* 引数aの値を無視したい場合に1を設定 */
            unsigned int str:1; /* 引数strの値を無視したい場合に1を設定 */
        } ignored;
    } func_Expectation;
    

    例:

    以下のエクスペクテーションを設定します。
    - func()が2回呼び出されること
    - 1回目のfunc()の引数aは100であること
    - 1回目のfunc()の引数strは"foo"であること
    - 1回目のfunc()は200を返す
    - 2回目のfunc()の引数aは200であること
    - 2回目のfunc()の引数strは何でもよい
    - 2回目のfunc()は300を返す
    
    /* テスト関数 */
    static void test_func_expect(void)
    {
        /* func_Expectationの配列をローカル変数またはstatic変数で確保。
         * 配列の要素数が、期待されるfunc()の呼び出し回数となる。
         * 不定値でignoredが有効にならないように、配列は必ず0クリアすること。 */
        func_Expectation e[2] = {{0}};
        /* エクスペクテーションの設定 */
        e[0].expected.a = 100;     /* 1回目の呼び出し時に期待される引数aの値 */
        e[0].expected.str = "foo"; /* 1回目の呼び出し時に期待される引数strの値 */
        e[0].retval = 200;         /* 1回目の呼び出し時の戻り値 */
        e[1].expected.a = 200;     /* 2回目の呼び出し時に期待される引数aの値 */
        e[1].ignored.str = 1;      /* 2回目の呼び出し時の引数strは無視 */
        e[1].retval = 300;         /* 2回目の呼び出し時の戻り値 */
        func_expect(e, sizeof e / sizeof e[0]);
        /* 1回目の呼び出し。引数aが100かつ引数strが"foo" でない場合はテスト失敗を出力する */
        PCU_ASSERT_EQUAL(200, func(100, "foo"));
        /* 2回目の呼び出し。引数aは200でなければならないが、引数strはどんな値でもよい */
        PCU_ASSERT_EQUAL(300, func(200, "bar"));
    }
    
  • void func_set_callback(func_Callback callback, int expected_num_calls)

    テストダブル関数にユーザー定義のコールバック関数を設定します。 テストダブル関数func()が呼ばれると、設定したcallback()が呼ばれるようになります。 func_Callback型はfunc()と同じ型の関数へのポインタ型で、 typedef int (*func_Callback)(int a, const char *str);と型定義されています。 expected_num_callsに期待されるfunc()の呼び出し回数を指定します。 呼び出し回数を無制限にしたい場合は、expected_num_callsに負の数を指定します。

    コールバック関数を使えば、*_expect()より複雑なエクスペクテーションを設定することができます。 例えば、期待される引数を範囲で指定したい場合や、ポインタ引数が指す値を変更する関数を使いたい場合など、 *_expect()では期待する設定ができない時に使用してください。

    例:

    以下のエクスペクテーションを設定します。
    - func()が2回呼び出されること
    - 1回目のfunc()の引数aの範囲は100 <= a < 200であること
    - 1回目のfunc()の引数strは"foo"であること
    - 1回目のfunc()は200を返す
    - 2回目のfunc()の引数aは何でもよい
    - 2回目のfunc()の引数strは何でもよい
    - 2回目のfunc()は300を返す
    
    /* func()と同じ型のコールバック関数 */
    static int func_callback(int a, const char *str)
    {
        /* func_num_calls()は既に呼び出された回数を返す。これを使って分岐できる */
        if (func_num_calls() == 0) {
            /* 1回目の呼び出し時の引数をチェック */
            PCU_ASSERT_OPERATOR(100 <= a, &&, a < 200);
            PCU_ASSERT_STRING_EQUAL("foo", str);
            return 200;
        } else {
            /* 2回目の呼び出しは引数をチェックしない */
            return 300;
        }
    }
    /* テスト関数 */
    static void test_func_set_callback(void)
    {
        /* コールバック関数と期待される呼び出し回数の設定 */
        func_set_callback(func_callback, 2);
        /* 1回目の呼び出し。引数aが100 <= a < 200かつ引数strが"foo" でない場合はテスト失敗を出力する */
        PCU_ASSERT_EQUAL(200, func(150, "foo"));
        /* 2回目の呼び出し。2つの引数はどんな値でもよい */
        PCU_ASSERT_EQUAL(300, func(200, "bar"));
    }
    
  • int func_num_calls(void)

    テストダブル関数func()が既に呼び出された回数を返します。 func_set_callbackを使用する場合、コールバック関数内で呼び出された回数によって処理を変える時などに使用できます。

ライセンス

PCUnitはzlibライセンスに従って配布されます。 ライセンスの詳細は、COPYINGファイル(日本語参考訳はCOPYING.jaファイル)をご覧ください。

<!-- vim:set ts=4 sts=4 sw=4 et: -->