1
|
|
|
<?php |
2
|
|
|
/* |
3
|
|
|
* Copyright (c) 2012-2014 Janos Szurovecz |
4
|
|
|
* |
5
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of |
6
|
|
|
* this software and associated documentation files (the "Software"), to deal in |
7
|
|
|
* the Software without restriction, including without limitation the rights to |
8
|
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies |
9
|
|
|
* of the Software, and to permit persons to whom the Software is furnished to do |
10
|
|
|
* so, subject to the following conditions: |
11
|
|
|
* |
12
|
|
|
* The above copyright notice and this permission notice shall be included in all |
13
|
|
|
* copies or substantial portions of the Software. |
14
|
|
|
* |
15
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
16
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
17
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
18
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
19
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
20
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
21
|
|
|
* SOFTWARE. |
22
|
|
|
*/ |
23
|
|
|
|
24
|
|
|
namespace predaddy\util\test; |
25
|
|
|
|
26
|
|
|
use precore\lang\ObjectClass; |
27
|
|
|
use precore\util\Preconditions; |
28
|
|
|
use predaddy\domain\Repository; |
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* Utility class which makes easier to test aggregates. Supports both ES and non-ES aggregates. |
32
|
|
|
* Follows BDD concept: |
33
|
|
|
* <ul> |
34
|
|
|
* <li>init commands or events initialize the AR |
35
|
|
|
* <li>the required command should be sent |
36
|
|
|
* <li>the expected events, return values, or thrown exception can be checked |
37
|
|
|
* </ul> |
38
|
|
|
* |
39
|
|
|
* It uses PHPUnit, which must be available. |
40
|
|
|
* |
41
|
|
|
* {@link Fixture} helps to fill commands with aggregate ID, and ignore some properties when compares events. |
42
|
|
|
* It is convenience if the aggregate ID is generated inside the AR, and further commands need to know it. |
43
|
|
|
* This feature works only with {@link AbstractCommand} and {@link AbstractDomainEvent} objects. |
44
|
|
|
* |
45
|
|
|
* @beta This, and all related test utility classes are under development and can be modified anytime. |
46
|
|
|
* @package predaddy\util |
47
|
|
|
* @author Janos Szurovecz <[email protected]> |
48
|
|
|
*/ |
49
|
|
|
final class Fixtures |
50
|
|
|
{ |
51
|
|
|
private function __construct() |
52
|
|
|
{ |
53
|
|
|
} |
54
|
|
|
|
55
|
|
|
/** |
56
|
|
|
* @param string $aggregateClass which should be tested |
57
|
|
|
* @param Repository $repository for DirectCommandBus only in non-ES case |
58
|
|
|
* @return Fixture |
59
|
|
|
*/ |
60
|
|
|
public static function newGivenWhenThenFixture($aggregateClass, Repository $repository = null) |
61
|
|
|
{ |
62
|
|
|
$arClassObject = ObjectClass::forName($aggregateClass); |
63
|
|
|
Preconditions::checkArgument( |
64
|
|
|
ObjectClass::forName('\predaddy\domain\AggregateRoot')->isAssignableFrom($arClassObject), |
65
|
|
|
'Aggregate class [%s] does not implement AggregateRoot interface', |
66
|
|
|
$aggregateClass |
67
|
|
|
); |
68
|
|
|
$eventSourcedClass = ObjectClass::forName('\predaddy\domain\eventsourcing\EventSourcedAggregateRoot'); |
69
|
|
|
return $eventSourcedClass->isAssignableFrom($arClassObject) |
70
|
|
|
? new EventSourcedFixture($aggregateClass) |
71
|
|
|
: new CommandSourcedFixture($aggregateClass, $repository); |
72
|
|
|
} |
73
|
|
|
} |
74
|
|
|
|