Repository navigation
Expand file tree
/
Copy pathYii2.php
More file actions
283 lines (260 loc) · 7.61 KB
/
Copy pathYii2.php
File metadata and controls
283 lines (260 loc) · 7.61 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
<?php
namespace Codeception\Module;
use Codeception\Exception\ModuleConfigException;
use Codeception\Lib\Framework;
use Codeception\Configuration;
use Codeception\TestInterface;
use Codeception\Lib\Interfaces\ActiveRecord;
use Codeception\Lib\Interfaces\PartedModule;
use Codeception\Lib\Connector\Yii2 as Yii2Connector;
use yii\db\ActiveRecordInterface;
use Yii;
/**
* This module provides integration with [Yii framework](http://www.yiiframework.com/) (2.0).
*
*
* ## Config
*
* * configFile *required* - the path to the application config file
*
* The entry script must return the application configuration array.
*
* You can use this module by setting params in your functional.suite.yml:
* <pre>
* class_name: TestGuy
* modules:
* enabled:
* - Yii2:
* configFile: '/path/to/config.php'
* </pre>
*
* ## Parts
*
* * ORM - include only haveRecord/grabRecord/seeRecord/dontSeeRecord actions
*
*
* ## Status
*
* Maintainer: **qiangxue**
* Stability: **stable**
*
*/
class Yii2 extends Framework implements ActiveRecord, PartedModule
{
/**
* Application config file must be set.
* @var array
*/
protected $config = ['cleanup' => false];
protected $requiredFields = ['configFile'];
protected $transaction;
public $app;
public function _initialize()
{
if (!is_file(Configuration::projectDir() . $this->config['configFile'])) {
throw new ModuleConfigException(
__CLASS__,
"The application config file does not exist: {$this->config['configFile']}"
);
}
}
public function _before(TestInterface $test)
{
$this->client = new Yii2Connector();
$this->client->configFile = Configuration::projectDir().$this->config['configFile'];
$mainConfig = Configuration::config();
if (isset($mainConfig['config']) && isset($mainConfig['config']['test_entry_url'])){
$this->client->setServerParameter(
'HTTPS',
parse_url($mainConfig['config']['test_entry_url'], PHP_URL_SCHEME) === 'https'
);
}
$this->app = $this->client->getApplication();
if ($this->config['cleanup'] && isset($this->app->db)) {
$this->transaction = $this->app->db->beginTransaction();
}
}
public function _after(\Codeception\TestInterface $test)
{
$_SESSION = [];
$_FILES = [];
$_GET = [];
$_POST = [];
$_COOKIE = [];
$_REQUEST = [];
if ($this->transaction && $this->config['cleanup']) {
$this->transaction->rollback();
}
\yii\web\UploadedFile::reset();
if (Yii::$app) {
Yii::$app->session->destroy();
}
parent::_after($test);
}
public function _parts()
{
return ['orm'];
}
/**
* Inserts 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 = $this->getModelRecord($model);
$record->setAttributes($attributes, false);
$res = $record->save(false);
if (!$res) {
$this->fail("Record $model was not saved");
}
return $record->primaryKey;
}
/**
* Checks that record exists in database.
*
* ``` php
* $I->seeRecord('app\models\User', array('name' => 'davert'));
* ```
*
* @param $model
* @param array $attributes
* @part orm
*/
public function seeRecord($model, $attributes = [])
{
$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 record does not exist in database.
*
* ``` php
* $I->dontSeeRecord('app\models\User', array('name' => 'davert'));
* ```
*
* @param $model
* @param array $attributes
* @part orm
*/
public function dontSeeRecord($model, $attributes = [])
{
$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 record from database
*
* ``` php
* $category = $I->grabRecord('app\models\User', array('name' => 'davert'));
* ```
*
* @param $model
* @param array $attributes
* @return mixed
* @part orm
*/
public function grabRecord($model, $attributes = [])
{
return $this->findRecord($model, $attributes);
}
protected function findRecord($model, $attributes = [])
{
$this->getModelRecord($model);
return call_user_func([$model, 'find'])
->where($attributes)
->one();
}
protected function getModelRecord($model)
{
if (!class_exists($model)) {
throw new \RuntimeException("Model $model does not exist");
}
$record = new $model;
if (!$record instanceof ActiveRecordInterface) {
throw new \RuntimeException("Model $model is not implement interface \\yii\\db\\ActiveRecordInterface");
}
return $record;
}
/**
* Converting $page to valid Yii 2 URL
*
* Allows input like:
*
* ```php
* $I->amOnPage(['site/view','page'=>'about']);
* $I->amOnPage('index-test.php?site/index');
* $I->amOnPage('http://localhost/index-test.php?site/index');
* ```
*
* @param $page string|array parameter for \yii\web\UrlManager::createUrl()
*/
public function amOnPage($page)
{
if (is_array($page)) {
$page = Yii::$app->getUrlManager()->createUrl($page);
}
parent::amOnPage($page);
}
/**
* Getting domain regex from rule host template
*
* @param string $template
* @return string
*/
private function getDomainRegex($template)
{
if (preg_match('#https?://(.*)#', $template, $matches)) {
$template = $matches[1];
}
$parameters = [];
if (strpos($template, '<') !== false) {
$template = preg_replace_callback(
'/<(?:\w+):?([^>]+)?>/u',
function ($matches) use (&$parameters) {
$key = '#' . count($parameters) . '#';
$parameters[$key] = isset($matches[1]) ? $matches[1] : '\w+';
return $key;
},
$template
);
}
$template = preg_quote($template);
$template = strtr($template, $parameters);
return '/^' . $template . '$/u';
}
/**
* Returns a list of regex patterns for recognized domain names
*
* @return array
*/
public function getInternalDomains()
{
$domains = [$this->getDomainRegex(Yii::$app->urlManager->hostInfo)];
if (Yii::$app->urlManager->enablePrettyUrl) {
foreach (Yii::$app->urlManager->rules as $rule) {
/** @var \yii\web\UrlRule $rule */
if ($rule->host !== null) {
$domains[] = $this->getDomainRegex($rule->host);
}
}
}
return array_unique($domains);
}
}