Skip to content

Commit b17a0d5

Browse files
DavertMikDavertMik
committed
auto updated documentation
1 parent cf388ec commit b17a0d5

46 files changed

Lines changed: 604 additions & 746 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_includes/modules.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<li><a href="/docs/modules/AMQP">AMQP</a></li><li><a href="/docs/modules/Asserts">Asserts</a></li><li><a href="/docs/modules/Cli">Cli</a></li><li><a href="/docs/modules/Db">Db</a></li><li><a href="/docs/modules/Dbh">Dbh</a></li><li><a href="/docs/modules/Doctrine1">Doctrine1</a></li><li><a href="/docs/modules/Doctrine2">Doctrine2</a></li><li><a href="/docs/modules/FTP">FTP</a></li><li><a href="/docs/modules/Facebook">Facebook</a></li><li><a href="/docs/modules/Filesystem">Filesystem</a></li><li><a href="/docs/modules/Kohana">Kohana</a></li><li><a href="/docs/modules/Laravel4">Laravel4</a></li><li><a href="/docs/modules/Memcache">Memcache</a></li><li><a href="/docs/modules/MongoDb">MongoDb</a></li><li><a href="/docs/modules/Phalcon1">Phalcon1</a></li><li><a href="/docs/modules/PhpBrowser">PhpBrowser</a></li><li><a href="/docs/modules/REST">REST</a></li><li><a href="/docs/modules/Redis">Redis</a></li><li><a href="/docs/modules/SOAP">SOAP</a></li><li><a href="/docs/modules/Sequence">Sequence</a></li><li><a href="/docs/modules/Silex">Silex</a></li><li><a href="/docs/modules/Symfony1">Symfony1</a></li><li><a href="/docs/modules/Symfony2">Symfony2</a></li><li><a href="/docs/modules/WebDriver">WebDriver</a></li><li><a href="/docs/modules/XMLRPC">XMLRPC</a></li><li><a href="/docs/modules/Yii1">Yii1</a></li><li><a href="/docs/modules/Yii2">Yii2</a></li><li><a href="/docs/modules/ZF1">ZF1</a></li><li><a href="/docs/modules/ZF2">ZF2</a></li>
1+
<li><a href="/docs/modules/AMQP">AMQP</a></li><li><a href="/docs/modules/PhpBrowser">PhpBrowser</a></li><li><a href="/docs/modules/Asserts">Asserts</a></li><li><a href="/docs/modules/REST">REST</a></li><li><a href="/docs/modules/Cli">Cli</a></li><li><a href="/docs/modules/Redis">Redis</a></li><li><a href="/docs/modules/Db">Db</a></li><li><a href="/docs/modules/SOAP">SOAP</a></li><li><a href="/docs/modules/Dbh">Dbh</a></li><li><a href="/docs/modules/Sequence">Sequence</a></li><li><a href="/docs/modules/Doctrine1">Doctrine1</a></li><li><a href="/docs/modules/Silex">Silex</a></li><li><a href="/docs/modules/Doctrine2">Doctrine2</a></li><li><a href="/docs/modules/Symfony1">Symfony1</a></li><li><a href="/docs/modules/FTP">FTP</a></li><li><a href="/docs/modules/Symfony2">Symfony2</a></li><li><a href="/docs/modules/Facebook">Facebook</a></li><li><a href="/docs/modules/WebDriver">WebDriver</a></li><li><a href="/docs/modules/Filesystem">Filesystem</a></li><li><a href="/docs/modules/XMLRPC">XMLRPC</a></li><li><a href="/docs/modules/Kohana">Kohana</a></li><li><a href="/docs/modules/Yii1">Yii1</a></li><li><a href="/docs/modules/Laravel4">Laravel4</a></li><li><a href="/docs/modules/Yii2">Yii2</a></li><li><a href="/docs/modules/Memcache">Memcache</a></li><li><a href="/docs/modules/ZF1">ZF1</a></li><li><a href="/docs/modules/MongoDb">MongoDb</a></li><li><a href="/docs/modules/ZF2">ZF2</a></li><li><a href="/docs/modules/Phalcon1">Phalcon1</a></li>

‎changelog.markdown‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@ title: Codeception Changelog
77

88
#### 2.0.2
99

10-
* [Yii1] disabled logging for better functional test performance
10+
* [PhpBrowser][Frameworks] correctly send values when there are several submit buttons in a form by @TrustNik *2014-07-08*
11+
* [REST] fixed connection with framework modules *2014-07-06*
12+
* [PhpBrowser][Frameworks] `checkOption` now works for checkboxes with array[] name by @TrustNik
13+
* [PhpBrowser][Frameworks] FIX: `seeOptionIsSelected` and `dontSeeOptionIsSelected` now works with radiobuttons by @TrustNik *2014-07-05*
14+
* [FTP] MODULE ADDED by @nathanmac *2014-07-05*
15+
* [WebDriver] Enabled remote upload of local files to remote selenium server by @motin *2014-07-05*
16+
* [Yii2][Yii1] disabled logging for better functional test performance
1117

1218
#### 2.0.1
1319

‎docs/01-Introduction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,4 +137,4 @@ It could be called a BDD framework. All Codeception tests are written in a descr
137137

138138

139139

140-
* **Next Chapter: [GettingStarted >](/docs/02-GettingStarted)**
140+
* **Next Chapter: [GettingStarted >](/docs/02-GettingStarted)**<p>&nbsp;</p><div class="alert alert-warning">Docs are incomplete? Outdated? Or you just found a typo? <a href="https://github.com/Codeception/Codeception/tree/2.0/docs">Help us to improve documentation. Edit it on GitHub</a>

‎docs/02-GettingStarted.md‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Actor classes are not written but generated from suite configuration. When you c
1717

1818
If Actor classes are not created or updated as you expect, try to generate them manually with `build` command:
1919

20-
{% highlight yaml %}
20+
{% highlight bash %}
2121

2222
$ php codecept.phar build
2323

@@ -32,7 +32,7 @@ Let's say, we created a file `tests/acceptance/SigninCept.php`
3232

3333
We can do that by running command:
3434

35-
{% highlight yaml %}
35+
{% highlight bash %}
3636

3737
$ php codecept.phar generate:cept acceptance Signin
3838

@@ -67,7 +67,7 @@ $I->see('Hello, davert');
6767
Before we execute this test, we should make sure that the site is running on a local web server. Let's open the `tests/acceptance.suite.yml` file and replace the URL with the URL of your web application:
6868

6969
{% highlight yaml %}
70-
yaml
70+
7171
config:
7272
PhpBrowser:
7373
url: 'http://myappurl.local'
@@ -76,16 +76,16 @@ config:
7676

7777
After we configured URL we can run this test with `run` command:
7878

79-
{% highlight yaml %}
80-
bash
79+
{% highlight bash %}
80+
8181
$ php codecept.phar run
8282

8383
{% endhighlight %}
8484

8585
Here is the output we should see:
8686

87-
{% highlight yaml %}
88-
bash
87+
{% highlight bash %}
88+
8989
Acceptance Tests (1) -------------------------------
9090
Trying log in as regular user (SigninCept.php) Ok
9191
----------------------------------------------------
@@ -104,16 +104,16 @@ OK (1 test, 1 assertions)
104104

105105
Let's get a detailed output:
106106

107-
{% highlight yaml %}
108-
bash
107+
{% highlight bash %}
108+
109109
$ php codecept.phar run acceptance --steps
110110

111111
{% endhighlight %}
112112

113113
We should see a step-by-step report on the performed actions.
114114

115-
{% highlight yaml %}
116-
bash
115+
{% highlight bash %}
116+
117117
Acceptance Tests (1) -------------------------------
118118
Trying to log in as regular user (SigninCept.php)
119119
Scenario:
@@ -157,40 +157,40 @@ Codeception has a global configuration in `codeception.yml` and a config for eac
157157

158158
Tests can be started with the `run` command.
159159

160-
{% highlight yaml %}
161-
bash
160+
{% highlight bash %}
161+
162162
$ php codecept.phar run
163163

164164
{% endhighlight %}
165165

166166
With the first argument you can run tests from one suite.
167167

168-
{% highlight yaml %}
169-
bash
168+
{% highlight bash %}
169+
170170
$ php codecept.phar run acceptance
171171

172172
{% endhighlight %}
173173

174174
To run exactly one test, add a second argument. Provide a local path to the test, from the suite directory.
175175

176-
{% highlight yaml %}
177-
bash
176+
{% highlight bash %}
177+
178178
$ php codecept.phar run acceptance SigninCept.php
179179

180180
{% endhighlight %}
181181

182182
Alternatively you can provide full path to test file:
183183

184-
{% highlight yaml %}
185-
bash
184+
{% highlight bash %}
185+
186186
$ php codecept.phar run tests/acceptance/SigninCept.php
187187

188188
{% endhighlight %}
189189

190190
You can provide a directory path as well:
191191

192-
{% highlight yaml %}
193-
bash
192+
{% highlight bash %}
193+
194194
$ php codecept.phar run tests/acceptance/backend
195195

196196
{% endhighlight %}
@@ -203,8 +203,8 @@ To execute a group of tests that are not stored in the same dir you can organize
203203

204204
To generate JUnit XML output you can provide `--xml` option, and `--html` for HTML report.
205205

206-
{% highlight yaml %}
207-
bash
206+
{% highlight bash %}
207+
208208
$ php codecept.phar run --steps --xml --html
209209

210210
{% endhighlight %}
@@ -213,8 +213,8 @@ This command will run all tests for all suites, displaying the steps, and buildi
213213

214214
And to learn all available options:
215215

216-
{% highlight yaml %}
217-
bash
216+
{% highlight bash %}
217+
218218
$ php codecept.phar help run
219219

220220
{% endhighlight %}
@@ -232,7 +232,7 @@ There are plenty of useful Codeception commands.
232232
* `generate:cest` *suite* *filename* - Generates a sample Cest test.
233233
* `generate:test` *suite* *filename* - Generates a sample PHPUnit Test with Codeception hooks.
234234
* `generate:phpunit` *suite* *filename* - Generates a classic PHPUnit Test.
235-
* `generate:suite` *suite* *guy* - Generates a new suite with the given Guy class name.
235+
* `generate:suite` *suite* *actor* - Generates a new suite with the given Actor class name.
236236
* `generate:scenarios` *suite* - Generates text files containing scenarios from tests.
237237

238238

@@ -244,4 +244,4 @@ We took a look into the Codeception structure. Most of the things you need were
244244

245245

246246
* **Next Chapter: [ModulesAndHelpers >](/docs/03-ModulesAndHelpers)**
247-
* **Previous Chapter: [< Introduction](/docs/01-Introduction)**
247+
* **Previous Chapter: [< Introduction](/docs/01-Introduction)**<p>&nbsp;</p><div class="alert alert-warning">Docs are incomplete? Outdated? Or you just found a typo? <a href="https://github.com/Codeception/Codeception/tree/2.0/docs">Help us to improve documentation. Edit it on GitHub</a>

‎docs/03-ModulesAndHelpers.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Modules are attached to Actor classes in the suite config.
3030
For example, in `tests/functional.suite.yml` we should see.
3131

3232
{% highlight yaml %}
33-
yaml
33+
3434
class_name: FunctionalTester
3535
modules:
3636
enabled: [PhpBrowser, Db, Filesystem]
@@ -44,7 +44,7 @@ The FunctionalTester class has its methods defined in modules. Actually, it does
4444
Codeception has many bundled modules which will help you run tests for different purposes and in different environments. The number of modules is not constant -- it's supposed to grow as more frameworks and ORMs are supported.
4545
See all of them listed in the main menu under Modules section.
4646

47-
All of these modules are documented. You can review their detailed references on [GitHub](https://github.com/DavertMik/Codeception/tree/master/docs/modules).
47+
All of these modules are documented. You can review their detailed references on [GitHub](https://github.com/Codeception/Codeception/tree/master/docs/modules).
4848

4949
## Helpers
5050

@@ -138,7 +138,7 @@ Just type `$this->assert` to see all of them.
138138

139139
What happens if you have two modules which contain the same named actions?
140140
Codeception allows you to override actions by changing the module order.
141-
The action from the second module will be loaded and the action from the first will be ignored.
141+
The action from the second module will be loaded and the action from the first one will be ignored.
142142
The order of the modules can be defined in the suite config.
143143

144144
### Connecting Modules
@@ -198,7 +198,7 @@ All hooks are defined in `\Codeception\Module` and are listed here. You are free
198198
public function _initialize() {
199199
}
200200
201-
// HOOK: on every Guy class initialization
201+
// HOOK: on every Actor class initialization
202202
public function _cleanup() {
203203
}
204204
@@ -214,7 +214,7 @@ All hooks are defined in `\Codeception\Module` and are listed here. You are free
214214
public function _beforeStep(\Codeception\Step $step) {
215215
}
216216
217-
// HOOK: after each step
217+
// HOOK: after each step
218218
public function _afterStep(\Codeception\Step $step) {
219219
}
220220
@@ -258,8 +258,8 @@ Here is an example of how it works for PhpBrowser:
258258

259259
This test, running with PhpBrowser module in debug mode, will print something like this:
260260

261-
{% highlight yaml %}
262-
bash
261+
{% highlight bash %}
262+
263263
I click "All pages"
264264
* Request (GET) http://localhost/pages {}
265265
* Response code: 200
@@ -300,7 +300,7 @@ class WebDriver extends \Codeception\Module
300300
The host and port parameter can be redefined in the suite config. Values are set in the `modules:config` section of the configuration file.
301301

302302
{% highlight yaml %}
303-
yaml
303+
304304
modules:
305305
enabled:
306306
- WebDriver
@@ -315,7 +315,7 @@ modules:
315315

316316
{% endhighlight %}
317317

318-
Optional and mandatory parameters can be accessed through the `$config` property. Use `$this->config['parameter']` to get it's value.
318+
Optional and mandatory parameters can be accessed through the `$config` property. Use `$this->config['parameter']` to get its value.
319319

320320
### Dynamic Configuration
321321

@@ -390,7 +390,7 @@ class SecondDbHelper extends Db {
390390

391391
{% endhighlight %}
392392

393-
`$includeInheritedActions` set to false won't include the methods from parent classes into the generated Guy.
393+
`$includeInheritedActions` set to false won't include the methods from parent classes into the generated Actor.
394394
Still you can use inherited methods in your helper class.
395395

396396
## Conclusion
@@ -399,10 +399,10 @@ Modules are the true power of Codeception. They are used to emulate multiple inh
399399
Codeception provides modules to emulate web requests, access data, interact with popular PHP libraries, etc.
400400
For your application you might need custom actions. These can be defined in helper classes.
401401
If you have written a module that may be useful to others, share it.
402-
Fork the Codeception repository, put the module into the __src/Codeception/Module__ directory, and send a pull request
402+
Fork the Codeception repository, put the module into the __src/Codeception/Module__ directory, and send a pull request.
403403

404404

405405

406406

407407
* **Next Chapter: [AcceptanceTests >](/docs/04-AcceptanceTests)**
408-
* **Previous Chapter: [< GettingStarted](/docs/02-GettingStarted)**
408+
* **Previous Chapter: [< GettingStarted](/docs/02-GettingStarted)**<p>&nbsp;</p><div class="alert alert-warning">Docs are incomplete? Outdated? Or you just found a typo? <a href="https://github.com/Codeception/Codeception/tree/2.0/docs">Help us to improve documentation. Edit it on GitHub</a>

0 commit comments

Comments
 (0)