PHP Unitで、パーシャルモックしたメソッドを実行するとエラーになります。

Question

いつもお世話になっております。
PHP Unitでモックオブジェクト作成し、モックしたメソッドを呼び出すと、
PHPUnit_Framework_MockObject_BadMethodCallException:
となり、テストが失敗してしまいます。

実行環境と実際のコードを以下に添付しますので、
どなたかご教授いただけますか?

<実行環境>

• PHP:5.5(古いですね(笑))
• PHPUnitのversion:4.8.21(こちらも古い...)

<コード(抜粋)>
以下になります。
質問内容とは関係ありませんが、ユーザの課金情報をロギングする機能に対するテストになります。

<?php

//1.テスト対象のコードは、以下になります

class SocialApiUtil{
  /**
   * KPI算出用に、ユーザの課金情報をロギングする
   */
  public function loggingPaymentInfoForKpi(array $paymentInfo,$logUtil)
  {
    //...
    
    //ロギング用のメソッドです。以下2つを引数に取ります。
    //1.ロギングする際のタイトル情報(課金についてのログ、ログインについてのログetc...)
    //2.ロギングしたい変数
    $logUtil->kpiLogger(
      'yamada_purchase_amount',
      array(
        'use_paid_coin' => $paymentInfo['use_coin'],
        'use_free_coin' => $paymentInfo['use_free_coin']
      ));

    return true;
  }
}


//2.ユニットテストのコードは、以下です

class SocialApiUtilTest extends PHPUnit_Framework_TestCase{
  /**
   * データプロバイダ
   * @dataProvider loggingPaymentInfoForKpiProvider
   */
  public function loggingPaymentInfoForKpiProvider()
  {

    $paymentInfo = array(
      'use_coin'       => 0,
      'use_free_coin'  => 100,
    );

    //ここで、ロギング用オブジェクトのモックを作ります。
    //with($this->anything())としているので、上手くいくように思えるのですが、
    //呼び出すとPHPUnit_Framework_MockObject_BadMethodCallException が発生します...
    $logUtil = $this->getMockBuilder('LogUtil')->disableOriginalConstructor()->getMock();
    $logUtil->expects($this->any())->method('kpiLogger')->with($this->anything())->will($this->returnValue(true));

    return array(
      '正常ケース' => array($paymentInfo,$logUtil,true),
      '引数が不正' => array(array(),$logUtil,false),
    );
  }

  /**
   * 課金情報のロギングのテスト
   * @dataProvider loggingPaymentInfoForKpiProvider
   */
  public function testLoggingPaymentInfoForKpiProvider($paymentInfo,$logUtil,$expectedRet)
  {
    $actualRet = $this->apiUtil->loggingPaymentInfoForKpi($paymentInfo,$logUtil);
    $this->assertSame($expectedRet ,$actualRet);
  }
}

以上になります。PHPUnit使ってると、色々苦労すること多いですね^^;
mockeryが使いやすいと聞いたので、ちょっと試してみようかなーと思ってます。

それでは、ご回答よろしくお願いします！

Answer 1

LogUtilクラスが見えてないのではないでしょうか。必要なファイルをrequire_onceとかしてみてください。モックを作るときに元のクラス定義をreflectionで参照していろいろ用意するのですが、指定された名前のクラスが存在しないときはメソッドのない空のクラスを仮に定義するようになっていますので上記のようなことになると思われます。

Comments

[th1209]

crhgさん

ご回答いただきありがとうございます。
こちら、Test側の処理でLogUtilクラスのメソッドを読んでみたところ、
うまく呼び出せました。なので、Test側から対象クラスが見えていないということは無さそうです。

ngyukiさんにご回答いただいた、
メソッドがstaticであるのが原因だったようです。

PHP Unitでは対処できないので、
別の方法で何とかしてみようかなと思います。

ご回答いただき、ありがとうございました！

Answer 2

LogUtil::kpiLogger が static メソッドなのではないでしょうか？

static メソッドをモックして呼ぶと PHPUnit_Framework_MockObject_BadMethodCallException になります。

<?php
class Hoge
{
    public static function func($val) {}
}

class HogeTest extends PHPUnit_Framework_TestCase
{
    public function test()
    {
        $obj = $this->getMockBuilder(Hoge::class)->getMock();
        $obj->expects($this->any())->method('func')->with($this->anything())->will($this->returnValue(true));
        $this->assertTrue($obj->func(123));
    }
}

1) HogeTest::test
PHPUnit_Framework_MockObject_BadMethodCallException:

少し古い PHPUnit だと PHPUnit_Framework_MockObject_BadMethodCallException にはならないのですが、その場合でも expects ではモックにできません。
かわりに staticExpects を使うことが出来たのですが、最近の PHPUnit には staticExpects はありません。

http://qiita.com/ngyuki/items/ca43aaa1a728f48c8cde

Comments

[th1209]

ngyukiさん

ご回答頂きありがとうございます。
ご指摘いただいた通り、staticなメソッドでした...!

PHP Unitではstaticメソッドのモックができないはずなので、
(確か、数年前に機能廃止している)
別の方法を取るよう検討してみます。

ご回答いただき、ありがとうございました！