-
-
Notifications
You must be signed in to change notification settings - Fork 155
/
IncludeInterceptorTest.php
228 lines (186 loc) · 7.12 KB
/
IncludeInterceptorTest.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
<?php
/**
* This code is licensed under the BSD 3-Clause License.
*
* Copyright (c) 2017-2019, Maks Rafalko
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
declare(strict_types=1);
namespace Infection\Tests\StreamWrapper;
use Infection\StreamWrapper\IncludeInterceptor;
/**
* @internal
*
* Tests IncludeInterceptor for correct operation.
*
* We mainly interested in methods, essential to interception:
*
* stream_close
* stream_eof
* stream_open
* stream_read
* stream_stat
* url_stat
*
* Other methods are not essential for interception to work,
* but still are required to be implemented by a full wrapper
*/
final class IncludeInterceptorTest extends \PHPUnit\Framework\TestCase
{
private static $files = [];
public static function setUpBeforeClass(): void
{
foreach (range(1, 3) as $number) {
$tempnam = tempnam('', basename(__FILE__, 'php'));
file_put_contents($tempnam, "<?php return $number;");
self::$files[$number] = $tempnam;
}
}
public static function tearDownAfterClass(): void
{
/*
* We need to always disable so not to interfere with other tests
* if any of our tests fail for any reason.
*
* Silenced a warning here: stream_wrapper_restore(): file:// was never changed, nothing to restore
* (this warning will never happen in normal circumstances)
*/
@IncludeInterceptor::disable();
array_map('unlink', self::$files);
}
/**
* @runInSeparateProcess
* @preserveGlobalState disabled
*/
public function test_it_throws_an_exception_if_not_configured(): void
{
$this->expectException(\RuntimeException::class);
IncludeInterceptor::enable();
}
public function test_it_throws_an_exception_if_target_not_exists(): void
{
$this->expectException(\InvalidArgumentException::class);
IncludeInterceptor::intercept('', '');
}
public function test_it_throws_an_exception_if_destination_not_exists(): void
{
$this->expectException(\InvalidArgumentException::class);
IncludeInterceptor::intercept(self::$files[1], '');
}
public function test_it_not_intercepts_when_not_included(): void
{
$before = file_get_contents(self::$files[1]);
// Sanity check
$this->assertStringContainsString('1', $before);
IncludeInterceptor::intercept(self::$files[1], self::$files[2]);
IncludeInterceptor::enable();
$after = file_get_contents(self::$files[1]);
IncludeInterceptor::disable();
$this->assertSame($before, $after);
}
public function test_it_intercepts_file_with_another(): void
{
$before = include self::$files[1];
$this->assertSame(1, $before);
IncludeInterceptor::intercept(self::$files[1], self::$files[2]);
IncludeInterceptor::enable();
$after = include self::$files[1];
IncludeInterceptor::disable();
$expected = include self::$files[2];
$this->assertNotSame($before, $after);
$this->assertSame($after, $expected);
}
public function test_it_does_not_intercept_file_where_should_not(): void
{
$before = include self::$files[3];
$this->assertSame(3, $before);
IncludeInterceptor::intercept(self::$files[1], self::$files[2]);
IncludeInterceptor::enable();
$after = include self::$files[3];
IncludeInterceptor::disable();
$this->assertSame($before, $after);
}
public function test_passthrough_file_methods_pass(): void
{
if (\PHP_SAPI === 'phpdbg') {
$this->markTestSkipped('Running this test on PHPDBG has issues with FD_SETSIZE. Consider removing this if that issue has been fixed.');
}
IncludeInterceptor::intercept(self::$files[1], self::$files[2]);
IncludeInterceptor::enable();
/*
* PHP will give a warning if our stream wrapper
* cannot handle any of these
*/
$tempnam = tempnam('', basename(__FILE__, 'php'));
$fp = fopen($tempnam, 'w+');
flock($fp, LOCK_EX);
fwrite($fp, 'test');
fseek($fp, 0);
$this->assertSame('test', fread($fp, 4));
ftruncate($fp, 0);
$streams = [$fp];
stream_select($streams, $streams, $streams, 0);
stream_set_blocking($fp, false);
stream_set_timeout($fp, 0);
stream_set_write_buffer($fp, 0);
stream_set_read_buffer($fp, 0);
fclose($fp);
$this->assertSame(0, stat($tempnam)['size']);
touch($tempnam);
touch($tempnam, time());
chown($tempnam, stat($tempnam)['uid']);
chgrp($tempnam, stat($tempnam)['gid']);
chmod($tempnam, stat($tempnam)['mode']);
$newname = tempnam('', basename(__FILE__, 'php'));
rename($tempnam, $newname);
unlink($newname);
IncludeInterceptor::disable();
}
public function test_passthrough_dir_methods_pass(): void
{
IncludeInterceptor::intercept(self::$files[1], self::$files[2]);
IncludeInterceptor::enable();
/*
* PHP will give a warning if our stream wrapper
* cannot handle any of these
*/
$this->assertGreaterThan(0, \count(glob(__DIR__ . '/*')));
$tempnam = tempnam('', basename(__FILE__, 'php'));
unlink($tempnam);
mkdir($tempnam);
$fp = opendir($tempnam);
readdir($fp);
rewinddir($fp);
closedir($fp);
$newname = tempnam('', basename(__FILE__, 'php'));
unlink($newname);
rename($tempnam, $newname);
rmdir($newname);
IncludeInterceptor::disable();
}
}