Monolog\Handler\HipChatHandlerTest Class Reference

Inheritance diagram for Monolog\Handler\HipChatHandlerTest:

Collaboration diagram for Monolog\Handler\HipChatHandlerTest:

Public Member Functions
	testWriteHeader ()
	testWriteCustomHostHeader ()
	testWriteV2 ()
	testWriteV2Notify ()
	testRoomSpaces ()
	testWriteContent ($content)
	testWriteHeader More...
	testWriteContentV1WithoutName ()
	testWriteContentNotify ($content)
	testWriteCustomHostHeader More...
	testWriteContentV2 ($content)
	testWriteV2 More...
	testWriteContentV2Notify ($content)
	testWriteV2Notify More...
	testWriteContentV2WithoutName ()
	testWriteWithComplexMessage ()
	testWriteTruncatesLongMessage ()
	testWriteWithErrorLevelsAndColors ($level, $expectedColor)
	provideLevelColors More...
	provideLevelColors ()
	testHandleBatch ($records, $expectedColor)
	provideBatchRecords More...
	provideBatchRecords ()
	testCreateWithTooLongName ()
	InvalidArgumentException More...
	testCreateWithTooLongNameV2 ()

Private Member Functions
	createHandler ($token='myToken', $room='room1', $name='Monolog', $notify=false, $host='api.hipchat.com', $version='v1')

Private Attributes
	$res
	$handler

Additional Inherited Members
Protected Member Functions inherited from Monolog\TestCase
	getRecord ($level=Logger::WARNING, $message='test', $context=array())
	getMultipleRecords ()
	getIdentityFormatter ()

Detailed Description

Author

Rafael Dohms rafae.nosp@m.l@do.nosp@m.h.ms

See also

https://www.hipchat.com/docs/api

Definition at line 21 of file HipChatHandlerTest.php.

Member Function Documentation

createHandler()

Monolog\Handler\HipChatHandlerTest::createHandler (   $token = 'myToken',   $room = 'room1',   $name = 'Monolog',   $notify = false,   $host = 'api.hipchat.com',   $version = 'v1'  )

private

Definition at line 239 of file HipChatHandlerTest.php.

References $name, PHPMailer\PHPMailer\$token, $version, Monolog\Logger\DEBUG, and Monolog\TestCase\getIdentityFormatter().

Referenced by Monolog\Handler\HipChatHandlerTest\testHandleBatch(), Monolog\Handler\HipChatHandlerTest\testRoomSpaces(), Monolog\Handler\HipChatHandlerTest\testWriteContentV1WithoutName(), Monolog\Handler\HipChatHandlerTest\testWriteContentV2WithoutName(), Monolog\Handler\HipChatHandlerTest\testWriteCustomHostHeader(), Monolog\Handler\HipChatHandlerTest\testWriteHeader(), Monolog\Handler\HipChatHandlerTest\testWriteTruncatesLongMessage(), Monolog\Handler\HipChatHandlerTest\testWriteV2(), Monolog\Handler\HipChatHandlerTest\testWriteV2Notify(), Monolog\Handler\HipChatHandlerTest\testWriteWithComplexMessage(), and Monolog\Handler\HipChatHandlerTest\testWriteWithErrorLevelsAndColors().

    {
        $constructorArgs = array($token, $room, $name, $notify, Logger::DEBUG, true, true, 'text', $host, $version);
        $this->res = fopen('php://memory', 'a');
        $this->handler = $this->getMock(
            '\Monolog\Handler\HipChatHandler',
            array('fsockopen', 'streamSetTimeout', 'closeSocket'),
            $constructorArgs
        );

        $reflectionProperty = new \ReflectionProperty('\Monolog\Handler\SocketHandler', 'connectionString');
        $reflectionProperty->setAccessible(true);
        $reflectionProperty->setValue($this->handler, 'localhost:1234');

        $this->handler->expects($this->any())
            ->method('fsockopen')
            ->will($this->returnValue($this->res));
        $this->handler->expects($this->any())
            ->method('streamSetTimeout')
            ->will($this->returnValue(true));
        $this->handler->expects($this->any())
            ->method('closeSocket')
            ->will($this->returnValue(true));

        $this->handler->setFormatter($this->getIdentityFormatter());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

provideBatchRecords()

Monolog\Handler\HipChatHandlerTest::provideBatchRecords

(

)

Definition at line 205 of file HipChatHandlerTest.php.

References Monolog\Logger\CRITICAL, Monolog\Logger\DEBUG, Monolog\Logger\NOTICE, and Monolog\Logger\WARNING.

    {
        return array(
            array(
                array(
                    array('level' => Logger::WARNING, 'message' => 'Oh bugger!', 'level_name' => 'warning', 'datetime' => new \DateTime()),
                    array('level' => Logger::NOTICE, 'message' => 'Something noticeable happened.', 'level_name' => 'notice', 'datetime' => new \DateTime()),
                    array('level' => Logger::CRITICAL, 'message' => 'Everything is broken!', 'level_name' => 'critical', 'datetime' => new \DateTime()),
                ),
                'red',
            ),
            array(
                array(
                    array('level' => Logger::WARNING, 'message' => 'Oh bugger!', 'level_name' => 'warning', 'datetime' => new \DateTime()),
                    array('level' => Logger::NOTICE, 'message' => 'Something noticeable happened.', 'level_name' => 'notice', 'datetime' => new \DateTime()),
                ),
                'yellow',
            ),
            array(
                array(
                    array('level' => Logger::DEBUG, 'message' => 'Just debugging.', 'level_name' => 'debug', 'datetime' => new \DateTime()),
                    array('level' => Logger::NOTICE, 'message' => 'Something noticeable happened.', 'level_name' => 'notice', 'datetime' => new \DateTime()),
                ),
                'green',
            ),
            array(
                array(
                    array('level' => Logger::DEBUG, 'message' => 'Just debugging.', 'level_name' => 'debug', 'datetime' => new \DateTime()),
                ),
                'gray',
            ),
        );
    }

provideLevelColors()

Monolog\Handler\HipChatHandlerTest::provideLevelColors

(

)

Definition at line 176 of file HipChatHandlerTest.php.

References Monolog\Logger\ALERT, Monolog\Logger\CRITICAL, Monolog\Logger\DEBUG, Monolog\Logger\EMERGENCY, Monolog\Logger\ERROR, Monolog\Logger\INFO, Monolog\Logger\NOTICE, and Monolog\Logger\WARNING.

    {
        return array(
            array(Logger::DEBUG,    'gray'),
            array(Logger::INFO,     'green'),
            array(Logger::WARNING,  'yellow'),
            array(Logger::ERROR,    'red'),
            array(Logger::CRITICAL, 'red'),
            array(Logger::ALERT,    'red'),
            array(Logger::EMERGENCY,'red'),
            array(Logger::NOTICE,   'green'),
        );
    }

testCreateWithTooLongName()

Monolog\Handler\HipChatHandlerTest::testCreateWithTooLongName

(

)

InvalidArgumentException

Definition at line 269 of file HipChatHandlerTest.php.

    {
        $hipChatHandler = new HipChatHandler('token', 'room', 'SixteenCharsHere');
    }

testCreateWithTooLongNameV2()

Monolog\Handler\HipChatHandlerTest::testCreateWithTooLongNameV2

(

)

Definition at line 274 of file HipChatHandlerTest.php.

References Monolog\Logger\CRITICAL.

    {
        // creating a handler with too long of a name but using the v2 api doesn't matter.
        $hipChatHandler = new HipChatHandler('token', 'room', 'SixteenCharsHere', false, Logger::CRITICAL, true, true, 'test', 'api.hipchat.com', 'v2');
    }

testHandleBatch()

Monolog\Handler\HipChatHandlerTest::testHandleBatch	(		$records,
			$expectedColor
	)

provideBatchRecords

Definition at line 193 of file HipChatHandlerTest.php.

References $records, and Monolog\Handler\HipChatHandlerTest\createHandler().

    {
        $this->createHandler();

        $this->handler->handleBatch($records);

        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/color='.$expectedColor.'/', $content);
    }

Here is the call graph for this function:

testRoomSpaces()

Monolog\Handler\HipChatHandlerTest::testRoomSpaces

(

)

Definition at line 75 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler('myToken', 'room name', 'Monolog', false, 'hipchat.foo.bar', 'v2');
        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/POST \/v2\/room\/room%20name\/notification\?auth_token=.* HTTP\/1.1\\r\\nHost: hipchat.foo.bar\\r\\nContent-Type: application\/x-www-form-urlencoded\\r\\nContent-Length: \d{2,4}\\r\\n\\r\\n/', $content);

        return $content;
    }

Here is the call graph for this function:

testWriteContent()

Monolog\Handler\HipChatHandlerTest::testWriteContent

(

$content

)

testWriteHeader

Definition at line 90 of file HipChatHandlerTest.php.

    {
        $this->assertRegexp('/notify=0&message=test1&message_format=text&color=red&room_id=room1&from=Monolog$/', $content);
    }

testWriteContentNotify()

Monolog\Handler\HipChatHandlerTest::testWriteContentNotify

(

$content

)

testWriteCustomHostHeader

Definition at line 110 of file HipChatHandlerTest.php.

    {
        $this->assertRegexp('/notify=1&message=test1&message_format=text&color=red&room_id=room1&from=Monolog$/', $content);
    }

testWriteContentV1WithoutName()

Monolog\Handler\HipChatHandlerTest::testWriteContentV1WithoutName

(

)

Definition at line 95 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler('myToken', 'room1', null, false, 'hipchat.foo.bar', 'v1');
        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/notify=0&message=test1&message_format=text&color=red&room_id=room1&from=$/', $content);

        return $content;
    }

Here is the call graph for this function:

testWriteContentV2()

Monolog\Handler\HipChatHandlerTest::testWriteContentV2

(

$content

)

testWriteV2

Definition at line 118 of file HipChatHandlerTest.php.

    {
        $this->assertRegexp('/notify=false&message=test1&message_format=text&color=red&from=Monolog$/', $content);
    }

testWriteContentV2Notify()

Monolog\Handler\HipChatHandlerTest::testWriteContentV2Notify

(

$content

)

testWriteV2Notify

Definition at line 126 of file HipChatHandlerTest.php.

    {
        $this->assertRegexp('/notify=true&message=test1&message_format=text&color=red&from=Monolog$/', $content);
    }

testWriteContentV2WithoutName()

Monolog\Handler\HipChatHandlerTest::testWriteContentV2WithoutName

(

)

Definition at line 131 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler('myToken', 'room1', null, false, 'hipchat.foo.bar', 'v2');
        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/notify=false&message=test1&message_format=text&color=red$/', $content);

        return $content;
    }

Here is the call graph for this function:

testWriteCustomHostHeader()

Monolog\Handler\HipChatHandlerTest::testWriteCustomHostHeader

(

)

Definition at line 39 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler('myToken', 'room1', 'Monolog', true, 'hipchat.foo.bar');
        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/POST \/v1\/rooms\/message\?format=json&auth_token=.* HTTP\/1.1\\r\\nHost: hipchat.foo.bar\\r\\nContent-Type: application\/x-www-form-urlencoded\\r\\nContent-Length: \d{2,4}\\r\\n\\r\\n/', $content);

        return $content;
    }

Here is the call graph for this function:

testWriteHeader()

Monolog\Handler\HipChatHandlerTest::testWriteHeader

(

)

Definition at line 27 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler();
        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/POST \/v1\/rooms\/message\?format=json&auth_token=.* HTTP\/1.1\\r\\nHost: api.hipchat.com\\r\\nContent-Type: application\/x-www-form-urlencoded\\r\\nContent-Length: \d{2,4}\\r\\n\\r\\n/', $content);

        return $content;
    }

Here is the call graph for this function:

testWriteTruncatesLongMessage()

Monolog\Handler\HipChatHandlerTest::testWriteTruncatesLongMessage

(

)

Definition at line 153 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler();
        $this->handler->handle($this->getRecord(Logger::CRITICAL, str_repeat('abcde', 2000)));
        fseek($this->res, 0);
        $content = fread($this->res, 12000);

        $this->assertRegexp('/message='.str_repeat('abcde', 1900).'\+%5Btruncated%5D/', $content);
    }

Here is the call graph for this function:

testWriteV2()

Monolog\Handler\HipChatHandlerTest::testWriteV2

(

)

Definition at line 51 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler('myToken', 'room1', 'Monolog', false, 'hipchat.foo.bar', 'v2');
        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/POST \/v2\/room\/room1\/notification\?auth_token=.* HTTP\/1.1\\r\\nHost: hipchat.foo.bar\\r\\nContent-Type: application\/x-www-form-urlencoded\\r\\nContent-Length: \d{2,4}\\r\\n\\r\\n/', $content);

        return $content;
    }

Here is the call graph for this function:

testWriteV2Notify()

Monolog\Handler\HipChatHandlerTest::testWriteV2Notify

(

)

Definition at line 63 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler('myToken', 'room1', 'Monolog', true, 'hipchat.foo.bar', 'v2');
        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'test1'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/POST \/v2\/room\/room1\/notification\?auth_token=.* HTTP\/1.1\\r\\nHost: hipchat.foo.bar\\r\\nContent-Type: application\/x-www-form-urlencoded\\r\\nContent-Length: \d{2,4}\\r\\n\\r\\n/', $content);

        return $content;
    }

Here is the call graph for this function:

testWriteWithComplexMessage()

Monolog\Handler\HipChatHandlerTest::testWriteWithComplexMessage

(

)

Definition at line 143 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), Monolog\Logger\CRITICAL, and Monolog\TestCase\getRecord().

    {
        $this->createHandler();
        $this->handler->handle($this->getRecord(Logger::CRITICAL, 'Backup of database "example" finished in 16 minutes.'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/message=Backup\+of\+database\+%22example%22\+finished\+in\+16\+minutes\./', $content);
    }

Here is the call graph for this function:

testWriteWithErrorLevelsAndColors()

Monolog\Handler\HipChatHandlerTest::testWriteWithErrorLevelsAndColors	(		$level,
			$expectedColor
	)

provideLevelColors

Definition at line 166 of file HipChatHandlerTest.php.

References Monolog\Handler\HipChatHandlerTest\createHandler(), and Monolog\TestCase\getRecord().

    {
        $this->createHandler();
        $this->handler->handle($this->getRecord($level, 'Backup of database "example" finished in 16 minutes.'));
        fseek($this->res, 0);
        $content = fread($this->res, 1024);

        $this->assertRegexp('/color='.$expectedColor.'/', $content);
    }

Here is the call graph for this function:

Field Documentation

$handler

Monolog\Handler\HipChatHandlerTest::$handler

private

Definition at line 25 of file HipChatHandlerTest.php.

$res

Monolog\Handler\HipChatHandlerTest::$res

private

Definition at line 23 of file HipChatHandlerTest.php.

---

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

• libs/composer/vendor/monolog/monolog/tests/Monolog/Handler/HipChatHandlerTest.php