引数不足の例外を捕捉できない

Question

my_add_return_int() という（自作の PHP Extension の中にある）関数
のテストを行っています。正常系は通りますが、引数が足りない場合の例外を
捕捉できません。

vagrant:~/php/ext/my_ext$ cat /usr/local/lib/php.ini
extension=/home/vagrant/php/ext/my_ext/modules/my_ext.so

vagrant:~/php/ext/my_ext$ cat tests/MyAddReturnIntTest.php
<?php

use PHPUnit\Framework\TestCase;

class MyAddReturnIntTest extends TestCase
{
  public function test3plus4returns7()
  {
    $ret = my_add_return_int(3, 4);
    $this->assertEquals(7, $ret);
  }

  /**
    * @expectedException InvalidArgumentException
    */
  public function testLackOfParameter()
  {
    $ret = my_add_return_int(3);
  }
}

vagrant:~/php/ext/my_ext$ php -v
PHP 7.1.5 (cli) (built: Jun  7 2017 09:13:29) ( NTS DEBUG )
Copyright (c) 1997-2017 The PHP Group
Zend Engine v3.1.0, Copyright (c) 1998-2017 Zend Technologies

vagrant:~/php/ext/my_ext$ phpunit tests/MyAddReturnIntTest.php
PHPUnit 6.2.1 by Sebastian Bergmann and contributors.

.E                                                                  2 / 2 (100%)

Time: 133 ms, Memory: 10.00MB

There was 1 error:

1) MyAddReturnIntTest::testLackOfParameter
Wrong parameter count for my_add_return_int()

/usr/local/src/php-7.1.5/ext/my_ext/tests/MyAddReturnIntTest.php:18

ERRORS!
Tests: 2, Assertions: 1, Errors: 1.

@expectedException を
$this->expectException(InvalidArgumentException::class);
に書き換えても同じエラーでした。試しに error_reporting() を入れてみると

  /**
    * @expectedException InvalidArgumentException
    */
  public function testLackOfParameter()
  {
    error_reporting(E_ERROR);
    $this->expectException(InvalidArgumentException::class);
    $ret = my_add_return_int(3);
  }

1) MyAddReturnIntTest::testLackOfParameter
Failed asserting that exception of type "InvalidArgumentException" is thrown.

となります。

無理やり RuntimeException に変換すれば補足できるのですが、PHPUnit のドキュメントの
記述と齟齬がある気がして、今ひとつ納得がいきません。ご教示をお願いします。

<?php

use PHPUnit\Framework\TestCase;

class MyAddReturnIntTest extends TestCase
{
  public static function setUpBeforeClass() {
    set_error_handler(function($errno, $errstr, $errfile, $errline) {
      throw new RuntimeException($errstr . " on line "
        . $errline . " in file " . $errfile);
    });
  }

  /**
    * @expectedException RuntimeException
    */
  public function testLackOfParameter()
  {
    error_reporting(E_ERROR);
    $ret = my_add_return_int(3);
  }
}

vagrant:~/php/ext/my_ext$ phpunit tests/MyAddReturnIntTest.php
PHPUnit 6.2.1 by Sebastian Bergmann and contributors.

..                                                                  2 / 2 (100%)

Time: 122 ms, Memory: 10.00MB

OK (2 tests, 2 assertions)

Answer 1

引数不足はE_WARNINGを返すので捕まえたければ以下のような感じでしょうか？

set_error_handler('myErrorHandler');
function myErrorHandler($errno, $errstr, $errfile, $errline)
{
  switch($errno) {
  case E_WARNING:
    throw new exception("I got warning:".$errstr."<br>");
    break;
  case E_USER_WARNING:
    throw new exception("My warning:".$errstr."<br>");
    break;
  default:
    return false;
  }
  return true;
}

try{
  print test(10);
}catch(exception $e){
  print $e->getMessage();
}

function test($a,$b){
  return $a*$b;
}

エラーが発生する前に事前にテストをする場合は
call_user_func_arrayなどで引数を渡すように変更し
(new ReflectionFunction("test"))->getNumberOfParameters()のようにして
必要な引数の数を数えておく手もあります。

もちろんエラーを出したくないだけであれば引数に初期値を与えておくだけでもいいでしょう

function test($a=0,$b=0){
  return $a*$b;
}
print test(100);//エラーにならない

Comments

[hotta]

質問の趣旨としては、このようなケースに対応できるような、
PHPUnit のテストケースを書きたいということでした。

http://php.net/manual/ja/language.errors.php7.php

ちなみに PHP7 からエラーの扱いが変わっており、ご提示いただいた
コードだと、以下のようになるようです。

Fatal error: Uncaught ArgumentCountError: Too few arguments to function test(), 1 passed in /home/vagrant/temp/e.php on line 23 and exactly 2 expected in /home/vagrant/temp/e.php:28
Stack trace:
#0 /home/vagrant/temp/e.php(23): test(10)
#1 {main}
thrown in /home/vagrant/temp/e.php on line 28

[yambejp]

それは失礼しました
PHP7は互換の絡みがあって導入していませんでした
追加でお知らせできそうなことがあればまた追記するようにします

Answer 2

【自己解決しました】
PHPUnit だけではできなかったのですが、
https://github.com/VladaHejda/PhpUnitAssertException
というのを見つけました。これを入れて、テストコードを以下のようにしたら通りました。

<?php

use PHPUnit\Framework\TestCase;
require_once '/home/vagrant/PhpUnitAssertException/src/AssertException.php';

function my_app_takes_two_args(int $a, int $b): int {
  return $a + $b;
}

class MyAddReturnIntTest extends TestCase
{
  use VladaHejda\AssertException;

  public function testLackOfParameter()
  {
    $test = function () {
      my_app_takes_two_args(3);
    };

    $this->assertError($test, ArgumentCountError::class);
  }
}

注意事項として、当該 trait は mbstring に依存します。mbstring が入ってないと、

Error: Call to undefined function mb_strpos()

というエラーになりました。

Comments

[hotta]

スミマセン。まだ不完全でした。

php で定義された関数であれば、上記の方法でうまく捕獲できます。
ただ本来の質問である、「PHP Extension 内で定義された関数」だと、返ってくるエラーのレベルが異なるようです。

ためしに、上記のテストで "strlen()" など C レベルで定義されている関数を指定した場合、"Failed asserting the class of a Throwable..." となります。もう少し調べてみます。