|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Nikoms\PhpUnit\Printer; |
|
4
|
|
|
|
|
5
|
|
|
use Doctrine\Common\Annotations\AnnotationReader; |
|
6
|
|
|
use Nikoms\PhpUnit\Annotation\Arrange; |
|
7
|
|
|
use Nikoms\PhpUnit\AnnotationReaderFactory; |
|
8
|
|
|
use Nikoms\PhpUnit\Listener\ArrangeListener; |
|
9
|
|
|
use PHPUnit_Framework_Test; |
|
10
|
|
|
|
|
11
|
|
|
/** |
|
12
|
|
|
* Class ArrangeResultPrinter |
|
13
|
|
|
* @package Nikoms\PhpUnit\Printer |
|
14
|
|
|
*/ |
|
15
|
|
|
class ArrangeResultPrinter extends \PHPUnit_Util_TestDox_ResultPrinter_Text |
|
16
|
|
|
{ |
|
17
|
|
|
/** |
|
18
|
|
|
* @param \PHPUnit_Framework_Test | \PHPUnit_Framework_TestCase $test |
|
19
|
|
|
*/ |
|
20
|
|
|
public function startTest(PHPUnit_Framework_Test $test) |
|
21
|
|
|
{ |
|
22
|
|
|
parent::startTest($test); |
|
23
|
|
|
if ($this->currentTestMethodPrettified == null || empty(ArrangeListener::$inputs[$test->getName(true)])) { |
|
|
|
|
|
|
24
|
|
|
return; |
|
25
|
|
|
} |
|
26
|
|
|
|
|
27
|
|
|
$arranges = $this->getArrangeLines($test); |
|
|
|
|
|
|
28
|
|
|
$arrangeText = $this->getArrangeText($arranges); |
|
29
|
|
|
$this->currentTestMethodPrettified = $arrangeText.$this->currentTestMethodPrettified; |
|
30
|
|
|
} |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* @param array $arranges |
|
34
|
|
|
* @return string |
|
35
|
|
|
*/ |
|
36
|
|
|
private function getArrangeText(array $arranges) |
|
37
|
|
|
{ |
|
38
|
|
|
$arrangeText = ''; |
|
39
|
|
|
$tab = ' '; |
|
40
|
|
|
if (!empty($arranges)) { |
|
41
|
|
|
$arrangeText = 'When ' |
|
42
|
|
|
.implode(PHP_EOL.$tab.'And ', $arranges) |
|
43
|
|
|
.PHP_EOL |
|
44
|
|
|
.$tab |
|
45
|
|
|
.'Then '; |
|
46
|
|
|
|
|
47
|
|
|
return $arrangeText; |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
return $arrangeText; |
|
51
|
|
|
} |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* @param \PHPUnit_Framework_TestCase $test |
|
55
|
|
|
* @return array |
|
56
|
|
|
*/ |
|
57
|
|
|
private function getArrangeLines(\PHPUnit_Framework_TestCase $test) |
|
58
|
|
|
{ |
|
59
|
|
|
$arranges = []; |
|
60
|
|
|
$annotationReader = AnnotationReaderFactory::getAnnotationReader(); |
|
61
|
|
|
|
|
62
|
|
|
foreach (ArrangeListener::$inputs[$test->getName(true)] as $i => $arrangeMethods) { |
|
63
|
|
|
foreach ($arrangeMethods as $arrangeMethod => $arguments) { |
|
64
|
|
|
try { |
|
65
|
|
|
$describe = $this->getArrangeDescription($test, $annotationReader, $arrangeMethod); |
|
66
|
|
|
$arranges[] = $this->getArrangeLine($describe, $arguments); |
|
67
|
|
|
} catch (\DomainException $ex) { |
|
68
|
|
|
continue; |
|
69
|
|
|
} |
|
70
|
|
|
} |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
|
|
return $arranges; |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* @param PHPUnit_Framework_Test $test |
|
78
|
|
|
* @param AnnotationReader $annotationReader |
|
79
|
|
|
* @param string $arrangeMethod |
|
80
|
|
|
* @return string |
|
81
|
|
|
*/ |
|
82
|
|
|
private function getArrangeDescription( |
|
83
|
|
|
PHPUnit_Framework_Test $test, |
|
84
|
|
|
AnnotationReader $annotationReader, |
|
85
|
|
|
$arrangeMethod |
|
86
|
|
|
) { |
|
87
|
|
|
$arrangeMethodAnnotation = $annotationReader->getMethodAnnotation( |
|
88
|
|
|
new \ReflectionMethod($test, $arrangeMethod), |
|
89
|
|
|
Arrange::class |
|
90
|
|
|
); |
|
91
|
|
|
if ($arrangeMethodAnnotation === null) { |
|
92
|
|
|
throw new \DomainException('The arrange method does not have an annotation itself'); |
|
93
|
|
|
} |
|
94
|
|
|
|
|
95
|
|
|
return $arrangeMethodAnnotation->getMethods()['describe']; |
|
96
|
|
|
} |
|
97
|
|
|
|
|
98
|
|
|
/** |
|
99
|
|
|
* @param string $describe |
|
100
|
|
|
* @param array $arguments |
|
101
|
|
|
* @return array |
|
102
|
|
|
*/ |
|
103
|
|
|
private function getArrangeLine($describe, array $arguments) |
|
104
|
|
|
{ |
|
105
|
|
|
return call_user_func_array( |
|
106
|
|
|
'sprintf', |
|
107
|
|
|
array_merge( |
|
108
|
|
|
[$describe], |
|
109
|
|
|
$this->getArgumentsAsString($arguments) |
|
110
|
|
|
) |
|
111
|
|
|
) |
|
112
|
|
|
.','; |
|
113
|
|
|
} |
|
114
|
|
|
|
|
115
|
|
|
/** |
|
116
|
|
|
* @param array $arguments |
|
117
|
|
|
* @return array |
|
118
|
|
|
*/ |
|
119
|
|
|
private function getArgumentsAsString(array $arguments) |
|
120
|
|
|
{ |
|
121
|
|
|
return array_map( |
|
122
|
|
|
function ($argument) { |
|
123
|
|
|
if (is_object($argument)) { |
|
124
|
|
|
$fullClassName = get_class($argument); |
|
125
|
|
|
|
|
126
|
|
|
return 'the '.strtolower(substr($fullClassName, strrpos($fullClassName, '\\') + 1)); |
|
127
|
|
|
} |
|
128
|
|
|
|
|
129
|
|
|
return $argument; |
|
130
|
|
|
}, |
|
131
|
|
|
$arguments |
|
132
|
|
|
); |
|
133
|
|
|
} |
|
134
|
|
|
} |
Nikoms /
phpunit-arrange
Loading history...
Let’s take a look at an example:
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.
Available Fixes
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the interface: