Repository navigation
Expand file tree
/
Copy pathLaravel5.php
More file actions
1222 lines (1103 loc) · 33.9 KB
/
Copy pathLaravel5.php
File metadata and controls
1222 lines (1103 loc) · 33.9 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
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
namespace Codeception\Module;
use Codeception\Exception\ModuleConfigException;
use Codeception\Exception\ModuleException;
use Codeception\Lib\Connector\Laravel5 as LaravelConnector;
use Codeception\Lib\Framework;
use Codeception\Lib\Interfaces\ActiveRecord;
use Codeception\Lib\Interfaces\PartedModule;
use Codeception\Lib\Shared\LaravelCommon;
use Codeception\Lib\ModuleContainer;
use Codeception\Subscriber\ErrorHandler;
use Codeception\Util\ReflectionHelper;
use Illuminate\Contracts\Auth\Authenticatable;
use Illuminate\Database\Eloquent\Model as EloquentModel;
use Illuminate\Support\Collection;
/**
*
* This module allows you to run functional tests for Laravel 5.
* It should **not** be used for acceptance tests.
* See the Acceptance tests section below for more details.
*
* As of Codeception 2.2 this module only works for Laravel 5.1 and later releases.
* If you want to test a Laravel 5.0 application you have to use Codeception 2.1.
* You can also upgrade your Laravel application to 5.1, for more details check the Laravel Upgrade Guide
* at <https://laravel.com/docs/master/upgrade>.
*
* ## Demo project
* <https://github.com/janhenkgerritsen/codeception-laravel5-sample>
*
* ## Status
*
* * Maintainer: **Jan-Henk Gerritsen**
* * Stability: **stable**
*
* ## Example
*
* modules:
* enabled:
* - Laravel5:
* environment_file: .env.testing
*
* ## 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.
* * run_database_migrations: `boolean`, default `false` - run database migrations before each test.
* * database_migrations_path: `string`, default `null` - path to the database migrations, relative to the root of the application.
* * run_database_seeder: `boolean`, default `false` - run database seeder before each test.
* * database_seeder_class: `string`, default `` - database seeder class name.
* * environment_file: `string`, default `.env` - the environment file to load for the tests.
* * 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).
* * vendor_dir: `string`, default `vendor` - optional relative path to vendor directory.
* * disable_exception_handling: `boolean`, default `true` - disable Laravel exception handling.
* * disable_middleware: `boolean`, default `false` - disable all middleware.
* * disable_events: `boolean`, default `false` - disable events (does not disable model events).
* * disable_model_events: `boolean`, default `false` - disable model events.
* * url: `string`, default `` - the application URL.
*
* ## API
*
* * app - `Illuminate\Foundation\Application`
* * config - `array`
*
* ## Parts
*
* * ORM - only include the database methods of this module:
* * have
* * haveMultiple
* * haveRecord
* * grabRecord
* * seeRecord
* * dontSeeRecord
*
* ## Acceptance tests
*
* You should not use this module for acceptance tests.
* If you want to use Laravel functionality with your acceptance tests,
* for example to do test setup, you can initialize the Laravel functionality
* by adding the following lines of code to the `_bootstrap.php` file of your test suite:
*
* require 'bootstrap/autoload.php';
* $app = require 'bootstrap/app.php';
* $app->loadEnvironmentFrom('.env.testing');
* $app->instance('request', new \Illuminate\Http\Request);
* $app->make('Illuminate\Contracts\Http\Kernel')->bootstrap();
*
*
*/
class Laravel5 extends Framework implements ActiveRecord, PartedModule
{
use LaravelCommon;
/**
* @var \Illuminate\Foundation\Application
*/
public $app;
/**
* @var array
*/
public $config = [];
/**
* Constructor.
*
* @param ModuleContainer $container
* @param array|null $config
*/
public function __construct(ModuleContainer $container, $config = null)
{
$this->config = array_merge(
[
'cleanup' => true,
'run_database_migrations' => false,
'database_migrations_path' => null,
'run_database_seeder' => false,
'database_seeder_class' => '',
'environment_file' => '.env',
'bootstrap' => 'bootstrap' . DIRECTORY_SEPARATOR . 'app.php',
'root' => '',
'packages' => 'workbench',
'vendor_dir' => 'vendor',
'disable_exception_handling' => true,
'disable_middleware' => false,
'disable_events' => false,
'disable_model_events' => false,
],
(array)$config
);
$projectDir = explode($this->config['packages'], \Codeception\Configuration::projectDir())[0];
$projectDir .= $this->config['root'];
$this->config['project_dir'] = $projectDir;
$this->config['bootstrap_file'] = $projectDir . $this->config['bootstrap'];
parent::__construct($container);
}
/**
* @return array
*/
public function _parts()
{
return ['orm'];
}
/**
* Initialize hook.
*/
public function _initialize()
{
$this->checkBootstrapFileExists();
$this->registerAutoloaders();
$this->revertErrorHandler();
}
/**
* Before hook.
*
* @param \Codeception\TestInterface $test
*/
public function _before(\Codeception\TestInterface $test)
{
$this->client = new LaravelConnector($this);
// Database migrations should run before database cleanup transaction starts
if ($this->config['run_database_migrations']) {
$this->callArtisan('migrate', ['--path' => $this->config['database_migrations_path']]);
}
if ($this->applicationUsesDatabase() && $this->config['cleanup']) {
$this->app['db']->beginTransaction();
}
if ($this->config['run_database_seeder']) {
$this->callArtisan('db:seed', ['--class' => $this->config['database_seeder_class']]);
}
}
/**
* After hook.
*
* @param \Codeception\TestInterface $test
*/
public function _after(\Codeception\TestInterface $test)
{
if ($this->applicationUsesDatabase()) {
$db = $this->app['db'];
if ($db instanceof \Illuminate\Database\DatabaseManager) {
if ($this->config['cleanup']) {
$db->rollback();
}
/**
* Close all DB connections in order to prevent "Too many connections" issue
*
* @var \Illuminate\Database\Connection $connection
*/
foreach ($db->getConnections() as $connection) {
$connection->disconnect();
}
}
}
}
/**
* Does the application use the database?
*
* @return bool
*/
private function applicationUsesDatabase()
{
return ! empty($this->app['config']['database.default']);
}
/**
* Make sure the Laravel bootstrap file exists.
*
* @throws ModuleConfig
*/
protected function checkBootstrapFileExists()
{
$bootstrapFile = $this->config['bootstrap_file'];
if (!file_exists($bootstrapFile)) {
throw new ModuleConfigException(
$this,
"Laravel bootstrap file not found in $bootstrapFile.\n"
. "Please provide a valid path to it using 'bootstrap' config param. "
);
}
}
/**
* Register Laravel autoloaders.
*/
protected function registerAutoloaders()
{
require $this->config['project_dir'] . $this->config['vendor_dir'] . DIRECTORY_SEPARATOR . 'autoload.php';
}
/**
* Revert back to the Codeception error handler,
* becauses Laravel registers it's own error handler.
*/
protected function revertErrorHandler()
{
$handler = new ErrorHandler();
set_error_handler(array($handler, 'errorHandler'));
}
/**
* Provides access the Laravel application object.
*
* @return \Illuminate\Foundation\Application
*/
public function getApplication()
{
return $this->app;
}
/**
* @param $app
*/
public function setApplication($app)
{
$this->app = $app;
}
/**
* Enable Laravel exception handling.
*
* ``` php
* <?php
* $I->enableExceptionHandling();
* ?>
* ```
*/
public function enableExceptionHandling()
{
$this->client->enableExceptionHandling();
}
/**
* Disable Laravel exception handling.
*
* ``` php
* <?php
* $I->disableExceptionHandling();
* ?>
* ```
*/
public function disableExceptionHandling()
{
$this->client->disableExceptionHandling();
}
/**
* Disable middleware for the next requests.
*
* ``` php
* <?php
* $I->disableMiddleware();
* ?>
* ```
*/
public function disableMiddleware()
{
$this->client->disableMiddleware();
}
/**
* Disable events for the next requests.
* This method does not disable model events.
* To disable model events you have to use the disableModelEvents() method.
*
* ``` php
* <?php
* $I->disableEvents();
* ?>
* ```
*/
public function disableEvents()
{
$this->client->disableEvents();
}
/**
* Disable model events for the next requests.
*
* ``` php
* <?php
* $I->disableModelEvents();
* ?>
* ```
*/
public function disableModelEvents()
{
$this->client->disableModelEvents();
}
/**
* Make sure events fired during the test.
*
* ``` php
* <?php
* $I->seeEventTriggered('App\MyEvent');
* $I->seeEventTriggered(new App\Events\MyEvent());
* $I->seeEventTriggered('App\MyEvent', 'App\MyOtherEvent');
* $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
* ?>
* ```
* @param $events
*/
public function seeEventTriggered($events)
{
$events = is_array($events) ? $events : func_get_args();
foreach ($events as $event) {
if (!$this->client->eventTriggered($event)) {
if (is_object($event)) {
$event = get_class($event);
}
$this->fail("The '$event' event did not trigger");
}
}
}
/**
* Make sure events did not fire during the test.
*
* ``` php
* <?php
* $I->dontSeeEventTriggered('App\MyEvent');
* $I->dontSeeEventTriggered(new App\Events\MyEvent());
* $I->dontSeeEventTriggered('App\MyEvent', 'App\MyOtherEvent');
* $I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
* ?>
* ```
* @param $events
*/
public function dontSeeEventTriggered($events)
{
$events = is_array($events) ? $events : func_get_args();
foreach ($events as $event) {
if ($this->client->eventTriggered($event)) {
if (is_object($event)) {
$event = get_class($event);
}
$this->fail("The '$event' event triggered");
}
}
}
/**
* Call an Artisan command.
*
* ``` php
* <?php
* $I->callArtisan('command:name');
* $I->callArtisan('command:name', ['parameter' => 'value']);
* ?>
* ```
* @param string $command
* @param array $parameters
*/
public function callArtisan($command, $parameters = [])
{
$console = $this->app->make('Illuminate\Contracts\Console\Kernel');
$console->call($command, $parameters);
return trim($console->output());
}
/**
* Opens web page using route name and parameters.
*
* ``` php
* <?php
* $I->amOnRoute('posts.create');
* ?>
* ```
*
* @param $routeName
* @param array $params
*/
public function amOnRoute($routeName, $params = [])
{
$route = $this->getRouteByName($routeName);
$absolute = !is_null($route->domain());
$url = $this->app['url']->route($routeName, $params, $absolute);
$this->amOnPage($url);
}
/**
* Checks that current url matches route
*
* ``` php
* <?php
* $I->seeCurrentRouteIs('posts.index');
* ?>
* ```
* @param $routeName
*/
public function seeCurrentRouteIs($routeName)
{
$this->getRouteByName($routeName); // Fails if route does not exists
$currentRoute = $this->app->request->route();
$currentRouteName = $currentRoute ? $currentRoute->getName() : '';
if ($currentRouteName != $routeName) {
$message = empty($currentRouteName)
? "Current route has no name"
: "Current route is \"$currentRouteName\"";
$this->fail($message);
}
}
/**
* Opens web page by action name
*
* ``` php
* <?php
* $I->amOnAction('PostsController@index');
* ?>
* ```
*
* @param $action
* @param array $params
*/
public function amOnAction($action, $params = [])
{
$route = $this->getRouteByAction($action);
$absolute = !is_null($route->domain());
$url = $this->app['url']->action($action, $params, $absolute);
$this->amOnPage($url);
}
/**
* Checks that current url matches action
*
* ``` php
* <?php
* $I->seeCurrentActionIs('PostsController@index');
* ?>
* ```
*
* @param $action
*/
public function seeCurrentActionIs($action)
{
$this->getRouteByAction($action); // Fails if route does not exists
$currentRoute = $this->app->request->route();
$currentAction = $currentRoute ? $currentRoute->getActionName() : '';
$currentAction = ltrim(str_replace($this->getRootControllerNamespace(), "", $currentAction), '\\');
if ($currentAction != $action) {
$this->fail("Current action is \"$currentAction\"");
}
}
/**
* @param $routeName
* @return mixed
*/
protected function getRouteByName($routeName)
{
if (!$route = $this->app['routes']->getByName($routeName)) {
$this->fail("Route with name '$routeName' does not exist");
}
return $route;
}
/**
* @param string $action
* @return \Illuminate\Routing\Route
*/
protected function getRouteByAction($action)
{
$namespacedAction = $this->actionWithNamespace($action);
if (!$route = $this->app['routes']->getByAction($namespacedAction)) {
$this->fail("Action '$action' does not exist");
}
return $route;
}
/**
* Normalize an action to full namespaced action.
*
* @param string $action
* @return string
*/
protected function actionWithNamespace($action)
{
$rootNamespace = $this->getRootControllerNamespace();
if ($rootNamespace && !(strpos($action, '\\') === 0)) {
return $rootNamespace . '\\' . $action;
} else {
return trim($action, '\\');
}
}
/**
* Get the root controller namespace for the application.
*
* @return string
*/
protected function getRootControllerNamespace()
{
$urlGenerator = $this->app['url'];
$reflection = new \ReflectionClass($urlGenerator);
$property = $reflection->getProperty('rootNamespace');
$property->setAccessible(true);
return $property->getValue($urlGenerator);
}
/**
* Assert that a session variable exists.
*
* ``` php
* <?php
* $I->seeInSession('key');
* $I->seeInSession('key', 'value');
* ?>
* ```
*
* @param string|array $key
* @param mixed|null $value
* @return void
*/
public function seeInSession($key, $value = null)
{
if (is_array($key)) {
$this->seeSessionHasValues($key);
return;
}
if (! $this->app['session']->has($key)) {
$this->fail("No session variable with key '$key'");
}
if (! is_null($value)) {
$this->assertEquals($value, $this->app['session']->get($key));
}
}
/**
* Assert that the session has a given list of values.
*
* ``` php
* <?php
* $I->seeSessionHasValues(['key1', 'key2']);
* $I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']);
* ?>
* ```
*
* @param array $bindings
* @return void
*/
public function seeSessionHasValues(array $bindings)
{
foreach ($bindings as $key => $value) {
if (is_int($key)) {
$this->seeInSession($value);
} else {
$this->seeInSession($key, $value);
}
}
}
/**
* Assert that form errors are bound to the View.
*
* ``` php
* <?php
* $I->seeFormHasErrors();
* ?>
* ```
*
* @return bool
*/
public function seeFormHasErrors()
{
$viewErrorBag = $this->app->make('view')->shared('errors');
if (count($viewErrorBag) == 0) {
$this->fail("There are no form errors");
}
}
/**
* Assert that there are no form errors bound to the View.
*
* ``` php
* <?php
* $I->dontSeeFormErrors();
* ?>
* ```
*
* @return bool
*/
public function dontSeeFormErrors()
{
$viewErrorBag = $this->app->make('view')->shared('errors');
if (count($viewErrorBag) > 0) {
$this->fail("Found the following form errors: \n\n" . $viewErrorBag->toJson(JSON_PRETTY_PRINT));
}
}
/**
* Assert that specific form error messages are set in the view.
*
* This method calls `seeFormErrorMessage` for each entry in the `$bindings` array.
*
* ``` php
* <?php
* $I->seeFormErrorMessages([
* 'username' => 'Invalid Username',
* 'password' => null,
* ]);
* ?>
* ```
* @param array $bindings
*/
public function seeFormErrorMessages(array $bindings)
{
foreach ($bindings as $key => $value) {
$this->seeFormErrorMessage($key, $value);
}
}
/**
* Assert that a specific form error message is set in the view.
*
* If you want to assert that there is a form error message for a specific key
* but don't care about the actual error message you can omit `$expectedErrorMessage`.
*
* If you do pass `$expectedErrorMessage`, this method checks if the actual error message for a key
* contains `$expectedErrorMessage`.
*
* ``` php
* <?php
* $I->seeFormErrorMessage('username');
* $I->seeFormErrorMessage('username', 'Invalid Username');
* ?>
* ```
* @param string $key
* @param string|null $expectedErrorMessage
*/
public function seeFormErrorMessage($key, $expectedErrorMessage = null)
{
$viewErrorBag = $this->app['view']->shared('errors');
if (!($viewErrorBag->has($key))) {
$this->fail("No form error message for key '$key'\n");
}
if (! is_null($expectedErrorMessage)) {
$this->assertContains($expectedErrorMessage, $viewErrorBag->first($key));
}
}
/**
* Set the currently logged in user for the application.
* Takes either an object that implements the User interface or
* an array of credentials.
*
* ``` php
* <?php
* // provide array of credentials
* $I->amLoggedAs(['username' => 'jane@example.com', 'password' => 'password']);
*
* // provide User object
* $I->amLoggedAs( new User );
*
* // can be verified with $I->seeAuthentication();
* ?>
* ```
* @param \Illuminate\Contracts\Auth\User|array $user
* @param string|null $driver The authentication driver for Laravel <= 5.1.*, guard name for Laravel >= 5.2
* @return void
*/
public function amLoggedAs($user, $driver = null)
{
$guard = $auth = $this->app['auth'];
if (method_exists($auth, 'driver')) {
$guard = $auth->driver($driver);
}
if (method_exists($auth, 'guard')) {
$guard = $auth->guard($driver);
}
if ($user instanceof Authenticatable) {
$guard->login($user);
return;
}
if (! $guard->attempt($user)) {
$this->fail("Failed to login with credentials " . json_encode($user));
}
}
/**
* Logout user.
*/
public function logout()
{
$this->app['auth']->logout();
}
/**
* Checks that a user is authenticated.
* You can specify the guard that should be use for Laravel >= 5.2.
* @param string|null $guard
*/
public function seeAuthentication($guard = null)
{
$auth = $this->app['auth'];
if (method_exists($auth, 'guard')) {
$auth = $auth->guard($guard);
}
if (! $auth->check()) {
$this->fail("There is no authenticated user");
}
}
/**
* Check that user is not authenticated.
* You can specify the guard that should be use for Laravel >= 5.2.
* @param string|null $guard
*/
public function dontSeeAuthentication($guard = null)
{
$auth = $this->app['auth'];
if (method_exists($auth, 'guard')) {
$auth = $auth->guard($guard);
}
if ($auth->check()) {
$this->fail("There is an authenticated user");
}
}
/**
* Return an instance of a class from the Laravel service container.
* (https://laravel.com/docs/master/container)
*
* ``` php
* <?php
* // In Laravel
* 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.
* ?>
* ```
*
* @param string $class
* @return mixed
*/
public function grabService($class)
{
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
* $user_id = $I->haveRecord('users', array('name' => 'Davert')); // returns integer
* $user = $I->haveRecord('App\User', array('name' => 'Davert')); // returns Eloquent model
* ?>
* ```
*
* @param string $table
* @param array $attributes
* @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 {
return $this->app['db']->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', array('name' => 'davert'));
* $I->seeRecord('App\User', array('name' => 'davert'));
* ?>
* ```
*
* @param string $table
* @param array $attributes
* @part orm
*/
public function seeRecord($table, $attributes = [])
{
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', array('name' => 'davert'));
* $I->dontSeeRecord('App\User', array('name' => 'davert'));
* ?>
* ```
*
* @param string $table
* @param array $attributes
* @part orm
*/
public function dontSeeRecord($table, $attributes = [])
{
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', array('name' => 'davert')); // returns array
* $record = $I->grabRecord('App\User', array('name' => 'davert')); // returns Eloquent model
* ?>
* ```
*
* @param string $table
* @param array $attributes
* @return array|EloquentModel
* @part orm
*/
public function grabRecord($table, $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;
}
/**
* Checks that number of given records were found 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->seeNumRecords(1, 'users', array('name' => 'davert'));
* $I->seeNumRecords(1, 'App\User', array('name' => 'davert'));
* ?>
* ```
*
* @param integer $expectedNum
* @param string $table
* @param array $attributes
* @part orm
*/
public function seeNumRecords($expectedNum, $table, $attributes = [])
{
if (class_exists($table)) {
$currentNum = $this->countModels($table, $attributes);
if ($currentNum != $expectedNum) {
$this->fail("The number of found $table ($currentNum) does not match expected number $expectedNum with " . json_encode($attributes));
}
} else {
$currentNum = $this->countRecords($table, $attributes);
if ($currentNum != $expectedNum) {
$this->fail("The number of found records ($currentNum) does not match expected number $expectedNum in table $table with " . json_encode($attributes));
}
}
}
/**
* Retrieves number of records from 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->grabNumRecords('users', array('name' => 'davert'));
* $I->grabNumRecords('App\User', array('name' => 'davert'));
* ?>
* ```
*