Initial
This commit is contained in:
Markus
326
system/Test/DatabaseTestTrait.php
Normal file
326
system/Test/DatabaseTestTrait.php
Normal file
@@ -0,0 +1,326 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Test;
|
||||
|
||||
use CodeIgniter\Database\BaseBuilder;
|
||||
use CodeIgniter\Database\Exceptions\DatabaseException;
|
||||
use CodeIgniter\Test\Constraints\SeeInDatabase;
|
||||
use Config\Database;
|
||||
use Config\Migrations;
|
||||
use Config\Services;
|
||||
|
||||
/**
|
||||
* DatabaseTestTrait
|
||||
*
|
||||
* Provides functionality for refreshing/seeding
|
||||
* the database during testing.
|
||||
*
|
||||
* @mixin CIUnitTestCase
|
||||
*/
|
||||
trait DatabaseTestTrait
|
||||
{
|
||||
/**
|
||||
* Is db migration done once or more than once?
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
private static $doneMigration = false;
|
||||
|
||||
/**
|
||||
* Is seeding done once or more than once?
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
private static $doneSeed = false;
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
// Staging
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Runs the trait set up methods.
|
||||
*/
|
||||
protected function setUpDatabase()
|
||||
{
|
||||
$this->loadDependencies();
|
||||
$this->setUpMigrate();
|
||||
$this->setUpSeed();
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs the trait set up methods.
|
||||
*/
|
||||
protected function tearDownDatabase()
|
||||
{
|
||||
$this->clearInsertCache();
|
||||
}
|
||||
|
||||
/**
|
||||
* Load any database test dependencies.
|
||||
*/
|
||||
public function loadDependencies()
|
||||
{
|
||||
if ($this->db === null) {
|
||||
$this->db = Database::connect($this->DBGroup);
|
||||
$this->db->initialize();
|
||||
}
|
||||
|
||||
if ($this->migrations === null) {
|
||||
// Ensure that we can run migrations
|
||||
$config = new Migrations();
|
||||
$config->enabled = true;
|
||||
|
||||
$this->migrations = Services::migrations($config, $this->db);
|
||||
$this->migrations->setSilent(false);
|
||||
}
|
||||
|
||||
if ($this->seeder === null) {
|
||||
$this->seeder = Database::seeder($this->DBGroup);
|
||||
$this->seeder->setSilent(true);
|
||||
}
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
// Migrations
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Migrate on setUp
|
||||
*/
|
||||
protected function setUpMigrate()
|
||||
{
|
||||
if ($this->migrateOnce === false || self::$doneMigration === false) {
|
||||
if ($this->refresh === true) {
|
||||
$this->regressDatabase();
|
||||
|
||||
// Reset counts on faked items
|
||||
Fabricator::resetCounts();
|
||||
}
|
||||
|
||||
$this->migrateDatabase();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Regress migrations as defined by the class
|
||||
*/
|
||||
protected function regressDatabase()
|
||||
{
|
||||
if ($this->migrate === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If no namespace was specified then rollback all
|
||||
if (empty($this->namespace)) {
|
||||
$this->migrations->setNamespace(null);
|
||||
$this->migrations->regress(0, 'tests');
|
||||
}
|
||||
|
||||
// Regress each specified namespace
|
||||
else {
|
||||
$namespaces = is_array($this->namespace) ? $this->namespace : [$this->namespace];
|
||||
|
||||
foreach ($namespaces as $namespace) {
|
||||
$this->migrations->setNamespace($namespace);
|
||||
$this->migrations->regress(0, 'tests');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Run migrations as defined by the class
|
||||
*/
|
||||
protected function migrateDatabase()
|
||||
{
|
||||
if ($this->migrate === false) {
|
||||
return;
|
||||
}
|
||||
|
||||
// If no namespace was specified then migrate all
|
||||
if (empty($this->namespace)) {
|
||||
$this->migrations->setNamespace(null);
|
||||
$this->migrations->latest('tests');
|
||||
self::$doneMigration = true;
|
||||
}
|
||||
// Run migrations for each specified namespace
|
||||
else {
|
||||
$namespaces = is_array($this->namespace) ? $this->namespace : [$this->namespace];
|
||||
|
||||
foreach ($namespaces as $namespace) {
|
||||
$this->migrations->setNamespace($namespace);
|
||||
$this->migrations->latest('tests');
|
||||
self::$doneMigration = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
// Seeds
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Seed on setUp
|
||||
*/
|
||||
protected function setUpSeed()
|
||||
{
|
||||
if ($this->seedOnce === false || self::$doneSeed === false) {
|
||||
$this->runSeeds();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Run seeds as defined by the class
|
||||
*/
|
||||
protected function runSeeds()
|
||||
{
|
||||
if (! empty($this->seed)) {
|
||||
if (! empty($this->basePath)) {
|
||||
$this->seeder->setPath(rtrim($this->basePath, '/') . '/Seeds');
|
||||
}
|
||||
|
||||
$seeds = is_array($this->seed) ? $this->seed : [$this->seed];
|
||||
|
||||
foreach ($seeds as $seed) {
|
||||
$this->seed($seed);
|
||||
}
|
||||
}
|
||||
|
||||
self::$doneSeed = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Seeds that database with a specific seeder.
|
||||
*/
|
||||
public function seed(string $name)
|
||||
{
|
||||
$this->seeder->call($name);
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
// Utility
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Reset $doneMigration and $doneSeed
|
||||
*
|
||||
* @afterClass
|
||||
*/
|
||||
public static function resetMigrationSeedCount()
|
||||
{
|
||||
self::$doneMigration = false;
|
||||
self::$doneSeed = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes any rows inserted via $this->hasInDatabase()
|
||||
*/
|
||||
protected function clearInsertCache()
|
||||
{
|
||||
foreach ($this->insertCache as $row) {
|
||||
$this->db->table($row[0])
|
||||
->where($row[1])
|
||||
->delete();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the Builder class appropriate for the current database.
|
||||
*
|
||||
* @return BaseBuilder
|
||||
*/
|
||||
public function loadBuilder(string $tableName)
|
||||
{
|
||||
$builderClass = str_replace('Connection', 'Builder', get_class($this->db));
|
||||
|
||||
return new $builderClass($tableName, $this->db);
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches a single column from a database row with criteria
|
||||
* matching $where.
|
||||
*
|
||||
* @throws DatabaseException
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function grabFromDatabase(string $table, string $column, array $where)
|
||||
{
|
||||
$query = $this->db->table($table)
|
||||
->select($column)
|
||||
->where($where)
|
||||
->get();
|
||||
|
||||
$query = $query->getRow();
|
||||
|
||||
return $query->{$column} ?? false;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
// Assertions
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Asserts that records that match the conditions in $where DO
|
||||
* exist in the database.
|
||||
*
|
||||
* @throws DatabaseException
|
||||
*/
|
||||
public function seeInDatabase(string $table, array $where)
|
||||
{
|
||||
$constraint = new SeeInDatabase($this->db, $where);
|
||||
static::assertThat($table, $constraint);
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that records that match the conditions in $where do
|
||||
* not exist in the database.
|
||||
*/
|
||||
public function dontSeeInDatabase(string $table, array $where)
|
||||
{
|
||||
$count = $this->db->table($table)
|
||||
->where($where)
|
||||
->countAllResults();
|
||||
|
||||
$this->assertTrue($count === 0, 'Row was found in database');
|
||||
}
|
||||
|
||||
/**
|
||||
* Inserts a row into to the database. This row will be removed
|
||||
* after the test has run.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function hasInDatabase(string $table, array $data)
|
||||
{
|
||||
$this->insertCache[] = [
|
||||
$table,
|
||||
$data,
|
||||
];
|
||||
|
||||
return $this->db->table($table)->insert($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that the number of rows in the database that match $where
|
||||
* is equal to $expected.
|
||||
*
|
||||
* @throws DatabaseException
|
||||
*/
|
||||
public function seeNumRecords(int $expected, string $table, array $where)
|
||||
{
|
||||
$count = $this->db->table($table)
|
||||
->where($where)
|
||||
->countAllResults();
|
||||
|
||||
$this->assertEquals($expected, $count, 'Wrong number of matching rows in database.');
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user