-
Notifications
You must be signed in to change notification settings - Fork 461
/
Container.php
663 lines (554 loc) · 17.6 KB
/
Container.php
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
<?php
/**
* Mockery (https://docs.mockery.io/)
*
* @copyright https://github.com/mockery/mockery/blob/HEAD/COPYRIGHT.md
* @license https://github.com/mockery/mockery/blob/HEAD/LICENSE BSD 3-Clause License
* @link https://github.com/mockery/mockery for the canonical source repository
*/
namespace Mockery;
use Exception as PHPException;
use Mockery;
use Mockery\Exception\InvalidOrderException;
use Mockery\Exception\RuntimeException;
use Mockery\Generator\Generator;
use Mockery\Generator\MockConfigurationBuilder;
use Mockery\Loader\Loader as LoaderInterface;
use ReflectionClass;
use ReflectionException;
use Throwable;
use function array_filter;
use function array_key_exists;
use function array_keys;
use function array_pop;
use function array_shift;
use function array_values;
use function class_exists;
use function count;
use function explode;
use function get_class;
use function interface_exists;
use function is_callable;
use function is_object;
use function is_string;
use function md5;
use function preg_grep;
use function preg_match;
use function range;
use function reset;
use function rtrim;
use function sprintf;
use function str_replace;
use function strlen;
use function strpos;
use function strtolower;
use function substr;
use function trait_exists;
class Container
{
public const BLOCKS = Mockery::BLOCKS;
/**
* Order number of allocation
*
* @var int
*/
protected $_allocatedOrder = 0;
/**
* Current ordered number
*
* @var int
*/
protected $_currentOrder = 0;
/**
* @var Generator
*/
protected $_generator;
/**
* Ordered groups
*
* @var array<string,int>
*/
protected $_groups = [];
/**
* @var LoaderInterface
*/
protected $_loader;
/**
* Store of mock objects
*
* @var array<class-string<LegacyMockInterface&MockInterface>|int,LegacyMockInterface&MockInterface>
*/
protected $_mocks = [];
/**
* @var array<string,string>
*/
protected $_namedMocks = [];
/**
* @var Instantiator
*/
protected $instantiator;
public function __construct(?Generator $generator = null, ?LoaderInterface $loader = null, ?Instantiator $instantiator = null)
{
$this->_generator = $generator instanceof Generator ? $generator : Mockery::getDefaultGenerator();
$this->_loader = $loader instanceof LoaderInterface ? $loader : Mockery::getDefaultLoader();
$this->instantiator = $instantiator instanceof Instantiator ? $instantiator : new Instantiator();
}
/**
* Return a specific remembered mock according to the array index it
* was stored to in this container instance
*
* @template TMock of object
*
* @param class-string<TMock> $reference
*
* @return null|(LegacyMockInterface&MockInterface&TMock)
*/
public function fetchMock($reference)
{
return $this->_mocks[$reference] ?? null;
}
/**
* @return Generator
*/
public function getGenerator()
{
return $this->_generator;
}
/**
* @param string $method
* @param string $parent
*
* @return null|string
*/
public function getKeyOfDemeterMockFor($method, $parent)
{
$keys = array_keys($this->_mocks);
$match = preg_grep('/__demeter_' . md5($parent) . sprintf('_%s$/', $method), $keys);
if ($match === false) {
return null;
}
if ($match === []) {
return null;
}
return array_values($match)[0];
}
/**
* @return LoaderInterface
*/
public function getLoader()
{
return $this->_loader;
}
/**
* @return array<class-string<LegacyMockInterface&MockInterface>|int,LegacyMockInterface&MockInterface>
*/
public function getMocks()
{
return $this->_mocks;
}
/**
* @return void
*/
public function instanceMock()
{
}
/**
* see http://php.net/manual/en/language.oop5.basic.php
*
* @param string $className
*
* @return bool
*/
public function isValidClassName($className)
{
if ($className[0] === '\\') {
$className = substr($className, 1); // remove the first backslash
}
// all the namespaces and class name should match the regex
return array_filter(
explode('\\', $className),
static function ($name): bool {
return ! preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $name);
}
) === [];
}
/**
* Generates a new mock object for this container
*
* I apologies in advance for this. A God Method just fits the API which
* doesn't require differentiating between classes, interfaces, abstracts,
* names or partials - just so long as it's something that can be mocked.
* I'll refactor it one day so it's easier to follow.
*
* @template TMock of LegacyMockInterface&MockInterface&object
*
* @param array|string ...$args
*
* @throws ReflectionException|RuntimeException
*
* @return TMock
*/
public function mock(...$args)
{
/** @var null|MockConfigurationBuilder $builder */
$builder = null;
/** @var null|callable $expectationClosure */
$expectationClosure = null;
$partialMethods = null;
$quickDefinitions = [];
$constructorArgs = null;
$blocks = [];
if (count($args) > 1) {
$finalArg = array_pop($args);
if (is_callable($finalArg) && is_object($finalArg)) {
$expectationClosure = $finalArg;
} else {
$args[] = $finalArg;
}
}
foreach ($args as $k => $arg) {
if ($arg instanceof MockConfigurationBuilder) {
$builder = $arg;
unset($args[$k]);
}
}
reset($args);
$builder = $builder ?? new MockConfigurationBuilder();
$mockeryConfiguration = Mockery::getConfiguration();
$builder->setParameterOverrides($mockeryConfiguration->getInternalClassMethodParamMaps());
$builder->setConstantsMap($mockeryConfiguration->getConstantsMap());
while ($args !== []) {
$arg = array_shift($args);
// check for multiple interfaces
if (is_string($arg)) {
foreach (explode('|', $arg) as $type) {
if ($arg === 'null') {
// skip PHP 8 'null's
continue;
}
if (strpos($type, ',') && (strpos($type, ']') === 0 || strpos($type, ']') === false)) {
$interfaces = explode(',', str_replace(' ', '', $type));
$builder->addTargets($interfaces);
continue;
}
if (strpos($type, 'alias:') === 0) {
$type = str_replace('alias:', '', $type);
$builder->addTarget('stdClass');
$builder->setName($type);
continue;
}
if (strpos($type, 'overload:') === 0) {
$type = str_replace('overload:', '', $type);
$builder->setInstanceMock(true);
$builder->addTarget('stdClass');
$builder->setName($type);
continue;
}
if ($type[strlen($type) - 1] === ']') {
$parts = explode('[', $type);
$class = $parts[0];
if (
! class_exists($class, true)
&& ! interface_exists($class, true)
) {
throw new Exception('Can only create a partial mock from an existing class or interface');
}
$builder->addTarget($class);
$partialMethods = array_filter(
explode(',', strtolower(rtrim(str_replace(' ', '', $parts[1]), ']')))
);
foreach ($partialMethods as $partialMethod) {
if ($partialMethod[0] === '!') {
$builder->addBlackListedMethod(substr($partialMethod, 1));
continue;
}
$builder->addWhiteListedMethod($partialMethod);
}
continue;
}
if (! $this->isValidClassName($type)) {
throw new Exception('Class name contains invalid characters');
}
if (
class_exists($type, true)
|| interface_exists($type, true)
|| trait_exists($type, true)
) {
$builder->addTarget($type);
continue;
}
if (! $mockeryConfiguration->mockingNonExistentMethodsAllowed()) {
throw new Exception(sprintf("Mockery can't find '%s' so can't mock it", $type));
}
$builder->addTarget($type);
// unions are "sum" types and not "intersections", and so we must only process the first part
break;
}
continue;
}
if (is_object($arg)) {
$builder->addTarget($arg);
continue;
}
if ($arg !== [] && array_keys($arg) !== range(0, count($arg) - 1)) {
// if associative array
if (array_key_exists(self::BLOCKS, $arg)) {
$blocks = $arg[self::BLOCKS];
}
unset($arg[self::BLOCKS]);
$quickDefinitions = $arg;
} else {
$constructorArgs = $arg;
}
}
$builder->addBlackListedMethods($blocks);
if ($constructorArgs !== null) {
$builder->addBlackListedMethod('__construct'); // we need to pass through
} else {
$builder->setMockOriginalDestructor(true);
}
if ($partialMethods !== null && $constructorArgs === null) {
$constructorArgs = [];
}
$config = $builder->getMockConfiguration();
$this->checkForNamedMockClashes($config);
$def = $this->getGenerator()->generate($config);
$className = $def->getClassName();
if (class_exists($className, $attemptAutoload = false)) {
$rfc = new ReflectionClass($className);
if (! $rfc->implementsInterface(LegacyMockInterface::class)) {
throw new RuntimeException(sprintf('Could not load mock %s, class already exists', $className));
}
}
$this->getLoader()->load($def);
$mock = $this->_getInstance($className, $constructorArgs);
$mock->mockery_init($this, $config->getTargetObject(), $config->isInstanceMock());
if ($quickDefinitions !== []) {
if ($mockeryConfiguration->getQuickDefinitions()->shouldBeCalledAtLeastOnce()) {
$mock->shouldReceive($quickDefinitions)->atLeast()->once();
} else {
$mock->shouldReceive($quickDefinitions)->byDefault();
}
}
if ($expectationClosure !== null) {
$expectationClosure($mock);
}
return $this->rememberMock($mock);
}
/**
* Fetch the next available allocation order number
*
* @return int
*/
public function mockery_allocateOrder()
{
return ++$this->_allocatedOrder;
}
/**
* Reset the container to its original state
*
* @return void
*/
public function mockery_close()
{
foreach ($this->_mocks as $mock) {
$mock->mockery_teardown();
}
$this->_mocks = [];
}
/**
* Get current ordered number
*
* @return int
*/
public function mockery_getCurrentOrder()
{
return $this->_currentOrder;
}
/**
* Gets the count of expectations on the mocks
*
* @return int
*/
public function mockery_getExpectationCount()
{
$count = 0;
foreach ($this->_mocks as $mock) {
$count += $mock->mockery_getExpectationCount();
}
return $count;
}
/**
* Fetch array of ordered groups
*
* @return array<string,int>
*/
public function mockery_getGroups()
{
return $this->_groups;
}
/**
* Set current ordered number
*
* @param int $order
*
* @return int The current order number that was set
*/
public function mockery_setCurrentOrder($order)
{
return $this->_currentOrder = $order;
}
/**
* Set ordering for a group
*
* @param string $group
* @param int $order
*
* @return void
*/
public function mockery_setGroup($group, $order)
{
$this->_groups[$group] = $order;
}
/**
* Tear down tasks for this container
*
* @throws PHPException
*/
public function mockery_teardown()
{
try {
$this->mockery_verify();
} catch (PHPException $phpException) {
$this->mockery_close();
throw $phpException;
}
}
/**
* Retrieves all exceptions thrown by mocks
*
* @return array<Throwable>
*/
public function mockery_thrownExceptions()
{
/** @var array<Throwable> $exceptions */
$exceptions = [];
foreach ($this->_mocks as $mock) {
foreach ($mock->mockery_thrownExceptions() as $exception) {
$exceptions[] = $exception;
}
}
return $exceptions;
}
/**
* Validate the current mock's ordering
*
* @param string $method
* @param int $order
*
* @throws Exception
*/
public function mockery_validateOrder($method, $order, LegacyMockInterface $mock)
{
if ($order < $this->_currentOrder) {
$exception = new InvalidOrderException(
sprintf(
'Method %s called out of order: expected order %d, was %d',
$method,
$order,
$this->_currentOrder
)
);
$exception->setMock($mock)
->setMethodName($method)
->setExpectedOrder($order)
->setActualOrder($this->_currentOrder);
throw $exception;
}
$this->mockery_setCurrentOrder($order);
}
/**
* Verify the container mocks
*/
public function mockery_verify()
{
foreach ($this->_mocks as $mock) {
$mock->mockery_verify();
}
}
/**
* Store a mock and set its container reference
*
* @param LegacyMockInterface|MockInterface $mock
*
* @return LegacyMockInterface|MockInterface
*/
public function rememberMock(LegacyMockInterface $mock)
{
$class = get_class($mock);
if (! array_key_exists($class, $this->_mocks)) {
return $this->_mocks[$class] = $mock;
}
/**
* This condition triggers for an instance mock where origin mock
* is already remembered
*/
return $this->_mocks[] = $mock;
}
/**
* Retrieve the last remembered mock object,
* which is the same as saying retrieve the current mock being programmed where you have yet to call mock()
* to change it thus why the method name is "self" since it will be used during the programming of the same mock.
*
* @return LegacyMockInterface|MockInterface
*/
public function self()
{
$mocks = array_values($this->_mocks);
$index = count($mocks) - 1;
return $mocks[$index];
}
/**
* @template TMock of object
*
* @param class-string<TMock> $mockName
* @param null|array<int,mixed> $constructorArgs
*
* @return LegacyMockInterface&MockInterface&TMock
*/
protected function _getInstance($mockName, $constructorArgs = null)
{
if ($constructorArgs !== null) {
return (new ReflectionClass($mockName))->newInstanceArgs($constructorArgs);
}
try {
$instance = $this->instantiator->instantiate($mockName);
} catch (PHPException $phpException) {
/** @var class-string<TMock> $internalMockName */
$internalMockName = $mockName . '_Internal';
if (! class_exists($internalMockName)) {
eval(sprintf(
'class %s extends %s { public function __construct() {} }',
$internalMockName,
$mockName
));
}
$instance = new $internalMockName();
}
return $instance;
}
protected function checkForNamedMockClashes($config)
{
$name = $config->getName();
if ($name === null) {
return;
}
$hash = $config->getHash();
if (array_key_exists($name, $this->_namedMocks) && $hash !== $this->_namedMocks[$name]) {
throw new Exception(
sprintf("The mock named '%s' has been already defined with a different mock configuration", $name)
);
}
$this->_namedMocks[$name] = $hash;
}
}