-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathLumen.php
More file actions
654 lines (586 loc) · 18.8 KB
/
Lumen.php
File metadata and controls
654 lines (586 loc) · 18.8 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
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
<?php
declare(strict_types=1);
namespace Codeception\Module;
use Codeception\Configuration;
use Codeception\Exception\ModuleConfigException;
use Codeception\Lib\Connector\Lumen as LumenConnector;
use Codeception\Lib\Framework;
use Codeception\Lib\Interfaces\ActiveRecord;
use Codeception\Lib\Interfaces\PartedModule;
use Codeception\Lib\ModuleContainer;
use Codeception\TestInterface;
use Codeception\Util\ReflectionHelper;
use Exception;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Contracts\Auth\Factory as AuthContract;
use Illuminate\Database\DatabaseManager;
use Illuminate\Database\Eloquent\Factories\Factory as EloquentFactory;
use Illuminate\Database\Eloquent\FactoryBuilder;
use Illuminate\Database\Eloquent\Model as EloquentModel;
use Laravel\Lumen\Application;
use Laravel\Lumen\Routing\Router;
use ReflectionException;
use RuntimeException;
use Throwable;
/**
*
* This module allows you to run functional tests for Lumen.
* Please try it and leave your feedback.
*
* ## Demo project
* <https://github.com/codeception/lumen-module-tests>
*
*
* ## Config
*
* * cleanup: `boolean`, default `true` - all database queries will be run in a transaction,
* which will be rolled back at the end of each test.
* * bootstrap: `string`, default `bootstrap/app.php` - relative path to app.php config file.
* * root: `string`, default `` - root path of the application.
* * packages: `string`, default `workbench` - root path of application packages (if any).
* * url: `string`, default `http://localhost` - the application URL
*
* ## API
*
* * app - `\Laravel\Lumen\Application`
* * config - `array`
*
* ## Parts
*
* * `ORM`: Only include the database methods of this module:
* * dontSeeRecord
* * grabRecord
* * have
* * haveMultiple
* * haveRecord
* * make
* * makeMultiple
* * seeRecord
*
* See [WebDriver module](https://codeception.com/docs/modules/WebDriver#Loading-Parts-from-other-Modules)
* for general information on how to load parts of a framework module.
*/
class Lumen extends Framework implements ActiveRecord, PartedModule
{
public Application $app;
/**
* @var array<string, mixed>
*/
public array $config = [];
public function __construct(ModuleContainer $container, ?array $config = null)
{
$this->config = array_merge(
[
'cleanup' => true,
'bootstrap' => 'bootstrap' . DIRECTORY_SEPARATOR . 'app.php',
'root' => '',
'packages' => 'workbench',
'url' => 'http://localhost',
],
(array)$config
);
$projectDir = explode($this->config['packages'], Configuration::projectDir())[0];
$projectDir .= $this->config['root'];
$this->config['project_dir'] = $projectDir;
$this->config['bootstrap_file'] = $projectDir . $this->config['bootstrap'];
parent::__construct($container);
}
public function _parts(): array
{
return ['orm'];
}
/**
* Initialize hook.
*
* @throws ModuleConfigException
*/
public function _initialize(): void
{
$this->checkBootstrapFileExists();
$this->registerAutoloaders();
}
/**
* Before hook.
*
* @param TestInterface $test
* @throws Throwable
*/
public function _before(TestInterface $test): void
{
$this->client = new LumenConnector($this);
/** @var DatabaseManager $dbManager */
$dbManager = $this->app['db'];
if ($dbManager instanceof DatabaseManager && $this->config['cleanup']) {
$dbManager->beginTransaction();
}
}
/**
* After hook.
*
* @param TestInterface $test
* @throws Throwable
*/
public function _after(TestInterface $test): void
{
/** @var DatabaseManager $dbManager */
if (!$dbManager = $this->app['db']) {
return;
}
if ($this->config['cleanup']) {
$dbManager->rollback();
}
// disconnect from DB to prevent "Too many connections" issue
$dbManager->disconnect();
}
/**
* Make sure the Lumen bootstrap file exists.
*
* @throws ModuleConfigException
*/
protected function checkBootstrapFileExists(): void
{
$bootstrapFile = $this->config['bootstrap_file'];
if (!file_exists($bootstrapFile)) {
throw new ModuleConfigException(
$this,
"Lumen bootstrap file not found in $bootstrapFile.\n"
. "Please provide a valid path using the 'bootstrap' config param. "
);
}
}
/**
* Register autoloaders.
*/
protected function registerAutoloaders(): void
{
require $this->config['project_dir'] . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';
}
/**
* Provides access the Lumen application object.
*/
public function getApplication(): Application
{
return $this->app;
}
public function setApplication(Application $app): void
{
$this->app = $app;
}
/**
* Opens web page using route name and parameters.
*
* ```php
* <?php
* $I->amOnRoute('homepage');
* ```
*/
public function amOnRoute(string $routeName, array $params = []): void
{
$route = $this->getRouteByName($routeName);
if (!$route) {
$this->fail("Could not find route with name '$routeName'");
}
$url = $this->generateUrlForRoute($route, $params);
$this->amOnPage($url);
}
/**
* Get the route for a route name.
*/
private function getRouteByName(string $routeName): ?array
{
/** @var Router $router */
$router = $this->app['router'];
$routes = $router->getRoutes();
foreach ($routes as $route) {
if (isset($route['action']['as']) && $route['action']['as'] == $routeName) {
return $route;
}
}
$this->fail("Route with name '$routeName' does not exist");
return null;
}
/**
* Generate the URL for a route specification.
* Replaces the route parameters from left to right with the parameters
* passed in the $params array.
*/
private function generateUrlForRoute(array $route, array $params): string
{
$url = $route['uri'];
while (count($params) > 0) {
$param = array_shift($params);
$url = preg_replace('/{.+?}/', $param, $url, 1);
}
return $url;
}
/**
* Set the authenticated user for the next request.
* This will not persist between multiple requests.
*/
public function amLoggedAs(Authenticatable $user, string $guardName = null): void
{
$auth = $this->app['auth'];
$guard = $auth->guard($guardName);
$guard->setUser($user);
}
/**
* Checks that user is authenticated.
*/
public function seeAuthentication(): void
{
/** @var AuthContract $auth */
$auth = $this->app['auth'];
$this->assertTrue($auth->check(), 'User is not logged in');
}
/**
* Check that user is not authenticated.
*/
public function dontSeeAuthentication(): void
{
/** @var AuthContract $auth */
$auth = $this->app['auth'];
$this->assertFalse($auth->check(), 'User is logged in');
}
/**
* Return an instance of a class from the IoC Container.
*
* Example
* ``` php
* <?php
* // In Lumen
* App::bind('foo', function($app)
* {
* return new FooBar;
* });
*
* // Then in test
* $service = $I->grabService('foo');
*
* // Will return an instance of FooBar, also works for singletons.
* ```
*/
public function grabService(string $class): mixed
{
return $this->app[$class];
}
/**
* Inserts record into the database.
* If you pass the name of a database table as the first argument, this method returns an integer ID.
* You can also pass the class name of an Eloquent model, in that case this method returns an Eloquent model.
*
* ``` php
* <?php
* $userId = $I->haveRecord('users', ['name' => 'Davert']); // returns integer
* $user = $I->haveRecord('App\Models\User', ['name' => 'Davert']); // returns Eloquent model
* ```
*
* @return integer|EloquentModel
* @part orm
*/
public function haveRecord($table, $attributes = [])
{
if (class_exists($table)) {
$model = new $table;
if (!$model instanceof EloquentModel) {
throw new RuntimeException("Class $table is not an Eloquent model");
}
$model->fill($attributes)->save();
return $model;
}
try {
/** @var DatabaseManager $dbManager */
$dbManager = $this->app['db'];
return $dbManager->table($table)->insertGetId($attributes);
} catch (Exception $e) {
$this->fail("Could not insert record into table '$table':\n\n" . $e->getMessage());
}
}
/**
* Checks that record exists in database.
* You can pass the name of a database table or the class name of an Eloquent model as the first argument.
*
* ``` php
* <?php
* $I->seeRecord('users', ['name' => 'Davert']);
* $I->seeRecord('App\Models\User', ['name' => 'Davert']);
* ?>
* ```
*
* @part orm
*/
public function seeRecord(string $table, array $attributes = []): void
{
if (class_exists($table)) {
if (!$this->findModel($table, $attributes)) {
$this->fail("Could not find $table with " . json_encode($attributes));
}
} elseif (!$this->findRecord($table, $attributes)) {
$this->fail("Could not find matching record in table '$table'");
}
}
/**
* Checks that record does not exist in database.
* You can pass the name of a database table or the class name of an Eloquent model as the first argument.
*
* ``` php
* <?php
* $I->dontSeeRecord('users', ['name' => 'davert']);
* $I->dontSeeRecord('App\Models\User', ['name' => 'davert']);
* ```
*
* @part orm
*/
public function dontSeeRecord(string $table, array $attributes = []): void
{
if (class_exists($table)) {
if ($this->findModel($table, $attributes)) {
$this->fail("Unexpectedly found matching $table with " . json_encode($attributes));
}
} elseif ($this->findRecord($table, $attributes)) {
$this->fail("Unexpectedly found matching record in table '$table'");
}
}
/**
* Retrieves record from database
* If you pass the name of a database table as the first argument, this method returns an array.
* You can also pass the class name of an Eloquent model, in that case this method returns an Eloquent model.
*
* ``` php
* <?php
* $record = $I->grabRecord('users', ['name' => 'davert']); // returns array
* $record = $I->grabRecord('App\Models\User', ['name' => 'davert']); // returns Eloquent model
* ```
*
* @return array|EloquentModel
* @part orm
*/
public function grabRecord(string $table, array $attributes = [])
{
if (class_exists($table)) {
if (!$model = $this->findModel($table, $attributes)) {
$this->fail("Could not find $table with " . json_encode($attributes));
}
return $model;
}
if (!$record = $this->findRecord($table, $attributes)) {
$this->fail("Could not find matching record in table '$table'");
}
return $record;
}
protected function findModel(string $modelClass, array $attributes = []): ?EloquentModel
{
$model = new $modelClass;
if (!$model instanceof EloquentModel) {
throw new RuntimeException("Class $modelClass is not an Eloquent model");
}
$query = $model->newQuery();
foreach ($attributes as $key => $value) {
$query->where($key, $value);
}
return $query->first();
}
protected function findRecord(string $table, array $attributes = []): array
{
/** @var DatabaseManager $dbManager */
$dbManager = $this->app['db'];
$query = $dbManager->table($table);
foreach ($attributes as $key => $value) {
$query->where($key, $value);
}
return (array)$query->first();
}
/**
* Use Lumen's model factory to create a model.
*
* ``` php
* <?php
* $I->have('App\Models\User');
* $I->have('App\Models\User', ['name' => 'John Doe']);
* $I->have('App\Models\User', [], 'admin');
* ```
*
* @see https://lumen.laravel.com/docs/master/testing#model-factories
* @part orm
*/
public function have(string $model, array $attributes = [], string $name = 'default'): mixed
{
try {
return $this->modelFactory($model, $name)->create($attributes);
} catch (Exception $e) {
$this->fail("Could not create model: \n\n" . get_class($e) . "\n\n" . $e->getMessage());
}
}
/**
* Use Laravel model factory to create multiple models.
*
* ``` php
* <?php
* $I->haveMultiple('App\Models\User', 10);
* $I->haveMultiple('App\Models\User', 10, ['name' => 'John Doe']);
* $I->haveMultiple('App\Models\User', 10, [], 'admin');
* ```
*
* @see https://lumen.laravel.com/docs/master/testing#model-factories
* @part orm
*/
public function haveMultiple(string $model, int $times, array $attributes = [], string $name = 'default'): mixed
{
try {
return $this->modelFactory($model, $name, $times)->create($attributes);
} catch (Exception $e) {
$this->fail("Could not create model: \n\n" . get_class($e) . "\n\n" . $e->getMessage());
}
}
/**
* Use Lumen's model factory to make a model instance.
*
* ``` php
* <?php
* $I->make('App\Models\User');
* $I->make('App\Models\User', ['name' => 'John Doe']);
* $I->make('App\Models\User', [], 'admin');
* ```
*
* @see https://lumen.laravel.com/docs/master/testing#model-factories
* @part orm
*/
public function make(string $model, array $attributes = [], string $name = 'default'): mixed
{
try {
return $this->modelFactory($model, $name)->make($attributes);
} catch (Exception $e) {
$this->fail("Could not make model: \n\n" . get_class($e) . "\n\n" . $e->getMessage());
}
}
/**
* Use Laravel model factory to make multiple model instances.
*
* ``` php
* <?php
* $I->makeMultiple('App\Models\User', 10);
* $I->makeMultiple('App\Models\User', 10, ['name' => 'John Doe']);
* $I->makeMultiple('App\Models\User', 10, [], 'admin');
* ```
*
* @see https://lumen.laravel.com/docs/master/testing#model-factories
* @part orm
*/
public function makeMultiple(string $model, int $times, array $attributes = [], string $name = 'default'): mixed
{
try {
return $this->modelFactory($model, $name, $times)->make($attributes);
} catch (Exception $e) {
$this->fail("Could not make model: \n\n" . get_class($e) . "\n\n" . $e->getMessage());
}
}
/**
* @return EloquentFactory|FactoryBuilder
*/
protected function modelFactory(string $model, string $name, int $times = 1)
{
if (!function_exists('factory')) {
return $model::factory()->count($times);
}
// Support for Lumen < 7 (Factory names defined in illuminate/database version < 7)
if (property_exists(FactoryBuilder::class, 'name')) {
return factory($model, $name, $times);
}
return factory($model, $times);
}
/**
* Returns a list of recognized domain names.
* The elements of this list are regular expressions.
*
* @return string[]
* @throws ReflectionException
*/
protected function getInternalDomains(): array
{
$server = ReflectionHelper::readPrivateProperty($this->client, 'server');
return ['/^' . str_replace('.', '\.', $server['HTTP_HOST']) . '$/'];
}
/**
* Add a binding to the Laravel service container.
* (https://laravel.com/docs/master/container)
*
* ``` php
* <?php
* $I->haveBinding('App\MyInterface', 'App\MyImplementation');
* ```
*/
public function haveBinding($abstract, $concrete): void
{
$this->client->haveBinding($abstract, $concrete);
}
/**
* Add a singleton binding to the Laravel service container.
* (https://laravel.com/docs/master/container)
*
* ``` php
* <?php
* $I->haveSingleton('My\Interface', 'My\Singleton');
* ```
*/
public function haveSingleton($abstract, $concrete): void
{
$this->client->haveBinding($abstract, $concrete, true);
}
/**
* Add a contextual binding to the Laravel service container.
* (https://laravel.com/docs/master/container)
*
* ``` php
* <?php
* $I->haveContextualBinding('App\MyClass', '$variable', 'value');
*
* // This is similar to the following in your Laravel application
* $app->when('App\MyClass')
* ->needs('$variable')
* ->give('value');
* ```
*/
public function haveContextualBinding($concrete, $abstract, $implementation): void
{
$this->client->haveContextualBinding($concrete, $abstract, $implementation);
}
/**
* Add an instance binding to the Laravel service container.
* (https://laravel.com/docs/master/container)
*
* ``` php
* <?php
* $I->haveInstance('App\MyClass', new App\MyClass());
* ```
*/
public function haveInstance($abstract, $instance): void
{
$this->client->haveInstance($abstract, $instance);
}
/**
* Register a handler than can be used to modify the Laravel application object after it is initialized.
* The Laravel application object will be passed as an argument to the handler.
*
* ``` php
* <?php
* $I->haveApplicationHandler(function($app) {
* $app->make('config')->set(['test_value' => '10']);
* });
* ```
*/
public function haveApplicationHandler($handler): void
{
$this->client->haveApplicationHandler($handler);
}
/**
* Clear the registered application handlers.
*
* ``` php
* <?php
* $I->clearApplicationHandlers();
* ```
*/
public function clearApplicationHandlers(): void
{
$this->client->clearApplicationHandlers();
}
}