You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: changelog.markdown
+5-40Lines changed: 5 additions & 40 deletions
Original file line number
Diff line number
Diff line change
@@ -7,41 +7,11 @@ title: Codeception Changelog
7
7
8
8
# Changelog
9
9
10
-
#### 2.1.0
11
-
12
-
* <strong>[Recorder]</strong>(https://github.com/Codeception/Codeception/tree/master/ext#codeceptionextensionrecorder) extension added. Shows acceptance test progress with a recorded slideshow.
13
-
***Updated to Guzzle 6**. Codeception can now work both with Guzzle v5 and Guzzle v6. PhpBrowser chooses right connector depending on Guzzle version installed. By <strong><ahref="https://github.com/davertmik">@davertmik</a></strong> and <strong><ahref="https://github.com/enumag">@enumag</a></strong>
14
-
* Annotations in Cept files.
15
-
Instead of calling `$scenario->skip()`, `$scenario->group('firefox')`, etc, it is recommended to set scenario metadata with annotations `// <strong><a href="https://github.com/skip">@skip</a></strong>`, `// <strong><a href="https://github.com/group">@group</a></strong> firefox`.
16
-
Annotations can be parsed from line or block comments. `$scenario->skip()` and `$scenario->incomplete()` are still valid and can be executed inside conditional statements:
17
-
```
18
-
if (!extension_loaded('xdebug')) $scenario->skip('Xdebug required')
19
-
```
20
-
***PSR-4**: all support classes moved to `tests/_support` by default. Actors, Helpers, PageObjects, StepObjects, GroupObjects to follow PSR-4 naming style. Autoloader implemented by <strong><ahref="https://github.com/splinter89">@splinter89</a></strong>.
21
-
***Dependency Injection**: support classes can be injected into tests. Support classes can be injected into each other too. This happens by implementing method `_inject` and explicitly specifying class names as parameters. Implemented by <strong><ahref="https://github.com/splinter89">@splinter89</a></strong>.
22
-
***Actor classes can be extended**, their generated parts were moved to special traits in `_generated` namespace. Each *Tester class can be updated with custom methods.
23
-
***Module config simplified**: Modules can be configured in `enabled` section of suite config.
24
-
***Conflicts**: module can define conflicts with each other by implementing `_conflicts` method
25
-
***Dependencies**: module can explicitly define dependencies and expect their injection by implementing `_inject` and `_depends` methods and relying on dependency injection container.
26
-
***Current** modules, environment, and test name can be received in scenario. Example: `$scenario->current('env')` returns current environment name. Fixes <ahref="https://github.com/Codeception/Codeception/issues/1251">#1251</a>
27
-
***Environment Matrix**: environments can be merged. Environment configs can be created in `tests/_envs`, environment generator added. Implemented by By <strong><ahref="https://github.com/sjableka">@sjableka</a></strong>. See <ahref="https://github.com/Codeception/Codeception/issues/1747">#1747</a>
28
-
***Custom Printers**: XML, JSON, TAP, Report printers can be redefined in configuration. See <ahref="https://github.com/Codeception/Codeception/issues/1425">#1425</a>
29
-
* <strong>[Db]</strong> Added `reconnect` option for long running tests, which will connect to database before the test and disconnect after. By <strong><ahref="https://github.com/Naktibalda">@Naktibalda</a></strong>
30
-
* Module parts. Actions of modules can be loaded partially in order to disable actions which are not used in current tests. For instance, disable web actions of framework modules in unit testsing.
31
-
***Kohana**, **Symfony1**, **Doctrine1** modules considered deprecated and moved to standalone packages.
32
-
*`shuffle` added to settings. Randomizes order of running tests. See <ahref="https://github.com/Codeception/Codeception/issues/1504">#1504</a>
33
-
* Console output improved: scenario stack traces contain files and lines of fail.
34
-
* <strong>[Doctrine2]</strong><strong>[Symfony2]</strong> `symfony_em_service` config option moved from Doctrine2 to Symfony2 module and renamed to `em_service`*2015-06-03*
35
-
* <strong>[PhpBrowser]</strong><strong>[Frameworks]</strong> Fixed cloning form nodes `Codeception\Lib\InnerBrowser::getFormFromCrawler(): ID XXX already defined`*2015-05-13*
36
-
* <strong>[WebDriver]</strong> session snapshot implemented, allows to store cookies and load them, i.e., to keep user session between testss.
37
-
* <strong>[WebDriver]</strong><strong>[PhpBrowser]</strong><strong>[Frameworks]</strong> Malformed XPath locators wil throw an exception <ahref="https://github.com/Codeception/Codeception/issues/1441">#1441</a>
38
-
*`MODULE_INIT` event is fired before initializing modules <ahref="https://github.com/Codeception/Codeception/issues/1370">#1370</a>
39
-
* Graceful tests termination using `pcntl_signal`. See <ahref="https://github.com/Codeception/Codeception/issues/1286">#1286</a>
40
-
* Group classes renamed to GroupObjects; Base GroupObject class renamed to `Codeception\GroupObject`
41
-
* Official extensions moved to `ext` dir; Base Extension class renamed to `Codeception\Extension`
42
-
* Duplicate environment options won't cause Codeception to run environment tests twice
43
-
* <strong>[Phalcon1]</strong> `haveServiceInDi` method implemented by <strong><ahref="https://github.com/sergeyklay">@sergeyklay</a></strong>
44
-
* <strong>[Db]</strong> `seeNumRecords` method added by <strong><ahref="https://github.com/sergeyklay">@sergeyklay</a></strong>
10
+
#### 2.0.16
11
+
12
+
* <strong>[REST]</strong> Module usage should not depend on order it was declared. Fixes <ahref="https://github.com/Codeception/Codeception/issues/2100">#2100</a> by <strong><ahref="https://github.com/Naktibalda">@Naktibalda</a></strong>
13
+
* <strong>[Db]</strong> When `populate` is enabled cleanup should happen only if enabled too <ahref="https://github.com/Codeception/Codeception/issues/2148">#2148</a> by <strong><ahref="https://github.com/gammamatrix">@gammamatrix</a></strong>
14
+
* <strong>[Laravel5]</strong> Rewrite of module to fix open issues and other problems *2015-07-09*
45
15
46
16
#### 2.0.15
47
17
@@ -152,11 +122,6 @@ Modifications to ensure multiple values get sent correctly.
152
122
* <strong>[Yii2]</strong> Fixed usage of PUT method by <strong><ahref="https://github.com/miroslav">@miroslav</a></strong>-chandler *2015-02-23*
153
123
154
124
155
-
#### 2.1.0
156
-
157
-
* <strong>[WebDriver]</strong> Saving and restoring session snapshots implemented *2015-03-16*
158
-
159
-
160
125
#### 2.0.10
161
126
162
127
***Console Improvement**: better formatting of test progress. Improved displaying of debug messages and PHP Fatal Errors.
***Next Chapter: [GettingStarted >](/docs/02-GettingStarted)**<p> </p><divclass="alert alert-warning">Docs are incomplete? Outdated? Or you just found a typo? <ahref="https://github.com/Codeception/Codeception/tree/2.0/docs">Help us to improve documentation. Edit it on GitHub</a></div>
Copy file name to clipboardExpand all lines: docs/02-GettingStarted.md
+17-72Lines changed: 17 additions & 72 deletions
Original file line number
Diff line number
Diff line change
@@ -11,21 +11,11 @@ Let's take a look at Codeception's architecture. We assume that you already [ins
11
11
12
12
One of the main concepts of Codeception is representation of tests as actions of a person. We have a UnitTester, who executes functions and tests the code. We also have a FunctionalTester, a qualified tester, who tests the application as a whole, with knowledge of its internals. And an AcceptanceTester, a user that works with our application through an interface that we provide.
13
13
14
-
Actor classes are not written but generated from suite configuration. **Methods of actor classes are generally taken from Codeception Modules**. Each module provides predefined actions for different testing purposes, and they can be combined to fit the testng environment. Codeception tries to solve 90% of possible testing issues in its modules, so you don't have reinvent the wheel. We think that you can spend more time on writing tests and less on writing support code to make those tests run. By default AcceptanceTester relies on PhpBrowser module, which is set in `tests/acceptance.suite.yml` configuration file:
14
+
Each of these Actors are PHP classes along with the actions that they are allowed to do. As you can see, each of these Actors have different abilities. They are not constant, you can extend them. One Actor belongs to one testing suite.
15
15
16
-
{% highlight yaml %}
17
-
18
-
class_name: AcceptanceTester
19
-
modules:
20
-
enabled:
21
-
- PhpBrowser:
22
-
url: http://localhost/myapp/
23
-
- \Helper\Acceptance
24
-
25
-
{% endhighlight %}
16
+
Actor classes are not written but generated from suite configuration. When you change configuration, actor classes are **rebuilt automatically**.
26
17
27
-
In this configuration file you can enable/disable and reconfigure modules for your needs.
28
-
When you change configuration, actor classes are rebuilt automatically. If Actor classes are not created or updated as you expect, try to generate them manually with `build` command:
18
+
If Actor classes are not created or updated as you expect, try to generate them manually with `build` command:
29
19
30
20
{% highlight bash %}
31
21
@@ -78,12 +68,9 @@ Before we execute this test, we should make sure that the website is running on
78
68
79
69
{% highlight yaml %}
80
70
81
-
class_name: AcceptanceTester
82
-
modules:
83
-
enabled:
84
-
- PhpBrowser:
85
-
url: 'http://myappurl.local'
86
-
- \Helper\Acceptance
71
+
config:
72
+
PhpBrowser:
73
+
url: 'http://myappurl.local'
87
74
88
75
{% endhighlight %}
89
76
@@ -144,70 +131,28 @@ OK (1 test, 1 assertions)
144
131
145
132
{% endhighlight %}
146
133
147
-
This simple test can be extended to a complete scenario of site usage.
148
-
So by emulating the user's actions you can test any of your websites.
134
+
That was a very simple test that you can reproduce for your own website.
135
+
By emulating the user's actions you can test all of your websites the same way.
149
136
150
137
Give it a try!
151
138
152
-
## Bootstrap
153
-
154
-
Each suite has its own bootstrap file. It's located in the suite directory and is named `_bootstrap.php`. It will be executed before test suite. There is also a global bootstrap file located in the `tests` directory. It can be used to include additional files.
155
-
156
-
## Cept, Cest and Test Formats
157
-
158
-
Codeception supports three test formats. Beside the previously described scenario-based Cept format, Codeception can also execute [PHPUnit test files for unit testing](http://codeception.com/docs/06-UnitTests), and Cest format.
159
-
160
-
Cest combines scenario-driven test approach with OOP design. In case you want to group a few testing scenarios into one you should consider using Cest format. In the example below we are testing CRUD actions within a single file but with a several test (one per each operation):
161
-
162
-
{% highlight php %}
163
-
164
-
<?php
165
-
class PageCrudCest
166
-
{
167
-
function _before(AcceptanceTester $I)
168
-
{
169
-
// will be executed at the beginning of each test
170
-
$I->amOnPage('/');
171
-
}
172
-
173
-
function createPage(AcceptanceTester $I)
174
-
{
175
-
// todo: write test
176
-
}
177
-
178
-
function viewPage(AcceptanceTester $I)
179
-
{
180
-
// todo: write test
181
-
}
182
-
183
-
function updatePage(AcceptanceTester $I)
184
-
{
185
-
// todo: write test
186
-
}
187
-
188
-
function deletePage(AcceptanceTester $I)
189
-
{
190
-
// todo: write test
191
-
}
192
-
}
193
-
?>
194
-
195
-
{% endhighlight %}
139
+
## Modules and Helpers
196
140
197
-
Such Cest file can be created by running a generator:
141
+
The actions in Actor classes are taken from modules. Generated Actor classes emulate multiple inheritance. Modules are designed to have one action performed with one method. According to the [DRY principle](http://en.wikipedia.org/wiki/Don%27t_repeat_yourself), if you use the same scenario components in different modules, you can combine them and move them to a custom module. By default each suite has an empty module, which can be used to extend Actor classes. They are stored in the __support__ directory.
Each suite has its own bootstrap file. It's located in the suite directory and is named `_bootstrap.php`. It will be executed before test suite. There is also a global bootstrap file located in the `tests` directory. It can be used to include additional files.
202
146
203
-
{% endhighlight %}
147
+
## Test Formats
204
148
205
-
Learn more about [Cest format](http://codeception.com/docs/07-AdvancedUsage#Cest-Classes) in Advanced Testing section.
149
+
Codeception supports three test formats. Beside the previously described scenario-based Cept format, Codeception can also execute [PHPUnit test files for unit testing](http://codeception.com/docs/06-UnitTests), and [class-based Cest](http://codeception.com/docs/07-AdvancedUsage#Cest-Classes)format. They are covered in later chapters. There is no difference in the way the tests of either format will be run in the suite.
206
150
207
151
## Configuration
208
152
209
153
Codeception has a global configuration in `codeception.yml` and a config for each suite. We also support `.dist` configuration files. If you have several developers in a project, put shared settings into `codeception.dist.yml` and personal settings into `codeception.yml`. The same goes for suite configs. For example, the `unit.suite.yml` will be merged with `unit.suite.dist.yml`.
210
154
155
+
211
156
## Running Tests
212
157
213
158
Tests can be started with the `run` command.
@@ -306,5 +251,5 @@ We took a look into the Codeception structure. Most of the things you need were
***Previous Chapter: [< Introduction](/docs/01-Introduction)**<p> </p><divclass="alert alert-warning">Docs are incomplete? Outdated? Or you just found a typo? <ahref="https://github.com/Codeception/Codeception/tree/2.0/docs">Help us to improve documentation. Edit it on GitHub</a></div>
0 commit comments