|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: Codeception Documentation |
| 4 | +--- |
| 5 | + |
| 6 | +# Documentation |
| 7 | + |
| 8 | +## Guides |
| 9 | + |
| 10 | +Guides will walk you though the basic concepts of testing to the full understanding knowlegde of Codeception. |
| 11 | +Everything you want to know about Codeception can be found in Guides. |
| 12 | + |
| 13 | +* [Intruduction](/docs/01-Introduction) - all about testing: acceptance, unit, and functional tests explained. |
| 14 | +* [Getting Started](/docs/02-GettingStarted) - setting up and writing a first test with Codeception |
| 15 | +* [Modules](/docs/03-Modules) - understanding modules and helpers |
| 16 | +* [Acceptance Tests](/docs/04-AcceptanceTests) - writing Selenium and PhpBrowser accetance tests. |
| 17 | +* [Functional Tests](/docs/05-FunctionalTests) - writing functional tests for popular PHP frameworks. |
| 18 | +* [Unit Tests in Scenarios](/docs/06-UnitTestsScenarios) - unit testing in scenarios proof of concept. |
| 19 | +* [Unit Tests Practice](/docs/07-UnitTestsPractice) - practical approach to unit testing in scenario manner. |
| 20 | +* [Data](/docs/08-Data) - repopulation of database, cleaning up data, using fixtures, etc. |
| 21 | + |
| 22 | +## References |
| 23 | + |
| 24 | +References explains API of verious parts of Codeception. Look for them if you forgot something. |
| 25 | + |
| 26 | +* [Commands](/docs/reference/commands) - explains usage of Codecption console utility. |
| 27 | +* Configuration - explains basics of suites configuration. |
| 28 | +* [Xml Builder](/docs/reference/xmlbuilder) - building XMLs pragmatically. |
| 29 | +* [Stubs](/docs/reference/stubs) - cool stub builder explained. |
| 30 | + |
| 31 | +## Modules |
| 32 | + |
| 33 | +Modules are used to test various parts of your application. There are plenty of those and many should arrive in a future. |
| 34 | +Choose the best module for your needs and see it's reference. |
| 35 | + |
| 36 | +### Testing Web Applications with Javascript |
| 37 | + |
| 38 | +* [Selenium](/docs/modules/Selenium) - use Selenium server to run tests in browser. |
| 39 | +* [Selenium2](/docs/modules/Selenium2) - use Selenium server to run tests in browser. |
| 40 | +* [ZombieJS](/docs/modules/ZombieJS) - use Zombie.js backend to run tests without browser. |
| 41 | + |
| 42 | +### Testing Web Applications without Javascript |
| 43 | + |
| 44 | +* [PhpBrowser](/docs/modules/PhpBrowser) - emulates browser usage by fetching and parsing html pages. |
| 45 | + |
| 46 | +### Testing Inside PHP Frameworks |
| 47 | + |
| 48 | +* [Symfony2](/docs/modules/Symfony2) - wraper for [Symfony2](http://symfony.com) functional tests. |
| 49 | +* [Zend Framework](/docs/modules/Zend) - wraper for [ZF](http://framework.zend.com) functional test. |
| 50 | +* [symfony](/docs/modules/symfony) - wraper for [symfony 1.x](http://symfony-project.org) functional test |
| 51 | +* [Kohana](/docs/modules/Kohana) |
| 52 | +* [Social Engine](/docs/module/SocialEngine) - ZF module adopted for SE |
| 53 | + |
| 54 | +### Unit Testing |
| 55 | + |
| 56 | +Basically you could use PHPUnit tests for unit testing. But Codeception scenario-driven unit tests are much powerful ) |
| 57 | + |
| 58 | +* [Unit](/docs/modules/unit) - everything for unit testing. |
| 59 | + |
| 60 | +### API Testing |
| 61 | + |
| 62 | +* [REST](/docs/modules/REST) - testing REST Web services (can be tested inside framework) |
| 63 | +* [SOAP](/docs/modules/SOAP) - testing SOAP WSDL web-services (can be tested inside framework) |
| 64 | + |
| 65 | +### Database Testing |
| 66 | + |
| 67 | +* [Db](/docs/modules/Db) - use to test changes in database |
| 68 | +* [Doctrine2](/docs/modules/doctrine2) - test database managed by [Doctrine2](http://www.doctrine-project.org/) ORM |
| 69 | +* [Doctrine](docs/modules/doctrine) - test database managed by [Doctrine](http://www.doctrine-project.org/) 1.x ORM |
| 70 | + |
0 commit comments