PHPUnit のモックオブジェクトの使い方を仕組みから理解する

├── Builder
│   ├── Identity.php
│   ├── InvocationMocker.php
│   ├── Match.php
│   ├── MethodNameMatch.php
│   ├── Namespace.php
│   ├── ParametersMatch.php
│   └── Stub.php
├── Exception
│   ├── BadMethodCallException.php
│   ├── Exception.php
│   └── RuntimeException.php
├── Generator
│   ├── deprecation.tpl.dist
│   ├── 省略...
├── Generator.php
├── Invocation
│   ├── Object.php
│   └── Static.php
├── Invocation.php
├── InvocationMocker.php
├── Invokable.php
├── Matcher
│   ├── AnyInvokedCount.php
│   ├── AnyParameters.php
│   ├── ConsecutiveParameters.php
│   ├── Invocation.php
│   ├── InvokedAtIndex.php
│   ├── InvokedAtLeastCount.php
│   ├── InvokedAtLeastOnce.php
│   ├── InvokedAtMostCount.php
│   ├── InvokedCount.php
│   ├── InvokedRecorder.php
│   ├── MethodName.php
│   ├── Parameters.php
│   └── StatelessInvocation.php
├── Matcher.php
├── MockBuilder.php
├── MockObject.php
├── Stub
│   ├── ConsecutiveCalls.php
│   ├── Exception.php
│   ├── MatcherCollection.php
│   ├── Return.php
│   ├── ReturnArgument.php
│   ├── ReturnCallback.php
│   ├── ReturnReference.php
│   ├── ReturnSelf.php
│   └── ReturnValueMap.php
├── Stub.php
└── Verifiable.php

protected function createMock($originalClassName)
{
	return $this->getMockBuilder($originalClassName)
	->disableOriginalConstructor()
	->disableOriginalClone()
	->disableArgumentCloning()
	->disallowMockingUnknownTypes()
	->getMock();
}

protected function createPartialMock($originalClassName, array $methods)
{
	return $this->getMockBuilder($originalClassName)
	->disableOriginalConstructor()
	->disableOriginalClone()
	->disableArgumentCloning()
	->disallowMockingUnknownTypes()
	->setMethods(empty($methods) ? null : $methods)
	->getMock();
}

protected function createConfiguredMock($originalClassName, array $configuration)
{
	$o = $this->createMock($originalClassName);
	foreach ($configuration as $method => $return) {
	$o->method($method)->willReturn($return);
	}
	return $o;
}

class Example {
	private $total = 0;
	private static $static_total = 1;

	public function __construct() {
		$this->total = 1;
		self::$static_total = 2;
	}

	public function plusA() {
		return $this->total += 1;
	}

	public function plusB() {
		$this->total = $this->getTotal();
		return $this->total += 1;
	}
	
	public function plusC() {
		$this->setTotal(10);
		return $this->total += 1;
	}
	
	private function plusD() {
		return $this->total += 1;
	}

	public function getTotal() {
		return $this->total;
	}
	
	public function setTotal($total) {
		$this->total = $total;
	}
	
	public static function getStaticTotal() {
		return self::$static_total;
	}
}

/**
* 全メソッド握りつぶす
*
* 引数：クラスのみ
* コンストラクタ：呼ばれない
*/
public function test_createMock_all() {
	$this->example = $this->createMock(Example::class);
	$result = $this->example->plusA();
	$this->assertNull($result);
	$result = $this->example->plusB();
	$this->assertNull($result);
	$result = $this->example->plusC();
	$this->assertNull($result);
}

/**
* 全メソッド握りつぶす
* plusAだけに振る舞い設定
*
* 引数：クラスのみ
* コンストラクタ：呼ばれない
*/
public function test_createMock_all_stub() {
	$this->example = $this->createMock(Example::class);
	$this->example->expects($this->once())->method('plusA')->willReturn('A');
	$result = $this->example->plusA();
	$this->assertEquals('A', $result);
}

/**
* 一部握りつぶす
*
* 引数：クラスとメソッド
* コンストラクタ：呼ばれない
*/
public function test_createPartialMock_partial() {
	$this->example = $this->createPartialMock(Example::class, ['getTotal']);
	$result = $this->example->plusA();
	$this->assertEquals(1, $result);
	// getTotalは振る舞いを設定していないためnullとなるがエラーにはならない
	$result = $this->example->plusB();
	$this->assertEquals(1, $result);
	$result = $this->example->plusC();
	$this->assertEquals(11, $result);
}

/**
* 一部スタブ化&振る舞い設定
*
* 引数：クラスとメソッド
* コンストラクタ：呼ばれない
*/
public function test_createPartialMock_setStub() {
	$this->example = $this->createPartialMock(Example::class, ['getTotal']);
	$this->example->expects($this->once())->method('getTotal')->willReturn(3);
	$result = $this->example->plusA();
	$this->assertEquals(1, $result);
	$result = $this->example->plusB();
	$this->assertEquals(4, $result);
	$result = $this->example->plusC();
	$this->assertEquals(11, $result);
}

/**
* 一部スタブ化&期待値設定(1 test, 4 assertions)
*
* 引数：クラスとメソッド
* コンストラクタ：呼ばれない
*/
public function test_createPartialMock_setStub2() {
	$this->example = $this->createPartialMock(Example::class, ['setTotal']);
	$this->example->expects($this->once())->method('setTotal')->with(10);
	$result = $this->example->plusA();
	$this->assertEquals(1, $result);
	$result = $this->example->plusA();
	$this->assertEquals(2, $result);
	// setTotalは期待値の設定はあるが振る舞いはないので実行はされない
	$result = $this->example->plusC();
	$this->assertEquals(3, $result);
}

phpunit --bootstrap Bootstrap.php --coverage-html ./report --whitelist src/ test/ExamplePhpUnitMockTest.php