StreamHandlerTest.php 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. <?php declare(strict_types=1);
  2. /*
  3. * This file is part of the Monolog package.
  4. *
  5. * (c) Jordi Boggiano <j.boggiano@seld.be>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Monolog\Handler;
  11. use Monolog\Test\TestCase;
  12. use Monolog\Logger;
  13. class StreamHandlerTest extends TestCase
  14. {
  15. /**
  16. * @covers Monolog\Handler\StreamHandler::__construct
  17. * @covers Monolog\Handler\StreamHandler::write
  18. */
  19. public function testWrite()
  20. {
  21. $handle = fopen('php://memory', 'a+');
  22. $handler = new StreamHandler($handle);
  23. $handler->setFormatter($this->getIdentityFormatter());
  24. $handler->handle($this->getRecord(Logger::WARNING, 'test'));
  25. $handler->handle($this->getRecord(Logger::WARNING, 'test2'));
  26. $handler->handle($this->getRecord(Logger::WARNING, 'test3'));
  27. fseek($handle, 0);
  28. $this->assertEquals('testtest2test3', fread($handle, 100));
  29. }
  30. /**
  31. * @covers Monolog\Handler\StreamHandler::close
  32. */
  33. public function testCloseKeepsExternalHandlersOpen()
  34. {
  35. $handle = fopen('php://memory', 'a+');
  36. $handler = new StreamHandler($handle);
  37. $this->assertTrue(is_resource($handle));
  38. $handler->close();
  39. $this->assertTrue(is_resource($handle));
  40. }
  41. /**
  42. * @covers Monolog\Handler\StreamHandler::close
  43. */
  44. public function testClose()
  45. {
  46. $handler = new StreamHandler('php://memory');
  47. $handler->handle($this->getRecord(Logger::WARNING, 'test'));
  48. $stream = $handler->getStream();
  49. $this->assertTrue(is_resource($stream));
  50. $handler->close();
  51. $this->assertFalse(is_resource($stream));
  52. }
  53. /**
  54. * @covers Monolog\Handler\StreamHandler::close
  55. * @covers Monolog\Handler\Handler::__sleep
  56. */
  57. public function testSerialization()
  58. {
  59. $handler = new StreamHandler('php://memory');
  60. $handler->handle($this->getRecord(Logger::WARNING, 'testfoo'));
  61. $stream = $handler->getStream();
  62. $this->assertTrue(is_resource($stream));
  63. fseek($stream, 0);
  64. $this->assertContains('testfoo', stream_get_contents($stream));
  65. $serialized = serialize($handler);
  66. $this->assertFalse(is_resource($stream));
  67. $handler = unserialize($serialized);
  68. $handler->handle($this->getRecord(Logger::WARNING, 'testbar'));
  69. $stream = $handler->getStream();
  70. $this->assertTrue(is_resource($stream));
  71. fseek($stream, 0);
  72. $contents = stream_get_contents($stream);
  73. $this->assertNotContains('testfoo', $contents);
  74. $this->assertContains('testbar', $contents);
  75. }
  76. /**
  77. * @covers Monolog\Handler\StreamHandler::write
  78. */
  79. public function testWriteCreatesTheStreamResource()
  80. {
  81. $handler = new StreamHandler('php://memory');
  82. $handler->handle($this->getRecord());
  83. }
  84. /**
  85. * @covers Monolog\Handler\StreamHandler::__construct
  86. * @covers Monolog\Handler\StreamHandler::write
  87. */
  88. public function testWriteLocking()
  89. {
  90. $temp = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'monolog_locked_log';
  91. $handler = new StreamHandler($temp, Logger::DEBUG, true, null, true);
  92. $handler->handle($this->getRecord());
  93. }
  94. /**
  95. * @expectedException LogicException
  96. * @covers Monolog\Handler\StreamHandler::__construct
  97. * @covers Monolog\Handler\StreamHandler::write
  98. */
  99. public function testWriteMissingResource()
  100. {
  101. $handler = new StreamHandler(null);
  102. $handler->handle($this->getRecord());
  103. }
  104. public function invalidArgumentProvider()
  105. {
  106. return [
  107. [1],
  108. [[]],
  109. [['bogus://url']],
  110. ];
  111. }
  112. /**
  113. * @dataProvider invalidArgumentProvider
  114. * @expectedException InvalidArgumentException
  115. * @covers Monolog\Handler\StreamHandler::__construct
  116. */
  117. public function testWriteInvalidArgument($invalidArgument)
  118. {
  119. $handler = new StreamHandler($invalidArgument);
  120. }
  121. /**
  122. * @expectedException UnexpectedValueException
  123. * @covers Monolog\Handler\StreamHandler::__construct
  124. * @covers Monolog\Handler\StreamHandler::write
  125. */
  126. public function testWriteInvalidResource()
  127. {
  128. $handler = new StreamHandler('bogus://url');
  129. $handler->handle($this->getRecord());
  130. }
  131. /**
  132. * @expectedException UnexpectedValueException
  133. * @covers Monolog\Handler\StreamHandler::__construct
  134. * @covers Monolog\Handler\StreamHandler::write
  135. */
  136. public function testWriteNonExistingResource()
  137. {
  138. $handler = new StreamHandler('ftp://foo/bar/baz/'.rand(0, 10000));
  139. $handler->handle($this->getRecord());
  140. }
  141. /**
  142. * @covers Monolog\Handler\StreamHandler::__construct
  143. * @covers Monolog\Handler\StreamHandler::write
  144. */
  145. public function testWriteNonExistingPath()
  146. {
  147. $handler = new StreamHandler(sys_get_temp_dir().'/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000));
  148. $handler->handle($this->getRecord());
  149. }
  150. /**
  151. * @covers Monolog\Handler\StreamHandler::__construct
  152. * @covers Monolog\Handler\StreamHandler::write
  153. */
  154. public function testWriteNonExistingFileResource()
  155. {
  156. $handler = new StreamHandler('file://'.sys_get_temp_dir().'/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000));
  157. $handler->handle($this->getRecord());
  158. }
  159. /**
  160. * @expectedException Exception
  161. * @expectedExceptionMessageRegExp /There is no existing directory at/
  162. * @covers Monolog\Handler\StreamHandler::__construct
  163. * @covers Monolog\Handler\StreamHandler::write
  164. */
  165. public function testWriteNonExistingAndNotCreatablePath()
  166. {
  167. if (defined('PHP_WINDOWS_VERSION_BUILD')) {
  168. $this->markTestSkipped('Permissions checks can not run on windows');
  169. }
  170. $handler = new StreamHandler('/foo/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000));
  171. $handler->handle($this->getRecord());
  172. }
  173. /**
  174. * @expectedException Exception
  175. * @expectedExceptionMessageRegExp /There is no existing directory at/
  176. * @covers Monolog\Handler\StreamHandler::__construct
  177. * @covers Monolog\Handler\StreamHandler::write
  178. */
  179. public function testWriteNonExistingAndNotCreatableFileResource()
  180. {
  181. if (defined('PHP_WINDOWS_VERSION_BUILD')) {
  182. $this->markTestSkipped('Permissions checks can not run on windows');
  183. }
  184. $handler = new StreamHandler('file:///foo/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000));
  185. $handler->handle($this->getRecord());
  186. }
  187. }