私は主にPHPで開発を行っており、ユニットテストも書いています。
クラスのスタティックメソッドをモック化する必要に迫られたのですが、そこでたどり着いたのが『Mockery』の存在。
＜参照：GitHub『Mockery』＞
GitHub内に記載されたドキュメントを見る限りでは、スタティックメソッドのモック化もできるとのこと。
まさに私の現在のニーズにピッタリ！ ……ということで、さっそく使ってみることにしました。
『Mockery』の良さそうなところ
使う前ではありますが、『Mockery』の期待できそうな点が以下の通り。
- スタティックメソッドがモック化できる（今回の最大の目的！）
- テスト対象のメソッド内でnewされるクラスもモックにできる
- シンプルな記述で簡単に使えそう（何気に重要！）
期待値ばかりが異様に高まってしまいましたが、さっそくインストールしてみましょう。
インストール方法はいくつかあるようですが、Composerでさくっと実行しちゃいましょう。
「composer.json」に下記を追加し、「composer update」でインストール。
|
1 2 3 |
"require-dev": { "mockery/mockery": "dev-master" } |
※「PHPUnit」は既にインストール済みの環境
あとは、テストファイルでRequireするなり、ComposerのAutoloadを使うなりして読み込んでしまえば準備完了です。
さっそく『Mockery』を使ってみた
今回の目的である、クラスメソッド中の「MathClass」のスタティックメソッドでインスタンスを取得しています。
さっそくこれをモック化するテストコードを書いてみましょう。
|
1 2 3 4 5 6 7 8 |
class Hoge { public function add($x, $y) { $math = MathClass::getInstance(); return $math->add($x, $y); } } |
下記のテストコードでモック化できて、テストも通りました！
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
class HogeTest extends \Mockery\Adapter\Phpunit\MockeryTestCase { public function testAdd() { //モックに名前をつけられます。 $mockMathClass = \Mockery::mock('mockMathClass'); //モックのaddメソッドが呼ばれたら3を返すようにします。 $mockMathClass->shouldReceive('add')->andReturn(3); //MathClassのaliasモックを作ります。 $mock = \Mockery::mock('alias:MathClass'); //MathClass::getInstaneceが呼ばれたらmockMathClassを返します。 $mock->shouldReceive('getInstance')->andReturn($mockMathClass); $hoge = new Hoge(); //テストしてみます $this->assertEquals(3, $hoge->add(1, 2)); } } |
思いの外、カンタンにできてしまいました。
では、ついでにPHP組み込み関数のdate関数を利用したクラスもテストしてみましょう。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
namespace Hoge; class HogeGreet { public funtion say() { $hour = date('H'); if ($hour > 0 && $hour <10) { return 'おはよう'; } else if ($hour >= 10 && $hour < 17) { return 'こんにちは'; } else { return 'こんばんは'; } } } |
これはちょっとひねりが必要でしたね。
このような組み込み関数をモック化する場合は、現在の名前空間で組み込み関数名と同名の関数を定義してから上書きすることで、モックと置き換えることができるようです。
なお、名前空間が設定されていない場合は、この方法は使えませんでした……。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
namespace Hoge; function date($param) { return HogeGreetTest::$func->date($param); } class HogeGreetTest extends \Mockery\Adapter\Phpunit\MockeryTestCase { public static $func; public function setUp() { self::$func = \Mockery::mock('mockDate'); } public function testSay() { //パラメータに'H'が渡されたら、コール順に7、14、20を返す。 self::$func->shouldReceive('date')->with('H')->andReturn(7,14,20); $hogeGreet = new HogeGreet(); //テストしてみます $this->assertEquals('おはよう', $hogeGreet->say()); // 7時 $this->assertEquals('こんにちは', $hogeGreet->say()); // 14時 $this->assertEquals('こんばんは', $hogeGreet->say()); // 20時 } } |
『Mockery』を使ってみた感想
『Mockery』には他にも便利な機能を備えているようです。
一部のメソッドをモック化するパーシャルモック機能、引数のバリデート等、ユニットテストを行うための便利機能……などなど。
とても使いやすいモッキングフレームワークですね。
私と同じニーズでお悩みの方はもちろんのこと、今後役立ちそうと感じた方は、ぜひお試しくださいね！
コメント