class LoggingTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Database/LoggingTest.php \Drupal\KernelTests\Core\Database\LoggingTest
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Database/LoggingTest.php \Drupal\KernelTests\Core\Database\LoggingTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Database/LoggingTest.php \Drupal\KernelTests\Core\Database\LoggingTest

Tests the query logging facility.

@coversDefaultClass \Drupal\Core\Database\Log

@group Database

Hierarchy

Expanded class hierarchy of LoggingTest

File

core/tests/Drupal/KernelTests/Core/Database/LoggingTest.php, line 17

Namespace

Drupal\KernelTests\Core\Database
View source
class LoggingTest extends DatabaseTestBase {
    
    /**
     * Tests that we can log the existence of a query.
     */
    public function testEnableLogging() : void {
        Database::startLog('testing');
        $start = microtime(TRUE);
        $this->connection
            ->query('SELECT [name] FROM {test} WHERE [age] > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        $this->connection
            ->query('SELECT [age] FROM {test} WHERE [name] = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        // Trigger a call that does not have file in the backtrace.
        call_user_func_array([
            Database::getConnection(),
            'query',
        ], [
            'SELECT [age] FROM {test} WHERE [name] = :name',
            [
                ':name' => 'Ringo',
            ],
        ])->fetchCol();
        $queries = Database::getLog('testing', 'default');
        $this->assertCount(3, $queries, 'Correct number of queries recorded.');
        foreach ($queries as $query) {
            $this->assertEquals(__FUNCTION__, $query['caller']['function'], 'Correct function in query log.');
            $this->assertIsFloat($query['start']);
            $this->assertGreaterThanOrEqual($start, $query['start']);
        }
    }
    
    /**
     * Tests that we can run two logs in parallel.
     */
    public function testEnableMultiLogging() : void {
        Database::startLog('testing1');
        $this->connection
            ->query('SELECT [name] FROM {test} WHERE [age] > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        Database::startLog('testing2');
        $this->connection
            ->query('SELECT [age] FROM {test} WHERE [name] = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        $queries1 = Database::getLog('testing1');
        $queries2 = Database::getLog('testing2');
        $this->assertCount(2, $queries1, 'Correct number of queries recorded for log 1.');
        $this->assertCount(1, $queries2, 'Correct number of queries recorded for log 2.');
    }
    
    /**
     * Tests logging queries against multiple targets on the same connection.
     */
    public function testEnableTargetLogging() : void {
        // Clone the primary credentials to a replica connection and to another fake
        // connection.
        $connection_info = Database::getConnectionInfo('default');
        Database::addConnectionInfo('default', 'replica', $connection_info['default']);
        Database::startLog('testing1');
        $this->connection
            ->query('SELECT [name] FROM {test} WHERE [age] > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        Database::getConnection('replica')->query('SELECT [age] FROM {test} WHERE [name] = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        $queries1 = Database::getLog('testing1');
        $this->assertCount(2, $queries1, 'Recorded queries from all targets.');
        $this->assertEquals('default', $queries1[0]['target'], 'First query used default target.');
        $this->assertEquals('replica', $queries1[1]['target'], 'Second query used replica target.');
    }
    
    /**
     * Tests that logs to separate targets use the same connection properly.
     *
     * This test is identical to the one above, except that it doesn't create
     * a fake target so the query should fall back to running on the default
     * target.
     */
    public function testEnableTargetLoggingNoTarget() : void {
        Database::startLog('testing1');
        $this->connection
            ->query('SELECT [name] FROM {test} WHERE [age] > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        // We use "fake" here as a target because any non-existent target will do.
        // However, because all of the tests in this class share a single page
        // request there is likely to be a target of "replica" from one of the other
        // unit tests, so we use a target here that we know with absolute certainty
        // does not exist.
        Database::getConnection('fake')->query('SELECT [age] FROM {test} WHERE [name] = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        $queries1 = Database::getLog('testing1');
        $this->assertCount(2, $queries1, 'Recorded queries from all targets.');
        $this->assertEquals('default', $queries1[0]['target'], 'First query used default target.');
        $this->assertEquals('default', $queries1[1]['target'], 'Second query used default target as fallback.');
    }
    
    /**
     * Tests that we can log queries separately on different connections.
     */
    public function testEnableMultiConnectionLogging() : void {
        // Clone the primary credentials to a fake connection.
        // That both connections point to the same physical database is irrelevant.
        $connection_info = Database::getConnectionInfo('default');
        Database::addConnectionInfo('test2', 'default', $connection_info['default']);
        Database::startLog('testing1');
        Database::startLog('testing1', 'test2');
        $this->connection
            ->query('SELECT [name] FROM {test} WHERE [age] > :age', [
            ':age' => 25,
        ])
            ->fetchCol();
        $old_key = Database::setActiveConnection('test2');
        Database::getConnection('replica')->query('SELECT [age] FROM {test} WHERE [name] = :name', [
            ':name' => 'Ringo',
        ])
            ->fetchCol();
        Database::setActiveConnection($old_key);
        $queries1 = Database::getLog('testing1');
        $queries2 = Database::getLog('testing1', 'test2');
        $this->assertCount(1, $queries1, 'Correct number of queries recorded for first connection.');
        $this->assertCount(1, $queries2, 'Correct number of queries recorded for second connection.');
    }
    
    /**
     * Tests that getLog with a wrong key return an empty array.
     */
    public function testGetLoggingWrongKey() : void {
        $result = Database::getLog('wrong');
        $this->assertEquals([], $result, 'The function getLog with a wrong key returns an empty array.');
    }
    
    /**
     * Tests that a log called by a custom database driver returns proper caller.
     *
     * @param string $driver_namespace
     *   The driver namespace to be tested.
     * @param string $stack
     *   A test debug_backtrace stack.
     * @param array $expected_entry
     *   The expected stack entry.
     *
     * @covers ::findCaller
     *
     * @dataProvider providerContribDriverLog
     *
     * @group legacy
     */
    public function testContribDriverLog($driver_namespace, $stack, array $expected_entry) : void {
        $this->expectDeprecation('Drupal\\Core\\Database\\Log::findCaller() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use Connection::findCallerFromDebugBacktrace(). See https://www.drupal.org/node/3328053');
        $this->expectDeprecation('Drupal\\Core\\Database\\Log::removeDatabaseEntries() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use Connection::removeDatabaseEntriesFromDebugBacktrace(). See https://www.drupal.org/node/3328053');
        $mock_builder = $this->getMockBuilder(Log::class);
        $log = $mock_builder->onlyMethods([
            'getDebugBacktrace',
        ])
            ->setConstructorArgs([
            'test',
        ])
            ->getMock();
        $log->expects($this->once())
            ->method('getDebugBacktrace')
            ->willReturn($stack);
        Database::addConnectionInfo('test', 'default', [
            'driver' => 'mysql',
            'namespace' => $driver_namespace,
        ]);
        $result = $log->findCaller($stack);
        $this->assertEquals($expected_entry, $result);
    }
    
    /**
     * Provides data for the testContribDriverLog test.
     *
     * @return array[]
     *   A associative array of simple arrays, each having the following elements:
     *   - the contrib driver PHP namespace
     *   - a test debug_backtrace stack
     *   - the stack entry expected to be returned.
     *
     * @see ::testContribDriverLog()
     */
    public static function providerContribDriverLog() {
        $stack = [
            [
                'file' => '/var/www/core/lib/Drupal/Core/Database/Log.php',
                'line' => 125,
                'function' => 'findCaller',
                'class' => 'Drupal\\Core\\Database\\Log',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => '/var/www/libraries/test/lib/Statement.php',
                'line' => 264,
                'function' => 'log',
                'class' => 'Drupal\\Core\\Database\\Log',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => '/var/www/libraries/test/lib/Connection.php',
                'line' => 213,
                'function' => 'execute',
                'class' => 'Drupal\\Driver\\Database\\dbal\\Statement',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => '/var/www/core/tests/Drupal/KernelTests/Core/Database/LoggingTest.php',
                'line' => 23,
                'function' => 'query',
                'class' => 'Drupal\\Driver\\Database\\dbal\\Connection',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => '/var/www/vendor/phpunit/phpunit/src/Framework/TestCase.php',
                'line' => 1154,
                'function' => 'testEnableLogging',
                'class' => 'Drupal\\KernelTests\\Core\\Database\\LoggingTest',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => '/var/www/vendor/phpunit/phpunit/src/Framework/TestCase.php',
                'line' => 842,
                'function' => 'runTest',
                'class' => 'PHPUnit\\Framework\\TestCase',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => '/var/www/vendor/phpunit/phpunit/src/Framework/TestResult.php',
                'line' => 693,
                'function' => 'runBare',
                'class' => 'PHPUnit\\Framework\\TestCase',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => '/var/www/vendor/phpunit/phpunit/src/Framework/TestCase.php',
                'line' => 796,
                'function' => 'run',
                'class' => 'PHPUnit\\Framework\\TestResult',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => 'Standard input code',
                'line' => 57,
                'function' => 'run',
                'class' => 'PHPUnit\\Framework\\TestCase',
                'object' => 'test',
                'type' => '->',
                'args' => [
                    0 => 'test',
                ],
            ],
            [
                'file' => 'Standard input code',
                'line' => 111,
                'function' => '__phpunit_run_isolated_test',
                'args' => [
                    0 => 'test',
                ],
            ],
        ];
        return [
            // Test that if the driver namespace is in the stack trace, the first
            // non-database entry is returned.
'contrib driver namespace' => [
                'Drupal\\Driver\\Database\\dbal',
                $stack,
                [
                    'class' => 'Drupal\\KernelTests\\Core\\Database\\LoggingTest',
                    'function' => 'testEnableLogging',
                    'file' => '/var/www/core/tests/Drupal/KernelTests/Core/Database/LoggingTest.php',
                    'line' => 23,
                    'type' => '->',
                    'args' => [
                        0 => 'test',
                    ],
                ],
            ],
            // Extreme case, should not happen at normal runtime - if the driver
            // namespace is not in the stack trace, the first entry to a method
            // in core database namespace is returned.
'missing driver namespace' => [
                'Drupal\\Driver\\Database\\fake',
                $stack,
                [
                    'class' => 'Drupal\\Driver\\Database\\dbal\\Statement',
                    'function' => 'execute',
                    'file' => '/var/www/libraries/test/lib/Statement.php',
                    'line' => 264,
                    'type' => '->',
                    'args' => [
                        0 => 'test',
                    ],
                ],
            ],
        ];
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DatabaseTestBase::$connection protected property The database connection for testing.
DatabaseTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 3
DatabaseTestBase::ensureSampleDataNull public function Sets up tables for NULL handling.
DatabaseTestBase::setUp protected function Overrides KernelTestBase::setUp 1
DatabaseTestSchemaDataTrait::addSampleData protected function Sets up our sample data.
DatabaseTestSchemaInstallTrait::installSampleSchema protected function Sets up our sample table schema.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
LoggingTest::providerContribDriverLog public static function Provides data for the testContribDriverLog test.
LoggingTest::testContribDriverLog public function Tests that a log called by a custom database driver returns proper caller.
LoggingTest::testEnableLogging public function Tests that we can log the existence of a query.
LoggingTest::testEnableMultiConnectionLogging public function Tests that we can log queries separately on different connections.
LoggingTest::testEnableMultiLogging public function Tests that we can run two logs in parallel.
LoggingTest::testEnableTargetLogging public function Tests logging queries against multiple targets on the same connection.
LoggingTest::testEnableTargetLoggingNoTarget public function Tests that logs to separate targets use the same connection properly.
LoggingTest::testGetLoggingWrongKey public function Tests that getLog with a wrong key return an empty array.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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