codeception/codeception 4.1.21

Codeception is a full-stack testing framework for PHP. Influenced by Behavior-Driven Development (BDD), it offers a unique approach to writing various types of tests, including acceptance, functional, and unit tests. Codeception is designed to describe what is being tested and how it is being tested, enabling developers to write test descriptions efficiently using PHP. The results of those tests are easily observable, indicating what actions were taken and their outcomes.

Using Codeception is straightforward. To get started, you must first install the package using Composer as follows:

php composer.phar require "codeception/codeception"

The libraries required for specific features of Codeception must also be installed. For instance, to use the PhpBrowser module:

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

Once installed, Codeception can be incorporated into your project via its Phar file, which can be downloaded from the official Codeception website. Here's how you can make Codeception executable and move it into your $PATH:

wget https://codeception.com/codecept.phar
chmod +x codecept.phar
sudo mv codecept.phar /usr/local/bin/codecept

After that, you can initialize default settings and suites with:

codecept bootstrap

An example of how you may write a test using Codeception is:

$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

You can find comprehensive Codeception documentation at https://codeception.com/docs/Introduction. Additionally, the documentation source files are available in the repository https://github.com/Codeception/codeception.github.com/tree/master/docs/. Through these resources, users can dive into a more detailed understanding of how Codeception functions, its use cases, and how to effectively implement it in their projects.