Repository navigation
Expand file tree
/
Copy pathSymfony.php
More file actions
627 lines (577 loc) · 19.1 KB
/
Copy pathSymfony.php
File metadata and controls
627 lines (577 loc) · 19.1 KB
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
<?php
namespace Codeception\Module;
use Codeception\Configuration;
use Codeception\Lib\Framework;
use Codeception\Exception\ModuleRequireException;
use Codeception\Lib\Connector\Symfony as SymfonyConnector;
use Codeception\Lib\Interfaces\DoctrineProvider;
use Codeception\Lib\Interfaces\PartedModule;
use Symfony\Component\Finder\Finder;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Component\VarDumper\Cloner\Data;
/**
* This module uses Symfony Crawler and HttpKernel to emulate requests and test response.
*
* ## Demo Project
*
* <https://github.com/Codeception/symfony-demo>
*
* ## Config
*
* ### Symfony 4.x
*
* * app_path: 'src' - in Symfony 4 Kernel is located inside `src`
* * environment: 'local' - environment used for load kernel
* * em_service: 'doctrine.orm.entity_manager' - use the stated EntityManager to pair with Doctrine Module.
* * debug: true - turn on/off debug mode
* * cache_router: 'false' - enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
* * rebootable_client: 'true' - reboot client's kernel before each request
*
* #### Example (`functional.suite.yml`) - Symfony 4 Directory Structure
*
* modules:
* enabled:
* - Symfony:
* app_path: 'src'
* environment: 'test'
*
*
* ### Symfony 3.x
*
* * app_path: 'app' - specify custom path to your app dir, where the kernel interface is located.
* * var_path: 'var' - specify custom path to your var dir, where bootstrap cache is located.
* * environment: 'local' - environment used for load kernel
* * em_service: 'doctrine.orm.entity_manager' - use the stated EntityManager to pair with Doctrine Module.
* * debug: true - turn on/off debug mode
* * cache_router: 'false' - enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
* * rebootable_client: 'true' - reboot client's kernel before each request
*
* #### Example (`functional.suite.yml`) - Symfony 3 Directory Structure
*
* modules:
* enabled:
* - Symfony:
* app_path: 'app/front'
* var_path: 'var'
* environment: 'local_test'
*
*
* ### Symfony 2.x
*
* * app_path: 'app' - specify custom path to your app dir, where bootstrap cache and kernel interface is located.
* * environment: 'local' - environment used for load kernel
* * debug: true - turn on/off debug mode
* * em_service: 'doctrine.orm.entity_manager' - use the stated EntityManager to pair with Doctrine Module.
* * cache_router: 'false' - enable router caching between tests in order to [increase performance](http://lakion.com/blog/how-did-we-speed-up-sylius-behat-suite-with-blackfire)
* * rebootable_client: 'true' - reboot client's kernel before each request
*
* ### Example (`functional.suite.yml`) - Symfony 2.x Directory Structure
*
* ```
* modules:
* - Symfony:
* app_path: 'app/front'
* environment: 'local_test'
* ```
*
* ## Public Properties
*
* * kernel - HttpKernel instance
* * client - current Crawler instance
*
* ## Parts
*
* * services - allows to use Symfony DIC only with WebDriver or PhpBrowser modules.
*
* Usage example:
*
* ```yaml
* actor: AcceptanceTester
* modules:
* enabled:
* - Symfony:
* part: SERVICES
* - Doctrine2:
* depends: Symfony
* - WebDriver:
* url: http://your-url.com
* browser: phantomjs
* ```
*
*/
class Symfony extends Framework implements DoctrineProvider, PartedModule
{
/**
* @var \Symfony\Component\HttpKernel\Kernel
*/
public $kernel;
public $config = [
'app_path' => 'app',
'var_path' => 'app',
'environment' => 'test',
'debug' => true,
'cache_router' => false,
'em_service' => 'doctrine.orm.entity_manager',
'rebootable_client' => true,
];
/**
* @return array
*/
public function _parts()
{
return ['services'];
}
/**
* @var
*/
protected $kernelClass;
/**
* Services that should be persistent permanently for all tests
*
* @var array
*/
protected $permanentServices = [];
/**
* Services that should be persistent during test execution between kernel reboots
*
* @var array
*/
protected $persistentServices = [];
public function _initialize()
{
$this->initializeSymfonyCache();
$this->kernelClass = $this->getKernelClass();
$maxNestingLevel = 200; // Symfony may have very long nesting level
$xdebugMaxLevelKey = 'xdebug.max_nesting_level';
if (ini_get($xdebugMaxLevelKey) < $maxNestingLevel) {
ini_set($xdebugMaxLevelKey, $maxNestingLevel);
}
$this->kernel = new $this->kernelClass($this->config['environment'], $this->config['debug']);
$this->kernel->boot();
if ($this->config['cache_router'] === true) {
$this->persistService('router', true);
}
}
/**
* Require Symfonys bootstrap.php.cache only for PHP Version < 7
*
* @throws ModuleRequireException
*/
private function initializeSymfonyCache()
{
$cache = Configuration::projectDir() . $this->config['var_path'] . DIRECTORY_SEPARATOR . 'bootstrap.php.cache';
if (PHP_VERSION_ID < 70000 && !file_exists($cache)) {
throw new ModuleRequireException(
__CLASS__,
"Symfony bootstrap file not found in $cache\n \n" .
"Please specify path to bootstrap file using `var_path` config option\n \n" .
"If you are trying to load bootstrap from a Bundle provide path like:\n \n" .
"modules:\n enabled:\n" .
" - Symfony:\n" .
" var_path: '../../app'\n" .
" app_path: '../../app'"
);
}
if (file_exists($cache)) {
require_once $cache;
}
}
/**
* Initialize new client instance before each test
*/
public function _before(\Codeception\TestInterface $test)
{
$this->persistentServices = array_merge($this->persistentServices, $this->permanentServices);
$this->client = new SymfonyConnector($this->kernel, $this->persistentServices, $this->config['rebootable_client']);
}
/**
* Update permanent services after each test
*/
public function _after(\Codeception\TestInterface $test)
{
foreach ($this->permanentServices as $serviceName => $service) {
$this->permanentServices[$serviceName] = $this->grabService($serviceName);
}
parent::_after($test);
}
/**
* Retrieve Entity Manager.
*
* EM service is retrieved once and then that instance returned on each call
*/
public function _getEntityManager()
{
if ($this->kernel === null) {
$this->fail('Symfony2 platform module is not loaded');
}
if (!isset($this->permanentServices[$this->config['em_service']])) {
// try to persist configured EM
$this->persistService($this->config['em_service'], true);
if ($this->_getContainer()->has('doctrine')) {
$this->persistService('doctrine', true);
}
if ($this->_getContainer()->has('doctrine.orm.default_entity_manager')) {
$this->persistService('doctrine.orm.default_entity_manager', true);
}
if ($this->_getContainer()->has('doctrine.dbal.backend_connection')) {
$this->persistService('doctrine.dbal.backend_connection', true);
}
}
return $this->permanentServices[$this->config['em_service']];
}
/**
* Return container.
*
* @return ContainerInterface
*/
public function _getContainer()
{
return $this->kernel->getContainer();
}
/**
* Attempts to guess the kernel location.
*
* When the Kernel is located, the file is required.
*
* @return string The Kernel class name
*/
protected function getKernelClass()
{
$path = codecept_root_dir() . $this->config['app_path'];
if (!file_exists(codecept_root_dir() . $this->config['app_path'])) {
throw new ModuleRequireException(
__CLASS__,
"Can't load Kernel from $path.\n"
. "Directory does not exists. Use `app_path` parameter to provide valid application path"
);
}
$finder = new Finder();
$finder->name('*Kernel.php')->depth('0')->in($path);
$results = iterator_to_array($finder);
if (!count($results)) {
throw new ModuleRequireException(
__CLASS__,
"File with Kernel class was not found at $path. "
. "Specify directory where file with Kernel class for your application is located with `app_path` parameter."
);
}
$file = current($results);
if (file_exists(codecept_root_dir() . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php')) {
// ensure autoloader from this dir is loaded
require_once codecept_root_dir() . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
}
require_once $file;
$possibleKernelClasses = [
'AppKernel', // Symfony Standard
'App\Kernel', // Symfony Flex
];
foreach ($possibleKernelClasses as $class) {
if (class_exists($class)) {
$refClass = new \ReflectionClass($class);
if ($refClass->getFileName() === $file->getRealpath()) {
return $class;
}
}
}
throw new ModuleRequireException(
__CLASS__,
"Kernel class was not found in $file. "
. "Specify directory where file with Kernel class for your application is located with `app_path` parameter."
);
}
/**
* Get service $serviceName and add it to the lists of persistent services.
* If $isPermanent then service becomes persistent between tests
*
* @param string $serviceName
* @param boolean $isPermanent
*/
public function persistService($serviceName, $isPermanent = false)
{
$service = $this->grabService($serviceName);
$this->persistentServices[$serviceName] = $service;
if ($isPermanent) {
$this->permanentServices[$serviceName] = $service;
}
if ($this->client) {
$this->client->persistentServices[$serviceName] = $service;
}
}
/**
* Remove service $serviceName from the lists of persistent services.
*
* @param string $serviceName
*/
public function unpersistService($serviceName)
{
if (isset($this->persistentServices[$serviceName])) {
unset($this->persistentServices[$serviceName]);
}
if (isset($this->permanentServices[$serviceName])) {
unset($this->permanentServices[$serviceName]);
}
if ($this->client && isset($this->client->persistentServices[$serviceName])) {
unset($this->client->persistentServices[$serviceName]);
}
}
/**
* Invalidate previously cached routes.
*/
public function invalidateCachedRouter()
{
$this->unpersistService('router');
}
/**
* Opens web page using route name and parameters.
*
* ``` php
* <?php
* $I->amOnRoute('posts.create');
* $I->amOnRoute('posts.show', array('id' => 34));
* ?>
* ```
*
* @param $routeName
* @param array $params
*/
public function amOnRoute($routeName, array $params = [])
{
$router = $this->grabService('router');
if (!$router->getRouteCollection()->get($routeName)) {
$this->fail(sprintf('Route with name "%s" does not exists.', $routeName));
}
$url = $router->generate($routeName, $params);
$this->amOnPage($url);
}
/**
* Checks that current url matches route.
*
* ``` php
* <?php
* $I->seeCurrentRouteIs('posts.index');
* $I->seeCurrentRouteIs('posts.show', array('id' => 8));
* ?>
* ```
*
* @param $routeName
* @param array $params
*/
public function seeCurrentRouteIs($routeName, array $params = [])
{
$router = $this->grabService('router');
if (!$router->getRouteCollection()->get($routeName)) {
$this->fail(sprintf('Route with name "%s" does not exists.', $routeName));
}
$uri = explode('?', $this->grabFromCurrentUrl())[0];
try {
$match = $router->match($uri);
} catch (\Symfony\Component\Routing\Exception\ResourceNotFoundException $e) {
$this->fail(sprintf('The "%s" url does not match with any route', $uri));
}
$expected = array_merge(['_route' => $routeName], $params);
$intersection = array_intersect_assoc($expected, $match);
$this->assertEquals($expected, $intersection);
}
/**
* Checks that current url matches route.
* Unlike seeCurrentRouteIs, this can matches without exact route parameters
*
* ``` php
* <?php
* $I->seeCurrentRouteMatches('my_blog_pages');
* ?>
* ```
*
* @param $routeName
*/
public function seeInCurrentRoute($routeName)
{
$router = $this->grabService('router');
if (!$router->getRouteCollection()->get($routeName)) {
$this->fail(sprintf('Route with name "%s" does not exists.', $routeName));
}
$uri = explode('?', $this->grabFromCurrentUrl())[0];
try {
$matchedRouteName = $router->match($uri)['_route'];
} catch (\Symfony\Component\Routing\Exception\ResourceNotFoundException $e) {
$this->fail(sprintf('The "%s" url does not match with any route', $uri));
}
$this->assertEquals($matchedRouteName, $routeName);
}
/**
* Checks if any email were sent by last request
*
* @throws \LogicException
*/
public function seeEmailIsSent()
{
$profile = $this->getProfile();
if (!$profile) {
$this->fail('Emails can\'t be tested without Profiler');
}
if (!$profile->hasCollector('swiftmailer')) {
$this->fail('Emails can\'t be tested without SwiftMailer connector');
}
$this->assertGreaterThan(0, $profile->getCollector('swiftmailer')->getMessageCount());
}
/**
* Grabs a service from Symfony DIC container.
* Recommended to use for unit testing.
*
* ``` php
* <?php
* $em = $I->grabServiceFromContainer('doctrine');
* ?>
* ```
*
* @param $service
* @return mixed
* @part services
* @deprecated Use grabService instead
*/
public function grabServiceFromContainer($service)
{
return $this->grabService($service);
}
/**
* Grabs a service from Symfony DIC container.
* Recommended to use for unit testing.
*
* ``` php
* <?php
* $em = $I->grabService('doctrine');
* ?>
* ```
*
* @param $service
* @return mixed
* @part services
*/
public function grabService($service)
{
$container = $this->_getContainer();
if (!$container->has($service)) {
$this->fail("Service $service is not available in container");
}
return $container->get($service);
}
/**
* @return \Symfony\Component\HttpKernel\Profiler\Profile
*/
protected function getProfile()
{
$container = $this->_getContainer();
if (!$container->has('profiler')) {
return null;
}
$profiler = $this->grabService('profiler');
$response = $this->client->getResponse();
if (null === $response) {
$this->fail("You must perform a request before using this method.");
}
return $profiler->loadProfileFromResponse($response);
}
/**
* @param $url
*/
protected function debugResponse($url)
{
parent::debugResponse($url);
if ($profile = $this->getProfile()) {
if ($profile->hasCollector('security')) {
if ($profile->getCollector('security')->isAuthenticated()) {
$roles = $profile->getCollector('security')->getRoles();
if ($roles instanceof Data) {
$roles = $this->extractRawRoles($roles);
}
$this->debugSection(
'User',
$profile->getCollector('security')->getUser()
. ' [' . implode(',', $roles) . ']'
);
} else {
$this->debugSection('User', 'Anonymous');
}
}
if ($profile->hasCollector('swiftmailer')) {
$messages = $profile->getCollector('swiftmailer')->getMessageCount();
if ($messages) {
$this->debugSection('Emails', $messages . ' sent');
}
}
if ($profile->hasCollector('timer')) {
$this->debugSection('Time', $profile->getCollector('timer')->getTime());
}
}
}
/**
* @param Data $data
* @return array
*/
private function extractRawRoles(Data $data)
{
if ($this->dataRevealsValue($data)) {
$roles = $data->getValue();
} else {
$raw = $data->getRawData();
$roles = isset($raw[1]) ? $raw[1] : [];
}
return $roles;
}
/**
* Returns a list of recognized domain names.
*
* @return array
*/
protected function getInternalDomains()
{
$internalDomains = [];
$routes = $this->grabService('router')->getRouteCollection();
/* @var \Symfony\Component\Routing\Route $route */
foreach ($routes as $route) {
if (!is_null($route->getHost())) {
$compiled = $route->compile();
if (!is_null($compiled->getHostRegex())) {
$internalDomains[] = $compiled->getHostRegex();
}
}
}
return array_unique($internalDomains);
}
/**
* Reboot client's kernel.
* Can be used to manually reboot kernel when 'rebootable_client' => false
*
* ``` php
* <?php
* ...
* perform some requests
* ...
* $I->rebootClientKernel();
* ...
* perform other requests
* ...
*
* ?>
* ```
*
*/
public function rebootClientKernel()
{
if ($this->client) {
$this->client->rebootKernel();
}
}
/**
* Public API from Data changed from Symfony 3.2 to 3.3.
*
* @param \Symfony\Component\VarDumper\Cloner\Data $data
*
* @return bool
*/
private function dataRevealsValue(Data $data)
{
return method_exists($data, 'getValue');
}
}