はじめに
テストを書いていると、一時的に関数の挙動を書き換えたいときがあります。
time()がハードコードされている関数をデバッグしたい時や、稀にしか失敗しないAPIの失敗をエミュレーションしたい時などです。これらはテストの自動化の妨げになっていました。
拙作のSEXYHOOKを利用すると、一時的に関数の挙動を書き換え、失敗を返すことが可能になります。
本稿では、SEXYHOOKの使い方について説明します。
対象読者
- C++でソフトの開発を行い、テストを書きたいエンジニア
SEXYHOOKはC++で使うことを想定しています。
必要な環境
- Windows
- Linux
Microsoft Visual C++ 6/2003/2005/2008
GCC 4.x(推奨) / 3.x
現状では32bitバージョンのみのサポートになります。SEXYHOOKはデバッグビルドのみで利用できます。
SEXYHOOK本体
ご自由にご利用ください。
コンパイルオプションの注意
Microsoft Visual C++ 6~2003
このバージョンには、__LINE__の展開バグがあるため、デバッグ情報に標準のエディットコンティニュ(/ZI)オプションが利用できません。
エディットコンティニュ(/ZI)オプションの代わりにプログラムデータベースを使用(/Zi)オプションを指定してください。
詳しくは、マイクロソフトのナレッジをご覧ください。
gcc
デバッグビルド、最適化なしで実行してください。
-g -O0
ソースコードはSJISで記述しているため、--input-charset=cp932オプションを推奨します。
テストと接合部
この関数は2000年以上だったらtrue、それ以前だったらfalseを返す関数です。
//2000年以上か? bool isOver2000year() { //現在なら間違いなく true. これを falseにするには? return time(NULL) >= 946652400; //2000-01-01 00:00:00 }
現在は2000年以降なので、isOver2000year関数を動かしてみるとtrueを必ず返します。確かに仕様どおりなのですが、テストを行う以上、isOver2000year関数がfalseを返すところを確かめないといけません。
isOver2000year関数は、残念なことに関数内にtime関数をハードコードしています。そのため、isOver2000year関数がfalseを返すことを確認するには、PCの時計を1999年などの昔に戻し、関数を実行しなくてはいけません。
毎回PCの時計を戻すなどの作業を行うのは手間です。手作業が発生するため、自動テストを構築することもできません。ここで、一時的にtime関数をフックして、昔の時刻を返すことができないかと考えました。もし、time関数が現在は1999年だと答えさせることができれば、isOver2000year関数がfalseを返すところを確認できます。
そこでSEXYHOOKの出番です。SEXYHOOKを利用すれば、関数、API、クラスメソッドなどの挙動を一時的に書き換えることができます。