1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/* |
4
|
|
|
* This file is part of the Liip/FunctionalTestBundle |
5
|
|
|
* |
6
|
|
|
* (c) Lukas Kahwe Smith <[email protected]> |
7
|
|
|
* |
8
|
|
|
* This source file is subject to the MIT license that is bundled |
9
|
|
|
* with this source code in the file LICENSE. |
10
|
|
|
*/ |
11
|
|
|
|
12
|
|
|
namespace Liip\FunctionalTestBundle\Test; |
13
|
|
|
|
14
|
|
|
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase as BaseWebTestCase; |
15
|
|
|
use Symfony\Bundle\FrameworkBundle\Console\Application; |
16
|
|
|
use Symfony\Bundle\FrameworkBundle\Client; |
17
|
|
|
use Symfony\Component\Console\Input\ArrayInput; |
18
|
|
|
use Symfony\Component\Console\Output\OutputInterface; |
19
|
|
|
use Symfony\Component\Console\Output\StreamOutput; |
20
|
|
|
use Symfony\Component\DomCrawler\Crawler; |
21
|
|
|
use Symfony\Component\BrowserKit\Cookie; |
22
|
|
|
use Symfony\Component\HttpKernel\Kernel; |
23
|
|
|
use Symfony\Component\HttpFoundation\Response; |
24
|
|
|
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface; |
25
|
|
|
use Symfony\Component\Security\Core\User\UserInterface; |
26
|
|
|
use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken; |
27
|
|
|
use Symfony\Component\DependencyInjection\ContainerInterface; |
28
|
|
|
use Symfony\Component\HttpFoundation\Session\Session; |
29
|
|
|
use Symfony\Component\Routing\Generator\UrlGeneratorInterface; |
30
|
|
|
use Symfony\Bridge\Doctrine\ManagerRegistry; |
31
|
|
|
use Symfony\Bundle\DoctrineFixturesBundle\Common\DataFixtures\Loader; |
32
|
|
|
use Doctrine\Common\Persistence\ObjectManager; |
33
|
|
|
use Doctrine\Common\DataFixtures\DependentFixtureInterface; |
34
|
|
|
use Doctrine\Common\DataFixtures\Executor\AbstractExecutor; |
35
|
|
|
use Doctrine\Common\DataFixtures\ProxyReferenceRepository; |
36
|
|
|
use Doctrine\DBAL\Driver\PDOSqlite\Driver as SqliteDriver; |
37
|
|
|
use Doctrine\DBAL\Platforms\MySqlPlatform; |
38
|
|
|
use Doctrine\ORM\EntityManager; |
39
|
|
|
use Doctrine\ORM\Tools\SchemaTool; |
40
|
|
|
use Nelmio\Alice\Fixtures; |
41
|
|
|
use Liip\FunctionalTestBundle\Utils\HttpAssertions; |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* @author Lea Haensenberger |
45
|
|
|
* @author Lukas Kahwe Smith <[email protected]> |
46
|
|
|
* @author Benjamin Eberlei <[email protected]> |
47
|
|
|
*/ |
48
|
|
|
abstract class WebTestCase extends BaseWebTestCase |
49
|
|
|
{ |
50
|
|
|
protected $environment = 'test'; |
51
|
|
|
protected $containers; |
52
|
|
|
protected $kernelDir; |
53
|
|
|
// 5 * 1024 * 1024 KB |
54
|
|
|
protected $maxMemory = 5242880; |
55
|
|
|
|
56
|
|
|
// RUN COMMAND |
57
|
|
|
protected $verbosityLevel; |
58
|
|
|
protected $decorated; |
59
|
|
|
|
60
|
|
|
/** |
61
|
|
|
* @var array |
62
|
|
|
*/ |
63
|
|
|
private $firewallLogins = array(); |
64
|
|
|
|
65
|
|
|
/** |
66
|
|
|
* @var array |
67
|
|
|
*/ |
68
|
|
|
private $excludedDoctrineTables = array(); |
69
|
|
|
|
70
|
|
|
/** |
71
|
|
|
* @var array |
72
|
|
|
*/ |
73
|
|
|
private static $cachedMetadatas = array(); |
74
|
|
|
|
75
|
|
|
protected static function getKernelClass() |
|
|
|
|
76
|
|
|
{ |
77
|
|
|
$dir = isset($_SERVER['KERNEL_DIR']) ? $_SERVER['KERNEL_DIR'] : static::getPhpUnitXmlDir(); |
78
|
|
|
|
79
|
|
|
list($appname) = explode('\\', get_called_class()); |
80
|
|
|
|
81
|
|
|
$class = $appname.'Kernel'; |
82
|
|
|
$file = $dir.'/'.strtolower($appname).'/'.$class.'.php'; |
83
|
|
|
if (!file_exists($file)) { |
84
|
|
|
return parent::getKernelClass(); |
85
|
|
|
} |
86
|
|
|
require_once $file; |
87
|
|
|
|
88
|
|
|
return $class; |
89
|
|
|
} |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* Creates a mock object of a service identified by its id. |
93
|
|
|
* |
94
|
|
|
* @param string $id |
95
|
|
|
* |
96
|
|
|
* @return \PHPUnit_Framework_MockObject_MockBuilder |
97
|
|
|
*/ |
98
|
|
|
protected function getServiceMockBuilder($id) |
99
|
|
|
{ |
100
|
|
|
$service = $this->getContainer()->get($id); |
101
|
|
|
$class = get_class($service); |
102
|
|
|
|
103
|
|
|
return $this->getMockBuilder($class)->disableOriginalConstructor(); |
104
|
|
|
} |
105
|
|
|
|
106
|
|
|
/** |
107
|
|
|
* Builds up the environment to run the given command. |
108
|
|
|
* |
109
|
|
|
* @param string $name |
110
|
|
|
* @param array $params |
111
|
|
|
* @param bool $reuseKernel |
112
|
|
|
* |
113
|
|
|
* @return string |
114
|
|
|
*/ |
115
|
12 |
|
protected function runCommand($name, array $params = array(), $reuseKernel = false) |
116
|
|
|
{ |
117
|
12 |
|
array_unshift($params, $name); |
118
|
|
|
|
119
|
12 |
|
if (!$reuseKernel) { |
120
|
12 |
|
if (null !== static::$kernel) { |
121
|
9 |
|
static::$kernel->shutdown(); |
122
|
9 |
|
} |
123
|
|
|
|
124
|
12 |
|
$kernel = static::$kernel = $this->createKernel(array('environment' => $this->environment)); |
125
|
12 |
|
$kernel->boot(); |
126
|
12 |
|
} else { |
127
|
2 |
|
$kernel = $this->getContainer()->get('kernel'); |
128
|
|
|
} |
129
|
|
|
|
130
|
12 |
|
$application = new Application($kernel); |
131
|
12 |
|
$application->setAutoExit(false); |
132
|
|
|
|
133
|
|
|
// @codeCoverageIgnoreStart |
134
|
|
|
if ('203' === substr(Kernel::VERSION_ID, 0, 3)) { |
135
|
|
|
$params = $this->configureVerbosityForSymfony203($params); |
136
|
|
|
} |
137
|
|
|
// @codeCoverageIgnoreEnd |
138
|
|
|
|
139
|
12 |
|
$input = new ArrayInput($params); |
140
|
12 |
|
$input->setInteractive(false); |
141
|
|
|
|
142
|
12 |
|
$fp = fopen('php://temp/maxmemory:'.$this->maxMemory, 'r+'); |
143
|
12 |
|
$output = new StreamOutput($fp, $this->getVerbosityLevel(), $this->getDecorated()); |
144
|
|
|
|
145
|
11 |
|
$application->run($input, $output); |
146
|
|
|
|
147
|
11 |
|
rewind($fp); |
148
|
|
|
|
149
|
11 |
|
return stream_get_contents($fp); |
150
|
|
|
} |
151
|
|
|
|
152
|
|
|
/** |
153
|
|
|
* Retrieves the output verbosity level. |
154
|
|
|
* |
155
|
|
|
* @see Symfony\Component\Console\Output\OutputInterface for available levels |
156
|
|
|
* |
157
|
|
|
* @return int |
158
|
|
|
* |
159
|
|
|
* @throws \OutOfBoundsException If the set value isn't accepted |
160
|
|
|
*/ |
161
|
12 |
|
protected function getVerbosityLevel() |
162
|
|
|
{ |
163
|
|
|
// If `null`, is not yet set |
164
|
12 |
|
if (null === $this->verbosityLevel) { |
165
|
|
|
// Set the global verbosity level that is set as NORMAL by the TreeBuilder in Configuration |
166
|
6 |
|
$level = strtoupper($this->getContainer()->getParameter('liip_functional_test.command_verbosity')); |
167
|
6 |
|
$verbosity = '\Symfony\Component\Console\Output\StreamOutput::VERBOSITY_'.$level; |
168
|
|
|
|
169
|
6 |
|
$this->verbosityLevel = constant($verbosity); |
170
|
6 |
|
} |
171
|
|
|
|
172
|
|
|
// If string, it is set by the developer, so check that the value is an accepted one |
173
|
12 |
|
if (is_string($this->verbosityLevel)) { |
174
|
6 |
|
$level = strtoupper($this->verbosityLevel); |
175
|
6 |
|
$verbosity = '\Symfony\Component\Console\Output\StreamOutput::VERBOSITY_'.$level; |
176
|
|
|
|
177
|
6 |
|
if (!defined($verbosity)) { |
178
|
1 |
|
throw new \OutOfBoundsException( |
179
|
1 |
|
sprintf('The set value "%s" for verbosityLevel is not valid. Accepted are: "quiet", "normal", "verbose", "very_verbose" and "debug".', $level) |
180
|
1 |
|
); |
181
|
|
|
} |
182
|
|
|
|
183
|
5 |
|
$this->verbosityLevel = constant($verbosity); |
184
|
5 |
|
} |
185
|
|
|
|
186
|
11 |
|
return $this->verbosityLevel; |
187
|
|
|
} |
188
|
|
|
|
189
|
|
|
/** |
190
|
|
|
* In Symfony 2.3.* the verbosity level has to be set through {Symfony\Component\Console\Input\ArrayInput} and not |
191
|
|
|
* in {Symfony\Component\Console\Output\OutputInterface}. |
192
|
|
|
* |
193
|
|
|
* This method builds $params to be passed to {Symfony\Component\Console\Input\ArrayInput}. |
194
|
|
|
* |
195
|
|
|
* @codeCoverageIgnore |
196
|
|
|
* |
197
|
|
|
* @param array $params |
198
|
|
|
* |
199
|
|
|
* @return array |
200
|
|
|
*/ |
201
|
|
|
private function configureVerbosityForSymfony203(array $params) |
202
|
|
|
{ |
203
|
|
|
switch ($this->getVerbosityLevel()) { |
204
|
|
|
case OutputInterface::VERBOSITY_QUIET: |
205
|
|
|
$params['-q'] = '-q'; |
206
|
|
|
break; |
207
|
|
|
|
208
|
|
|
case OutputInterface::VERBOSITY_VERBOSE: |
209
|
|
|
$params['-v'] = ''; |
210
|
|
|
break; |
211
|
|
|
|
212
|
|
|
case OutputInterface::VERBOSITY_VERY_VERBOSE: |
213
|
|
|
$params['-vv'] = ''; |
214
|
|
|
break; |
215
|
|
|
|
216
|
|
|
case OutputInterface::VERBOSITY_DEBUG: |
217
|
|
|
$params['-vvv'] = ''; |
218
|
|
|
break; |
219
|
|
|
} |
220
|
|
|
|
221
|
|
|
return $params; |
222
|
|
|
} |
223
|
|
|
|
224
|
6 |
|
public function setVerbosityLevel($level) |
225
|
|
|
{ |
226
|
6 |
|
$this->verbosityLevel = $level; |
227
|
6 |
|
} |
228
|
|
|
|
229
|
|
|
/** |
230
|
|
|
* Retrieves the flag indicating if the output should be decorated or not. |
231
|
|
|
* |
232
|
|
|
* @return bool |
233
|
|
|
*/ |
234
|
11 |
|
protected function getDecorated() |
235
|
|
|
{ |
236
|
11 |
|
if (null === $this->decorated) { |
237
|
|
|
// Set the global decoration flag that is set to `true` by the TreeBuilder in Configuration |
238
|
5 |
|
$this->decorated = $this->getContainer()->getParameter('liip_functional_test.command_decoration'); |
239
|
5 |
|
} |
240
|
|
|
|
241
|
|
|
// Check the local decorated flag |
242
|
11 |
|
if (false === is_bool($this->decorated)) { |
243
|
|
|
throw new \OutOfBoundsException( |
244
|
|
|
sprintf('`WebTestCase::decorated` has to be `bool`. "%s" given.', gettype($this->decorated)) |
245
|
|
|
); |
246
|
|
|
} |
247
|
|
|
|
248
|
11 |
|
return $this->decorated; |
249
|
|
|
} |
250
|
|
|
|
251
|
6 |
|
public function isDecorated($decorated) |
252
|
|
|
{ |
253
|
6 |
|
$this->decorated = $decorated; |
254
|
6 |
|
} |
255
|
|
|
|
256
|
|
|
/** |
257
|
|
|
* Get an instance of the dependency injection container. |
258
|
|
|
* (this creates a kernel *without* parameters). |
259
|
|
|
* |
260
|
|
|
* @return ContainerInterface |
261
|
|
|
*/ |
262
|
46 |
|
protected function getContainer() |
|
|
|
|
263
|
|
|
{ |
264
|
46 |
|
if (!empty($this->kernelDir)) { |
265
|
|
|
$tmpKernelDir = isset($_SERVER['KERNEL_DIR']) ? $_SERVER['KERNEL_DIR'] : null; |
266
|
|
|
$_SERVER['KERNEL_DIR'] = getcwd().$this->kernelDir; |
267
|
|
|
} |
268
|
|
|
|
269
|
46 |
|
$cacheKey = $this->kernelDir.'|'.$this->environment; |
270
|
46 |
|
if (empty($this->containers[$cacheKey])) { |
271
|
|
|
$options = array( |
272
|
45 |
|
'environment' => $this->environment, |
273
|
45 |
|
); |
274
|
45 |
|
$kernel = $this->createKernel($options); |
275
|
45 |
|
$kernel->boot(); |
276
|
|
|
|
277
|
45 |
|
$this->containers[$cacheKey] = $kernel->getContainer(); |
278
|
45 |
|
} |
279
|
|
|
|
280
|
46 |
|
if (isset($tmpKernelDir)) { |
281
|
|
|
$_SERVER['KERNEL_DIR'] = $tmpKernelDir; |
282
|
|
|
} |
283
|
|
|
|
284
|
46 |
|
return $this->containers[$cacheKey]; |
285
|
|
|
} |
286
|
|
|
|
287
|
|
|
/** |
288
|
|
|
* This function finds the time when the data blocks of a class definition |
289
|
|
|
* file were being written to, that is, the time when the content of the |
290
|
|
|
* file was changed. |
291
|
|
|
* |
292
|
|
|
* @param string $class The fully qualified class name of the fixture class to |
293
|
|
|
* check modification date on |
294
|
|
|
* |
295
|
|
|
* @return \DateTime|null |
296
|
|
|
*/ |
297
|
3 |
|
protected function getFixtureLastModified($class) |
298
|
|
|
{ |
299
|
3 |
|
$lastModifiedDateTime = null; |
300
|
|
|
|
301
|
3 |
|
$reflClass = new \ReflectionClass($class); |
302
|
3 |
|
$classFileName = $reflClass->getFileName(); |
303
|
|
|
|
304
|
3 |
|
if (file_exists($classFileName)) { |
305
|
3 |
|
$lastModifiedDateTime = new \DateTime(); |
306
|
3 |
|
$lastModifiedDateTime->setTimestamp(filemtime($classFileName)); |
307
|
3 |
|
} |
308
|
|
|
|
309
|
3 |
|
return $lastModifiedDateTime; |
310
|
|
|
} |
311
|
|
|
|
312
|
|
|
/** |
313
|
|
|
* Determine if the Fixtures that define a database backup have been |
314
|
|
|
* modified since the backup was made. |
315
|
|
|
* |
316
|
|
|
* @param array $classNames The fixture classnames to check |
317
|
|
|
* @param string $backup The fixture backup SQLite database file path |
318
|
|
|
* |
319
|
|
|
* @return bool TRUE if the backup was made since the modifications to the |
320
|
|
|
* fixtures; FALSE otherwise |
321
|
|
|
*/ |
322
|
7 |
|
protected function isBackupUpToDate(array $classNames, $backup) |
323
|
|
|
{ |
324
|
7 |
|
$backupLastModifiedDateTime = new \DateTime(); |
325
|
7 |
|
$backupLastModifiedDateTime->setTimestamp(filemtime($backup)); |
326
|
|
|
|
327
|
|
|
/** @var \Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader $loader */ |
328
|
7 |
|
$loader = $this->getFixtureLoader($this->getContainer(), $classNames); |
329
|
|
|
|
330
|
|
|
// Use loader in order to fetch all the dependencies fixtures. |
331
|
7 |
|
foreach ($loader->getFixtures() as $className) { |
332
|
3 |
|
$fixtureLastModifiedDateTime = $this->getFixtureLastModified($className); |
333
|
3 |
|
if ($backupLastModifiedDateTime < $fixtureLastModifiedDateTime) { |
334
|
1 |
|
return false; |
335
|
|
|
} |
336
|
7 |
|
} |
337
|
|
|
|
338
|
7 |
|
return true; |
339
|
|
|
} |
340
|
|
|
|
341
|
|
|
/** |
342
|
|
|
* Set the database to the provided fixtures. |
343
|
|
|
* |
344
|
|
|
* Drops the current database and then loads fixtures using the specified |
345
|
|
|
* classes. The parameter is a list of fully qualified class names of |
346
|
|
|
* classes that implement Doctrine\Common\DataFixtures\FixtureInterface |
347
|
|
|
* so that they can be loaded by the DataFixtures Loader::addFixture |
348
|
|
|
* |
349
|
|
|
* When using SQLite this method will automatically make a copy of the |
350
|
|
|
* loaded schema and fixtures which will be restored automatically in |
351
|
|
|
* case the same fixture classes are to be loaded again. Caveat: changes |
352
|
|
|
* to references and/or identities may go undetected. |
353
|
|
|
* |
354
|
|
|
* Depends on the doctrine data-fixtures library being available in the |
355
|
|
|
* class path. |
356
|
|
|
* |
357
|
|
|
* @param array $classNames List of fully qualified class names of fixtures to load |
358
|
|
|
* @param string $omName The name of object manager to use |
359
|
|
|
* @param string $registryName The service id of manager registry to use |
360
|
|
|
* @param int $purgeMode Sets the ORM purge mode |
361
|
|
|
* |
362
|
|
|
* @return null|AbstractExecutor |
363
|
|
|
*/ |
364
|
33 |
|
protected function loadFixtures(array $classNames, $omName = null, $registryName = 'doctrine', $purgeMode = null) |
365
|
|
|
{ |
366
|
33 |
|
$container = $this->getContainer(); |
367
|
|
|
/** @var ManagerRegistry $registry */ |
368
|
33 |
|
$registry = $container->get($registryName); |
369
|
|
|
/** @var ObjectManager $om */ |
370
|
33 |
|
$om = $registry->getManager($omName); |
371
|
33 |
|
$type = $registry->getName(); |
372
|
|
|
|
373
|
33 |
|
$executorClass = 'PHPCR' === $type && class_exists('Doctrine\Bundle\PHPCRBundle\DataFixtures\PHPCRExecutor') |
374
|
33 |
|
? 'Doctrine\Bundle\PHPCRBundle\DataFixtures\PHPCRExecutor' |
375
|
33 |
|
: 'Doctrine\\Common\\DataFixtures\\Executor\\'.$type.'Executor'; |
376
|
33 |
|
$referenceRepository = new ProxyReferenceRepository($om); |
377
|
33 |
|
$cacheDriver = $om->getMetadataFactory()->getCacheDriver(); |
378
|
|
|
|
379
|
33 |
|
if ($cacheDriver) { |
380
|
33 |
|
$cacheDriver->deleteAll(); |
381
|
33 |
|
} |
382
|
|
|
|
383
|
33 |
|
if ('ORM' === $type) { |
384
|
32 |
|
$connection = $om->getConnection(); |
385
|
32 |
|
if ($connection->getDriver() instanceof SqliteDriver) { |
386
|
27 |
|
$params = $connection->getParams(); |
387
|
27 |
|
if (isset($params['master'])) { |
388
|
|
|
$params = $params['master']; |
389
|
|
|
} |
390
|
|
|
|
391
|
27 |
|
$name = isset($params['path']) ? $params['path'] : (isset($params['dbname']) ? $params['dbname'] : false); |
392
|
27 |
|
if (!$name) { |
393
|
|
|
throw new \InvalidArgumentException("Connection does not contain a 'path' or 'dbname' parameter and cannot be dropped."); |
394
|
|
|
} |
395
|
|
|
|
396
|
27 |
|
if (!isset(self::$cachedMetadatas[$omName])) { |
397
|
10 |
|
self::$cachedMetadatas[$omName] = $om->getMetadataFactory()->getAllMetadata(); |
398
|
10 |
|
usort(self::$cachedMetadatas[$omName], function ($a, $b) { |
399
|
|
|
return strcmp($a->name, $b->name); |
400
|
10 |
|
}); |
401
|
10 |
|
} |
402
|
27 |
|
$metadatas = self::$cachedMetadatas[$omName]; |
403
|
|
|
|
404
|
27 |
|
if ($container->getParameter('liip_functional_test.cache_sqlite_db')) { |
405
|
9 |
|
$backup = $container->getParameter('kernel.cache_dir').'/test_'.md5(serialize($metadatas).serialize($classNames)).'.db'; |
406
|
9 |
|
if (file_exists($backup) && file_exists($backup.'.ser') && $this->isBackupUpToDate($classNames, $backup)) { |
407
|
7 |
|
$om->flush(); |
408
|
7 |
|
$om->clear(); |
409
|
|
|
|
410
|
7 |
|
$this->preFixtureRestore($om, $referenceRepository); |
411
|
|
|
|
412
|
7 |
|
copy($backup, $name); |
413
|
|
|
|
414
|
7 |
|
$executor = new $executorClass($om); |
415
|
7 |
|
$executor->setReferenceRepository($referenceRepository); |
416
|
7 |
|
$executor->getReferenceRepository()->load($backup); |
417
|
|
|
|
418
|
7 |
|
$this->postFixtureRestore(); |
419
|
|
|
|
420
|
7 |
|
return $executor; |
421
|
|
|
} |
422
|
3 |
|
} |
423
|
|
|
|
424
|
|
|
// TODO: handle case when using persistent connections. Fail loudly? |
425
|
21 |
|
$schemaTool = new SchemaTool($om); |
|
|
|
|
426
|
21 |
|
$schemaTool->dropDatabase(); |
427
|
21 |
|
if (!empty($metadatas)) { |
428
|
21 |
|
$schemaTool->createSchema($metadatas); |
429
|
21 |
|
} |
430
|
21 |
|
$this->postFixtureSetup(); |
431
|
|
|
|
432
|
21 |
|
$executor = new $executorClass($om); |
433
|
21 |
|
$executor->setReferenceRepository($referenceRepository); |
434
|
21 |
|
} |
435
|
26 |
|
} |
436
|
|
|
|
437
|
27 |
|
if (empty($executor)) { |
438
|
6 |
|
$purgerClass = 'Doctrine\\Common\\DataFixtures\\Purger\\'.$type.'Purger'; |
439
|
6 |
|
if ('PHPCR' === $type) { |
440
|
1 |
|
$purger = new $purgerClass($om); |
441
|
1 |
|
$initManager = $container->has('doctrine_phpcr.initializer_manager') |
442
|
1 |
|
? $container->get('doctrine_phpcr.initializer_manager') |
443
|
1 |
|
: null; |
444
|
|
|
|
445
|
1 |
|
$executor = new $executorClass($om, $purger, $initManager); |
446
|
1 |
|
} else { |
447
|
5 |
|
if ('ORM' === $type) { |
448
|
5 |
|
$purger = new $purgerClass(null, $this->excludedDoctrineTables); |
449
|
5 |
|
} else { |
450
|
|
|
$purger = new $purgerClass(); |
451
|
|
|
} |
452
|
|
|
|
453
|
5 |
|
if (null !== $purgeMode) { |
454
|
2 |
|
$purger->setPurgeMode($purgeMode); |
455
|
2 |
|
} |
456
|
|
|
|
457
|
5 |
|
$executor = new $executorClass($om, $purger); |
458
|
|
|
} |
459
|
|
|
|
460
|
6 |
|
$executor->setReferenceRepository($referenceRepository); |
461
|
6 |
|
$executor->purge(); |
462
|
6 |
|
} |
463
|
|
|
|
464
|
27 |
|
$loader = $this->getFixtureLoader($container, $classNames); |
465
|
|
|
|
466
|
27 |
|
$executor->execute($loader->getFixtures(), true); |
467
|
|
|
|
468
|
27 |
|
if (isset($name) && isset($backup)) { |
469
|
3 |
|
$this->preReferenceSave($om, $executor, $backup); |
470
|
|
|
|
471
|
3 |
|
$executor->getReferenceRepository()->save($backup); |
472
|
3 |
|
copy($name, $backup); |
473
|
|
|
|
474
|
3 |
|
$this->postReferenceSave($om, $executor, $backup); |
475
|
3 |
|
} |
476
|
|
|
|
477
|
27 |
|
return $executor; |
478
|
|
|
} |
479
|
|
|
|
480
|
|
|
/** |
481
|
|
|
* Clean database. |
482
|
|
|
* |
483
|
|
|
* @param ManagerRegistry $registry |
484
|
|
|
* @param EntityManager $om |
485
|
|
|
* @param null $omName |
486
|
|
|
*/ |
487
|
6 |
|
private function cleanDatabase(ManagerRegistry $registry, EntityManager $om, $omName = null) |
488
|
|
|
{ |
489
|
6 |
|
$connection = $om->getConnection(); |
490
|
|
|
|
491
|
6 |
|
$mysql = ($registry->getName() === 'ORM' |
492
|
6 |
|
&& $connection->getDatabasePlatform() instanceof MySqlPlatform); |
493
|
|
|
|
494
|
6 |
|
if ($mysql) { |
495
|
1 |
|
$connection->query('SET FOREIGN_KEY_CHECKS=0'); |
496
|
1 |
|
} |
497
|
|
|
|
498
|
6 |
|
$this->loadFixtures(array(), $omName); |
499
|
|
|
|
500
|
6 |
|
if ($mysql) { |
501
|
1 |
|
$connection->query('SET FOREIGN_KEY_CHECKS=1'); |
502
|
1 |
|
} |
503
|
6 |
|
} |
504
|
|
|
|
505
|
|
|
/** |
506
|
|
|
* Locate fixture files. |
507
|
|
|
* |
508
|
|
|
* @param array $paths |
509
|
|
|
* |
510
|
|
|
* @return array $files |
511
|
|
|
*/ |
512
|
6 |
|
private function locateResources($paths) |
513
|
|
|
{ |
514
|
6 |
|
$files = array(); |
515
|
|
|
|
516
|
6 |
|
$kernel = $this->getContainer()->get('kernel'); |
517
|
|
|
|
518
|
6 |
|
foreach ($paths as $path) { |
519
|
6 |
|
if ($path[0] !== '@' && file_exists($path) === true) { |
520
|
1 |
|
$files[] = $path; |
521
|
1 |
|
continue; |
522
|
|
|
} |
523
|
|
|
|
524
|
5 |
|
$files[] = $kernel->locateResource($path); |
525
|
6 |
|
} |
526
|
|
|
|
527
|
6 |
|
return $files; |
528
|
|
|
} |
529
|
|
|
|
530
|
|
|
/** |
531
|
|
|
* @param array $paths Either symfony resource locators (@ BundleName/etc) or actual file paths |
532
|
|
|
* @param bool $append |
533
|
|
|
* @param null $omName |
534
|
|
|
* @param string $registryName |
535
|
|
|
* |
536
|
|
|
* @return array |
537
|
|
|
* |
538
|
|
|
* @throws \BadMethodCallException |
539
|
|
|
*/ |
540
|
6 |
|
public function loadFixtureFiles(array $paths = array(), $append = false, $omName = null, $registryName = 'doctrine') |
541
|
|
|
{ |
542
|
6 |
|
if (!class_exists('Nelmio\Alice\Fixtures')) { |
543
|
|
|
// This class is available during tests, no exception will be thrown. |
544
|
|
|
// @codeCoverageIgnoreStart |
545
|
|
|
throw new \BadMethodCallException('nelmio/alice should be installed to use this method.'); |
546
|
|
|
// @codeCoverageIgnoreEnd |
547
|
|
|
} |
548
|
|
|
|
549
|
|
|
/** @var ContainerInterface $container */ |
550
|
6 |
|
$container = $this->getContainer(); |
551
|
|
|
|
552
|
|
|
/** @var ManagerRegistry $registry */ |
553
|
6 |
|
$registry = $container->get($registryName); |
554
|
|
|
|
555
|
|
|
/** @var EntityManager $om */ |
556
|
6 |
|
$om = $registry->getManager($omName); |
557
|
|
|
|
558
|
6 |
|
if ($append === false) { |
559
|
6 |
|
$this->cleanDatabase($registry, $om, $omName); |
560
|
6 |
|
} |
561
|
|
|
|
562
|
6 |
|
$files = $this->locateResources($paths); |
563
|
|
|
|
564
|
|
|
// Check if the Hautelook AliceBundle is registered and if yes, use it instead of Nelmio Alice |
565
|
6 |
|
$hautelookLoaderServiceName = 'hautelook_alice.fixtures.loader'; |
566
|
6 |
|
if ($container->has($hautelookLoaderServiceName)) { |
567
|
3 |
|
$loaderService = $container->get($hautelookLoaderServiceName); |
568
|
3 |
|
$persisterClass = class_exists('Nelmio\Alice\ORM\Doctrine') ? |
569
|
3 |
|
'Nelmio\Alice\ORM\Doctrine' : |
570
|
3 |
|
'Nelmio\Alice\Persister\Doctrine'; |
571
|
|
|
|
572
|
3 |
|
return $loaderService->load(new $persisterClass($om), $files); |
573
|
|
|
} |
574
|
|
|
|
575
|
3 |
|
return Fixtures::load($files, $om); |
576
|
|
|
} |
577
|
|
|
|
578
|
|
|
/** |
579
|
|
|
* Callback function to be executed after Schema creation. |
580
|
|
|
* Use this to execute acl:init or other things necessary. |
581
|
|
|
*/ |
582
|
21 |
|
protected function postFixtureSetup() |
583
|
|
|
{ |
584
|
21 |
|
} |
585
|
|
|
|
586
|
|
|
/** |
587
|
|
|
* Callback function to be executed after Schema restore. |
588
|
|
|
* |
589
|
|
|
* @return WebTestCase |
590
|
|
|
*/ |
591
|
7 |
|
protected function postFixtureRestore() |
592
|
|
|
{ |
593
|
7 |
|
} |
594
|
|
|
|
595
|
|
|
/** |
596
|
|
|
* Callback function to be executed before Schema restore. |
597
|
|
|
* |
598
|
|
|
* @param ObjectManager $manager The object manager |
599
|
|
|
* @param ProxyReferenceRepository $referenceRepository The reference repository |
600
|
|
|
* |
601
|
|
|
* @return WebTestCase |
602
|
|
|
*/ |
603
|
7 |
|
protected function preFixtureRestore(ObjectManager $manager, ProxyReferenceRepository $referenceRepository) |
|
|
|
|
604
|
|
|
{ |
605
|
7 |
|
} |
606
|
|
|
|
607
|
|
|
/** |
608
|
|
|
* Callback function to be executed after save of references. |
609
|
|
|
* |
610
|
|
|
* @param ObjectManager $manager The object manager |
611
|
|
|
* @param AbstractExecutor $executor Executor of the data fixtures |
612
|
|
|
* @param string $backupFilePath Path of file used to backup the references of the data fixtures |
613
|
|
|
* |
614
|
|
|
* @return WebTestCase |
615
|
|
|
*/ |
616
|
3 |
|
protected function postReferenceSave(ObjectManager $manager, AbstractExecutor $executor, $backupFilePath) |
|
|
|
|
617
|
|
|
{ |
618
|
3 |
|
} |
619
|
|
|
|
620
|
|
|
/** |
621
|
|
|
* Callback function to be executed before save of references. |
622
|
|
|
* |
623
|
|
|
* @param ObjectManager $manager The object manager |
624
|
|
|
* @param AbstractExecutor $executor Executor of the data fixtures |
625
|
|
|
* @param string $backupFilePath Path of file used to backup the references of the data fixtures |
626
|
|
|
* |
627
|
|
|
* @return WebTestCase |
628
|
|
|
*/ |
629
|
3 |
|
protected function preReferenceSave(ObjectManager $manager, AbstractExecutor $executor, $backupFilePath) |
|
|
|
|
630
|
|
|
{ |
631
|
3 |
|
} |
632
|
|
|
|
633
|
|
|
/** |
634
|
|
|
* Retrieve Doctrine DataFixtures loader. |
635
|
|
|
* |
636
|
|
|
* @param ContainerInterface $container |
637
|
|
|
* @param array $classNames |
638
|
|
|
* |
639
|
|
|
* @return Loader |
640
|
|
|
*/ |
641
|
33 |
|
protected function getFixtureLoader(ContainerInterface $container, array $classNames) |
642
|
|
|
{ |
643
|
33 |
|
$loaderClass = class_exists('Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader') |
644
|
33 |
|
? 'Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader' |
645
|
33 |
|
: (class_exists('Doctrine\Bundle\FixturesBundle\Common\DataFixtures\Loader') |
646
|
|
|
// This class is not available during tests. |
647
|
|
|
// @codeCoverageIgnoreStart |
648
|
|
|
? 'Doctrine\Bundle\FixturesBundle\Common\DataFixtures\Loader' |
649
|
|
|
// @codeCoverageIgnoreEnd |
650
|
33 |
|
: 'Symfony\Bundle\DoctrineFixturesBundle\Common\DataFixtures\Loader'); |
651
|
|
|
|
652
|
33 |
|
$loader = new $loaderClass($container); |
653
|
|
|
|
654
|
33 |
|
foreach ($classNames as $className) { |
655
|
11 |
|
$this->loadFixtureClass($loader, $className); |
656
|
33 |
|
} |
657
|
|
|
|
658
|
33 |
|
return $loader; |
659
|
|
|
} |
660
|
|
|
|
661
|
|
|
/** |
662
|
|
|
* Load a data fixture class. |
663
|
|
|
* |
664
|
|
|
* @param Loader $loader |
665
|
|
|
* @param string $className |
666
|
|
|
*/ |
667
|
11 |
|
protected function loadFixtureClass($loader, $className) |
668
|
|
|
{ |
669
|
11 |
|
$fixture = new $className(); |
670
|
|
|
|
671
|
11 |
|
if ($loader->hasFixture($fixture)) { |
672
|
2 |
|
unset($fixture); |
673
|
|
|
|
674
|
2 |
|
return; |
675
|
|
|
} |
676
|
|
|
|
677
|
11 |
|
$loader->addFixture($fixture); |
678
|
|
|
|
679
|
11 |
|
if ($fixture instanceof DependentFixtureInterface) { |
680
|
2 |
|
foreach ($fixture->getDependencies() as $dependency) { |
681
|
2 |
|
$this->loadFixtureClass($loader, $dependency); |
682
|
2 |
|
} |
683
|
2 |
|
} |
684
|
11 |
|
} |
685
|
|
|
|
686
|
|
|
/** |
687
|
|
|
* Creates an instance of a lightweight Http client. |
688
|
|
|
* |
689
|
|
|
* If $authentication is set to 'true' it will use the content of |
690
|
|
|
* 'liip_functional_test.authentication' to log in. |
691
|
|
|
* |
692
|
|
|
* $params can be used to pass headers to the client, note that they have |
693
|
|
|
* to follow the naming format used in $_SERVER. |
694
|
|
|
* Example: 'HTTP_X_REQUESTED_WITH' instead of 'X-Requested-With' |
695
|
|
|
* |
696
|
|
|
* @param bool|array $authentication |
697
|
|
|
* @param array $params |
698
|
|
|
* |
699
|
|
|
* @return Client |
700
|
|
|
*/ |
701
|
51 |
|
protected function makeClient($authentication = false, array $params = array()) |
702
|
|
|
{ |
703
|
51 |
|
if ($authentication) { |
704
|
2 |
|
if ($authentication === true) { |
705
|
|
|
$authentication = array( |
706
|
1 |
|
'username' => $this->getContainer() |
707
|
1 |
|
->getParameter('liip_functional_test.authentication.username'), |
708
|
1 |
|
'password' => $this->getContainer() |
709
|
1 |
|
->getParameter('liip_functional_test.authentication.password'), |
710
|
1 |
|
); |
711
|
1 |
|
} |
712
|
|
|
|
713
|
2 |
|
$params = array_merge($params, array( |
714
|
2 |
|
'PHP_AUTH_USER' => $authentication['username'], |
715
|
2 |
|
'PHP_AUTH_PW' => $authentication['password'], |
716
|
2 |
|
)); |
717
|
2 |
|
} |
718
|
|
|
|
719
|
51 |
|
$client = static::createClient(array('environment' => $this->environment), $params); |
720
|
|
|
|
721
|
51 |
|
if ($this->firewallLogins) { |
|
|
|
|
722
|
|
|
// has to be set otherwise "hasPreviousSession" in Request returns false. |
723
|
2 |
|
$options = $client->getContainer()->getParameter('session.storage.options'); |
724
|
|
|
|
725
|
2 |
|
if (!$options || !isset($options['name'])) { |
726
|
|
|
throw new \InvalidArgumentException('Missing session.storage.options#name'); |
727
|
|
|
} |
728
|
|
|
|
729
|
2 |
|
$session = $client->getContainer()->get('session'); |
730
|
|
|
// Since the namespace of the session changed in symfony 2.1, instanceof can be used to check the version. |
731
|
2 |
|
if ($session instanceof Session) { |
732
|
2 |
|
$session->setId(uniqid()); |
733
|
2 |
|
} |
734
|
|
|
|
735
|
2 |
|
$client->getCookieJar()->set(new Cookie($options['name'], $session->getId())); |
736
|
|
|
|
737
|
|
|
/** @var $user UserInterface */ |
738
|
2 |
|
foreach ($this->firewallLogins as $firewallName => $user) { |
739
|
2 |
|
$token = $this->createUserToken($user, $firewallName); |
740
|
|
|
|
741
|
|
|
// BC: security.token_storage is available on Symfony 2.6+ |
742
|
|
|
// see http://symfony.com/blog/new-in-symfony-2-6-security-component-improvements |
743
|
2 |
|
if ($client->getContainer()->has('security.token_storage')) { |
744
|
2 |
|
$tokenStorage = $client->getContainer()->get('security.token_storage'); |
745
|
2 |
|
} else { |
746
|
|
|
// This block will never be reached with Symfony 2.6+ |
747
|
|
|
// @codeCoverageIgnoreStart |
748
|
|
|
$tokenStorage = $client->getContainer()->get('security.context'); |
749
|
|
|
// @codeCoverageIgnoreEnd |
750
|
|
|
} |
751
|
|
|
|
752
|
2 |
|
$tokenStorage->setToken($token); |
753
|
2 |
|
$session->set('_security_'.$firewallName, serialize($token)); |
754
|
2 |
|
} |
755
|
|
|
|
756
|
2 |
|
$session->save(); |
757
|
2 |
|
} |
758
|
|
|
|
759
|
51 |
|
return $client; |
760
|
|
|
} |
761
|
|
|
|
762
|
|
|
/** |
763
|
|
|
* Create User Token. |
764
|
|
|
* |
765
|
|
|
* Factory method for creating a User Token object for the firewall based on |
766
|
|
|
* the user object provided. By default it will be a Username/Password |
767
|
|
|
* Token based on the user's credentials, but may be overridden for custom |
768
|
|
|
* tokens in your applications. |
769
|
|
|
* |
770
|
|
|
* @param UserInterface $user The user object to base the token off of |
771
|
|
|
* @param string $firewallName name of the firewall provider to use |
772
|
|
|
* |
773
|
|
|
* @return TokenInterface The token to be used in the security context |
774
|
|
|
*/ |
775
|
2 |
|
protected function createUserToken(UserInterface $user, $firewallName) |
776
|
|
|
{ |
777
|
2 |
|
return new UsernamePasswordToken( |
778
|
2 |
|
$user, |
779
|
2 |
|
null, |
780
|
2 |
|
$firewallName, |
781
|
2 |
|
$user->getRoles() |
782
|
2 |
|
); |
783
|
|
|
} |
784
|
|
|
|
785
|
|
|
/** |
786
|
|
|
* Extracts the location from the given route. |
787
|
|
|
* |
788
|
|
|
* @param string $route The name of the route |
789
|
|
|
* @param array $params Set of parameters |
790
|
|
|
* @param int $absolute |
791
|
|
|
* |
792
|
|
|
* @return string |
793
|
|
|
*/ |
794
|
1 |
|
protected function getUrl($route, $params = array(), $absolute = UrlGeneratorInterface::ABSOLUTE_PATH) |
795
|
|
|
{ |
796
|
1 |
|
return $this->getContainer()->get('router')->generate($route, $params, $absolute); |
797
|
|
|
} |
798
|
|
|
|
799
|
|
|
/** |
800
|
|
|
* Checks the success state of a response. |
801
|
|
|
* |
802
|
|
|
* @param Response $response Response object |
803
|
|
|
* @param bool $success to define whether the response is expected to be successful |
804
|
|
|
* @param string $type |
805
|
|
|
*/ |
806
|
6 |
|
public function isSuccessful(Response $response, $success = true, $type = 'text/html') |
807
|
|
|
{ |
808
|
6 |
|
HttpAssertions::isSuccessful($response, $success, $type); |
809
|
5 |
|
} |
810
|
|
|
|
811
|
|
|
/** |
812
|
|
|
* Executes a request on the given url and returns the response contents. |
813
|
|
|
* |
814
|
|
|
* This method also asserts the request was successful. |
815
|
|
|
* |
816
|
|
|
* @param string $path path of the requested page |
817
|
|
|
* @param string $method The HTTP method to use, defaults to GET |
818
|
|
|
* @param bool $authentication Whether to use authentication, defaults to false |
819
|
|
|
* @param bool $success to define whether the response is expected to be successful |
820
|
|
|
* |
821
|
|
|
* @return string |
822
|
|
|
*/ |
823
|
1 |
|
public function fetchContent($path, $method = 'GET', $authentication = false, $success = true) |
824
|
|
|
{ |
825
|
1 |
|
$client = $this->makeClient($authentication); |
826
|
1 |
|
$client->request($method, $path); |
827
|
|
|
|
828
|
1 |
|
$content = $client->getResponse()->getContent(); |
829
|
1 |
|
if (is_bool($success)) { |
830
|
1 |
|
$this->isSuccessful($client->getResponse(), $success); |
|
|
|
|
831
|
1 |
|
} |
832
|
|
|
|
833
|
1 |
|
return $content; |
834
|
|
|
} |
835
|
|
|
|
836
|
|
|
/** |
837
|
|
|
* Executes a request on the given url and returns a Crawler object. |
838
|
|
|
* |
839
|
|
|
* This method also asserts the request was successful. |
840
|
|
|
* |
841
|
|
|
* @param string $path path of the requested page |
842
|
|
|
* @param string $method The HTTP method to use, defaults to GET |
843
|
|
|
* @param bool $authentication Whether to use authentication, defaults to false |
844
|
|
|
* @param bool $success Whether the response is expected to be successful |
845
|
|
|
* |
846
|
|
|
* @return Crawler |
847
|
|
|
*/ |
848
|
1 |
|
public function fetchCrawler($path, $method = 'GET', $authentication = false, $success = true) |
849
|
|
|
{ |
850
|
1 |
|
$client = $this->makeClient($authentication); |
851
|
1 |
|
$crawler = $client->request($method, $path); |
852
|
|
|
|
853
|
1 |
|
$this->isSuccessful($client->getResponse(), $success); |
|
|
|
|
854
|
|
|
|
855
|
1 |
|
return $crawler; |
856
|
|
|
} |
857
|
|
|
|
858
|
|
|
/** |
859
|
|
|
* @param UserInterface $user |
860
|
|
|
* @param string $firewallName |
861
|
|
|
* |
862
|
|
|
* @return WebTestCase |
863
|
|
|
*/ |
864
|
2 |
|
public function loginAs(UserInterface $user, $firewallName) |
865
|
|
|
{ |
866
|
2 |
|
$this->firewallLogins[$firewallName] = $user; |
867
|
|
|
|
868
|
2 |
|
return $this; |
869
|
|
|
} |
870
|
|
|
|
871
|
|
|
/** |
872
|
|
|
* Asserts that the HTTP response code of the last request performed by |
873
|
|
|
* $client matches the expected code. If not, raises an error with more |
874
|
|
|
* information. |
875
|
|
|
* |
876
|
|
|
* @param $expectedStatusCode |
877
|
|
|
* @param Client $client |
878
|
|
|
*/ |
879
|
12 |
|
public function assertStatusCode($expectedStatusCode, Client $client) |
880
|
|
|
{ |
881
|
12 |
|
HttpAssertions::assertStatusCode($expectedStatusCode, $client); |
882
|
9 |
|
} |
883
|
|
|
|
884
|
|
|
/** |
885
|
|
|
* Assert that the last validation errors within $container match the |
886
|
|
|
* expected keys. |
887
|
|
|
* |
888
|
|
|
* @param array $expected A flat array of field names |
889
|
|
|
* @param ContainerInterface $container |
890
|
|
|
*/ |
891
|
3 |
|
public function assertValidationErrors(array $expected, ContainerInterface $container) |
892
|
|
|
{ |
893
|
3 |
|
HttpAssertions::assertValidationErrors($expected, $container); |
894
|
1 |
|
} |
895
|
|
|
|
896
|
|
|
/** |
897
|
|
|
* @param array $excludedDoctrineTables |
898
|
|
|
*/ |
899
|
1 |
|
public function setExcludedDoctrineTables($excludedDoctrineTables) |
900
|
|
|
{ |
901
|
1 |
|
$this->excludedDoctrineTables = $excludedDoctrineTables; |
902
|
1 |
|
} |
903
|
|
|
} |
904
|
|
|
|
Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: