How To Start With Codeception PHP Framework And Selenium
Recently I have been working on one job interview with test case requiring to write portion of automatized tests in Codeception PHP framework. Since I didn’t have any experience with Codeception PHP framework I needed to learn quickly as much as I could.
This is a small guide explaining how to start with Codeception PHP test framework and how to integrate it with Selenium for automated tests.
What is Codeception and what is good for?
Codeception is PHP framework devoted to test PHP code. Installation is very simple and requires only a few steps. It is actually well known for its easy code readability of test units. Codeception PHP framework is used for acceptance testing. Codeception emphasize usage of the variable name $I, so than many lines of code are very descriptive exp. $I want to do this and that, $I expect to see something. etc.
Codeception helps with creating test suites for 3 types of testing:
What is acceptance testing?
Acceptance tests are emulating behavior of a real user visiting website.
Acceptance testing is formal testing with respect to user needs, requirements, and business processes conducted to determine whether a system satisfies the acceptance criteria and to enable the user, customers or other authorized entity to determine whether or not to accept the system. Acceptance testing is also known as user acceptance testing (UAT), end-user testing, operational acceptance testing or field (acceptance) testing.
First of all I have to recommend to watch first video by Jeffrey Way from EnvatoTuts+ for Codeception series Modern Testing in PHP with Codeception. Although the first video is very well narrated and instructive for beginner, rest of the serie is not and I would not recommend to pay for premium account to watch the rest. Jeffrey expect knowledge of many related topics where you can use Codeception (DB connection, Laravel, …) but do not create simple code snippets for your first test and does not talk much about usage of elemental Codeception functions. Serie is aimed for advanced users.
You can download Codeception framework out of the box via composer by CLI command
$ composer require "codeception/codeception" .
You can also implement it into already existing project updating a composer.json file placing following:
For newest version of Codeception please visit and search packagist.org . Over CLI just hit composer command in folder of your project:
composer update (or
2. Create codeception.yml
codecept bootstrap Codeception creates the codeception.yml file and bunch of new files for test suites.
What is test suite?
The test suite is a collection of test cases that are intended to be used to test a software program to show that it has some specified set of behaviours. A test suite often contains detailed instructions or goals for each collection of test cases and information on the system configuration to be used during testing. A group of test cases may also contain prerequisite states or steps, and descriptions of the following tests.
Collections of test cases are sometimes incorrectly termed a test plan, a test script, or even a test scenario.
3. Create your first test
Create your first test by Codeception command:
codecept generate:cept acceptance FirstTest
Note: Codeception scenario tests are called Cepts.
4. Setting Acceptance test method
Basically there are 2 method which I managed to try to in short time – PHP Browser and Selenium WebDriver:
- PHP Browser – works on idea of web scrapper. Code does not emulate real browser but just download HTML code and apply test scenarios on it.
- Selenium WebDriver – works as “artificial user”. PHP test case code emulate real browser and perform actions upon real website in browser.
4.1. PHP Browser
For setting up PHP Browser just change acceptance.suite.yml to:
4.2. Selenium WebDriver
For setting Selenium WebDriver you need to make 3 steps.
1) Change acceptance.suite.yml to:
2) In your .bash_profile you must also set GeckoDriver (drivers emulating Firefox) which you can download from mozilla/geckodriver GitHub page.
## Selenium GeckoDriver
3) To set Selenium WebDriver is also necessary download Selenium Server and run it prior the test. To run Selenium Server change directory to folder where is file located and type server run command
java -jar selenium-server-standalone-YOUR.V.NO.jar .
5 .Writing first PHP test
Under acceptance folder we will create first test in FirstTest.php file. We will try to check “Hello World!” text at homepage:
$I = new AcceptanceTester($scenario);
$I->see('Hello World!', 'h1');
6. Running the test
Running the test case is possible by simple command
codecept run . You will write this command often so you can create temporary (alias in your folder) or permanent alias (in .bash_profile) by creating alias exp.
alias runtest=vendor/bin/codecept run and than just type your alias.
If you have done everything right, with Selenium you should new see Firefox window executing your first test. After finishing it, browser will close down and terminal shows announcement about Success. PHP Webdriver execute all test just over the terminal info panel.
6.1 Further use
To show the list of all available commands you need to type
vendor/bin/codecept . It will also handy to create alias for it ( but just for
vendor/bin/ and than type
Codecept will always by run execute every single test you have wrote all together. It helps to nerrow down only the test suite which we want by selecting test suit in command:
codecept acceptance/functional/unit run .