1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<?php declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <sebastian@phpunit.de>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\MockObject;
use function assert;
use function class_exists;
use function interface_exists;
use function md5;
use function mt_rand;
use function substr;
use function trait_exists;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\IgnorePhpunitDeprecations;
use PHPUnit\Framework\Attributes\Medium;
use PHPUnit\Framework\Attributes\TestDox;
use PHPUnit\Framework\MockObject\Generator\CannotUseAddMethodsException;
use PHPUnit\Framework\MockObject\Generator\DuplicateMethodException;
use PHPUnit\Framework\MockObject\Generator\InvalidMethodNameException;
use PHPUnit\Framework\MockObject\Generator\NameAlreadyInUseException;
use PHPUnit\Framework\TestCase;
use PHPUnit\TestFixture\MockObject\AbstractClass;
use PHPUnit\TestFixture\MockObject\ExtendableClass;
use PHPUnit\TestFixture\MockObject\ExtendableClassCallingMethodInConstructor;
use PHPUnit\TestFixture\MockObject\ExtendableClassWithConstructorArguments;
use PHPUnit\TestFixture\MockObject\InterfaceWithReturnTypeDeclaration;
use PHPUnit\TestFixture\MockObject\TraitWithConcreteAndAbstractMethod;
#[CoversClass(MockBuilder::class)]
#[CoversClass(CannotUseAddMethodsException::class)]
#[CoversClass(DuplicateMethodException::class)]
#[CoversClass(InvalidMethodNameException::class)]
#[CoversClass(NameAlreadyInUseException::class)]
#[Group('test-doubles')]
#[Group('test-doubles/creation')]
#[Group('test-doubles/mock-object')]
#[Medium]
final class MockBuilderTest extends TestCase
{
#[TestDox('setMockClassName() can be used to configure the name of the mock object class')]
public function testCanCreateMockObjectWithSpecifiedClassName(): void
{
$className = 'random_' . md5((string) mt_rand());
$double = $this->getMockBuilder(InterfaceWithReturnTypeDeclaration::class)
->setMockClassName($className)
->getMock();
$this->assertSame($className, $double::class);
}
#[TestDox('setMockClassName() cannot be used to configure the name of the mock object class when a class with that name already exists')]
public function testCannotCreateMockObjectWithSpecifiedClassNameWhenClassWithThatNameAlreadyExists(): void
{
$this->expectException(NameAlreadyInUseException::class);
$this->getMockBuilder(InterfaceWithReturnTypeDeclaration::class)
->setMockClassName(__CLASS__)
->getMock();
}
#[TestDox('setConstructorArgs() can be used to configure constructor arguments for a partially mocked class')]
public function testConstructorArgumentsCanBeConfiguredForPartiallyMockedClass(): void
{
$value = 'string';
$double = $this->getMockBuilder(ExtendableClassWithConstructorArguments::class)
->enableOriginalConstructor()
->setConstructorArgs([$value])
->onlyMethods([])
->getMock();
$this->assertSame($value, $double->value());
}
#[IgnorePhpunitDeprecations]
#[TestDox('addMethods() can be used to configure an additional method for the mock object class when the original class does not have a method of the same name')]
public function testCanCreateMockObjectForExtendableClassWhileAddingMethodsToIt(): void
{
$double = $this->getMockBuilder(ExtendableClass::class)
->addMethods(['additionalMethod'])
->getMock();
$value = 'value';
$double->method('additionalMethod')->willReturn($value);
$this->assertSame($value, $double->additionalMethod());
}
#[IgnorePhpunitDeprecations]
#[TestDox('addMethods() cannot be used to configure an additional method for the mock object class when the original class has a method of the same name')]
public function testCannotCreateMockObjectForExtendableClassAddingMethodToItThatItAlreadyHas(): void
{
$this->expectException(CannotUseAddMethodsException::class);
$this->getMockBuilder(ExtendableClass::class)
->addMethods(['doSomething'])
->getMock();
}
#[IgnorePhpunitDeprecations]
#[TestDox('addMethods() cannot be used to configure an additional method for the mock object class multiple times using the same name')]
public function testCannotCreateMockObjectForExtendableClassAddingMultipleMethodsWithSameNameToIt(): void
{
$this->expectException(DuplicateMethodException::class);
$this->getMockBuilder(ExtendableClass::class)
->addMethods(['additionalMethod', 'additionalMethod'])
->getMock();
}
#[IgnorePhpunitDeprecations]
#[TestDox('addMethods() cannot be used to configure an additional method for the mock object class with invalid name')]
public function testCannotCreateMockObjectForExtendableClassAddingMethodToItWithInvalidName(): void
{
$this->expectException(InvalidMethodNameException::class);
$this->getMockBuilder(ExtendableClass::class)
->addMethods(['1234'])
->getMock();
}
#[IgnorePhpunitDeprecations]
#[TestDox('getMockForAbstractClass() can be used to create a mock object for an abstract class')]
public function testCreatesMockObjectForAbstractClassAndAllowsConfigurationOfAbstractMethods(): void
{
$double = $this->getMockBuilder(AbstractClass::class)
->getMockForAbstractClass();
$double->expects($this->once())->method('doSomethingElse')->willReturn(true);
$this->assertTrue($double->doSomething());
}
#[IgnorePhpunitDeprecations]
#[TestDox('getMockForTrait() can be used to create a mock object for a trait')]
public function testCreatesMockObjectForTraitAndAllowsConfigurationOfMethods(): void
{
$double = $this->getMockBuilder(TraitWithConcreteAndAbstractMethod::class)
->getMockForTrait();
$double->method('abstractMethod')->willReturn(true);
$this->assertTrue($double->concreteMethod());
}
#[TestDox('onlyMethods() can be used to configure which methods should be doubled')]
public function testCreatesPartialMockObjectForExtendableClass(): void
{
$double = $this->getMockBuilder(ExtendableClass::class)
->onlyMethods(['doSomethingElse'])
->getMock();
$double->expects($this->once())->method('doSomethingElse')->willReturn(true);
$this->assertTrue($double->doSomething());
}
#[IgnorePhpunitDeprecations]
#[TestDox('allowMockingUnknownTypes() can be used to allow mocking of unknown types')]
public function testCreatesMockObjectForUnknownType(): void
{
$type = 'Type_' . substr(md5((string) mt_rand()), 0, 8);
assert(!class_exists($type) && !interface_exists($type) && !trait_exists($type));
$double = $this->getMockBuilder($type)
->allowMockingUnknownTypes()
->getMock();
$this->assertInstanceOf($type, $double);
$this->assertInstanceOf(MockObject::class, $double);
}
#[IgnorePhpunitDeprecations]
public function testDefaultBehaviourCanBeConfiguredExplicitly(): void
{
$double = $this->getMockBuilder(ExtendableClass::class)
->enableOriginalConstructor()
->enableOriginalClone()
->enableAutoload()
->enableArgumentCloning()
->disableProxyingToOriginalMethods()
->allowMockingUnknownTypes()
->enableAutoReturnValueGeneration()
->getMock();
$this->assertTrue($double->constructorCalled);
}
#[TestDox('Mocked methods can be called from the original constructor of a partially mocked class')]
public function testOnlyMethodCalledInConstructorWorks(): void
{
$double = $this->getMockBuilder(ExtendableClassCallingMethodInConstructor::class)
->onlyMethods(['reset'])
->getMock();
$double->expects($this->once())->method('reset');
$double->second();
}
}
|
