-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
StreamHandlerTest.php
327 lines (280 loc) · 10 KB
/
StreamHandlerTest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
<?php declare(strict_types=1);
/*
* This file is part of the Monolog package.
*
* (c) Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Monolog\Handler;
use Monolog\Handler\StreamHandler;
use Monolog\Test\TestCase;
use Monolog\Logger;
class StreamHandlerTest extends TestCase
{
public function tearDown(): void
{
parent::tearDown();
@unlink(__DIR__.'/test.log');
}
/**
* @covers Monolog\Handler\StreamHandler::__construct
* @covers Monolog\Handler\StreamHandler::write
*/
public function testWrite()
{
$handle = fopen('php://memory', 'a+');
$handler = new StreamHandler($handle);
$handler->setFormatter($this->getIdentityFormatter());
$handler->handle($this->getRecord(Logger::WARNING, 'test'));
$handler->handle($this->getRecord(Logger::WARNING, 'test2'));
$handler->handle($this->getRecord(Logger::WARNING, 'test3'));
fseek($handle, 0);
$this->assertEquals('testtest2test3', fread($handle, 100));
}
/**
* @covers Monolog\Handler\StreamHandler::close
*/
public function testCloseKeepsExternalHandlersOpen()
{
$handle = fopen('php://memory', 'a+');
$handler = new StreamHandler($handle);
$this->assertTrue(is_resource($handle));
$handler->close();
$this->assertTrue(is_resource($handle));
}
/**
* @covers Monolog\Handler\StreamHandler::close
*/
public function testHandlerOwnedHandlesAreClosedAfterEachWrite()
{
$handler = new StreamHandler(__DIR__.'/test.log');
$handler->handle($this->getRecord(Logger::WARNING, 'test'));
$stream = $handler->getStream();
$this->assertFalse(is_resource($stream));
}
/**
* @covers Monolog\Handler\StreamHandler::close
*/
public function testHandlerOwnedHandlesAreClosedAfterEachBatchWrite()
{
$handler = new StreamHandler(__DIR__.'/test.log');
$handler->handleBatch([$this->getRecord(Logger::WARNING, 'test')]);
$stream = $handler->getStream();
$this->assertFalse(is_resource($stream));
}
/**
* @covers Monolog\Handler\StreamHandler::close
* @covers Monolog\Handler\Handler::__sleep
*/
public function testSerialization()
{
$handler = new StreamHandler('php://memory');
$handler->handle($this->getRecord(Logger::WARNING, 'testfoo'));
$stream = $handler->getStream();
$this->assertTrue(is_resource($stream));
fseek($stream, 0);
$this->assertStringContainsString('testfoo', stream_get_contents($stream));
$serialized = serialize($handler);
$this->assertFalse(is_resource($stream));
$handler = unserialize($serialized);
$handler->handle($this->getRecord(Logger::WARNING, 'testbar'));
$stream = $handler->getStream();
$this->assertTrue(is_resource($stream));
fseek($stream, 0);
$contents = stream_get_contents($stream);
$this->assertStringNotContainsString('testfoo', $contents);
$this->assertStringContainsString('testbar', $contents);
}
/**
* @covers Monolog\Handler\StreamHandler::write
*/
public function testWriteCreatesTheStreamResource()
{
$handler = new StreamHandler('php://memory');
$handler->handle($this->getRecord());
}
/**
* @covers Monolog\Handler\StreamHandler::__construct
* @covers Monolog\Handler\StreamHandler::write
*/
public function testWriteLocking()
{
$temp = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'monolog_locked_log';
$handler = new StreamHandler($temp, Logger::DEBUG, true, null, true);
$handler->handle($this->getRecord());
}
/**
* @covers Monolog\Handler\StreamHandler::__construct
* @covers Monolog\Handler\StreamHandler::write
*/
public function testWriteMissingResource()
{
$this->expectException(\LogicException::class);
$handler = new StreamHandler(null);
$handler->handle($this->getRecord());
}
public function invalidArgumentProvider()
{
return [
[1],
[[]],
[['bogus://url']],
];
}
/**
* @dataProvider invalidArgumentProvider
* @covers Monolog\Handler\StreamHandler::__construct
*/
public function testWriteInvalidArgument($invalidArgument)
{
$this->expectException(\InvalidArgumentException::class);
$handler = new StreamHandler($invalidArgument);
}
/**
* @covers Monolog\Handler\StreamHandler::__construct
* @covers Monolog\Handler\StreamHandler::write
*/
public function testWriteInvalidResource()
{
$this->expectException(\UnexpectedValueException::class);
$php7xMessage = <<<STRING
The stream or file "bogus://url" could not be opened in append mode: failed to open stream: No such file or directory
The exception occurred while attempting to log: test
Context: {"foo":"bar"}
Extra: [1,2,3]
STRING;
$php8xMessage = <<<STRING
The stream or file "bogus://url" could not be opened in append mode: Failed to open stream: No such file or directory
The exception occurred while attempting to log: test
Context: {"foo":"bar"}
Extra: [1,2,3]
STRING;
$phpVersionString = phpversion();
$phpVersionComponents = explode('.', $phpVersionString);
$majorVersion = (int) $phpVersionComponents[0];
$this->expectExceptionMessage(($majorVersion >= 8) ? $php8xMessage : $php7xMessage);
$handler = new StreamHandler('bogus://url');
$record = $this->getRecord();
$record['context'] = ['foo' => 'bar'];
$record['extra'] = [1, 2, 3];
$handler->handle($record);
}
/**
* @covers Monolog\Handler\StreamHandler::__construct
* @covers Monolog\Handler\StreamHandler::write
*/
public function testWriteNonExistingResource()
{
$this->expectException(\UnexpectedValueException::class);
$handler = new StreamHandler('ftp://foo/bar/baz/'.rand(0, 10000));
$handler->handle($this->getRecord());
}
/**
* @covers Monolog\Handler\StreamHandler::__construct
* @covers Monolog\Handler\StreamHandler::write
*/
public function testWriteNonExistingPath()
{
$handler = new StreamHandler(sys_get_temp_dir().'/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000));
$handler->handle($this->getRecord());
}
/**
* @covers Monolog\Handler\StreamHandler::__construct
* @covers Monolog\Handler\StreamHandler::write
*/
public function testWriteNonExistingFileResource()
{
$handler = new StreamHandler('file://'.sys_get_temp_dir().'/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000));
$handler->handle($this->getRecord());
}
/**
* @covers Monolog\Handler\StreamHandler::__construct
* @covers Monolog\Handler\StreamHandler::write
* @dataProvider provideNonExistingAndNotCreatablePath
*/
public function testWriteNonExistingAndNotCreatablePath($nonExistingAndNotCreatablePath)
{
if (defined('PHP_WINDOWS_VERSION_BUILD')) {
$this->markTestSkipped('Permissions checks can not run on windows');
}
$handler = null;
try {
$handler = new StreamHandler($nonExistingAndNotCreatablePath);
} catch (\Exception $fail) {
$this->fail(
'A non-existing and not creatable path should throw an Exception earliest on first write.
Not during instantiation.'
);
}
$this->expectException(\UnexpectedValueException::class);
$this->expectExceptionMessage('There is no existing directory at');
$handler->handle($this->getRecord());
}
public function provideNonExistingAndNotCreatablePath()
{
return [
'/foo/bar/…' => [
'/foo/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000),
],
'file:///foo/bar/…' => [
'file:///foo/bar/'.rand(0, 10000).DIRECTORY_SEPARATOR.rand(0, 10000),
],
];
}
public function provideMemoryValues()
{
return [
['1M', (int) (1024*1024/10)],
['10M', (int) (1024*1024)],
['1024M', (int) (1024*1024*1024/10)],
['1G', (int) (1024*1024*1024/10)],
['2000M', (int) (2000*1024*1024/10)],
['2050M', (int) (2050*1024*1024/10)],
['2048M', (int) (2048*1024*1024/10)],
['3G', (int) (3*1024*1024*1024/10)],
['2560M', (int) (2560*1024*1024/10)],
];
}
/**
* @dataProvider provideMemoryValues
* @return void
*/
public function testPreventOOMError($phpMemory, $expectedChunkSize)
{
$previousValue = ini_set('memory_limit', $phpMemory);
if ($previousValue === false) {
$this->markTestSkipped('We could not set a memory limit that would trigger the error.');
}
try {
$stream = tmpfile();
if ($stream === false) {
$this->markTestSkipped('We could not create a temp file to be use as a stream.');
}
$handler = new StreamHandler($stream);
stream_get_contents($stream, 1024);
$this->assertEquals($expectedChunkSize, $handler->getStreamChunkSize());
} finally {
ini_set('memory_limit', $previousValue);
}
}
/**
* @return void
*/
public function testSimpleOOMPrevention()
{
$previousValue = ini_set('memory_limit', '2048M');
if ($previousValue === false) {
$this->markTestSkipped('We could not set a memory limit that would trigger the error.');
}
try {
$stream = tmpfile();
new StreamHandler($stream);
stream_get_contents($stream);
$this->assertTrue(true);
} finally {
ini_set('memory_limit', $previousValue);
}
}
}