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
<?php
namespace MongoDB\Tests\SpecTests;
use MongoDB\Driver\Monitoring\CommandFailedEvent;
use MongoDB\Driver\Monitoring\CommandStartedEvent;
use MongoDB\Driver\Monitoring\CommandSucceededEvent;
use MongoDB\Driver\Monitoring\CommandSubscriber;
use ArrayIterator;
use LogicException;
use MultipleIterator;
use stdClass;
/**
* Spec test CommandStartedEvent expectations.
*/
class CommandExpectations implements CommandSubscriber
{
private $actualEvents = [];
private $expectedEvents = [];
private $ignoreCommandFailed = false;
private $ignoreCommandStarted = false;
private $ignoreCommandSucceeded = false;
private $ignoreExtraEvents = false;
private function __construct(array $events)
{
foreach ($events as $event) {
switch (key($event)) {
case 'command_failed_event':
$this->expectedEvents[] = [$event->command_failed_event, CommandFailedEvent::class];
break;
case 'command_started_event':
$this->expectedEvents[] = [$event->command_started_event, CommandStartedEvent::class];
break;
case 'command_succeeded_event':
$this->expectedEvents[] = [$event->command_succeeded_event, CommandSucceededEvent::class];
break;
default:
throw new LogicException('Unsupported event type: ' . key($event));
}
}
}
public static function fromChangeStreams(array $expectedEvents)
{
$o = new self($expectedEvents);
$o->ignoreCommandFailed = true;
$o->ignoreCommandSucceeded = true;
/* Change Streams spec tests do not include getMore commands in the
* list of expected events, so ignore any observed events beyond the
* number that are expected. */
$o->ignoreExtraEvents = true;
return $o;
}
public static function fromCommandMonitoring(array $expectedEvents)
{
return new self($expectedEvents);
}
public static function fromCrud(array $expectedEvents)
{
$o = new self($expectedEvents);
$o->ignoreCommandFailed = true;
$o->ignoreCommandSucceeded = true;
return $o;
}
public static function fromTransactions(array $expectedEvents)
{
$o = new self($expectedEvents);
$o->ignoreCommandFailed = true;
$o->ignoreCommandSucceeded = true;
return $o;
}
/**
* Not used.
*
* @see https://www.php.net/manual/en/mongodb-driver-monitoring-commandsubscriber.commandfailed.php
*/
public function commandFailed(CommandFailedEvent $event)
{
if ($this->ignoreCommandFailed || ($this->ignoreExtraEvents && count($this->actualEvents) === count($this->expectedEvents))) {
return;
}
$this->actualEvents[] = $event;
}
/**
* Tracks outgoing commands for spec test APM assertions.
*
* @see https://www.php.net/manual/en/mongodb-driver-monitoring-commandsubscriber.commandstarted.php
*/
public function commandStarted(CommandStartedEvent $event)
{
if ($this->ignoreCommandStarted || ($this->ignoreExtraEvents && count($this->actualEvents) === count($this->expectedEvents))) {
return;
}
$this->actualEvents[] = $event;
}
/**
* Not used.
*
* @see https://www.php.net/manual/en/mongodb-driver-monitoring-commandsubscriber.commandsucceeded.php
*/
public function commandSucceeded(CommandSucceededEvent $event)
{
if ($this->ignoreCommandSucceeded || ($this->ignoreExtraEvents && count($this->actualEvents) === count($this->expectedEvents))) {
return;
}
$this->actualEvents[] = $event;
}
/**
* Start command monitoring.
*/
public function startMonitoring()
{
\MongoDB\Driver\Monitoring\addSubscriber($this);
}
/**
* Stop command monitoring.
*/
public function stopMonitoring()
{
\MongoDB\Driver\Monitoring\removeSubscriber($this);
}
/**
* Assert that the command expectations match the monitored events.
*
* @param FunctionalTestCase $test Test instance
* @param Context $context Execution context
*/
public function assert(FunctionalTestCase $test, Context $context)
{
$test->assertCount(count($this->expectedEvents), $this->actualEvents);
$mi = new MultipleIterator(MultipleIterator::MIT_NEED_ANY);
$mi->attachIterator(new ArrayIterator($this->expectedEvents));
$mi->attachIterator(new ArrayIterator($this->actualEvents));
foreach ($mi as $events) {
list($expectedEventAndClass, $actualEvent) = $events;
list($expectedEvent, $expectedClass) = $expectedEventAndClass;
$test->assertInstanceOf($expectedClass, $actualEvent);
if (isset($expectedEvent->command_name)) {
$test->assertSame($expectedEvent->command_name, $actualEvent->getCommandName());
}
if (isset($expectedEvent->database_name)) {
$test->assertSame($expectedEvent->database_name, $actualEvent->getDatabaseName());
}
if (isset($expectedEvent->command)) {
$test->assertInstanceOf(CommandStartedEvent::class, $actualEvent);
$expectedCommand = $expectedEvent->command;
$context->replaceCommandSessionPlaceholder($expectedCommand);
$test->assertCommandMatches($expectedCommand, $actualEvent->getCommand());
}
if (isset($expectedEvent->reply)) {
$test->assertInstanceOf(CommandSucceededEvent::class, $actualEvent);
$test->assertCommandReplyMatches($expectedEvent->reply, $actualEvent->getReply());
}
}
}
}