Skip to content

Dbh.md

Latest commit

 

History

History
136 lines (76 loc) · 3.69 KB

Dbh.md

File metadata and controls

136 lines (76 loc) · 3.69 KB
layout doc
title Dbh - Codeception - Documentation

This module replaces Db module for functional and unit testing, and requires PDO instance to be set. By default it will cover all database queries into transaction and rollback it afterwards. The database should support nested transactions, in order to make cleanup work as expected.

Pass PDO instance to this module from within your bootstrap file.

In _bootstrap.php:

{% highlight php %}

{% endhighlight %}

This will make all queries in this connection run withing transaction and rolled back afterwards.

Note, that you can't use this module with MySQL. Or perhaps you don't use transactions in your project, then it's ok. Otherwise consider using ORMs like Doctrine, that emulate nested transactions, or switch to Db module.

Status

This module despite of it's stability may act unstable because of transactions issue. If test fails with fatal error and transaction is not finished, it may affect other transactions.

Please review the code of non-stable modules and provide patches if you have issues.

Configuration

  • cleanup: true - enable cleanups by covering all queries inside transaction.

Example

modules:
   enabled: [Dbh]
   config:
      Dbh:
         cleanup: false

dontSeeInDatabase

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.

Example:

{% highlight php %}

dontSeeInDatabase('users', array('name' => 'Davert', 'email' => 'davert * `mail.com'));` {% endhighlight %} Will generate: {% highlight sql %} SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert * `mail.com'` {% endhighlight %} Fails if such user was found. * `param` $table * `param array` $criteria #### grabFromDatabase Fetches a single column value from a database. Provide table name, desired column and criteria. Example: {% highlight php %} grabFromDatabase('users', 'email', array('name' => 'Davert')); {% endhighlight %} * `Available since` 1.1 * `param` $table * `param` $column * `param array` $criteria #### seeInDatabase Asserts that a row with the given column values exists. Provide table name and column values. Example: {% highlight php %} seeInDatabase('users', array('name' => 'Davert', 'email' => 'davert * `mail.com'));` {% endhighlight %} Will generate: {% highlight sql %} SELECT COUNT(*) FROM `users` WHERE `name` = 'Davert' AND `email` = 'davert * `mail.com'` {% endhighlight %} Fails if no such user found. * `param` $table * `param array` $criteria

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference