Monolog\Formatter\GelfMessageFormatterTest Class Reference

Inheritance diagram for Monolog\Formatter\GelfMessageFormatterTest:

Collaboration diagram for Monolog\Formatter\GelfMessageFormatterTest:

Public Member Functions
	setUp ()
	testDefaultFormatter ()
	@covers Monolog\Formatter\GelfMessageFormatter::format More...
	testFormatWithFileAndLine ()
	@covers Monolog\Formatter\GelfMessageFormatter::format More...
	testFormatInvalidFails ()
	@covers Monolog\Formatter\GelfMessageFormatter::format @expectedException InvalidArgumentException More...
	testFormatWithContext ()
	@covers Monolog\Formatter\GelfMessageFormatter::format More...
	testFormatWithContextContainingException ()
	@covers Monolog\Formatter\GelfMessageFormatter::format More...
	testFormatWithExtra ()
	@covers Monolog\Formatter\GelfMessageFormatter::format More...
	testFormatWithLargeData ()

Private Member Functions
	isLegacy ()

Detailed Description

Definition at line 16 of file GelfMessageFormatterTest.php.

Member Function Documentation

isLegacy()

Monolog\Formatter\GelfMessageFormatterTest::isLegacy ( )

private

Definition at line 230 of file GelfMessageFormatterTest.php.

    {
        return interface_exists('\Gelf\IMessagePublisher');
    }

Referenced by Monolog\Formatter\GelfMessageFormatterTest\testDefaultFormatter().

Here is the caller graph for this function:

setUp()

Monolog\Formatter\GelfMessageFormatterTest::setUp

(

)

Definition at line 18 of file GelfMessageFormatterTest.php.

    {
        if (!class_exists('\Gelf\Message')) {
            $this->markTestSkipped("graylog2/gelf-php or mlehner/gelf-php is not installed");
        }
    }

testDefaultFormatter()

Monolog\Formatter\GelfMessageFormatterTest::testDefaultFormatter

(

)

@covers Monolog\Formatter\GelfMessageFormatter::format

Definition at line 28 of file GelfMessageFormatterTest.php.

    {
        $formatter = new GelfMessageFormatter();
        $record = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
            'channel' => 'meh',
            'context' => array(),
            'datetime' => new \DateTime("@0"),
            'extra' => array(),
            'message' => 'log',
        );
 
        $message = $formatter->format($record);
 
        $this->assertInstanceOf('Gelf\Message', $message);
        $this->assertEquals(0, $message->getTimestamp());
        $this->assertEquals('log', $message->getShortMessage());
        $this->assertEquals('meh', $message->getFacility());
        $this->assertEquals(null, $message->getLine());
        $this->assertEquals(null, $message->getFile());
        $this->assertEquals($this->isLegacy() ? 3 : 'error', $message->getLevel());
        $this->assertNotEmpty($message->getHost());
 
        $formatter = new GelfMessageFormatter('mysystem');
 
        $message = $formatter->format($record);
 
        $this->assertInstanceOf('Gelf\Message', $message);
        $this->assertEquals('mysystem', $message->getHost());
    }

References $message, Monolog\Logger\ERROR, and Monolog\Formatter\GelfMessageFormatterTest\isLegacy().

Here is the call graph for this function:

testFormatInvalidFails()

Monolog\Formatter\GelfMessageFormatterTest::testFormatInvalidFails

(

)

@covers Monolog\Formatter\GelfMessageFormatter::format @expectedException InvalidArgumentException

Definition at line 87 of file GelfMessageFormatterTest.php.

    {
        $formatter = new GelfMessageFormatter();
        $record = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
        );
 
        $formatter->format($record);
    }

References Monolog\Logger\ERROR.

testFormatWithContext()

Monolog\Formatter\GelfMessageFormatterTest::testFormatWithContext

(

)

@covers Monolog\Formatter\GelfMessageFormatter::format

Definition at line 101 of file GelfMessageFormatterTest.php.

    {
        $formatter = new GelfMessageFormatter();
        $record = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
            'channel' => 'meh',
            'context' => array('from' => 'logger'),
            'datetime' => new \DateTime("@0"),
            'extra' => array('key' => 'pair'),
            'message' => 'log',
        );
 
        $message = $formatter->format($record);
 
        $this->assertInstanceOf('Gelf\Message', $message);
 
        $message_array = $message->toArray();
 
        $this->assertArrayHasKey('_ctxt_from', $message_array);
        $this->assertEquals('logger', $message_array['_ctxt_from']);
 
        // Test with extraPrefix
        $formatter = new GelfMessageFormatter(null, null, 'CTX');
        $message = $formatter->format($record);
 
        $this->assertInstanceOf('Gelf\Message', $message);
 
        $message_array = $message->toArray();
 
        $this->assertArrayHasKey('_CTXfrom', $message_array);
        $this->assertEquals('logger', $message_array['_CTXfrom']);
    }

References $message, and Monolog\Logger\ERROR.

testFormatWithContextContainingException()

Monolog\Formatter\GelfMessageFormatterTest::testFormatWithContextContainingException

(

)

@covers Monolog\Formatter\GelfMessageFormatter::format

Definition at line 138 of file GelfMessageFormatterTest.php.

    {
        $formatter = new GelfMessageFormatter();
        $record = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
            'channel' => 'meh',
            'context' => array('from' => 'logger', 'exception' => array(
                'class' => '\Exception',
                'file'  => '/some/file/in/dir.php:56',
                'trace' => array('/some/file/1.php:23', '/some/file/2.php:3'),
            )),
            'datetime' => new \DateTime("@0"),
            'extra' => array(),
            'message' => 'log',
        );
 
        $message = $formatter->format($record);
 
        $this->assertInstanceOf('Gelf\Message', $message);
 
        $this->assertEquals("/some/file/in/dir.php", $message->getFile());
        $this->assertEquals("56", $message->getLine());
    }

References $message, and Monolog\Logger\ERROR.

testFormatWithExtra()

Monolog\Formatter\GelfMessageFormatterTest::testFormatWithExtra

(

)

@covers Monolog\Formatter\GelfMessageFormatter::format

Definition at line 166 of file GelfMessageFormatterTest.php.

    {
        $formatter = new GelfMessageFormatter();
        $record = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
            'channel' => 'meh',
            'context' => array('from' => 'logger'),
            'datetime' => new \DateTime("@0"),
            'extra' => array('key' => 'pair'),
            'message' => 'log',
        );
 
        $message = $formatter->format($record);
 
        $this->assertInstanceOf('Gelf\Message', $message);
 
        $message_array = $message->toArray();
 
        $this->assertArrayHasKey('_key', $message_array);
        $this->assertEquals('pair', $message_array['_key']);
 
        // Test with extraPrefix
        $formatter = new GelfMessageFormatter(null, 'EXT');
        $message = $formatter->format($record);
 
        $this->assertInstanceOf('Gelf\Message', $message);
 
        $message_array = $message->toArray();
 
        $this->assertArrayHasKey('_EXTkey', $message_array);
        $this->assertEquals('pair', $message_array['_EXTkey']);
    }

References $message, and Monolog\Logger\ERROR.

testFormatWithFileAndLine()

Monolog\Formatter\GelfMessageFormatterTest::testFormatWithFileAndLine

(

)

@covers Monolog\Formatter\GelfMessageFormatter::format

Definition at line 63 of file GelfMessageFormatterTest.php.

    {
        $formatter = new GelfMessageFormatter();
        $record = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
            'channel' => 'meh',
            'context' => array('from' => 'logger'),
            'datetime' => new \DateTime("@0"),
            'extra' => array('file' => 'test', 'line' => 14),
            'message' => 'log',
        );
 
        $message = $formatter->format($record);
 
        $this->assertInstanceOf('Gelf\Message', $message);
        $this->assertEquals('test', $message->getFile());
        $this->assertEquals(14, $message->getLine());
    }

References $message, and Monolog\Logger\ERROR.

testFormatWithLargeData()

Monolog\Formatter\GelfMessageFormatterTest::testFormatWithLargeData

(

)

Definition at line 200 of file GelfMessageFormatterTest.php.

    {
        $formatter = new GelfMessageFormatter();
        $record = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
            'channel' => 'meh',
            'context' => array('exception' => str_repeat(' ', 32767)),
            'datetime' => new \DateTime("@0"),
            'extra' => array('key' => str_repeat(' ', 32767)),
            'message' => 'log'
        );
        $message = $formatter->format($record);
        $messageArray = $message->toArray();
 
        // 200 for padding + metadata
        $length = 200;
 
        foreach ($messageArray as $key => $value) {
            if (!in_array($key, array('level', 'timestamp'))) {
                $length += strlen($value);
            }
        }
 
        // in graylog2/gelf-php before 1.4.1 empty strings are filtered and won't be included in the message
        // though it should be sufficient to ensure that the entire message length does not exceed the maximum
        // length being allowed
        $this->assertLessThanOrEqual(32766, $length, 'The message length is no longer than the maximum allowed length');
    }

References $key, $message, and Monolog\Logger\ERROR.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/monolog/monolog/tests/Monolog/Formatter/GelfMessageFormatterTest.php