Install latest stable Codeception and required modules via Composer:
composer require codeception/codeception codeception/module-laravel codeception/module-rest codeception/module-webdriver codeception/module-asserts --dev
It is easy to setup tests by running bootstrap command:
php vendor/bin/codecept bootstrap
This will create
tests directory and configuration file
codeception.yml. This also prepares 3 suites for testing: acceptance, functional, and unit. You will also need to prepare .env file for testing environment:
cp .env .env.testing
Functional tests allow test application by simulating user actions, this is done by sending requests to framework kernel and checking HTML as a result. Unilke internal tests of Laravel, Codeception doesn’t limit you to testing only one request per test. You can test complex interactions involving different actions and controllers. This way you can easily cover your specifictions with functional tests.
To start you need to configure
tests/functional.suite.yml to use Laravel module:
class_name: FunctionalTester modules: enabled: - Laravel: environment_file: .env.testing - \AppBundle\Helper\Functional
Codeception will also use Eloquent to cleanup changes to database by wrapping tests into transaction and rolling it back in the end of a test. This makes tests isolated and fast. Laravel module allows to access services from DIC container, user authentication methods, fixture generators, check form validations and more.
To create first functional test for
Login you should run:
php vendor/bin/codecept g:cest functional Login
To generate a unit test run:
php vendor/bin/codecept g:test unit "Foo\Bar"
Codeception\Test\Unit testcase which is inherited from PHPUnit but provides a module access.
Enable Laravel module in
unit.suite.yml to have its methods inside a testcase. They are available injected into
$this->tester property of a testcase.
To test an application in a real environment by using its UI you should use a real browser. Codeception uses Selenium Webdriver and corresponding WebDriver module to interact with a browser. You should configure
acceptance.suite.yml to use WebDriver module and a browser of your choice.
class_name: AcceptanceTester modules: enabled: - WebDriver: url: 'https://localhost/' # put your local url browser: firefox - \Helper\Acceptance
Browser can be specified as
chrome, or others.
Acceptance tests will be executed in development environment using real web server, so settings from
.env.testing can’t be passed to them.
You can also use Eloquent to create data for acceptance tests. This way you can use data factories and models to prepare and cleanup data for tests. You should enable Laravel module with ORM part to add ActiveRecord methods:
class_name: AcceptanceTester modules: enabled: - WebDriver: url: 'https://localhost/' # put your local url browser: firefox - Laravel: part: ORM cleanup: false # can't wrap into transaction - \Helper\Acceptance
Laravel module won’t be able to wrap test execution in a transaction but methods like
haveModel will delete objects they created when test ends.
API Tests are done at functional testing level but instead of testing HTML responses on user actions, they test requests and responses via protocols like REST or SOAP. To create api tests you should create a suite for them
php vendor/bin/codecept g:suite api
You will need to enable
Laravel module in
class_name: ApiTester modules: enabled: - REST: url: /api/v1 depends: Laravel - \Helper\Api config: - Laravel: environment_file: .env.testing
Laravel module actions like
see should not be available for testing API. This why Laravel module is not enabled but declared with
depends for REST module. Laravel should use testing environment which is specified in
If you prefer to describe application with feature files, Codeception can turn them to acceptance or functional tests. It is recommended to store feature files in
features directory (like it does Behat) but symlinking it to
tests/functional/features so they can be treated as tests too. For using BDD with acceptance tests you need to run:
ln -s $PWD/features tests/acceptance
Codeception allows to combine tests written in different formats. If are about to wirite a regression test it probably should not be described as a product’s feature. That’s why feature-files is subset of all acceptance tests, and they are stored in subfolder of
There is no standard Gherkin steps built in. By writing your feature files you can get code snippets which should be added to
php vendor/bin/codecept gherkin:snippets
In the same manner features can be set up as functional tests.