TestDatabaseTest.php

Same filename in other branches
  1. 8.9.x core/tests/Drupal/Tests/Core/Test/TestDatabaseTest.php
  2. 10 core/tests/Drupal/Tests/Core/Test/TestDatabaseTest.php
  3. 11.x core/tests/Drupal/Tests/Core/Test/TestDatabaseTest.php

Namespace

Drupal\Tests\Core\Test

File

core/tests/Drupal/Tests/Core/Test/TestDatabaseTest.php

View source
<?php

namespace Drupal\Tests\Core\Test;

use Drupal\Core\Test\TestDatabase;
use Drupal\Tests\UnitTestCase;

/**
 * @coversDefaultClass \Drupal\Core\Test\TestDatabase
 *
 * @group Test
 * @group simpletest
 * @group Template
 */
class TestDatabaseTest extends UnitTestCase {
    
    /**
     * @covers ::__construct
     */
    public function testConstructorException() {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage("Invalid database prefix: blah1253");
        new TestDatabase('blah1253');
    }
    
    /**
     * @covers ::__construct
     * @covers ::getDatabasePrefix
     * @covers ::getTestSitePath
     *
     * @dataProvider providerTestConstructor
     */
    public function testConstructor($db_prefix, $expected_db_prefix, $expected_site_path) {
        $test_db = new TestDatabase($db_prefix);
        $this->assertEquals($expected_db_prefix, $test_db->getDatabasePrefix());
        $this->assertEquals($expected_site_path, $test_db->getTestSitePath());
    }
    
    /**
     * Data provider for self::testConstructor()
     */
    public function providerTestConstructor() {
        return [
            [
                'test1234',
                'test1234',
                'sites/simpletest/1234',
            ],
            [
                'test123456test234567',
                'test123456test234567',
                'sites/simpletest/234567',
            ],
        ];
    }
    
    /**
     * Verify that a test lock is generated if there is no provided prefix.
     *
     * @covers ::__construct
     */
    public function testConstructorNullPrefix() {
        // We use a stub class here because we can't mock getTestLock() so that it's
        // available before the constructor is called.
        $test_db = new TestTestDatabase(NULL);
        $this->assertEquals('test23', $test_db->getDatabasePrefix());
        $this->assertEquals('sites/simpletest/23', $test_db->getTestSitePath());
    }

}

/**
 * Stub class supports TestDatabaseTest::testConstructorNullPrefix().
 */
class TestTestDatabase extends TestDatabase {
    protected function getTestLock($create_lock = FALSE) {
        return 23;
    }

}

Classes

Title Deprecated Summary
TestDatabaseTest @coversDefaultClass \Drupal\Core\Test\TestDatabase
TestTestDatabase Stub class supports TestDatabaseTest::testConstructorNullPrefix().

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.