Completed
Pull Request — master (#46)
by Alexis
13:52 queued 07:07
created

WebTestCase::locateResources()   A

Complexity

Conditions 4
Paths 3

Size

Total Lines 17
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 10
CRAP Score 4

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 17
ccs 10
cts 10
cp 1
rs 9.2
cc 4
eloc 9
nc 3
nop 1
crap 4
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\Executor\AbstractExecutor;
34
use Doctrine\Common\DataFixtures\ProxyReferenceRepository;
35
use Doctrine\DBAL\Driver\PDOSqlite\Driver as SqliteDriver;
36
use Doctrine\DBAL\Platforms\MySqlPlatform;
37
use Doctrine\ORM\EntityManager;
38
use Doctrine\ORM\Tools\SchemaTool;
39
use Nelmio\Alice\Fixtures;
40
use Liip\FunctionalTestBundle\Utils\FixturesLoader;
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 static $cachedMetadatas = array();
69
70
    protected static function getKernelClass()
0 ignored issues
show
Coding Style introduced by
getKernelClass uses the super-global variable $_SERVER which is generally not recommended.

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:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
71
    {
72
        $dir = isset($_SERVER['KERNEL_DIR']) ? $_SERVER['KERNEL_DIR'] : static::getPhpUnitXmlDir();
73
74
        list($appname) = explode('\\', get_called_class());
75
76
        $class = $appname.'Kernel';
77
        $file = $dir.'/'.strtolower($appname).'/'.$class.'.php';
78
        if (!file_exists($file)) {
79
            return parent::getKernelClass();
80
        }
81
        require_once $file;
82
83
        return $class;
84
    }
85
86
    /**
87
     * Creates a mock object of a service identified by its id.
88
     *
89
     * @param string $id
90
     *
91
     * @return \PHPUnit_Framework_MockObject_MockBuilder
92
     */
93 2
    protected function getServiceMockBuilder($id)
94
    {
95 2
        $service = $this->getContainer()->get($id);
96
        $class = get_class($service);
97
98
        return $this->getMockBuilder($class)->disableOriginalConstructor();
99
    }
100
101
    /**
102
     * Builds up the environment to run the given command.
103
     *
104
     * @param string $name
105
     * @param array  $params
106
     * @param bool   $reuseKernel
107
     *
108
     * @return string
109
     */
110 13
    protected function runCommand($name, array $params = array(), $reuseKernel = false)
111
    {
112 13
        array_unshift($params, $name);
113
114 13
        if (!$reuseKernel) {
115 13
            if (null !== static::$kernel) {
116 9
                static::$kernel->shutdown();
117 9
            }
118
119 13
            $kernel = static::$kernel = $this->createKernel(array('environment' => $this->environment));
120 13
            $kernel->boot();
121 13
        } else {
122 2
            $kernel = $this->getContainer()->get('kernel');
123
        }
124
125 13
        $application = new Application($kernel);
126 13
        $application->setAutoExit(false);
127
128
        // @codeCoverageIgnoreStart
129
        if ('20301' === Kernel::VERSION_ID) {
130
            $params = $this->configureVerbosityForSymfony20301($params);
131
        }
132
        // @codeCoverageIgnoreEnd
133
134 13
        $input = new ArrayInput($params);
135 13
        $input->setInteractive(false);
136
137 13
        $fp = fopen('php://temp/maxmemory:'.$this->maxMemory, 'r+');
138 13
        $output = new StreamOutput($fp, $this->getVerbosityLevel(), $this->getDecorated());
139
140 12
        $application->run($input, $output);
141
142 12
        rewind($fp);
143
144 12
        return stream_get_contents($fp);
145
    }
146
147
    /**
148
     * Retrieves the output verbosity level.
149
     *
150
     * @see Symfony\Component\Console\Output\OutputInterface for available levels
151
     *
152
     * @return int
153
     *
154
     * @throws \OutOfBoundsException If the set value isn't accepted
155
     */
156 13
    protected function getVerbosityLevel()
157
    {
158
        // If `null`, is not yet set
159 13
        if (null === $this->verbosityLevel) {
160
            // Set the global verbosity level that is set as NORMAL by the TreeBuilder in Configuration
161 7
            $level = strtoupper($this->getContainer()->getParameter('liip_functional_test.command_verbosity'));
162 7
            $verbosity = '\Symfony\Component\Console\Output\StreamOutput::VERBOSITY_'.$level;
163
164 7
            $this->verbosityLevel = constant($verbosity);
165 7
        }
166
167
        // If string, it is set by the developer, so check that the value is an accepted one
168 13
        if (is_string($this->verbosityLevel)) {
169 6
            $level = strtoupper($this->verbosityLevel);
170 6
            $verbosity = '\Symfony\Component\Console\Output\StreamOutput::VERBOSITY_'.$level;
171
172 6
            if (!defined($verbosity)) {
173 1
                throw new \OutOfBoundsException(
174 1
                    sprintf('The set value "%s" for verbosityLevel is not valid. Accepted are: "quiet", "normal", "verbose", "very_verbose" and "debug".', $level)
175 1
                    );
176
            }
177
178 5
            $this->verbosityLevel = constant($verbosity);
179 5
        }
180
181 12
        return $this->verbosityLevel;
182
    }
183
184
    /**
185
     * In Symfony 2.3.1 the verbosity level has to be set through {Symfony\Component\Console\Input\ArrayInput} and not
186
     * in {Symfony\Component\Console\Output\OutputInterface}.
187
     *
188
     * This method builds $params to be passed to {Symfony\Component\Console\Input\ArrayInput}.
189
     *
190
     * @codeCoverageIgnore
191
     *
192
     * @param array $params
193
     *
194
     * @return array
195
     */
196
    private function configureVerbosityForSymfony20301(array $params)
197
    {
198
        switch ($this->getVerbosityLevel()) {
199
            case OutputInterface::VERBOSITY_QUIET:
200
                $params['-q'] = '-q';
201
                break;
202
203
            case OutputInterface::VERBOSITY_VERBOSE:
204
                $params['-v'] = '';
205
                break;
206
207
            case OutputInterface::VERBOSITY_VERY_VERBOSE:
208
                $params['-vv'] = '';
209
                break;
210
211
            case OutputInterface::VERBOSITY_DEBUG:
212
                $params['-vvv'] = '';
213
                break;
214
        }
215
216
        return $params;
217
    }
218
219 6
    public function setVerbosityLevel($level)
220
    {
221 6
        $this->verbosityLevel = $level;
222 6
    }
223
224
    /**
225
     * Retrieves the flag indicating if the output should be decorated or not.
226
     *
227
     * @return bool
228
     */
229 12
    protected function getDecorated()
230
    {
231 12
        if (null === $this->decorated) {
232
            // Set the global decoration flag that is set to `true` by the TreeBuilder in Configuration
233 5
            $this->decorated = $this->getContainer()->getParameter('liip_functional_test.command_decoration');
234 5
        }
235
236
        // Check the local decorated flag
237 12
        if (false === is_bool($this->decorated)) {
238
            throw new \OutOfBoundsException(
239
                sprintf('`WebTestCase::decorated` has to be `bool`. "%s" given.', gettype($this->decorated))
240
            );
241
        }
242
243 12
        return $this->decorated;
244
    }
245
246 7
    public function isDecorated($decorated)
247
    {
248 7
        $this->decorated = $decorated;
249 7
    }
250
251
    /**
252
     * Get an instance of the dependency injection container.
253
     * (this creates a kernel *without* parameters).
254
     *
255
     * @return ContainerInterface
256
     */
257 46
    protected function getContainer()
0 ignored issues
show
Coding Style introduced by
getContainer uses the super-global variable $_SERVER which is generally not recommended.

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:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
258
    {
259 46
        if (!empty($this->kernelDir)) {
260
            $tmpKernelDir = isset($_SERVER['KERNEL_DIR']) ? $_SERVER['KERNEL_DIR'] : null;
261
            $_SERVER['KERNEL_DIR'] = getcwd().$this->kernelDir;
262
        }
263
264 46
        $cacheKey = $this->kernelDir.'|'.$this->environment;
265 46
        if (empty($this->containers[$cacheKey])) {
266
            $options = array(
267 45
                'environment' => $this->environment,
268 45
            );
269 45
            $kernel = $this->createKernel($options);
270 45
            $kernel->boot();
271
272 45
            $this->containers[$cacheKey] = $kernel->getContainer();
273 45
        }
274
275 46
        if (isset($tmpKernelDir)) {
276
            $_SERVER['KERNEL_DIR'] = $tmpKernelDir;
277
        }
278
279 46
        return $this->containers[$cacheKey];
280
    }
281
282
    /**
283
     * Set the database to the provided fixtures.
284
     *
285
     * Drops the current database and then loads fixtures using the specified
286
     * classes. The parameter is a list of fully qualified class names of
287
     * classes that implement Doctrine\Common\DataFixtures\FixtureInterface
288
     * so that they can be loaded by the DataFixtures Loader::addFixture
289
     *
290
     * When using SQLite this method will automatically make a copy of the
291
     * loaded schema and fixtures which will be restored automatically in
292
     * case the same fixture classes are to be loaded again. Caveat: changes
293
     * to references and/or identities may go undetected.
294
     *
295
     * Depends on the doctrine data-fixtures library being available in the
296
     * class path.
297
     *
298
     * @param array  $classNames   List of fully qualified class names of fixtures to load
299
     * @param string $omName       The name of object manager to use
300
     * @param string $registryName The service id of manager registry to use
301
     * @param int    $purgeMode    Sets the ORM purge mode
302
     *
303
     * @return null|AbstractExecutor
304
     */
305 32
    protected function loadFixtures(array $classNames, $omName = null, $registryName = 'doctrine', $purgeMode = null)
306
    {
307 32
        $container = $this->getContainer();
308
        /** @var ManagerRegistry $registry */
309 32
        $registry = $container->get($registryName);
310
        /** @var ObjectManager $om */
311 32
        $om = $registry->getManager($omName);
312 32
        $type = $registry->getName();
313
314 32
        $executorClass = 'PHPCR' === $type && class_exists('Doctrine\Bundle\PHPCRBundle\DataFixtures\PHPCRExecutor')
315 32
            ? 'Doctrine\Bundle\PHPCRBundle\DataFixtures\PHPCRExecutor'
316 32
            : 'Doctrine\\Common\\DataFixtures\\Executor\\'.$type.'Executor';
317 32
        $referenceRepository = new ProxyReferenceRepository($om);
318 32
        $cacheDriver = $om->getMetadataFactory()->getCacheDriver();
319
320 32
        if ($cacheDriver) {
321 32
            $cacheDriver->deleteAll();
322 32
        }
323
324 32
        if ('ORM' === $type) {
325 31
            $connection = $om->getConnection();
326 31
            if ($connection->getDriver() instanceof SqliteDriver) {
327 27
                $params = $connection->getParams();
328 27
                if (isset($params['master'])) {
329
                    $params = $params['master'];
330
                }
331
332 27
                $name = isset($params['path']) ? $params['path'] : (isset($params['dbname']) ? $params['dbname'] : false);
333 27
                if (!$name) {
334
                    throw new \InvalidArgumentException("Connection does not contain a 'path' or 'dbname' parameter and cannot be dropped.");
335
                }
336
337 27
                if (!isset(self::$cachedMetadatas[$omName])) {
338 10
                    self::$cachedMetadatas[$omName] = $om->getMetadataFactory()->getAllMetadata();
339 10
                    usort(self::$cachedMetadatas[$omName], function ($a, $b) {
340
                        return strcmp($a->name, $b->name);
341 10
                    });
342 10
                }
343 27
                $metadatas = self::$cachedMetadatas[$omName];
344
345 27
                if ($container->getParameter('liip_functional_test.cache_sqlite_db')) {
346 9
                    $backup = $container->getParameter('kernel.cache_dir').'/test_'.md5(serialize($metadatas).serialize($classNames)).'.db';
347 9
                    if (file_exists($backup) && file_exists($backup.'.ser') && FixturesLoader::isBackupUpToDate($classNames, $backup, $container)) {
348 7
                        $om->flush();
349 7
                        $om->clear();
350
351 7
                        $this->preFixtureRestore($om, $referenceRepository);
352
353 7
                        copy($backup, $name);
354
355 7
                        $executor = new $executorClass($om);
356 7
                        $executor->setReferenceRepository($referenceRepository);
357 7
                        $executor->getReferenceRepository()->load($backup);
358
359 7
                        $this->postFixtureRestore();
360
361 7
                        return $executor;
362
                    }
363 3
                }
364
365
                // TODO: handle case when using persistent connections. Fail loudly?
366 21
                $schemaTool = new SchemaTool($om);
0 ignored issues
show
Compatibility introduced by
$om of type object<Doctrine\Common\Persistence\ObjectManager> is not a sub-type of object<Doctrine\ORM\EntityManagerInterface>. It seems like you assume a child interface of the interface Doctrine\Common\Persistence\ObjectManager to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
367 21
                $schemaTool->dropDatabase();
368 21
                if (!empty($metadatas)) {
369 21
                    $schemaTool->createSchema($metadatas);
370 21
                }
371 21
                $this->postFixtureSetup();
372
373 21
                $executor = new $executorClass($om);
374 21
                $executor->setReferenceRepository($referenceRepository);
375 21
            }
376 25
        }
377
378 26
        if (empty($executor)) {
379 5
            $purgerClass = 'Doctrine\\Common\\DataFixtures\\Purger\\'.$type.'Purger';
380 5
            if ('PHPCR' === $type) {
381 1
                $purger = new $purgerClass($om);
382 1
                $initManager = $container->has('doctrine_phpcr.initializer_manager')
383 1
                    ? $container->get('doctrine_phpcr.initializer_manager')
384 1
                    : null;
385
386 1
                $executor = new $executorClass($om, $purger, $initManager);
387 1
            } else {
388 4
                $purger = new $purgerClass();
389 4
                if (null !== $purgeMode) {
390 1
                    $purger->setPurgeMode($purgeMode);
391 1
                }
392
393 4
                $executor = new $executorClass($om, $purger);
394
            }
395
396 5
            $executor->setReferenceRepository($referenceRepository);
397 5
            $executor->purge();
398 5
        }
399
400 26
        $loader = FixturesLoader::getFixtureLoader($container, $classNames);
401
402 26
        $executor->execute($loader->getFixtures(), true);
403
404 26
        if (isset($name) && isset($backup)) {
405 3
            $this->preReferenceSave($om, $executor, $backup);
406
407 3
            $executor->getReferenceRepository()->save($backup);
408 3
            copy($name, $backup);
409
410 3
            $this->postReferenceSave($om, $executor, $backup);
411 3
        }
412
413 26
        return $executor;
414
    }
415
416
    /**
417
     * Clean database.
418
     *
419
     * @param ManagerRegistry $registry
420
     * @param EntityManager   $om
421
     */
422 6
    private function cleanDatabase(ManagerRegistry $registry, EntityManager $om)
423
    {
424 6
        $connection = $om->getConnection();
425
426 6
        $mysql = ($registry->getName() === 'ORM'
427 6
            && $connection->getDatabasePlatform() instanceof MySqlPlatform);
428
429 6
        if ($mysql) {
430 1
            $connection->query('SET FOREIGN_KEY_CHECKS=0');
431 1
        }
432
433 6
        $this->loadFixtures(array());
434
435 6
        if ($mysql) {
436 1
            $connection->query('SET FOREIGN_KEY_CHECKS=1');
437 1
        }
438 6
    }
439
440
    /**
441
     * @param array  $paths        Either symfony resource locators (@ BundleName/etc) or actual file paths
442
     * @param bool   $append
443
     * @param null   $omName
444
     * @param string $registryName
445
     *
446
     * @return array
447
     *
448
     * @throws \BadMethodCallException
449
     */
450 6
    public function loadFixtureFiles(array $paths = array(), $append = false, $omName = null, $registryName = 'doctrine')
451
    {
452 6
        if (!class_exists('Nelmio\Alice\Fixtures')) {
453
            // This class is available during tests, no exception will be thrown.
454
            // @codeCoverageIgnoreStart
455
            throw new \BadMethodCallException('nelmio/alice should be installed to use this method.');
456
            // @codeCoverageIgnoreEnd
457
        }
458
459
        /** @var ContainerInterface $container */
460 6
        $container = $this->getContainer();
461
462
        /** @var ManagerRegistry $registry */
463 6
        $registry = $container->get($registryName);
464
465
        /** @var EntityManager $om */
466 6
        $om = $registry->getManager($omName);
467
468 6
        if ($append === false) {
469 6
            $this->cleanDatabase($registry, $om);
470 6
        }
471
472 6
        $files = FixturesLoader::locateResources($paths, $container);
473
474
        // Check if the Hautelook AliceBundle is registered and if yes, use it instead of Nelmio Alice
475 6
        $hautelookLoaderServiceName = 'hautelook_alice.fixtures.loader';
476 6
        if ($container->has($hautelookLoaderServiceName)) {
477 3
            $loaderService = $container->get($hautelookLoaderServiceName);
478 3
            $persisterClass = class_exists('Nelmio\Alice\ORM\Doctrine') ?
479 3
                'Nelmio\Alice\ORM\Doctrine' :
480 3
                'Nelmio\Alice\Persister\Doctrine';
481
482 3
            return $loaderService->load(new $persisterClass($om), $files);
483
        }
484
485 3
        return Fixtures::load($files, $om);
486
    }
487
488
    /**
489
     * Callback function to be executed after Schema creation.
490
     * Use this to execute acl:init or other things necessary.
491
     */
492 21
    protected function postFixtureSetup()
493
    {
494 21
    }
495
496
    /**
497
     * Callback function to be executed after Schema restore.
498
     *
499
     * @return WebTestCase
500
     */
501 7
    protected function postFixtureRestore()
502
    {
503 7
    }
504
505
    /**
506
     * Callback function to be executed before Schema restore.
507
     *
508
     * @param ObjectManager            $manager             The object manager
509
     * @param ProxyReferenceRepository $referenceRepository The reference repository
510
     *
511
     * @return WebTestCase
512
     */
513 7
    protected function preFixtureRestore(ObjectManager $manager, ProxyReferenceRepository $referenceRepository)
0 ignored issues
show
Unused Code introduced by
The parameter $manager is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $referenceRepository is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
514
    {
515 7
    }
516
517
    /**
518
     * Callback function to be executed after save of references.
519
     *
520
     * @param ObjectManager    $manager        The object manager
521
     * @param AbstractExecutor $executor       Executor of the data fixtures
522
     * @param string           $backupFilePath Path of file used to backup the references of the data fixtures
523
     *
524
     * @return WebTestCase
525
     */
526 3
    protected function postReferenceSave(ObjectManager $manager, AbstractExecutor $executor, $backupFilePath)
0 ignored issues
show
Unused Code introduced by
The parameter $manager is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $executor is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $backupFilePath is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
527
    {
528 3
    }
529
530
    /**
531
     * Callback function to be executed before save of references.
532
     *
533
     * @param ObjectManager    $manager        The object manager
534
     * @param AbstractExecutor $executor       Executor of the data fixtures
535
     * @param string           $backupFilePath Path of file used to backup the references of the data fixtures
536
     *
537
     * @return WebTestCase
538
     */
539 3
    protected function preReferenceSave(ObjectManager $manager, AbstractExecutor $executor, $backupFilePath)
0 ignored issues
show
Unused Code introduced by
The parameter $manager is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $executor is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $backupFilePath is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
540
    {
541 3
    }
542
543
    /**
544
     * Creates an instance of a lightweight Http client.
545
     *
546
     * If $authentication is set to 'true' it will use the content of
547
     * 'liip_functional_test.authentication' to log in.
548
     *
549
     * $params can be used to pass headers to the client, note that they have
550
     * to follow the naming format used in $_SERVER.
551
     * Example: 'HTTP_X_REQUESTED_WITH' instead of 'X-Requested-With'
552
     *
553
     * @param bool|array $authentication
554
     * @param array      $params
555
     *
556
     * @return Client
557
     */
558 49
    protected function makeClient($authentication = false, array $params = array())
559
    {
560 49
        if ($authentication) {
561 2
            if ($authentication === true) {
562
                $authentication = array(
563 1
                    'username' => $this->getContainer()
564 1
                        ->getParameter('liip_functional_test.authentication.username'),
565 1
                    'password' => $this->getContainer()
566 1
                        ->getParameter('liip_functional_test.authentication.password'),
567 1
                );
568 1
            }
569
570 2
            $params = array_merge($params, array(
571 2
                'PHP_AUTH_USER' => $authentication['username'],
572 2
                'PHP_AUTH_PW' => $authentication['password'],
573 2
            ));
574 2
        }
575
576 49
        $client = static::createClient(array('environment' => $this->environment), $params);
577
578 49
        if ($this->firewallLogins) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->firewallLogins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
579
            // has to be set otherwise "hasPreviousSession" in Request returns false.
580 2
            $options = $client->getContainer()->getParameter('session.storage.options');
581
582 2
            if (!$options || !isset($options['name'])) {
583
                throw new \InvalidArgumentException('Missing session.storage.options#name');
584
            }
585
586 2
            $session = $client->getContainer()->get('session');
587
            // Since the namespace of the session changed in symfony 2.1, instanceof can be used to check the version.
588 2
            if ($session instanceof Session) {
589 2
                $session->setId(uniqid());
590 2
            }
591
592 2
            $client->getCookieJar()->set(new Cookie($options['name'], $session->getId()));
593
594
            /** @var $user UserInterface */
595 2
            foreach ($this->firewallLogins as $firewallName => $user) {
596 2
                $token = $this->createUserToken($user, $firewallName);
597
598
                // BC: security.token_storage is available on Symfony 2.6+
599
                // see http://symfony.com/blog/new-in-symfony-2-6-security-component-improvements
600 2
                if ($client->getContainer()->has('security.token_storage')) {
601 2
                    $tokenStorage = $client->getContainer()->get('security.token_storage');
602 2
                } else {
603
                    // This block will never be reached with Symfony 2.6+
604
                    // @codeCoverageIgnoreStart
605
                    $tokenStorage = $client->getContainer()->get('security.context');
606
                    // @codeCoverageIgnoreEnd
607
                }
608
609 2
                $tokenStorage->setToken($token);
610 2
                $session->set('_security_'.$firewallName, serialize($token));
611 2
            }
612
613 2
            $session->save();
614 2
        }
615
616 49
        return $client;
617
    }
618
619
    /**
620
     * Create User Token.
621
     *
622
     * Factory method for creating a User Token object for the firewall based on
623
     * the user object provided. By default it will be a Username/Password
624
     * Token based on the user's credentials, but may be overridden for custom
625
     * tokens in your applications.
626
     *
627
     * @param UserInterface $user         The user object to base the token off of
628
     * @param string        $firewallName name of the firewall provider to use
629
     *
630
     * @return TokenInterface The token to be used in the security context
631
     */
632 2
    protected function createUserToken(UserInterface $user, $firewallName)
633
    {
634 2
        return new UsernamePasswordToken(
635 2
            $user,
636 2
            null,
637 2
            $firewallName,
638 2
            $user->getRoles()
639 2
        );
640
    }
641
642
    /**
643
     * Extracts the location from the given route.
644
     *
645
     * @param string $route    The name of the route
646
     * @param array  $params   Set of parameters
647
     * @param int    $absolute
648
     *
649
     * @return string
650
     */
651 1
    protected function getUrl($route, $params = array(), $absolute = UrlGeneratorInterface::ABSOLUTE_PATH)
652
    {
653 1
        return $this->getContainer()->get('router')->generate($route, $params, $absolute);
654
    }
655
656
    /**
657
     * Checks the success state of a response.
658
     *
659
     * @param Response $response Response object
660
     * @param bool     $success  to define whether the response is expected to be successful
661
     * @param string   $type
662
     */
663 6
    public function isSuccessful(Response $response, $success = true, $type = 'text/html')
664
    {
665 6
        HttpAssertions::isSuccessful($response, $success, $type);
666 5
    }
667
668
    /**
669
     * Executes a request on the given url and returns the response contents.
670
     *
671
     * This method also asserts the request was successful.
672
     *
673
     * @param string $path           path of the requested page
674
     * @param string $method         The HTTP method to use, defaults to GET
675
     * @param bool   $authentication Whether to use authentication, defaults to false
676
     * @param bool   $success        to define whether the response is expected to be successful
677
     *
678
     * @return string
679
     */
680 1
    public function fetchContent($path, $method = 'GET', $authentication = false, $success = true)
681
    {
682 1
        $client = $this->makeClient($authentication);
683 1
        $client->request($method, $path);
684
685 1
        $content = $client->getResponse()->getContent();
686 1
        if (is_bool($success)) {
687 1
            $this->isSuccessful($client->getResponse(), $success);
688 1
        }
689
690 1
        return $content;
691
    }
692
693
    /**
694
     * Executes a request on the given url and returns a Crawler object.
695
     *
696
     * This method also asserts the request was successful.
697
     *
698
     * @param string $path           path of the requested page
699
     * @param string $method         The HTTP method to use, defaults to GET
700
     * @param bool   $authentication Whether to use authentication, defaults to false
701
     * @param bool   $success        Whether the response is expected to be successful
702
     *
703
     * @return Crawler
704
     */
705 1
    public function fetchCrawler($path, $method = 'GET', $authentication = false, $success = true)
706
    {
707 1
        $client = $this->makeClient($authentication);
708 1
        $crawler = $client->request($method, $path);
709
710 1
        $this->isSuccessful($client->getResponse(), $success);
711
712 1
        return $crawler;
713
    }
714
715
    /**
716
     * @param UserInterface $user
717
     * @param string        $firewallName
718
     *
719
     * @return WebTestCase
720
     */
721 2
    public function loginAs(UserInterface $user, $firewallName)
722
    {
723 2
        $this->firewallLogins[$firewallName] = $user;
724
725 2
        return $this;
726
    }
727
728
    /**
729
     * Asserts that the HTTP response code of the last request performed by
730
     * $client matches the expected code. If not, raises an error with more
731
     * information.
732
     *
733
     * @param $expectedStatusCode
734
     * @param Client $client
735
     */
736 11
    public function assertStatusCode($expectedStatusCode, Client $client)
737
    {
738 11
        HttpAssertions::assertStatusCode($expectedStatusCode, $client);
739 8
    }
740
741
    /**
742
     * Assert that the last validation errors within $container match the
743
     * expected keys.
744
     *
745
     * @param array              $expected  A flat array of field names
746
     * @param ContainerInterface $container
747
     */
748 2
    public function assertValidationErrors(array $expected, ContainerInterface $container)
749
    {
750 2
        HttpAssertions::assertValidationErrors($expected, $container);
751 1
    }
752
}
753