1 | <?php //[STAMP] 141a71be31fb850b4f0890a80e070f8c |
||
8 | trait AcceptanceTesterActions |
||
9 | { |
||
10 | /** |
||
11 | * @return \Codeception\Scenario |
||
12 | */ |
||
13 | abstract protected function getScenario(); |
||
14 | |||
15 | |||
16 | /** |
||
17 | * [!] Method is generated. Documentation taken from corresponding module. |
||
18 | * |
||
19 | * Executes a shell command. |
||
20 | * Fails If exit code is > 0. You can disable this by setting second parameter to false |
||
21 | * |
||
22 | * ```php |
||
23 | * <?php |
||
24 | * $I->runShellCommand('phpunit'); |
||
25 | * |
||
26 | * // do not fail test when command fails |
||
27 | * $I->runShellCommand('phpunit', false); |
||
28 | * ``` |
||
29 | * |
||
30 | * @param $command |
||
31 | * @param bool $failNonZero |
||
32 | * @see \Codeception\Module\Cli::runShellCommand() |
||
33 | */ |
||
34 | public function runShellCommand($command, $failNonZero = null) { |
||
37 | |||
38 | |||
39 | /** |
||
40 | * [!] Method is generated. Documentation taken from corresponding module. |
||
41 | * |
||
42 | * Checks that output from last executed command contains text |
||
43 | * |
||
44 | * @param $text |
||
45 | * Conditional Assertion: Test won't be stopped on fail |
||
46 | * @see \Codeception\Module\Cli::seeInShellOutput() |
||
47 | */ |
||
48 | public function canSeeInShellOutput($text) { |
||
51 | /** |
||
52 | * [!] Method is generated. Documentation taken from corresponding module. |
||
53 | * |
||
54 | * Checks that output from last executed command contains text |
||
55 | * |
||
56 | * @param $text |
||
57 | * @see \Codeception\Module\Cli::seeInShellOutput() |
||
58 | */ |
||
59 | public function seeInShellOutput($text) { |
||
62 | |||
63 | |||
64 | /** |
||
65 | * [!] Method is generated. Documentation taken from corresponding module. |
||
66 | * |
||
67 | * Checks that output from latest command doesn't contain text |
||
68 | * |
||
69 | * @param $text |
||
70 | * |
||
71 | * Conditional Assertion: Test won't be stopped on fail |
||
72 | * @see \Codeception\Module\Cli::dontSeeInShellOutput() |
||
73 | */ |
||
74 | public function cantSeeInShellOutput($text) { |
||
77 | /** |
||
78 | * [!] Method is generated. Documentation taken from corresponding module. |
||
79 | * |
||
80 | * Checks that output from latest command doesn't contain text |
||
81 | * |
||
82 | * @param $text |
||
83 | * |
||
84 | * @see \Codeception\Module\Cli::dontSeeInShellOutput() |
||
85 | */ |
||
86 | public function dontSeeInShellOutput($text) { |
||
89 | |||
90 | |||
91 | /** |
||
92 | * [!] Method is generated. Documentation taken from corresponding module. |
||
93 | * |
||
94 | * @param $regex |
||
95 | * Conditional Assertion: Test won't be stopped on fail |
||
96 | * @see \Codeception\Module\Cli::seeShellOutputMatches() |
||
97 | */ |
||
98 | public function canSeeShellOutputMatches($regex) { |
||
101 | /** |
||
102 | * [!] Method is generated. Documentation taken from corresponding module. |
||
103 | * |
||
104 | * @param $regex |
||
105 | * @see \Codeception\Module\Cli::seeShellOutputMatches() |
||
106 | */ |
||
107 | public function seeShellOutputMatches($regex) { |
||
110 | |||
111 | |||
112 | /** |
||
113 | * [!] Method is generated. Documentation taken from corresponding module. |
||
114 | * |
||
115 | * Checks result code |
||
116 | * |
||
117 | * ```php |
||
118 | * <?php |
||
119 | * $I->seeResultCodeIs(0); |
||
120 | * ``` |
||
121 | * |
||
122 | * @param $code |
||
123 | * Conditional Assertion: Test won't be stopped on fail |
||
124 | * @see \Codeception\Module\Cli::seeResultCodeIs() |
||
125 | */ |
||
126 | public function canSeeResultCodeIs($code) { |
||
129 | /** |
||
130 | * [!] Method is generated. Documentation taken from corresponding module. |
||
131 | * |
||
132 | * Checks result code |
||
133 | * |
||
134 | * ```php |
||
135 | * <?php |
||
136 | * $I->seeResultCodeIs(0); |
||
137 | * ``` |
||
138 | * |
||
139 | * @param $code |
||
140 | * @see \Codeception\Module\Cli::seeResultCodeIs() |
||
141 | */ |
||
142 | public function seeResultCodeIs($code) { |
||
145 | |||
146 | |||
147 | /** |
||
148 | * [!] Method is generated. Documentation taken from corresponding module. |
||
149 | * |
||
150 | * Checks result code |
||
151 | * |
||
152 | * ```php |
||
153 | * <?php |
||
154 | * $I->seeResultCodeIsNot(0); |
||
155 | * ``` |
||
156 | * |
||
157 | * @param $code |
||
158 | * Conditional Assertion: Test won't be stopped on fail |
||
159 | * @see \Codeception\Module\Cli::seeResultCodeIsNot() |
||
160 | */ |
||
161 | public function canSeeResultCodeIsNot($code) { |
||
164 | /** |
||
165 | * [!] Method is generated. Documentation taken from corresponding module. |
||
166 | * |
||
167 | * Checks result code |
||
168 | * |
||
169 | * ```php |
||
170 | * <?php |
||
171 | * $I->seeResultCodeIsNot(0); |
||
172 | * ``` |
||
173 | * |
||
174 | * @param $code |
||
175 | * @see \Codeception\Module\Cli::seeResultCodeIsNot() |
||
176 | */ |
||
177 | public function seeResultCodeIsNot($code) { |
||
180 | |||
181 | |||
182 | /** |
||
183 | * [!] Method is generated. Documentation taken from corresponding module. |
||
184 | * |
||
185 | * Enters a directory In local filesystem. |
||
186 | * Project root directory is used by default |
||
187 | * |
||
188 | * @param string $path |
||
189 | * @see \Codeception\Module\Filesystem::amInPath() |
||
190 | */ |
||
191 | public function amInPath($path) { |
||
194 | |||
195 | |||
196 | /** |
||
197 | * [!] Method is generated. Documentation taken from corresponding module. |
||
198 | * |
||
199 | * Opens a file and stores it's content. |
||
200 | * |
||
201 | * Usage: |
||
202 | * |
||
203 | * ``` php |
||
204 | * <?php |
||
205 | * $I->openFile('composer.json'); |
||
206 | * $I->seeInThisFile('codeception/codeception'); |
||
207 | * ?> |
||
208 | * ``` |
||
209 | * |
||
210 | * @param string $filename |
||
211 | * @see \Codeception\Module\Filesystem::openFile() |
||
212 | */ |
||
213 | public function openFile($filename) { |
||
216 | |||
217 | |||
218 | /** |
||
219 | * [!] Method is generated. Documentation taken from corresponding module. |
||
220 | * |
||
221 | * Deletes a file |
||
222 | * |
||
223 | * ``` php |
||
224 | * <?php |
||
225 | * $I->deleteFile('composer.lock'); |
||
226 | * ?> |
||
227 | * ``` |
||
228 | * |
||
229 | * @param string $filename |
||
230 | * @see \Codeception\Module\Filesystem::deleteFile() |
||
231 | */ |
||
232 | public function deleteFile($filename) { |
||
235 | |||
236 | |||
237 | /** |
||
238 | * [!] Method is generated. Documentation taken from corresponding module. |
||
239 | * |
||
240 | * Deletes directory with all subdirectories |
||
241 | * |
||
242 | * ``` php |
||
243 | * <?php |
||
244 | * $I->deleteDir('vendor'); |
||
245 | * ?> |
||
246 | * ``` |
||
247 | * |
||
248 | * @param string $dirname |
||
249 | * @see \Codeception\Module\Filesystem::deleteDir() |
||
250 | */ |
||
251 | public function deleteDir($dirname) { |
||
254 | |||
255 | |||
256 | /** |
||
257 | * [!] Method is generated. Documentation taken from corresponding module. |
||
258 | * |
||
259 | * Copies directory with all contents |
||
260 | * |
||
261 | * ``` php |
||
262 | * <?php |
||
263 | * $I->copyDir('vendor','old_vendor'); |
||
264 | * ?> |
||
265 | * ``` |
||
266 | * |
||
267 | * @param string $src |
||
268 | * @param string $dst |
||
269 | * @see \Codeception\Module\Filesystem::copyDir() |
||
270 | */ |
||
271 | public function copyDir($src, $dst) { |
||
274 | |||
275 | |||
276 | /** |
||
277 | * [!] Method is generated. Documentation taken from corresponding module. |
||
278 | * |
||
279 | * Checks If opened file has `text` in it. |
||
280 | * |
||
281 | * Usage: |
||
282 | * |
||
283 | * ``` php |
||
284 | * <?php |
||
285 | * $I->openFile('composer.json'); |
||
286 | * $I->seeInThisFile('codeception/codeception'); |
||
287 | * ?> |
||
288 | * ``` |
||
289 | * |
||
290 | * @param string $text |
||
291 | * Conditional Assertion: Test won't be stopped on fail |
||
292 | * @see \Codeception\Module\Filesystem::seeInThisFile() |
||
293 | */ |
||
294 | public function canSeeInThisFile($text) { |
||
297 | /** |
||
298 | * [!] Method is generated. Documentation taken from corresponding module. |
||
299 | * |
||
300 | * Checks If opened file has `text` in it. |
||
301 | * |
||
302 | * Usage: |
||
303 | * |
||
304 | * ``` php |
||
305 | * <?php |
||
306 | * $I->openFile('composer.json'); |
||
307 | * $I->seeInThisFile('codeception/codeception'); |
||
308 | * ?> |
||
309 | * ``` |
||
310 | * |
||
311 | * @param string $text |
||
312 | * @see \Codeception\Module\Filesystem::seeInThisFile() |
||
313 | */ |
||
314 | public function seeInThisFile($text) { |
||
317 | |||
318 | |||
319 | /** |
||
320 | * [!] Method is generated. Documentation taken from corresponding module. |
||
321 | * |
||
322 | * Checks If opened file has the `number` of new lines. |
||
323 | * |
||
324 | * Usage: |
||
325 | * |
||
326 | * ``` php |
||
327 | * <?php |
||
328 | * $I->openFile('composer.json'); |
||
329 | * $I->seeNumberNewLines(5); |
||
330 | * ?> |
||
331 | * ``` |
||
332 | * |
||
333 | * @param int $number New lines |
||
334 | * Conditional Assertion: Test won't be stopped on fail |
||
335 | * @see \Codeception\Module\Filesystem::seeNumberNewLines() |
||
336 | */ |
||
337 | public function canSeeNumberNewLines($number) { |
||
340 | /** |
||
341 | * [!] Method is generated. Documentation taken from corresponding module. |
||
342 | * |
||
343 | * Checks If opened file has the `number` of new lines. |
||
344 | * |
||
345 | * Usage: |
||
346 | * |
||
347 | * ``` php |
||
348 | * <?php |
||
349 | * $I->openFile('composer.json'); |
||
350 | * $I->seeNumberNewLines(5); |
||
351 | * ?> |
||
352 | * ``` |
||
353 | * |
||
354 | * @param int $number New lines |
||
355 | * @see \Codeception\Module\Filesystem::seeNumberNewLines() |
||
356 | */ |
||
357 | public function seeNumberNewLines($number) { |
||
360 | |||
361 | |||
362 | /** |
||
363 | * [!] Method is generated. Documentation taken from corresponding module. |
||
364 | * |
||
365 | * Checks that contents of currently opened file matches $regex |
||
366 | * |
||
367 | * @param string $regex |
||
368 | * Conditional Assertion: Test won't be stopped on fail |
||
369 | * @see \Codeception\Module\Filesystem::seeThisFileMatches() |
||
370 | */ |
||
371 | public function canSeeThisFileMatches($regex) { |
||
374 | /** |
||
375 | * [!] Method is generated. Documentation taken from corresponding module. |
||
376 | * |
||
377 | * Checks that contents of currently opened file matches $regex |
||
378 | * |
||
379 | * @param string $regex |
||
380 | * @see \Codeception\Module\Filesystem::seeThisFileMatches() |
||
381 | */ |
||
382 | public function seeThisFileMatches($regex) { |
||
385 | |||
386 | |||
387 | /** |
||
388 | * [!] Method is generated. Documentation taken from corresponding module. |
||
389 | * |
||
390 | * Checks the strict matching of file contents. |
||
391 | * Unlike `seeInThisFile` will fail if file has something more than expected lines. |
||
392 | * Better to use with HEREDOC strings. |
||
393 | * Matching is done after removing "\r" chars from file content. |
||
394 | * |
||
395 | * ``` php |
||
396 | * <?php |
||
397 | * $I->openFile('process.pid'); |
||
398 | * $I->seeFileContentsEqual('3192'); |
||
399 | * ?> |
||
400 | * ``` |
||
401 | * |
||
402 | * @param string $text |
||
403 | * Conditional Assertion: Test won't be stopped on fail |
||
404 | * @see \Codeception\Module\Filesystem::seeFileContentsEqual() |
||
405 | */ |
||
406 | public function canSeeFileContentsEqual($text) { |
||
409 | /** |
||
410 | * [!] Method is generated. Documentation taken from corresponding module. |
||
411 | * |
||
412 | * Checks the strict matching of file contents. |
||
413 | * Unlike `seeInThisFile` will fail if file has something more than expected lines. |
||
414 | * Better to use with HEREDOC strings. |
||
415 | * Matching is done after removing "\r" chars from file content. |
||
416 | * |
||
417 | * ``` php |
||
418 | * <?php |
||
419 | * $I->openFile('process.pid'); |
||
420 | * $I->seeFileContentsEqual('3192'); |
||
421 | * ?> |
||
422 | * ``` |
||
423 | * |
||
424 | * @param string $text |
||
425 | * @see \Codeception\Module\Filesystem::seeFileContentsEqual() |
||
426 | */ |
||
427 | public function seeFileContentsEqual($text) { |
||
430 | |||
431 | |||
432 | /** |
||
433 | * [!] Method is generated. Documentation taken from corresponding module. |
||
434 | * |
||
435 | * Checks If opened file doesn't contain `text` in it |
||
436 | * |
||
437 | * ``` php |
||
438 | * <?php |
||
439 | * $I->openFile('composer.json'); |
||
440 | * $I->dontSeeInThisFile('codeception/codeception'); |
||
441 | * ?> |
||
442 | * ``` |
||
443 | * |
||
444 | * @param string $text |
||
445 | * Conditional Assertion: Test won't be stopped on fail |
||
446 | * @see \Codeception\Module\Filesystem::dontSeeInThisFile() |
||
447 | */ |
||
448 | public function cantSeeInThisFile($text) { |
||
451 | /** |
||
452 | * [!] Method is generated. Documentation taken from corresponding module. |
||
453 | * |
||
454 | * Checks If opened file doesn't contain `text` in it |
||
455 | * |
||
456 | * ``` php |
||
457 | * <?php |
||
458 | * $I->openFile('composer.json'); |
||
459 | * $I->dontSeeInThisFile('codeception/codeception'); |
||
460 | * ?> |
||
461 | * ``` |
||
462 | * |
||
463 | * @param string $text |
||
464 | * @see \Codeception\Module\Filesystem::dontSeeInThisFile() |
||
465 | */ |
||
466 | public function dontSeeInThisFile($text) { |
||
469 | |||
470 | |||
471 | /** |
||
472 | * [!] Method is generated. Documentation taken from corresponding module. |
||
473 | * |
||
474 | * Deletes a file |
||
475 | * @see \Codeception\Module\Filesystem::deleteThisFile() |
||
476 | */ |
||
477 | public function deleteThisFile() { |
||
480 | |||
481 | |||
482 | /** |
||
483 | * [!] Method is generated. Documentation taken from corresponding module. |
||
484 | * |
||
485 | * Checks if file exists in path. |
||
486 | * Opens a file when it's exists |
||
487 | * |
||
488 | * ``` php |
||
489 | * <?php |
||
490 | * $I->seeFileFound('UserModel.php','app/models'); |
||
491 | * ?> |
||
492 | * ``` |
||
493 | * |
||
494 | * @param string $filename |
||
495 | * @param string $path |
||
496 | * Conditional Assertion: Test won't be stopped on fail |
||
497 | * @see \Codeception\Module\Filesystem::seeFileFound() |
||
498 | */ |
||
499 | public function canSeeFileFound($filename, $path = null) { |
||
502 | /** |
||
503 | * [!] Method is generated. Documentation taken from corresponding module. |
||
504 | * |
||
505 | * Checks if file exists in path. |
||
506 | * Opens a file when it's exists |
||
507 | * |
||
508 | * ``` php |
||
509 | * <?php |
||
510 | * $I->seeFileFound('UserModel.php','app/models'); |
||
511 | * ?> |
||
512 | * ``` |
||
513 | * |
||
514 | * @param string $filename |
||
515 | * @param string $path |
||
516 | * @see \Codeception\Module\Filesystem::seeFileFound() |
||
517 | */ |
||
518 | public function seeFileFound($filename, $path = null) { |
||
521 | |||
522 | |||
523 | /** |
||
524 | * [!] Method is generated. Documentation taken from corresponding module. |
||
525 | * |
||
526 | * Checks if file does not exist in path |
||
527 | * |
||
528 | * @param string $filename |
||
529 | * @param string $path |
||
530 | * Conditional Assertion: Test won't be stopped on fail |
||
531 | * @see \Codeception\Module\Filesystem::dontSeeFileFound() |
||
532 | */ |
||
533 | public function cantSeeFileFound($filename, $path = null) { |
||
536 | /** |
||
537 | * [!] Method is generated. Documentation taken from corresponding module. |
||
538 | * |
||
539 | * Checks if file does not exist in path |
||
540 | * |
||
541 | * @param string $filename |
||
542 | * @param string $path |
||
543 | * @see \Codeception\Module\Filesystem::dontSeeFileFound() |
||
544 | */ |
||
545 | public function dontSeeFileFound($filename, $path = null) { |
||
548 | |||
549 | |||
550 | /** |
||
551 | * [!] Method is generated. Documentation taken from corresponding module. |
||
552 | * |
||
553 | * Erases directory contents |
||
554 | * |
||
555 | * ``` php |
||
556 | * <?php |
||
557 | * $I->cleanDir('logs'); |
||
558 | * ?> |
||
559 | * ``` |
||
560 | * |
||
561 | * @param string $dirname |
||
562 | * @see \Codeception\Module\Filesystem::cleanDir() |
||
563 | */ |
||
564 | public function cleanDir($dirname) { |
||
567 | |||
568 | |||
569 | /** |
||
570 | * [!] Method is generated. Documentation taken from corresponding module. |
||
571 | * |
||
572 | * Saves contents to file |
||
573 | * |
||
574 | * @param string $filename |
||
575 | * @param string $contents |
||
576 | * @see \Codeception\Module\Filesystem::writeToFile() |
||
577 | */ |
||
578 | public function writeToFile($filename, $contents) { |
||
581 | } |
||
582 |
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.