phpstan phpunit

PHPStan PHPUnit の拡張機能とルール

• PHPStan

• PHPUユニット

この拡張機能は次の機能を提供します。

• createMock() 、 getMockForAbstractClass() 、およびgetMockFromWsdl()メソッドは、モック オブジェクトとモックされたクラスの交差タイプ (交差タイプの詳細な説明を参照) を返すため、モック オブジェクト ( expectsなど) とモック クラスの両方のメソッドが実行されます。オブジェクト上で利用可能です。

• MockBuilderで呼び出されるgetMock()もサポートされています。

• phpDoc 内のFoo|PHPUnit_Framework_MockObject_MockObjectを解釈して、結果が共用体型ではなく交差型になります。

• 未定義変数エラーを防ぐために、 PHPUnitFrameworkTestCaseクラスの早期終了メソッド呼び出しを定義します。

• assertInstanceOf 、 assertTrue 、 assertInternalTypeなどのさまざまなassertメソッドに渡される式のタイプを指定します。

• PHPStan のレベル 4 と組み合わせると、 assertTrue(true)などの常に true と常に false のアサートを指摘します。

これには、次の厳密なフレームワーク固有のルールも含まれています (個別に有効にすることができます)。

• 期待値としてtrueを指定してassertSame()使用していないことを確認してください。代わりにassertTrue()使用する必要があります。

• 期待値としてfalseを指定してassertSame()使用していないことを確認してください。代わりにassertFalse()使用する必要があります。

• 期待値としてnullを指定してassertSame()使用していないことを確認してください。代わりにassertNull()使用する必要があります。

• 2 番目のパラメータとしてcount($variable)を指定してassertSame()使用していないことを確認してください。代わりにassertCount($variable)使用する必要があります。

phpDocs でモック オブジェクトを文書化するにはどうすればよいですか?

モックをプロパティに割り当てた後、またはメソッドから返した後でもモックを構成する必要がある場合は、 PHPUnit_Framework_MockObject_MockObject phpDoc に追加する必要があります。

 /** * @return Foo&PHPUnit_Framework_MockObject_MockObject */private function createFooMock()
{ return $this->createMock(Foo::class);
}パブリック関数testSomething()
{ $fooMock = $this->createFooMock(); $fooMock->method('doFoo')->will($this->returnValue('test')); $fooMock->doFoo();
}

交差タイプの正しい構文はFoo&PHPUnit_Framework_MockObject_MockObjectであることに注意してください。 Foo|PHPUnit_Framework_MockObject_MockObjectもサポートされていますが、これはエコシステムと従来の理由からのみです。

モックが完全に構成されており、モックされたクラスのメソッドのみが値に対して呼び出されることになっている場合は、モックされたクラスのみをタイプヒントしても問題ありません。

 /** @var Foo */private $foo;保護された関数 setUp()
{ $fooMock = $this->createMock(Foo::class); $fooMock->method('doFoo')->will($this->returnValue('test')); $this->foo = $fooMock;
}パブリック関数testSomething()
{ $this->foo->doFoo(); // $this->foo->method() と Expects() は呼び出せなくなります}

インストール

この拡張機能を使用するには、Composer でそれを要求します。

composer require --dev phpstan/phpstan-phpunit

phpstan/extension-installer もインストールすれば準備完了です。

手動インストール

phpstan/extension-installer使用したくない場合は、プロジェクトの PHPStan 構成に extension.neon を含めます。

includes:
    - vendor/phpstan/phpstan-phpunit/extension.neon

フレームワーク固有のチェックを実行するには、次のファイルも含めます。

    - vendor/phpstan/phpstan-phpunit/rules.neon