class LogMessageParserTest

Same name in other branches
  1. 8.9.x core/tests/Drupal/Tests/Core/Logger/LogMessageParserTest.php \Drupal\Tests\Core\Logger\LogMessageParserTest
  2. 10 core/tests/Drupal/Tests/Core/Logger/LogMessageParserTest.php \Drupal\Tests\Core\Logger\LogMessageParserTest
  3. 11.x core/tests/Drupal/Tests/Core/Logger/LogMessageParserTest.php \Drupal\Tests\Core\Logger\LogMessageParserTest

@coversDefaultClass \Drupal\Core\Logger\LogMessageParser @group Logger

Hierarchy

Expanded class hierarchy of LogMessageParserTest

File

core/tests/Drupal/Tests/Core/Logger/LogMessageParserTest.php, line 12

Namespace

Drupal\Tests\Core\Logger
View source
class LogMessageParserTest extends UnitTestCase {
    
    /**
     * Tests for LogMessageParserTrait::parseMessagePlaceholders()
     *
     * @param array $value
     *   An array containing:
     *    - message: A string that contains a message with placeholders.
     *    - context: An array with placeholder values.
     * @param array $expected
     *   An array with the expected values after the test has run.
     *    - message: The expected parsed message.
     *    - context: The expected values of the placeholders.
     *
     * @dataProvider providerTestParseMessagePlaceholders
     * @covers ::parseMessagePlaceholders
     */
    public function testParseMessagePlaceholders(array $value, array $expected) {
        $parser = new LogMessageParser();
        $message_placeholders = $parser->parseMessagePlaceholders($value['message'], $value['context']);
        $this->assertEquals($expected['message'], $value['message']);
        $this->assertEquals($expected['context'], $message_placeholders);
    }
    
    /**
     * Data provider for testParseMessagePlaceholders().
     */
    public function providerTestParseMessagePlaceholders() {
        return [
            // PSR3 only message.
[
                [
                    'message' => 'User {username} created',
                    'context' => [
                        'username' => 'Dries',
                    ],
                ],
                [
                    'message' => 'User @username created',
                    'context' => [
                        '@username' => 'Dries',
                    ],
                ],
            ],
            // PSR3 style mixed in a format_string style message.
[
                [
                    'message' => 'User {username} created @time',
                    'context' => [
                        'username' => 'Dries',
                        '@time' => 'now',
                    ],
                ],
                [
                    'message' => 'User @username created @time',
                    'context' => [
                        '@username' => 'Dries',
                        '@time' => 'now',
                    ],
                ],
            ],
            // format_string style message only.
[
                [
                    'message' => 'User @username created',
                    'context' => [
                        '@username' => 'Dries',
                    ],
                ],
                [
                    'message' => 'User @username created',
                    'context' => [
                        '@username' => 'Dries',
                    ],
                ],
            ],
            // Message without placeholders but wildcard characters.
[
                [
                    'message' => 'User W-\\};~{&! created @',
                    'context' => [
                        '' => '',
                    ],
                ],
                [
                    'message' => 'User W-\\};~{&! created @',
                    'context' => [],
                ],
            ],
            // Message with double PSR3 style messages.
[
                [
                    'message' => 'Test {with} two {{encapsuled}} strings',
                    'context' => [
                        'with' => 'together',
                        'encapsuled' => 'awesome',
                    ],
                ],
                [
                    'message' => 'Test @with two {@encapsuled} strings',
                    'context' => [
                        '@with' => 'together',
                        '@encapsuled' => 'awesome',
                    ],
                ],
            ],
            // Test removal of unexpected placeholders like ! while allowed
            // placeholders beginning with @, % and : are preserved.
[
                [
                    'message' => 'Test placeholder with :url and old !bang parameter',
                    'context' => [
                        ':url' => 'https://drupal.org',
                        '!bang' => 'foo bar',
                    ],
                ],
                [
                    'message' => 'Test placeholder with :url and old !bang parameter',
                    'context' => [
                        ':url' => 'https://drupal.org',
                    ],
                ],
            ],
        ];
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overrides
LogMessageParserTest::providerTestParseMessagePlaceholders public function Data provider for testParseMessagePlaceholders().
LogMessageParserTest::testParseMessagePlaceholders public function Tests for LogMessageParserTrait::parseMessagePlaceholders()
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.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUp protected function 338
UnitTestCase::setUpBeforeClass public static function

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