README

Codeception

Modern PHP Testing for everyone

Codeception is a modern full-stack testing framework for PHP.Inspired by BDD, it provides an absolutely new way of writing acceptance, functional and even unit tests.

Contributions

At Codeception we are glad to receive contributions from the community. If you want to send additions or fixes to the code or the documentation please check theContributing guide.

At a Glance

Describe what you test and how you test it. Use PHP to write descriptions faster.

Run tests and see what actions were taken and what results were seen.

Sample test

$I->amOnPage('/');$I->click('Pages');$I->click('New');$I->see('New Page');$I->submitForm('form#new_page', ['title' =>'Movie Review']);$I->see('page created');// notice generated$I->see('Movie Review','h1');// head of page of is our title$I->seeInCurrentUrl('pages/movie-review');// slug is generated$I->seeInDatabase('pages', ['title' =>'Movie Review']);// data is stored in database

For unit testing you can stay on classic PHPUnit tests, as Codeception can run them too.

Installation

Composer

php composer.phar require "codeception/codeception"

TODO: Document how to install the modules, e.g.

php composer.phar require "codeception/module-phpbrowser"

Phar

Downloadcodecept.phar

Copy it into your project.

You can also make Codeception an executable and it put it into your$PATH, for instance:

wget https://codeception.com/codecept.pharchmod +x codecept.pharsudo mv codecept.phar /usr/local/bin/codecept

You can then run Codecept in the command line using:codecept bootstrap,codecept run, etc

Run CLI utility:

php codecept.phar

See alsoInstallation |QuickStart

Getting Started

After you successfully installed Codeception, run this command:

codecept bootstrap

This will create a default directory structure and default test suites.

Documentation

View Documentation

The documentation source files can be found athttps://github.com/Codeception/codeception.github.com/tree/master/docs/.

License

MIT