Monolog\Handler\ElasticSearchHandlerTest Class Reference

Inheritance diagram for Monolog\Handler\ElasticSearchHandlerTest:

Collaboration diagram for Monolog\Handler\ElasticSearchHandlerTest:

Public Member Functions
	setUp ()
	testHandle ()
	@covers Monolog\Handler\ElasticSearchHandler::write @covers Monolog\Handler\ElasticSearchHandler::handleBatch @covers Monolog\Handler\ElasticSearchHandler::bulkSend @covers Monolog\Handler\ElasticSearchHandler::getDefaultFormatter More...
	testSetFormatter ()
	@covers Monolog\Handler\ElasticSearchHandler::setFormatter More...
	testSetFormatterInvalid ()
	@covers Monolog\Handler\ElasticSearchHandler::setFormatter @expectedException InvalidArgumentException @expectedExceptionMessage ElasticSearchHandler is only compatible with ElasticaFormatter More...
	testOptions ()
	@covers Monolog\Handler\ElasticSearchHandler::__construct @covers Monolog\Handler\ElasticSearchHandler::getOptions More...
	testConnectionErrors ($ignore, $expectedError)
	@covers Monolog\Handler\ElasticSearchHandler::bulkSend @dataProvider providerTestConnectionErrors More...
	providerTestConnectionErrors ()
	testHandleIntegration ()
	Integration test using localhost Elastic Search server. More...

Protected Member Functions
	getCreatedDocId (Response $response)
	Return last created document id from ES response. More...
	getDocSourceFromElastic (Client $client, $index, $type, $documentId)
	Retrieve document by id from Elasticsearch. More...
Protected Member Functions inherited from Monolog\TestCase
	getRecord ($level=Logger::WARNING, $message='test', $context=array())
	getMultipleRecords ()
	getIdentityFormatter ()

Protected Attributes
	$client
	$options

Detailed Description

Definition at line 22 of file ElasticSearchHandlerTest.php.

Member Function Documentation

getCreatedDocId()

Monolog\Handler\ElasticSearchHandlerTest::getCreatedDocId ( Response  $response )

protected

Return last created document id from ES response.

Parameters

Response

$response

Elastica Response object

Returns

string|null

Definition at line 213 of file ElasticSearchHandlerTest.php.

    {
        $data = $response->getData();
        if (!empty($data['items'][0]['create']['_id'])) {
            return $data['items'][0]['create']['_id'];
        }
    }

References $data.

Referenced by Monolog\Handler\ElasticSearchHandlerTest\testHandleIntegration().

Here is the caller graph for this function:

getDocSourceFromElastic()

Monolog\Handler\ElasticSearchHandlerTest::getDocSourceFromElastic ( Client  $client,   $index,   $type,   $documentId  )

protected

Retrieve document by id from Elasticsearch.

Parameters

Client	$client	Elastica client
string	$index
string	$type
string	$documentId

Returns

array

Definition at line 229 of file ElasticSearchHandlerTest.php.

    {
        $resp = $client->request("/{$index}/{$type}/{$documentId}", Request::GET);
        $data = $resp->getData();
        if (!empty($data['_source'])) {
            return $data['_source'];
        }
 
        return array();
    }

References Monolog\Handler\ElasticSearchHandlerTest\$client, and $data.

Referenced by Monolog\Handler\ElasticSearchHandlerTest\testHandleIntegration().

Here is the caller graph for this function:

providerTestConnectionErrors()

Monolog\Handler\ElasticSearchHandlerTest::providerTestConnectionErrors

(

)

Returns

array

Definition at line 147 of file ElasticSearchHandlerTest.php.

    {
        return array(
            array(false, array('RuntimeException', 'Error sending messages to Elasticsearch')),
            array(true, false),
        );
    }

setUp()

Monolog\Handler\ElasticSearchHandlerTest::setUp

(

)

Definition at line 37 of file ElasticSearchHandlerTest.php.

    {
        // Elastica lib required
        if (!class_exists("Elastica\Client")) {
            $this->markTestSkipped("ruflin/elastica not installed");
        }
 
        // base mock Elastica Client object
        $this->client = $this->getMockBuilder('Elastica\Client')
            ->setMethods(array('addDocuments'))
            ->disableOriginalConstructor()
            ->getMock();
    }

testConnectionErrors()

Monolog\Handler\ElasticSearchHandlerTest::testConnectionErrors	(		$ignore,
			$expectedError
	)

@covers Monolog\Handler\ElasticSearchHandler::bulkSend @dataProvider providerTestConnectionErrors

Definition at line 129 of file ElasticSearchHandlerTest.php.

    {
        $clientOpts = array('host' => '127.0.0.1', 'port' => 1);
        $client = new Client($clientOpts);
        $handlerOpts = array('ignore_error' => $ignore);
        $handler = new ElasticSearchHandler($client, $handlerOpts);
 
        if ($expectedError) {
            $this->setExpectedException($expectedError[0], $expectedError[1]);
            $handler->handle($this->getRecord());
        } else {
            $this->assertFalse($handler->handle($this->getRecord()));
        }
    }

References Monolog\Handler\ElasticSearchHandlerTest\$client, $ignore, and Monolog\TestCase\getRecord().

Here is the call graph for this function:

testHandle()

Monolog\Handler\ElasticSearchHandlerTest::testHandle

(

)

@covers Monolog\Handler\ElasticSearchHandler::write @covers Monolog\Handler\ElasticSearchHandler::handleBatch @covers Monolog\Handler\ElasticSearchHandler::bulkSend @covers Monolog\Handler\ElasticSearchHandler::getDefaultFormatter

Definition at line 57 of file ElasticSearchHandlerTest.php.

    {
        // log message
        $msg = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
            'channel' => 'meh',
            'context' => array('foo' => 7, 'bar', 'class' => new \stdClass),
            'datetime' => new \DateTime("@0"),
            'extra' => array(),
            'message' => 'log',
        );
 
        // format expected result
        $formatter = new ElasticaFormatter($this->options['index'], $this->options['type']);
        $expected = array($formatter->format($msg));
 
        // setup ES client mock
        $this->client->expects($this->any())
            ->method('addDocuments')
            ->with($expected);
 
        // perform tests
        $handler = new ElasticSearchHandler($this->client, $this->options);
        $handler->handle($msg);
        $handler->handleBatch(array($msg));
    }

References Monolog\Logger\ERROR.

testHandleIntegration()

Monolog\Handler\ElasticSearchHandlerTest::testHandleIntegration

(

)

Integration test using localhost Elastic Search server.

@covers Monolog\Handler\ElasticSearchHandler::__construct @covers Monolog\Handler\ElasticSearchHandler::handleBatch @covers Monolog\Handler\ElasticSearchHandler::bulkSend @covers Monolog\Handler\ElasticSearchHandler::getDefaultFormatter

Definition at line 163 of file ElasticSearchHandlerTest.php.

    {
        $msg = array(
            'level' => Logger::ERROR,
            'level_name' => 'ERROR',
            'channel' => 'meh',
            'context' => array('foo' => 7, 'bar', 'class' => new \stdClass),
            'datetime' => new \DateTime("@0"),
            'extra' => array(),
            'message' => 'log',
        );
 
        $expected = $msg;
        $expected['datetime'] = $msg['datetime']->format(\DateTime::ISO8601);
        $expected['context'] = array(
            'class' => '[object] (stdClass: {})',
            'foo' => 7,
            0 => 'bar',
        );
 
        $client = new Client();
        $handler = new ElasticSearchHandler($client, $this->options);
        try {
            $handler->handleBatch(array($msg));
        } catch (\RuntimeException $e) {
            $this->markTestSkipped("Cannot connect to Elastic Search server on localhost");
        }
 
        // check document id from ES server response
        $documentId = $this->getCreatedDocId($client->getLastResponse());
        $this->assertNotEmpty($documentId, 'No elastic document id received');
 
        // retrieve document source from ES and validate
        $document = $this->getDocSourceFromElastic(
            $client,
            $this->options['index'],
            $this->options['type'],
            $documentId
        );
        $this->assertEquals($expected, $document);
 
        // remove test index from ES
        $client->request("/{$this->options['index']}", Request::DELETE);
    }

References Monolog\Handler\ElasticSearchHandlerTest\$client, Monolog\Logger\ERROR, Monolog\Handler\ElasticSearchHandlerTest\getCreatedDocId(), and Monolog\Handler\ElasticSearchHandlerTest\getDocSourceFromElastic().

Here is the call graph for this function:

testOptions()

Monolog\Handler\ElasticSearchHandlerTest::testOptions

(

)

@covers Monolog\Handler\ElasticSearchHandler::__construct @covers Monolog\Handler\ElasticSearchHandler::getOptions

Definition at line 114 of file ElasticSearchHandlerTest.php.

    {
        $expected = array(
            'index' => $this->options['index'],
            'type' => $this->options['type'],
            'ignore_error' => false,
        );
        $handler = new ElasticSearchHandler($this->client, $this->options);
        $this->assertEquals($expected, $handler->getOptions());
    }

testSetFormatter()

Monolog\Handler\ElasticSearchHandlerTest::testSetFormatter

(

)

@covers Monolog\Handler\ElasticSearchHandler::setFormatter

Definition at line 88 of file ElasticSearchHandlerTest.php.

    {
        $handler = new ElasticSearchHandler($this->client);
        $formatter = new ElasticaFormatter('index_new', 'type_new');
        $handler->setFormatter($formatter);
        $this->assertInstanceOf('Monolog\Formatter\ElasticaFormatter', $handler->getFormatter());
        $this->assertEquals('index_new', $handler->getFormatter()->getIndex());
        $this->assertEquals('type_new', $handler->getFormatter()->getType());
    }

testSetFormatterInvalid()

Monolog\Handler\ElasticSearchHandlerTest::testSetFormatterInvalid

(

)

@covers Monolog\Handler\ElasticSearchHandler::setFormatter @expectedException InvalidArgumentException @expectedExceptionMessage ElasticSearchHandler is only compatible with ElasticaFormatter

Definition at line 103 of file ElasticSearchHandlerTest.php.

    {
        $handler = new ElasticSearchHandler($this->client);
        $formatter = new NormalizerFormatter();
        $handler->setFormatter($formatter);
    }

Field Documentation

$client

Monolog\Handler\ElasticSearchHandlerTest::$client

protected

Definition at line 27 of file ElasticSearchHandlerTest.php.

Referenced by Monolog\Handler\ElasticSearchHandlerTest\getDocSourceFromElastic(), Monolog\Handler\ElasticSearchHandlerTest\testConnectionErrors(), and Monolog\Handler\ElasticSearchHandlerTest\testHandleIntegration().

$options

Monolog\Handler\ElasticSearchHandlerTest::$options

protected

Initial value:

= array(
        'index' => 'my_index',
        'type'  => 'doc_type',
    )

Definition at line 32 of file ElasticSearchHandlerTest.php.

---

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

• Services/Logging/lib/vendor/monolog/monolog/tests/Monolog/Handler/ElasticSearchHandlerTest.php