-
Notifications
You must be signed in to change notification settings - Fork 36
/
Yii2.php
940 lines (867 loc) · 29.4 KB
/
Yii2.php
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
<?php
namespace Codeception\Module;
use Codeception\Configuration;
use Codeception\Exception\ConfigurationException;
use Codeception\Exception\ModuleConfigException;
use Codeception\Exception\ModuleException;
use Codeception\Lib\Connector\Yii2 as Yii2Connector;
use Codeception\Lib\Framework;
use Codeception\Lib\Interfaces\ActiveRecord;
use Codeception\Lib\Interfaces\MultiSession;
use Codeception\Lib\Interfaces\PartedModule;
use Codeception\TestInterface;
use Codeception\Util\Debug;
use Symfony\Component\DomCrawler\Crawler as SymfonyCrawler;
use Yii;
use yii\base\Event;
use yii\db\ActiveRecordInterface;
use yii\db\Connection;
use yii\db\QueryInterface;
use yii\db\Transaction;
use yii\helpers\Url;
/**
* This module provides integration with [Yii framework](https://www.yiiframework.com/) (2.0).
*
* It initializes the Yii framework in a test environment and provides actions
* for functional testing.
*
* ## Application state during testing
*
* This section details what you can expect when using this module.
*
* * You will get a fresh application in `\Yii::$app` at the start of each test
* (available in the test and in `_before()`).
* * Inside your test you may change application state; however these changes
* will be lost when doing a request if you have enabled `recreateApplication`.
* * When executing a request via one of the request functions the `request`
* and `response` component are both recreated.
* * After a request the whole application is available for inspection /
* interaction.
* * You may use multiple database connections, each will use a separate
* transaction; to prevent accidental mistakes we will warn you if you try to
* connect to the same database twice but we cannot reuse the same connection.
*
* ## Config
*
* * `configFile` *required* - path to the application config file. The file
* should be configured for the test environment and return a configuration
* array.
* * `applicationClass` - Fully qualified class name for the application. There are
* several ways to define the application class. Either via a `class` key in the Yii
* config, via specifying this codeception module configuration value or let codeception
* use its default value `yii\web\Application`. In a standard Yii application, this
* value should be either `yii\console\Application`, `yii\web\Application` or unset.
* * `entryUrl` - initial application url (default: http://localhost/index-test.php).
* * `entryScript` - front script title (like: index-test.php). If not set it's
* taken from `entryUrl`.
* * `transaction` - (default: `true`) wrap all database connection inside a
* transaction and roll it back after the test. Should be disabled for
* acceptance testing.
* * `cleanup` - (default: `true`) cleanup fixtures after the test
* * `ignoreCollidingDSN` - (default: `false`) When 2 database connections use
* the same DSN but different settings an exception will be thrown. Set this to
* true to disable this behavior.
* * `fixturesMethod` - (default: `_fixtures`) Name of the method used for
* creating fixtures.
* * `responseCleanMethod` - (default: `clear`) Method for cleaning the
* response object. Note that this is only for multiple requests inside a
* single test case. Between test cases the whole application is always
* recreated.
* * `requestCleanMethod` - (default: `recreate`) Method for cleaning the
* request object. Note that this is only for multiple requests inside a single
* test case. Between test cases the whole application is always recreated.
* * `recreateComponents` - (default: `[]`) Some components change their state
* making them unsuitable for processing multiple requests. In production
* this is usually not a problem since web apps tend to die and start over
* after each request. This allows you to list application components that
* need to be recreated before each request. As a consequence, any
* components specified here should not be changed inside a test since those
* changes will get discarded.
* * `recreateApplication` - (default: `false`) whether to recreate the whole
* application before each request
*
* You can use this module by setting params in your `functional.suite.yml`:
*
* ```yaml
* actor: FunctionalTester
* modules:
* enabled:
* - Yii2:
* configFile: 'path/to/config.php'
* ```
*
* ## Parts
*
* By default all available methods are loaded, but you can also use the `part`
* option to select only the needed actions and to avoid conflicts. The
* available parts are:
*
* * `init` - use the module only for initialization (for acceptance tests).
* * `orm` - include only `haveRecord/grabRecord/seeRecord/dontSeeRecord` actions.
* * `fixtures` - use fixtures inside tests with `haveFixtures/grabFixture/grabFixtures` actions.
* * `email` - include email actions `seeEmailsIsSent/grabLastSentEmail/...`
*
* 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.
*
* ### Example (`acceptance.suite.yml`)
*
* ```yaml
* actor: AcceptanceTester
* modules:
* enabled:
* - WebDriver:
* url: http://127.0.0.1:8080/
* browser: firefox
* - Yii2:
* configFile: 'config/test.php'
* part: orm # allow to use AR methods
* transaction: false # don't wrap test in transaction
* cleanup: false # don't cleanup the fixtures
* entryScript: index-test.php
* ```
*
* ## Fixtures
*
* This module allows to use
* [fixtures](https://www.yiiframework.com/doc-2.0/guide-test-fixtures.html)
* inside a test. There are two ways to do that. Fixtures can either be loaded
* with the [haveFixtures](#haveFixtures) method inside a test:
*
* ```php
* <?php
* $I->haveFixtures(['posts' => PostsFixture::class]);
* ```
*
* or, if you need to load fixtures before the test, you
* can specify fixtures in the `_fixtures` method of a test case:
*
* ```php
* <?php
* // inside Cest file or Codeception\TestCase\Unit
* public function _fixtures()
* {
* return ['posts' => PostsFixture::class]
* }
* ```
*
* ## URL
*
* With this module you can also use Yii2's URL format for all codeception
* commands that expect a URL:
*
* ```php
* <?php
* $I->amOnPage('index-test.php?site/index');
* $I->amOnPage('http://localhost/index-test.php?site/index');
* $I->sendAjaxPostRequest(['/user/update', 'id' => 1], ['UserForm[name]' => 'G.Hopper']);
* ```
*
* ## Status
*
* Maintainer: **samdark**
* Stability: **stable**
*
* @property \Codeception\Lib\Connector\Yii2 $client
*/
class Yii2 extends Framework implements ActiveRecord, MultiSession, PartedModule
{
/**
* Application config file must be set.
* @var array
*/
protected array $config = [
'fixturesMethod' => '_fixtures',
'cleanup' => true,
'ignoreCollidingDSN' => false,
'transaction' => true,
'entryScript' => '',
'entryUrl' => 'http://localhost/index-test.php',
'responseCleanMethod' => Yii2Connector::CLEAN_CLEAR,
'requestCleanMethod' => Yii2Connector::CLEAN_RECREATE,
'recreateComponents' => [],
'recreateApplication' => false,
'closeSessionOnRecreateApplication' => true,
'applicationClass' => null,
];
protected array $requiredFields = ['configFile'];
/**
* @var Yii2Connector\FixturesStore[]
*/
public array $loadedFixtures = [];
/**
* Helper to manage database connections
* @var Yii2Connector\ConnectionWatcher
*/
private $connectionWatcher;
/**
* Helper to force database transaction
* @var Yii2Connector\TransactionForcer
*/
private $transactionForcer;
/**
* @var array The contents of $_SERVER upon initialization of this object.
* This is only used to restore it upon object destruction.
* It MUST not be used anywhere else.
*/
private $server;
/**
* @var Yii2Connector\Logger
*/
private $yiiLogger;
public function _initialize()
{
if ($this->config['transaction'] === null) {
$this->config['transaction'] = $this->backupConfig['transaction'] = $this->config['cleanup'];
}
$this->defineConstants();
$this->server = $_SERVER;
$this->initServerGlobal();
}
/**
* Module configuration changed inside a test.
* We always re-create the application.
*/
protected function onReconfigure()
{
parent::onReconfigure();
$this->client->resetApplication();
$this->configureClient($this->config);
$this->yiiLogger->getAndClearLog();
$this->client->startApp($this->yiiLogger);
}
/**
* Adds the required server params.
* Note this is done separately from the request cycle since someone might call
* `Url::to` before doing a request, which would instantiate the request component with incorrect server params.
*/
private function initServerGlobal()
{
$entryUrl = $this->config['entryUrl'];
$entryFile = $this->config['entryScript'] ?: basename($entryUrl);
$entryScript = $this->config['entryScript'] ?: parse_url($entryUrl, PHP_URL_PATH);
$_SERVER = array_merge($_SERVER, [
'SCRIPT_FILENAME' => $entryFile,
'SCRIPT_NAME' => $entryScript,
'SERVER_NAME' => parse_url($entryUrl, PHP_URL_HOST),
'SERVER_PORT' => parse_url($entryUrl, PHP_URL_PORT) ?: '80',
'HTTPS' => parse_url($entryUrl, PHP_URL_SCHEME) === 'https'
]);
}
protected function validateConfig(): void
{
parent::validateConfig();
$pathToConfig = codecept_absolute_path($this->config['configFile']);
if (!is_file($pathToConfig)) {
throw new ModuleConfigException(
__CLASS__,
"The application config file does not exist: " . $pathToConfig
);
}
if (!in_array($this->config['responseCleanMethod'], Yii2Connector::CLEAN_METHODS)) {
throw new ModuleConfigException(
__CLASS__,
"The response clean method must be one of: " . implode(", ", Yii2Connector::CLEAN_METHODS)
);
}
if (!in_array($this->config['requestCleanMethod'], Yii2Connector::CLEAN_METHODS)) {
throw new ModuleConfigException(
__CLASS__,
"The response clean method must be one of: " . implode(", ", Yii2Connector::CLEAN_METHODS)
);
}
}
protected function configureClient(array $settings)
{
$settings['configFile'] = codecept_absolute_path($settings['configFile']);
foreach ($settings as $key => $value) {
if (property_exists($this->client, $key)) {
$this->client->$key = $value;
}
}
$this->client->resetApplication();
}
/**
* Instantiates the client based on module configuration
*/
protected function recreateClient()
{
$entryUrl = $this->config['entryUrl'];
$entryFile = $this->config['entryScript'] ?: basename($entryUrl);
$entryScript = $this->config['entryScript'] ?: parse_url($entryUrl, PHP_URL_PATH);
$this->client = new Yii2Connector([
'SCRIPT_FILENAME' => $entryFile,
'SCRIPT_NAME' => $entryScript,
'SERVER_NAME' => parse_url($entryUrl, PHP_URL_HOST),
'SERVER_PORT' => parse_url($entryUrl, PHP_URL_PORT) ?: '80',
'HTTPS' => parse_url($entryUrl, PHP_URL_SCHEME) === 'https'
]);
$this->configureClient($this->config);
}
public function _before(TestInterface $test)
{
$this->recreateClient();
$this->yiiLogger = new Yii2Connector\Logger();
$this->client->startApp($this->yiiLogger);
$this->connectionWatcher = new Yii2Connector\ConnectionWatcher();
$this->connectionWatcher->start();
// load fixtures before db transaction
if ($test instanceof \Codeception\Test\Cest) {
$this->loadFixtures($test->getTestInstance());
} elseif ($test instanceof \Codeception\Test\TestCaseWrapper) {
$this->loadFixtures($test->getTestCase());
} else {
$this->loadFixtures($test);
}
$this->startTransactions();
}
/**
* load fixtures before db transaction
*
* @param mixed $test instance of test class
*/
private function loadFixtures($test)
{
$this->debugSection('Fixtures', 'Loading fixtures');
if (empty($this->loadedFixtures)
&& method_exists($test, $this->_getConfig('fixturesMethod'))
) {
$connectionWatcher = new Yii2Connector\ConnectionWatcher();
$connectionWatcher->start();
$this->haveFixtures(call_user_func([$test, $this->_getConfig('fixturesMethod')]));
$connectionWatcher->stop();
$connectionWatcher->closeAll();
}
$this->debugSection('Fixtures', 'Done');
}
public function _after(TestInterface $test)
{
$_SESSION = [];
$_FILES = [];
$_GET = [];
$_POST = [];
$_COOKIE = [];
$_REQUEST = [];
$this->rollbackTransactions();
if ($this->config['cleanup']) {
foreach ($this->loadedFixtures as $fixture) {
$fixture->unloadFixtures();
}
$this->loadedFixtures = [];
}
if ($this->client !== null) {
$this->client->resetApplication();
}
if (isset($this->connectionWatcher)) {
$this->connectionWatcher->stop();
$this->connectionWatcher->closeAll();
unset($this->connectionWatcher);
}
parent::_after($test);
}
public function _failed(TestInterface $test, $fail)
{
if ($this->yiiLogger && $log = $this->yiiLogger->getAndClearLog()) {
$test->getMetadata()->addReport('yii-log', $log);
}
parent::_failed($test, $fail);
}
protected function startTransactions()
{
if ($this->config['transaction']) {
$this->transactionForcer = new Yii2Connector\TransactionForcer($this->config['ignoreCollidingDSN']);
$this->transactionForcer->start();
}
}
protected function rollbackTransactions()
{
if (isset($this->transactionForcer)) {
$this->transactionForcer->rollbackAll();
$this->transactionForcer->stop();
unset($this->transactionForcer);
}
}
public function _parts(): array
{
return ['orm', 'init', 'fixtures', 'email'];
}
/**
* Authenticates a user on a site without submitting a login form.
* Use it for fast pragmatic authorization in functional tests.
*
* ```php
* <?php
* // User is found by id
* $I->amLoggedInAs(1);
*
* // User object is passed as parameter
* $admin = \app\models\User::findByUsername('admin');
* $I->amLoggedInAs($admin);
* ```
* Requires the `user` component to be enabled and configured.
*
* @param $user
* @throws \Codeception\Exception\ModuleException
*/
public function amLoggedInAs($user)
{
try {
$this->client->findAndLoginUser($user);
} catch (ConfigurationException $e) {
throw new ModuleException($this, $e->getMessage());
} catch (\RuntimeException $e) {
throw new ModuleException($this, $e->getMessage());
}
}
/**
* Creates and loads fixtures from a config.
* The signature is the same as for the `fixtures()` method of `yii\test\FixtureTrait`
*
* ```php
* <?php
* $I->haveFixtures([
* 'posts' => PostsFixture::class,
* 'user' => [
* 'class' => UserFixture::class,
* 'dataFile' => '@tests/_data/models/user.php',
* ],
* ]);
* ```
*
* Note: if you need to load fixtures before a test (probably before the
* cleanup transaction is started; `cleanup` option is `true` by default),
* you can specify the fixtures in the `_fixtures()` method of a test case
*
* ```php
* <?php
* // inside Cest file or Codeception\TestCase\Unit
* public function _fixtures(){
* return [
* 'user' => [
* 'class' => UserFixture::class,
* 'dataFile' => codecept_data_dir() . 'user.php'
* ]
* ];
* }
* ```
* instead of calling `haveFixtures` in Cest `_before`
*
* @param $fixtures
* @part fixtures
*/
public function haveFixtures($fixtures)
{
if (empty($fixtures)) {
return;
}
$fixturesStore = new Yii2Connector\FixturesStore($fixtures);
$fixturesStore->unloadFixtures();
$fixturesStore->loadFixtures();
$this->loadedFixtures[] = $fixturesStore;
}
/**
* Returns all loaded fixtures.
* Array of fixture instances
*
* @part fixtures
* @return array
*/
public function grabFixtures()
{
if (!$this->loadedFixtures) {
return [];
}
return call_user_func_array(
'array_merge',
array_map( // merge all fixtures from all fixture stores
function ($fixturesStore) {
return $fixturesStore->getFixtures();
},
$this->loadedFixtures
)
);
}
/**
* Gets a fixture by name.
* Returns a Fixture instance. If a fixture is an instance of
* `\yii\test\BaseActiveFixture` a second parameter can be used to return a
* specific model:
*
* ```php
* <?php
* $I->haveFixtures(['users' => UserFixture::class]);
*
* $users = $I->grabFixture('users');
*
* // get first user by key, if a fixture is an instance of ActiveFixture
* $user = $I->grabFixture('users', 'user1');
* ```
*
* @param $name
* @return mixed
* @throws \Codeception\Exception\ModuleException if the fixture is not found
* @part fixtures
*/
public function grabFixture($name, $index = null)
{
$fixtures = $this->grabFixtures();
if (!isset($fixtures[$name])) {
throw new ModuleException($this, "Fixture $name is not loaded");
}
$fixture = $fixtures[$name];
if ($index === null) {
return $fixture;
}
if ($fixture instanceof \yii\test\BaseActiveFixture) {
return $fixture->getModel($index);
}
throw new ModuleException($this, "Fixture $name is not an instance of ActiveFixture and can't be loaded with second parameter");
}
/**
* Inserts a record into the database.
*
* ``` php
* <?php
* $user_id = $I->haveRecord('app\models\User', array('name' => 'Davert'));
* ?>
* ```
*
* @param $model
* @param array $attributes
* @return mixed
* @part orm
*/
public function haveRecord($model, $attributes = [])
{
/** @var $record \yii\db\ActiveRecord * */
$record = \Yii::createObject($model);
$record->setAttributes($attributes, false);
$res = $record->save(false);
if (!$res) {
$this->fail("Record $model was not saved: " . \yii\helpers\Json::encode($record->errors));
}
return $record->primaryKey;
}
/**
* Checks that a record exists in the database.
*
* ``` php
* $I->seeRecord('app\models\User', array('name' => 'davert'));
* ```
*
* @param $model
* @param array $attributes
* @part orm
*/
public function seeRecord(string $model, array $attributes = []): void
{
$record = $this->findRecord($model, $attributes);
if (!$record) {
$this->fail("Couldn't find $model with " . json_encode($attributes));
}
$this->debugSection($model, json_encode($record));
}
/**
* Checks that a record does not exist in the database.
*
* ``` php
* $I->dontSeeRecord('app\models\User', array('name' => 'davert'));
* ```
*
* @param $model
* @param array $attributes
* @part orm
*/
public function dontSeeRecord(string $model, array $attributes = []): void
{
$record = $this->findRecord($model, $attributes);
$this->debugSection($model, json_encode($record));
if ($record) {
$this->fail("Unexpectedly managed to find $model with " . json_encode($attributes));
}
}
/**
* Retrieves a record from the database
*
* ``` php
* $category = $I->grabRecord('app\models\User', array('name' => 'davert'));
* ```
*
* @param $model
* @param array $attributes
* @return mixed
* @part orm
*/
public function grabRecord(string $model, array $attributes = []): mixed
{
return $this->findRecord($model, $attributes);
}
/**
* @param string $model Class name
* @param array $attributes
* @return mixed
*/
protected function findRecord(string $model, array $attributes = []): mixed
{
if (!class_exists($model)) {
throw new \RuntimeException("Class $model does not exist");
}
$rc = new \ReflectionClass($model);
if ($rc->hasMethod('find')
&& ($findMethod = $rc->getMethod('find'))
&& $findMethod->isStatic()
&& $findMethod->isPublic()
&& $findMethod->getNumberOfRequiredParameters() === 0
) {
$activeQuery = $findMethod->invoke(null);
if ($activeQuery instanceof QueryInterface) {
return $activeQuery->andWhere($attributes)->one();
}
throw new \RuntimeException("$model::find() must return an instance of yii\db\QueryInterface");
}
throw new \RuntimeException("Class $model does not have a public static find() method without required parameters");
}
/**
* Similar to `amOnPage` but accepts a route as first argument and params as second
*
* ```
* $I->amOnRoute('site/view', ['page' => 'about']);
* ```
*
* @param string $route A route
* @param array $params Additional route parameters
*/
public function amOnRoute(string $route, array $params = []): void
{
if (Yii::$app->controller === null) {
$route = "/{$route}";
}
array_unshift($params, $route);
$this->amOnPage(Url::to($params));
}
/**
* Opens the page for the given relative URI or route.
*
* ``` php
* <?php
* // opens front page
* $I->amOnPage('/');
* // opens /register page
* $I->amOnPage('/register');
* ```
*
* @param string $page the page URI
*/
public function amOnPage(string $page): void
{
parent::amOnPage($page);
}
/**
* To support to use the behavior of urlManager component
* for the methods like this: amOnPage(), sendAjaxRequest() and etc.
* @param $method
* @param $uri
* @param array $parameters
* @param array $files
* @param array $server
* @param null $content
* @param bool $changeHistory
* @return mixed
*/
protected function clientRequest(string $method, string $uri, array $parameters = [], array $files = [], array $server = [], string $content = null, bool $changeHistory = true): SymfonyCrawler
{
return parent::clientRequest($method, $this->client->createUrl($uri), $parameters, $files, $server, $content, $changeHistory);
}
/**
* Gets a component from the Yii container. Throws an exception if the
* component is not available
*
* ```php
* <?php
* $mailer = $I->grabComponent('mailer');
* ```
*
* @param $component
* @return mixed
* @throws \Codeception\Exception\ModuleException
* @deprecated in your tests you can use \Yii::$app directly.
*/
public function grabComponent(mixed $component)
{
try {
return $this->client->getComponent($component);
} catch (ConfigurationException $e) {
throw new ModuleException($this, $e->getMessage());
}
}
/**
* Checks that an email is sent.
*
* ```php
* <?php
* // check that at least 1 email was sent
* $I->seeEmailIsSent();
*
* // check that only 3 emails were sent
* $I->seeEmailIsSent(3);
* ```
*
* @param int $num
* @throws \Codeception\Exception\ModuleException
* @part email
*/
public function seeEmailIsSent(int $num = null): void
{
if ($num === null) {
$this->assertNotEmpty($this->grabSentEmails(), 'emails were sent');
return;
}
$this->assertEquals($num, count($this->grabSentEmails()), 'number of sent emails is equal to ' . $num);
}
/**
* Checks that no email was sent
*
* @part email
*/
public function dontSeeEmailIsSent(): void
{
$this->seeEmailIsSent(0);
}
/**
* Returns array of all sent email messages.
* Each message implements the `yii\mail\MessageInterface` interface.
* Useful to perform additional checks using the `Asserts` module:
*
* ```php
* <?php
* $I->seeEmailIsSent();
* $messages = $I->grabSentEmails();
* $I->assertEquals('admin@site,com', $messages[0]->getTo());
* ```
*
* @part email
* @return array
* @throws \Codeception\Exception\ModuleException
*/
public function grabSentEmails(): array
{
try {
return $this->client->getEmails();
} catch (ConfigurationException $e) {
throw new ModuleException($this, $e->getMessage());
}
}
/**
* Returns the last sent email:
*
* ```php
* <?php
* $I->seeEmailIsSent();
* $message = $I->grabLastSentEmail();
* $I->assertEquals('admin@site,com', $message->getTo());
* ```
* @part email
*/
public function grabLastSentEmail(): object
{
$this->seeEmailIsSent();
$messages = $this->grabSentEmails();
return end($messages);
}
/**
* Returns a list of regex patterns for recognized domain names
*
* @return array
*/
public function getInternalDomains(): array
{
return $this->client->getInternalDomains();
}
private function defineConstants(): void
{
defined('YII_DEBUG') or define('YII_DEBUG', true);
defined('YII_ENV') or define('YII_ENV', 'test');
defined('YII_ENABLE_ERROR_HANDLER') or define('YII_ENABLE_ERROR_HANDLER', false);
}
/**
* Sets a cookie and, if validation is enabled, signs it.
* @param string $name The name of the cookie
* @param string $val The value of the cookie
* @param array $params Additional cookie params like `domain`, `path`, `expires` and `secure`.
*/
public function setCookie($name, $val, $params = [])
{
parent::setCookie($name, $this->client->hashCookieData($name, $val), $params);
}
/**
* Creates the CSRF Cookie.
* @param string $val The value of the CSRF token
* @return string[] Returns an array containing the name of the CSRF param and the masked CSRF token.
*/
public function createAndSetCsrfCookie(string $val): array
{
$masked = $this->client->maskToken($val);
$name = $this->client->getCsrfParamName();
$this->setCookie($name, $val);
return [$name, $masked];
}
public function _afterSuite(): void
{
parent::_afterSuite();
codecept_debug('Suite done, restoring $_SERVER to original');
$_SERVER = $this->server;
}
/**
* Initialize an empty session. Implements MultiSession.
*/
public function _initializeSession(): void
{
$this->client->removeContext();
$this->headers = [];
$_SESSION = [];
$_COOKIE = [];
}
/**
* Return the session content for future restoring. Implements MultiSession.
* @return array backup data
*/
public function _backupSession(): array
{
if (isset(Yii::$app) && Yii::$app->has('session', true) && Yii::$app->session->useCustomStorage) {
throw new ModuleException($this, "Yii2 MultiSession only supports the default session backend.");
}
return [
'clientContext' => $this->client->getContext(),
'headers' => $this->headers,
'cookie' => isset($_COOKIE) ? $_COOKIE : [],
'session' => isset($_SESSION) ? $_SESSION : [],
];
}
/**
* Restore a session. Implements MultiSession.
* @param array output of _backupSession()
*/
public function _loadSession($session): void
{
$this->client->setContext($session['clientContext']);
$this->headers = $session['headers'];
$_SESSION = $session['session'];
$_COOKIE = $session['cookie'];
// reset Yii::$app->user
if (isset(Yii::$app)) {
$definitions = Yii::$app->getComponents(true);
if (Yii::$app->has('user', true)) {
Yii::$app->set('user', $definitions['user']);
}
}
}
/**
* Close and dump a session. Implements MultiSession.
*/
public function _closeSession($session = null): void
{
if (!$session) {
$this->_initializeSession();
}
}
}