| CARVIEW |
Guides
- Introduction
- Getting Started
- Acceptance Tests
- Functional Tests
- Unit Tests
- Debugging
- Modules And Helpers
- Reusing Test Code
- Advanced Usage
- BDD
- Customization
- Data
- API Testing
- Codecoverage
- Reporting
- Continuous Integration
- Parallel Execution
Testomatio - Test Management for Codeception
Search
Db
Installation
composer require --dev codeception/module-dbDescription
Access a database.
The most important function of this module is to clean a database before each test. This module also provides actions to perform checks in a database, e.g. seeInDatabase()
In order to have your database populated with data you need a raw SQL dump.
Simply put the dump in the tests/Support/Data directory (by default) and specify the path in the config.
The next time after the database is cleared, all your data will be restored from the dump.
Don’t forget to include CREATE TABLE statements in the dump.
Supported and tested databases are:
- MySQL
- SQLite (i.e. just one file)
- PostgreSQL
Also available:
- MS SQL
- Oracle
Connection is done by database drivers, which are stored in the Codeception\Lib\Driver namespace.
Check out the drivers if you run into problems loading dumps and cleaning databases.
Example Functional.suite.yml
modules:
enabled:
- Db:
dsn: 'mysql:host=localhost;dbname=testdb'
user: 'root'
password: ''
dump: 'tests/Support/Data/dump.sql'
populate: true # whether the dump should be loaded before the test suite is started
cleanup: true # whether the dump should be reloaded before each test
reconnect: true # whether the module should reconnect to the database before each test
waitlock: 10 # wait lock (in seconds) that the database session should use for DDL statements
databases: # include more database configs and switch between them in tests.
skip_cleanup_if_failed: true # Do not perform the cleanup if the tests failed. If this is used, manual cleanup might be required when re-running
ssl_key: '/path/to/client-key.pem' # path to the SSL key (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-key)
ssl_cert: '/path/to/client-cert.pem' # path to the SSL certificate (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert)
ssl_ca: '/path/to/ca-cert.pem' # path to the SSL certificate authority (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca)
ssl_verify_server_cert: false # disables certificate CN verification (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php)
ssl_cipher: 'AES256-SHA' # list of one or more permissible ciphers to use for SSL encryption (MySQL specific, see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher)
initial_queries: # list of queries to be executed right after connection to the database has been initiated, i.e. creating the database if it does not exist or preparing the database collation
- 'CREATE DATABASE IF NOT EXISTS temp_db;'
- 'USE temp_db;'
- 'SET NAMES utf8;'Example with multi-dumps
modules:
enabled:
- Db:
dsn: 'mysql:host=localhost;dbname=testdb'
user: 'root'
password: ''
dump:
- 'tests/Support/Data/dump.sql'
- 'tests/Support/Data/dump-2.sql'Example with multi-databases
modules:
enabled:
- Db:
dsn: 'mysql:host=localhost;dbname=testdb'
user: 'root'
password: ''
databases:
db2:
dsn: 'mysql:host=localhost;dbname=testdb2'
user: 'userdb2'
password: ''Example with SQLite
modules:
enabled:
- Db:
dsn: 'sqlite:relative/path/to/sqlite-database.db'
user: ''
password: ''SQL data dump
There are two ways of loading the dump into your database:
Populator
The recommended approach is to configure a populator, an external command to load a dump. Command parameters like host, username, password, database
can be obtained from the config and inserted into placeholders:
For MySQL:
modules:
enabled:
- Db:
dsn: 'mysql:host=localhost;dbname=testdb'
user: 'root'
password: ''
dump: 'tests/Support/Data/dump.sql'
populate: true # run populator before all tests
cleanup: true # run populator before each test
populator: 'mysql -u $user -h $host $dbname < $dump'For PostgreSQL (using pg_restore)
modules:
enabled:
- Db:
dsn: 'pgsql:host=localhost;dbname=testdb'
user: 'root'
password: ''
dump: 'tests/Support/Data/db_backup.dump'
populate: true # run populator before all tests
cleanup: true # run populator before each test
populator: 'pg_restore -u $user -h $host -D $dbname < $dump'Variable names are being taken from config and DSN which has a keyword=value format, so you should expect to have a variable named as the
keyword with the full value inside it.
PDO dsn elements for the supported drivers:
- MySQL: PDO_MYSQL DSN
- SQLite: PDO_SQLITE DSN - use relative path from the project root
- PostgreSQL: PDO_PGSQL DSN
- MSSQL: PDO_SQLSRV DSN
- Oracle: PDO_OCI DSN
Dump
Db module by itself can load SQL dump without external tools by using current database connection. This approach is system-independent, however, it is slower than using a populator and may have parsing issues (see below).
Provide a path to SQL file in dump config option:
modules:
enabled:
- Db:
dsn: 'mysql:host=localhost;dbname=testdb'
user: 'root'
password: ''
populate: true # load dump before all tests
cleanup: true # load dump for each test
dump: 'tests/_data/dump.sql'To parse SQL Db file, it should follow this specification:
- Comments are permitted.
- The
dump.sqlmay contain multiline statements. - The delimiter, a semi-colon in this case, must be on the same line as the last statement:
-- Add a few contacts to the table.
REPLACE INTO `Contacts` (`created`, `modified`, `status`, `contact`, `first`, `last`) VALUES
(NOW(), NOW(), 1, 'Bob Ross', 'Bob', 'Ross'),
(NOW(), NOW(), 1, 'Fred Flintstone', 'Fred', 'Flintstone');
-- Remove existing orders for testing.
DELETE FROM `Order`;Query generation
seeInDatabase, dontSeeInDatabase, seeNumRecords, grabFromDatabase and grabNumRecords methods
accept arrays as criteria. WHERE condition is generated using item key as a field name and
item value as a field value.
Example:
<?php
$I->seeInDatabase('users', ['name' => 'Davert', 'email' => '[email protected]']);Will generate:
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = '[email protected]'Since version 2.1.9 it’s possible to use LIKE in a condition, as shown here:
<?php
$I->seeInDatabase('users', ['name' => 'Davert', 'email like' => 'davert%']);Will generate:
SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` LIKE 'davert%'Null comparisons are also available, as shown here:
<?php
$I->seeInDatabase('users', ['name' => null, 'email !=' => null]);Will generate:
SELECT COUNT(*) FROM `users` WHERE `name` IS NULL AND `email` IS NOT NULLPublic Properties
- dbh - contains the PDO connection
- driver - contains the Connection Driver
Actions
amConnectedToDatabase
param string$databaseKeythrows ModuleConfigExceptionreturn void
Make sure you are connected to the right database.
<?php
$I->seeNumRecords(2, 'users'); //executed on default database
$I->amConnectedToDatabase('db_books');
$I->seeNumRecords(30, 'books'); //executed on db_books database
//All the next queries will be on db_booksdontSeeInDatabase
param string$tableparam array$criteriareturn void
Effect is opposite to ->seeInDatabase
Asserts that there is no record with the given column values in a database. Provide table name and column values.
<?php
$I->dontSeeInDatabase('users', ['name' => 'Davert', 'email' => '[email protected]']);Fails if such user was found.
Comparison expressions can be used as well:
<?php
$I->dontSeeInDatabase('posts', ['num_comments >=' => '0']);
$I->dontSeeInDatabase('users', ['email like' => 'miles%']);Supported operators: <, >, >=, <=, !=, like.
grabColumnFromDatabase
param string$tableparam string$columnparam array$criteriareturn array
Fetches all values from the column in database.
Provide table name, desired column and criteria.
<?php
$mails = $I->grabColumnFromDatabase('users', 'email', ['name' => 'RebOOter']);grabEntriesFromDatabase
param string$tableparam array$criteriathrows PDOException|Exceptionreturn array<array<string,mixed» Returns an array of all matched rows
Fetches a set of entries from a database.
Provide table name and criteria.
<?php
$mail = $I->grabEntriesFromDatabase('users', ['name' => 'Davert']);Comparison expressions can be used as well:
<?php
$post = $I->grabEntriesFromDatabase('posts', ['num_comments >=' => 100]);
$user = $I->grabEntriesFromDatabase('users', ['email like' => 'miles%']);Supported operators: <, >, >=, <=, !=, like.
grabEntryFromDatabase
param string$tableparam array$criteriathrows PDOException|Exceptionreturn arrayReturns a single entry value
Fetches a whole entry from a database.
Make the test fail if the entry is not found. Provide table name, desired column and criteria.
<?php
$mail = $I->grabEntryFromDatabase('users', ['name' => 'Davert']);Comparison expressions can be used as well:
<?php
$post = $I->grabEntryFromDatabase('posts', ['num_comments >=' => 100]);
$user = $I->grabEntryFromDatabase('users', ['email like' => 'miles%']);Supported operators: <, >, >=, <=, !=, like.
grabFromDatabase
param string$tableparam string$columnparam array$criteriareturn mixedReturns a single column value or false
Fetches a single column value from a database.
Provide table name, desired column and criteria.
<?php
$mail = $I->grabFromDatabase('users', 'email', ['name' => 'Davert']);Comparison expressions can be used as well:
<?php
$postNum = $I->grabFromDatabase('posts', 'num_comments', ['num_comments >=' => 100]);
$mail = $I->grabFromDatabase('users', 'email', ['email like' => 'miles%']);Supported operators: <, >, >=, <=, !=, like.
grabNumRecords
param string$table Table nameparam array$criteria Search criteria [Optional]return int
Returns the number of rows in a database
haveInDatabase
param string$tableparam array$datareturn int
Inserts an SQL record into a database. This record will be erased after the test, unless you’ve configured “skip_cleanup_if_failed”, and the test fails.
<?php
$I->haveInDatabase('users', ['name' => 'miles', 'email' => '[email protected]']);performInDatabase
param$databaseKeyparam ActionSequence|array|callable$actionsthrows ModuleConfigExceptionreturn void
Can be used with a callback if you don’t want to change the current database in your test.
<?php
$I->seeNumRecords(2, 'users'); //executed on default database
$I->performInDatabase('db_books', function($I) {
$I->seeNumRecords(30, 'books'); //executed on db_books database
});
$I->seeNumRecords(2, 'users'); //executed on default databaseList of actions can be pragmatically built using Codeception\Util\ActionSequence:
<?php
$I->performInDatabase('db_books', ActionSequence::build()
->seeNumRecords(30, 'books')
);Alternatively an array can be used:
$I->performInDatabase('db_books', ['seeNumRecords' => [30, 'books']]);Choose the syntax you like the most and use it,
Actions executed from array or ActionSequence will print debug output for actions, and adds an action name to exception on failure.
seeInDatabase
param string$tableparam array$criteriareturn void
Asserts that a row with the given column values exists.
Provide table name and column values.
<?php
$I->seeInDatabase('users', ['name' => 'Davert', 'email' => '[email protected]']);Fails if no such user found.
Comparison expressions can be used as well:
<?php
$I->seeInDatabase('posts', ['num_comments >=' => '0']);
$I->seeInDatabase('users', ['email like' => '[email protected]']);Supported operators: <, >, >=, <=, !=, like.
seeNumRecords
param int$expectedNumber Expected numberparam string$table Table nameparam array$criteria Search criteria [Optional]return void
Asserts that the given number of records were found in the database.
<?php
$I->seeNumRecords(1, 'users', ['name' => 'davert'])updateInDatabase
param string$tableparam array$dataparam array$criteriareturn void
Update an SQL record into a database.
<?php
$I->updateInDatabase('users', ['isAdmin' => true], ['email' => '[email protected]']);
Codeception_
Codeception is a BDD-styled PHP testing framework, brought to you by Codeception Team. OpenSource MIT Licensed.
additional_thanks_to_
