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
|
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Bridge\Doctrine\Tests\DataCollector;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\ParameterType;
use Doctrine\DBAL\Platforms\MySQLPlatform;
use Doctrine\Persistence\ManagerRegistry;
use PHPUnit\Framework\TestCase;
use Symfony\Bridge\Doctrine\DataCollector\DoctrineDataCollector;
use Symfony\Bridge\Doctrine\Middleware\Debug\DebugDataHolder;
use Symfony\Bridge\Doctrine\Middleware\Debug\Query;
use Symfony\Bridge\PhpUnit\ClockMock;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\VarDumper\Cloner\Data;
use Symfony\Component\VarDumper\Dumper\CliDumper;
class DoctrineDataCollectorTest extends TestCase
{
protected function setUp(): void
{
ClockMock::register(self::class);
ClockMock::withClockMock(1500000000);
}
public function testCollectConnections()
{
$c = $this->createCollector([]);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEquals(['default' => 'doctrine.dbal.default_connection'], $c->getConnections());
}
public function testCollectManagers()
{
$c = $this->createCollector([]);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEquals(['default' => 'doctrine.orm.default_entity_manager'], $c->getManagers());
}
public function testCollectQueryCount()
{
$c = $this->createCollector([]);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEquals(0, $c->getQueryCount());
$queries = [
['sql' => 'SELECT * FROM table1', 'params' => [], 'types' => [], 'executionMS' => 0],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEquals(1, $c->getQueryCount());
}
/**
* @group nophpunit11
*/
public function testCollectTime()
{
$c = $this->createCollector([]);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEquals(0, $c->getTime());
$queries = [
['sql' => 'SELECT * FROM table1', 'params' => [], 'types' => [], 'executionMS' => 1],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEquals(1, $c->getTime());
$queries = [
['sql' => 'SELECT * FROM table1', 'params' => [], 'types' => [], 'executionMS' => 1],
['sql' => 'SELECT * FROM table2', 'params' => [], 'types' => [], 'executionMS' => 2],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEquals(3, $c->getTime());
}
/**
* @group nophpunit11
*/
public function testCollectTimeWithFloatExecutionMS()
{
$queries = [
['sql' => 'SELECT * FROM table1', 'params' => [], 'types' => [], 'executionMS' => 0.23],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEqualsWithDelta(0.23, $c->getTime(), .01);
$queries = [
['sql' => 'SELECT * FROM table1', 'params' => [], 'types' => [], 'executionMS' => 1.02],
['sql' => 'SELECT * FROM table2', 'params' => [], 'types' => [], 'executionMS' => 0.75],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEqualsWithDelta(1.77, $c->getTime(), .01);
$queries = [
['sql' => 'SELECT * FROM table1', 'params' => [], 'types' => [], 'executionMS' => 0.15],
['sql' => 'SELECT * FROM table2', 'params' => [], 'types' => [], 'executionMS' => 0.32],
['sql' => 'SELECT * FROM table3', 'params' => [], 'types' => [], 'executionMS' => 0.07],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEqualsWithDelta(0.54, $c->getTime(), .01);
}
public function testCollectQueryWithNoTypes()
{
$queries = [
['sql' => 'SET sql_mode=(SELECT REPLACE(@@sql_mode, \'ONLY_FULL_GROUP_BY\', \'\'))', 'params' => [], 'types' => null, 'executionMS' => 1],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$collectedQueries = $c->getQueries();
$this->assertSame([], $collectedQueries['default'][0]['types']);
}
public function testReset()
{
$queries = [
['sql' => 'SELECT * FROM table1', 'params' => [], 'types' => [], 'executionMS' => 1],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c->reset();
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$this->assertEquals([], $c->getQueries());
}
/**
* @dataProvider paramProvider
*/
public function testCollectQueries($param, $types, $expected)
{
$queries = [
['sql' => 'SELECT * FROM table1 WHERE field1 = ?1', 'params' => [$param], 'types' => $types, 'executionMS' => 1],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$collectedQueries = $c->getQueries();
$collectedParam = $collectedQueries['default'][0]['params'][0];
if ($collectedParam instanceof Data) {
$dumper = new CliDumper($out = fopen('php://memory', 'r+'));
$dumper->setColors(false);
$collectedParam->dump($dumper);
$this->assertStringMatchesFormat($expected, print_r(stream_get_contents($out, -1, 0), true));
} elseif (\is_string($expected)) {
$this->assertStringMatchesFormat($expected, $collectedParam);
} else {
$this->assertEquals($expected, $collectedParam);
}
$this->assertTrue($collectedQueries['default'][0]['explainable']);
$this->assertTrue($collectedQueries['default'][0]['runnable']);
}
public function testCollectQueryWithNoParams()
{
$queries = [
['sql' => 'SELECT * FROM table1', 'params' => [], 'types' => [], 'executionMS' => 1],
['sql' => 'SELECT * FROM table1', 'params' => null, 'types' => null, 'executionMS' => 1],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$collectedQueries = $c->getQueries();
$this->assertInstanceOf(Data::class, $collectedQueries['default'][0]['params']);
$this->assertEquals([], $collectedQueries['default'][0]['params']->getValue());
$this->assertTrue($collectedQueries['default'][0]['explainable']);
$this->assertTrue($collectedQueries['default'][0]['runnable']);
$this->assertInstanceOf(Data::class, $collectedQueries['default'][1]['params']);
$this->assertEquals([], $collectedQueries['default'][1]['params']->getValue());
$this->assertTrue($collectedQueries['default'][1]['explainable']);
$this->assertTrue($collectedQueries['default'][1]['runnable']);
}
/**
* @dataProvider paramProvider
*/
public function testSerialization($param, array $types, $expected)
{
$queries = [
['sql' => 'SELECT * FROM table1 WHERE field1 = ?1', 'params' => [$param], 'types' => $types, 'executionMS' => 1],
];
$c = $this->createCollector($queries);
$c->collect(new Request(), new Response());
$c = unserialize(serialize($c));
$collectedQueries = $c->getQueries();
$collectedParam = $collectedQueries['default'][0]['params'][0];
if ($collectedParam instanceof Data) {
$dumper = new CliDumper($out = fopen('php://memory', 'r+'));
$dumper->setColors(false);
$collectedParam->dump($dumper);
$this->assertStringMatchesFormat($expected, print_r(stream_get_contents($out, -1, 0), true));
} elseif (\is_string($expected)) {
$this->assertStringMatchesFormat($expected, $collectedParam);
} else {
$this->assertEquals($expected, $collectedParam);
}
$this->assertTrue($collectedQueries['default'][0]['explainable']);
$this->assertTrue($collectedQueries['default'][0]['runnable']);
}
public static function paramProvider(): array
{
return [
['some value', [], 'some value'],
[1, [], 1],
[true, [], true],
[null, [], null],
];
}
private function createCollector(array $queries): DoctrineDataCollector
{
$connection = $this->getMockBuilder(Connection::class)
->disableOriginalConstructor()
->getMock();
$connection->expects($this->any())
->method('getDatabasePlatform')
->willReturn(new MySQLPlatform());
$registry = $this->createMock(ManagerRegistry::class);
$registry
->expects($this->any())
->method('getConnectionNames')
->willReturn(['default' => 'doctrine.dbal.default_connection']);
$registry
->expects($this->any())
->method('getManagerNames')
->willReturn(['default' => 'doctrine.orm.default_entity_manager']);
$registry->expects($this->any())
->method('getConnection')
->willReturn($connection);
$debugDataHolder = new DebugDataHolder();
$collector = new DoctrineDataCollector($registry, $debugDataHolder);
foreach ($queries as $queryData) {
$query = new Query($queryData['sql'] ?? '');
foreach (($queryData['params'] ?? []) as $key => $value) {
if (\is_int($key)) {
++$key;
}
$query->setValue($key, $value, $queryData['type'][$key] ?? ParameterType::STRING);
}
$query->start();
$debugDataHolder->addQuery('default', $query);
if (isset($queryData['executionMS'])) {
usleep($queryData['executionMS'] * 1000000);
}
$query->stop();
}
return $collector;
}
}
|
