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
|
<?php
declare(strict_types=1);
namespace ProxyManagerTest\GeneratorStrategy;
use PHPUnit\Framework\TestCase;
use ProxyManager\Exception\FileNotWritableException;
use ProxyManager\FileLocator\FileLocatorInterface;
use ProxyManager\Generator\ClassGenerator;
use ProxyManager\Generator\Util\UniqueIdentifierGenerator;
use ProxyManager\GeneratorStrategy\FileWriterGeneratorStrategy;
use function class_exists;
use function clearstatcache;
use function decoct;
use function fileperms;
use function mkdir;
use function rmdir;
use function scandir;
use function strpos;
use function sys_get_temp_dir;
use function tempnam;
use function umask;
use function uniqid;
use function unlink;
use const SCANDIR_SORT_ASCENDING;
/**
* Tests for {@see \ProxyManager\GeneratorStrategy\FileWriterGeneratorStrategy}
*
* @group Coverage
* @covers \ProxyManager\GeneratorStrategy\FileWriterGeneratorStrategy
*
* Note: this test generates temporary files that are not deleted
*/
final class FileWriterGeneratorStrategyTest extends TestCase
{
private $tempDir;
protected function setUp(): void
{
parent::setUp();
$this->tempDir = tempnam(sys_get_temp_dir(), 'FileWriterGeneratorStrategyTest');
unlink($this->tempDir);
mkdir($this->tempDir);
}
public function testGenerate(): void
{
$locator = $this->createMock(FileLocatorInterface::class);
$generator = new FileWriterGeneratorStrategy($locator);
$tmpFile = $this->tempDir . '/' . uniqid('FileWriterGeneratorStrategyTest', true) . '.php';
$namespace = 'Foo';
$className = UniqueIdentifierGenerator::getIdentifier('Bar');
$fqcn = $namespace . '\\' . $className;
$locator
->method('getProxyFileName')
->with($fqcn)
->will(self::returnValue($tmpFile));
$body = $generator->generate(new ClassGenerator($fqcn));
self::assertGreaterThan(0, strpos($body, $className));
self::assertFalse(class_exists($fqcn, false));
self::assertFileExists($tmpFile);
self::assertFileIsReadable($tmpFile);
// a user note on php.net recommended calling this as we have just called chmod on a file.
clearstatcache();
// Calculate the permission that should have been set.
// The operators below are bit-wise "AND" (&) and "NOT" (~), read more at: http://php.net/manual/en/language.operators.bitwise.php
$perm = 0666 & ~umask();
self::assertSame($perm, fileperms($tmpFile) & 0777, 'File permission was not correct: ' . decoct($perm));
/* @noinspection PhpIncludeInspection */
require $tmpFile;
self::assertTrue(class_exists($fqcn, false));
}
public function testGenerateWillFailIfTmpFileCannotBeWrittenToDisk(): void
{
$tmpDirPath = $this->tempDir . '/' . uniqid('nonWritable', true);
mkdir($tmpDirPath, 0555, true);
$locator = $this->createMock(FileLocatorInterface::class);
$generator = new FileWriterGeneratorStrategy($locator);
$tmpFile = $tmpDirPath . '/' . uniqid('FileWriterGeneratorStrategyFailedFileWriteTest', true) . '.php';
$namespace = 'Foo';
$className = UniqueIdentifierGenerator::getIdentifier('Bar');
$fqcn = $namespace . '\\' . $className;
$locator
->method('getProxyFileName')
->with($fqcn)
->willReturn($tmpFile);
$this->expectException(FileNotWritableException::class);
$generator->generate(new ClassGenerator($fqcn));
}
public function testGenerateWillFailIfTmpFileCannotBeMovedToFinalDestination(): void
{
$locator = $this->createMock(FileLocatorInterface::class);
$generator = new FileWriterGeneratorStrategy($locator);
$tmpFile = $this->tempDir . '/' . uniqid('FileWriterGeneratorStrategyFailedFileMoveTest', true) . '.php';
$namespace = 'Foo';
$className = UniqueIdentifierGenerator::getIdentifier('Bar');
$fqcn = $namespace . '\\' . $className;
$locator
->method('getProxyFileName')
->with($fqcn)
->willReturn($tmpFile);
mkdir($tmpFile);
$this->expectException(FileNotWritableException::class);
$generator->generate(new ClassGenerator($fqcn));
}
public function testWhenFailingAllTemporaryFilesAreRemoved(): void
{
$tmpDirPath = $this->tempDir . '/' . uniqid('noTempFilesLeftBehind', true);
mkdir($tmpDirPath);
$locator = $this->createMock(FileLocatorInterface::class);
$generator = new FileWriterGeneratorStrategy($locator);
$tmpFile = $tmpDirPath . '/' . uniqid('FileWriterGeneratorStrategyFailedFileMoveTest', true) . '.php';
$namespace = 'Foo';
$className = UniqueIdentifierGenerator::getIdentifier('Bar');
$fqcn = $namespace . '\\' . $className;
$locator
->method('getProxyFileName')
->with($fqcn)
->willReturn($tmpFile);
mkdir($tmpFile);
try {
$generator->generate(new ClassGenerator($fqcn));
self::fail('An exception was supposed to be thrown');
} catch (FileNotWritableException $exception) {
rmdir($tmpFile);
self::assertEquals(['.', '..'], scandir($tmpDirPath, SCANDIR_SORT_ASCENDING));
}
}
}
|
