clang: テストフレームワーク fff
概要
C言語のテストフレームワーク fff を紹介する。
fff.hを見ると分かるが、
引数の数が異なるマクロがたくさんある。
そうすることでよほど引数が多い関数でなければ fake 関数に置き換えることができる。
簡単なサンプル
最近のサンプル(2023年)
2025/07/08時点で fff の最新版は 2023年5月である。
それに合わせて更新した fff の使用例である。
下にある 2021年版をビルドが通るように更新しただけなので見栄えはよろしくない。
$ make test
./build/tst
Running main() from /home/xxx/fff_examples/tests/fff/build/_deps/googletest-src/googletest/src/gtest_main.cc
[==========] Running 9 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 9 tests from test
[ RUN ] test.open_1
[ OK ] test.open_1 (0 ms)
[ RUN ] test.open_2
[ OK ] test.open_2 (0 ms)
[ RUN ] test.open_3
[ OK ] test.open_3 (0 ms)
[ RUN ] test.close_1
[ OK ] test.close_1 (0 ms)
[ RUN ] test.close_2
[ OK ] test.close_2 (0 ms)
[ RUN ] test.access_1
[ OK ] test.access_1 (0 ms)
[ RUN ] test.access_2
[ OK ] test.access_2 (0 ms)
[ RUN ] test.access_3
[ OK ] test.access_3 (0 ms)
[ RUN ] test.access_4
[ OK ] test.access_4 (0 ms)
[----------] 9 tests from test (0 ms total)
[----------] Global test environment tear-down
[==========] 9 tests from 1 test suite ran. (0 ms total)
[ PASSED ] 9 tests.
fff は CMakeを使うようになっているのだが、私が対応できていないのでそのままだ。
gtest のヘッダファイルやライブラリもfindでファイルを探したくらいなのでちゃんとしたやり方ではないだろう。
古いサンプル
こちらは2021年に私が作っていた fff の使用例である。
fff はインストールするタイプではなく fff.h をインクルードして使うので、プロジェクトの中に fff を取り込んでいる。
今思えば git modules で取り込めばよかったと思う。
当時の fff はこのような構成で、gtest が直接入っていた。
fake の使い方
同じスタブを複数のテストで使いたい
同じスタブが複数のテストファイルで使いたくなることがある。
そういう場合は、テストファイルの中に FAKE_VALUE_FUNC() を書かず、スタブだけをまとめたファイルを作るとよい。
その場合、まとめたソースファイルの方には DEFINE_FAKE_VALUE_FUNC() を、そのヘッダファイルには DECLARE_FAKE_VALUE_FUNC() を書く。
マクロ名以外はどちらも同じで良い。
そしてテストファイルはそのヘッダファイルを include する。
ついでに RESET_FAKE() などをまとめて呼び出す関数も作っておき、各テストファイルの Setup() で呼び出すようにすると良い。
自作の関数も別ファイルの関数はスタブにしたい
これもよくあることだが、自作の関数をテストしているとき、そのテストがまた別のファイルの自作関数を呼び出すことがある。
そうすると、別ファイルの自作関数もスタブにしたくなるだろう。
いろいろやったのだが、テストファイルを 1つずつ別の実行ファイルのするのがよい。
fff のサンプルもそうなっていたし、たぶんそうするしかないのだろう。
前節のようにスタブを別ファイルにするのがよいだろう。
そのとき、GCC 限定ではあるが FFF_GCC_FUNCTION_ATTRIBUTES を設定して weak にしておくのがよい。
コンパイルオプションだと -DFFF_GCC_FUNCTION_ATTRIBUTES="__attribute__((weak))" のような感じだ。
そして、スタブは staticライブラリとして ar コマンドでまとめておきテスト関数とリンクするようにすると良いだろう。
そうしておくと、ライブラリにあるスタブは weak なものとして扱われるので、テスト関数に同じ関数がなければスタブの方が有効になる。
テスト関数に本体があればそちらが使われてスタブは無視される。
weak については Weak Functions を参照しよう。
オライリー社の Binary Hack(最初に出た方)にも載っていた。
