既存ソースに手を入れずに同一ソース内の関数をスタブにしてユニットテストを実施する方法

Question

次のような条件のユニットテストを実施したいです。
0. ソースは既存であり、手を入れることはできない
0. このソースに対して関数単位のテストを実施したい
0. テスト対象となる関数から呼ばれる関数はスタブとしたい
0. スタブにする関数は、テスト対象と同一のソースに含まれる場合がある

この場合、4番目の同一ソースのスタブがネックになると思います。
既存ソースには手を入れずに同一ソースにある関数をスタブにしてユニットテストを行う方法があれば教えてください。

実は過去に実施済みで、その時は、散々調べて、試行錯誤した結果、「できない」という結論に至りました。
結局、泣く泣く既存ソースに次のようなコード（#ifdef UNITTEST～#endif）を足すことなってしまいました。

既存ソース側

#ifdef UNITTEST
#define func1	(*pfunc1)
#define func2	(*pfunc2)
#endif // UNITTEST
static void test(void)
{
	func1();
	func2();
～
}
#undef func1
#undef func2
void func1(void)
{
～
}
void func2(void)
{
～
}

テストコード側

void testcode(void)
{
	pfunc1 = func1_stub;
	pfunc2 = func2_stub;
	test();
}

実際にはもう少し簡潔に書けるように、インクルードファイルを作ったりしました。

Answer 1

むかーし、似たようなことをやったことがあります。
こんな感じではどうでしょうか。Chironianさんと同じような発想ですが、古い規格のCコンパイラーでも使えます。

テストコード側

// func1を'func1_stub_行番号'に置き換える
#define func1 func1_(__LINE__)
#define func1_(line) func1__(line)
#define func1__(line) func1_stub_ ## line

// func2を'func2_stub_行番号'に置き換える
#define func2 func2_(__LINE__)
#define func2_(line) func2__(line)
#define func2__(line) func2_stub_ ## line

// test関数内でfunc1が呼ばれているのは9行目
void func1_stub_9(void)
{
	printf("func1_stub\n");
}

// test関数内でfunc2が呼ばれているのは10行目
void func2_stub_10(void)
{
	printf("func2_stub\n");
}

#include "test.c"

int main()
{
	test();
	return 0;
}

既存ソース側

// test.c
#include <stdio.h>

void func1(void);
void func2(void);

static void test(void)
{
	func1();
	func2();
}

void func1(void)
{
	printf("func1()\n");
}
void func2(void)
{
	printf("func2()\n");
}

---

追記

スタブ関数を引数渡しにする方法。

typedef void (*func_t)(void);
#define test(a) test_stubcall(func_t func1, func_t func2)

#include "test.c"

void func1_stub(void)
{
	printf("func1_stub\n");
}

void func2_stub(void)
{
	printf("func2_stub\n");
}

int main()
{
	test_stubcall(func1_stub, func2_stub);
	return 0;
}

Comments

[Chironian]

おお、行番号を使うのですか！！　頭のいい方法ですね。
これなら__VA_ARGS__も要らないし、バラメータがあっても対応できますし。

[ttyp03]

おお！素晴らしいけど惜しい！
行番号を意識して書かないといけないのが惜しいですね。
例えばfunc1()をあちこちで使ってたら（例えば9行目と10行目）、
void func1_stub_9(){} と
void func1_stub_10(){}
を用意しないといけないのですよね。
あとテストコードを使いまわして、改修後のソースにも使いたいという場合、行番号の調整をしないといけなくなるのも手間がかかりますね。
質問では「既存ソースに手を入れない」前提で書いているので、これは目をつぶりますが。

というのを踏まえて少し改良してみました。

#define func1 func1_(__LINE__)
#define func1_(line) func1__(line)
#define func1__(line) func1_stub_ ## line
#define func1_stub_9 func1_stub // 追加
#define func1_stub_10 func1_stub // 追加

void func1_stub(void)
{
printf("func1_stub\n");
}

スタブ関数の数が減るだけであまりメリットはないですかね…。
行番号を意識しないといけないコードからも脱却できてませんし。
もう少しな気もするんですが難しいですね。

[catsforepaw]

> #define func1_stub_9 func1_stub // 追加
> #define func1_stub_10 func1_stub // 追加

複数箇所での呼び出しを考慮するなら、これがベストですね。
おそらく、同じ関数を、定義する場所と呼び出す場所で名前を変えるという方法は、これ以外にはないと思います。

既存ソースをメンテナンスすることがあるのなら、こういう状況を想定した仕組みを入れ込むようにするのが良いと思います。

例えば、

// test.c

#ifndef FUNC1
#define FUNC1 func1
#endif

static void test(void)
{
FUNC1();
}

void func1(void)
{
:
}

このようにしておけば、通常はfunc1を呼びますが、テストコード側でtest.cをインクルードする前にFUNC1マクロにスタブ関数名を設定すれば、それを呼ぶようにできます。

[ttyp03]

自分で一から作るならあらかじめ仕込んでおくのですが、この案件は既にあるものに対してテストをしないといけなかったので難儀しました。

[catsforepaw]

ひらめきました。スタブ関数をtest関数に引数として渡せば煩わしさは軽減します。
コード例は回答の方に追記します。

[ttyp03]

試してみました。
これは…いいかもしれない。
テスト対象関数に引数があっても大丈夫のようですし、スタブを使う/使わないの制御も楽にできそうです。

Answer 2

こんにちは。

制約が凄く厳しいのですが、下記のような方法があります。

#include <stdio.h>

void func1(void);
void func2(void);

#define func1(...)    func1##__VA_ARGS__()
#define func2(...)    func2##__VA_ARGS__()

// --- 既存ソース部分。実際には#includeで取り込む ---
static void test(void)
{
    func1();
    func2();
}

void func1(void)
{
    printf("func1()\n");
}
void func2(void)
{
    printf("func2()\n");
}
// --- 既存ソース終わり ---

#undef func1
#undef func2

void func1(void)
{
    printf("func1_stub()\n");
}
void func2(void)
{
    printf("func2_stub()\n");
}

int main()
{
    test();
    return 0;
}

__VA_ARGS__が使えることと、スタブ化したい関数がパラメータなし、かつ、定義ではvoidが記述されていることが条件ですので、かなり制約がきついです。

でちまる氏のようなプリプロセッサ・ウィザードならパラメータ付きの関数でもなんとかできるかも？

ちなみに既存ソース部分は下記のように展開されます。

static void test(void)
{
    func1();
    func2();
}

void func1void()
{
    printf("func1()\n");
}
void func2void()
{
    printf("func2()\n");
}

Comments

[ttyp03]

既存ソース側の関数名を置き換えるのですね。
しかしやはりパラメーターなしという制約が厳しいですね。
あと以前の環境では__VA_ARGS__が使えなかったので、こちらもアウトです。
ちなみに環境はHEWで、コンパイラはルネサスのCコンパイラです。

あとリンクしていただいたサイトは、職場のアクセス制限で見れませんでした。すみません。

Answer 3

既存のソースをコピーして手を入れたものをテストすれば良いのでは？

Comments

[ttyp03]

本番に使われているソースそのものをテストしたいので、少しでも手を入れてしまうと別物扱いになるので却下です。
あと既存ソースが修正された場合、コピーして、テスト用のコードを入れて、と二度手間になってしまいますし。

[Zuishin]

別物にならないよう工夫はいくらでもできると思いますが、どっちの手間が上ですかね

[ttyp03]

当然既存のコードを変更しないように手を入れることになりますが、既存コード＋テストコードという構成になる以上、別物と言わざるを得ないと思います。考え方次第ではありますが。
手を入れた場合、既存のソースと相違ないということを客先に証明しないといけないという手間もありますし、例えば1000本あるソースに対してそれをやる手間を考えると、やはりこの案は（私の環境では）採用できません。

[Zuishin]

了解しました。自社のソースを改良することもできない環境なのですね。大変でしょう。同情します。

[ttyp03]

自社ではないですよ。なので尚更気を使います。

[Zuishin]

どちらにしても大変ですね。ご自愛ください。
私はもう少し自由がきくもので、その感覚で言ってしまいました。

Answer 4

「まったく既存のコードを編集せずに」ということであれば、おそらく不可能かと思います。

下請けになっている関数が外部結合を持つ場合（staticでない場合）、プログラム全体で同じ識別子を持った関数が2つ以上現れると、それは未定義の動作ということになります（むろん、コンパイラやリンカの指定でどうにかできる処理系が、ひょっとしたらあるかもしれませんが）。つまり、関数定義は1つだけしか書けなく、そのまま使う以外に選択肢はありません。

逆にstaticな関数の場合も、外部からはどうしようもありませんし、それどころかコンパイル時にインライン展開されて関数ごと雲散霧消しているかもしれません。

Comments

[ttyp03]

同一プログラム内に同じ関数定義が存在できないのは承知です。
その一つの解として以前はマクロで置き換えるということで逃げたのですが、既存ソースを書き換えなくてもどうにかできたらと考えてます。

staticな関数については、テスト対象のソースをテストコードのソースにインクルードする方法で解決しました。

#include "test.c"
void testcode()
{
test();
}