codeception/codeception repository overview

⁠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 the Contributing 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.

⁠Getting Started

Initialize configuration files and default directory structure by running

docker container run --rm -v $(pwd):/project/ --user $(id -u):$(id -g) codeception/codeception:latest bootstrap

Then generate your first test file

docker container run --rm -v $(pwd):/project/  --user $(id -u):$(id -g) codeception/codeception:latest generate:cest Func
tional First

Add some actions to tests/Functional/FirstCest.php and run your tests:

docker container run --rm -v $(pwd):/project/  --user $(id -u):$(id -g) codeception/codeception:latest run

⁠Documentation

View Documentation⁠

⁠License

MIT

(c) Codeception Team⁠ 2011-2022