* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Monolog\Handler; use Monolog\Test\TestCase; use Monolog\Logger; /** * @author Pablo de Leon Belloc */ class SocketHandlerTest extends TestCase { /** * @var Monolog\Handler\SocketHandler */ private $handler; /** * @var resource */ private $res; /** * @expectedException UnexpectedValueException */ public function testInvalidHostname() { $this->createHandler('garbage://here'); $this->writeRecord('data'); } /** * @expectedException \InvalidArgumentException */ public function testBadConnectionTimeout() { $this->createHandler('localhost:1234'); $this->handler->setConnectionTimeout(-1); } public function testSetConnectionTimeout() { $this->createHandler('localhost:1234'); $this->handler->setConnectionTimeout(10.1); $this->assertEquals(10.1, $this->handler->getConnectionTimeout()); } /** * @expectedException \InvalidArgumentException */ public function testBadTimeout() { $this->createHandler('localhost:1234'); $this->handler->setTimeout(-1); } public function testSetTimeout() { $this->createHandler('localhost:1234'); $this->handler->setTimeout(10.25); $this->assertEquals(10.25, $this->handler->getTimeout()); } public function testSetWritingTimeout() { $this->createHandler('localhost:1234'); $this->handler->setWritingTimeout(10.25); $this->assertEquals(10.25, $this->handler->getWritingTimeout()); } public function testSetConnectionString() { $this->createHandler('tcp://localhost:9090'); $this->assertEquals('tcp://localhost:9090', $this->handler->getConnectionString()); } /** * @expectedException UnexpectedValueException */ public function testExceptionIsThrownOnFsockopenError() { $this->setMockHandler(['fsockopen']); $this->handler->expects($this->once()) ->method('fsockopen') ->will($this->returnValue(false)); $this->writeRecord('Hello world'); } /** * @expectedException UnexpectedValueException */ public function testExceptionIsThrownOnPfsockopenError() { $this->setMockHandler(['pfsockopen']); $this->handler->expects($this->once()) ->method('pfsockopen') ->will($this->returnValue(false)); $this->handler->setPersistent(true); $this->writeRecord('Hello world'); } /** * @expectedException UnexpectedValueException */ public function testExceptionIsThrownIfCannotSetTimeout() { $this->setMockHandler(['streamSetTimeout']); $this->handler->expects($this->once()) ->method('streamSetTimeout') ->will($this->returnValue(false)); $this->writeRecord('Hello world'); } /** * @expectedException RuntimeException */ public function testWriteFailsOnIfFwriteReturnsFalse() { $this->setMockHandler(['fwrite']); $callback = function ($arg) { $map = [ 'Hello world' => 6, 'world' => false, ]; return $map[$arg]; }; $this->handler->expects($this->exactly(2)) ->method('fwrite') ->will($this->returnCallback($callback)); $this->writeRecord('Hello world'); } /** * @expectedException RuntimeException */ public function testWriteFailsIfStreamTimesOut() { $this->setMockHandler(['fwrite', 'streamGetMetadata']); $callback = function ($arg) { $map = [ 'Hello world' => 6, 'world' => 5, ]; return $map[$arg]; }; $this->handler->expects($this->exactly(1)) ->method('fwrite') ->will($this->returnCallback($callback)); $this->handler->expects($this->exactly(1)) ->method('streamGetMetadata') ->will($this->returnValue(['timed_out' => true])); $this->writeRecord('Hello world'); } /** * @expectedException RuntimeException */ public function testWriteFailsOnIncompleteWrite() { $this->setMockHandler(['fwrite', 'streamGetMetadata']); $res = $this->res; $callback = function ($string) use ($res) { fclose($res); return strlen('Hello'); }; $this->handler->expects($this->exactly(1)) ->method('fwrite') ->will($this->returnCallback($callback)); $this->handler->expects($this->exactly(1)) ->method('streamGetMetadata') ->will($this->returnValue(['timed_out' => false])); $this->writeRecord('Hello world'); } public function testWriteWithMemoryFile() { $this->setMockHandler(); $this->writeRecord('test1'); $this->writeRecord('test2'); $this->writeRecord('test3'); fseek($this->res, 0); $this->assertEquals('test1test2test3', fread($this->res, 1024)); } public function testWriteWithMock() { $this->setMockHandler(['fwrite']); $callback = function ($arg) { $map = [ 'Hello world' => 6, 'world' => 5, ]; return $map[$arg]; }; $this->handler->expects($this->exactly(2)) ->method('fwrite') ->will($this->returnCallback($callback)); $this->writeRecord('Hello world'); } public function testClose() { $this->setMockHandler(); $this->writeRecord('Hello world'); $this->assertInternalType('resource', $this->res); $this->handler->close(); $this->assertFalse(is_resource($this->res), "Expected resource to be closed after closing handler"); } public function testCloseDoesNotClosePersistentSocket() { $this->setMockHandler(); $this->handler->setPersistent(true); $this->writeRecord('Hello world'); $this->assertTrue(is_resource($this->res)); $this->handler->close(); $this->assertTrue(is_resource($this->res)); } /** * @expectedException \RuntimeException */ public function testAvoidInfiniteLoopWhenNoDataIsWrittenForAWritingTimeoutSeconds() { $this->setMockHandler(['fwrite', 'streamGetMetadata']); $this->handler->expects($this->any()) ->method('fwrite') ->will($this->returnValue(0)); $this->handler->expects($this->any()) ->method('streamGetMetadata') ->will($this->returnValue(['timed_out' => false])); $this->handler->setWritingTimeout(1); $this->writeRecord('Hello world'); } private function createHandler($connectionString) { $this->handler = new SocketHandler($connectionString); $this->handler->setFormatter($this->getIdentityFormatter()); } private function writeRecord($string) { $this->handler->handle($this->getRecord(Logger::WARNING, $string)); } private function setMockHandler(array $methods = []) { $this->res = fopen('php://memory', 'a'); $defaultMethods = ['fsockopen', 'pfsockopen', 'streamSetTimeout']; $newMethods = array_diff($methods, $defaultMethods); $finalMethods = array_merge($defaultMethods, $newMethods); $this->handler = $this->getMockBuilder('Monolog\Handler\SocketHandler') ->setMethods($finalMethods) ->setConstructorArgs(['localhost:1234']) ->getMock(); if (!in_array('fsockopen', $methods)) { $this->handler->expects($this->any()) ->method('fsockopen') ->will($this->returnValue($this->res)); } if (!in_array('pfsockopen', $methods)) { $this->handler->expects($this->any()) ->method('pfsockopen') ->will($this->returnValue($this->res)); } if (!in_array('streamSetTimeout', $methods)) { $this->handler->expects($this->any()) ->method('streamSetTimeout') ->will($this->returnValue(true)); } $this->handler->setFormatter($this->getIdentityFormatter()); } }