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
|
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Config\Tests\Builder;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Config\Builder\ClassBuilder;
use Symfony\Component\Config\Builder\ConfigBuilderGenerator;
use Symfony\Component\Config\Builder\ConfigBuilderInterface;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\Tests\Builder\Fixtures\AddToList;
use Symfony\Component\Config\Tests\Builder\Fixtures\NodeInitialValues;
use Symfony\Component\DependencyInjection\Loader\Configurator\AbstractConfigurator;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Iterator\RecursiveDirectoryIterator;
use Symfony\Config\AddToListConfig;
/**
* Test to use the generated config and test its output.
*
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
*/
#[\PHPUnit\Framework\Attributes\CoversClass(\Symfony\Component\Config\Builder\ClassBuilder::class)]
#[\PHPUnit\Framework\Attributes\CoversClass(\Symfony\Component\Config\Builder\ConfigBuilderGenerator::class)]
#[\PHPUnit\Framework\Attributes\CoversClass(\Symfony\Component\Config\Builder\Method::class)]
#[\PHPUnit\Framework\Attributes\CoversClass(\Symfony\Component\Config\Builder\Property::class)]
class GeneratedConfigTest extends TestCase
{
private array $tempDir = [];
protected function setup(): void
{
parent::setup();
$this->tempDir = [];
}
protected function tearDown(): void
{
(new Filesystem())->remove($this->tempDir);
$this->tempDir = [];
parent::tearDown();
}
public static function fixtureNames()
{
$array = [
'ScalarNormalizedTypes' => 'scalar_normalized_types',
'PrimitiveTypes' => 'primitive_types',
'VariableType' => 'variable_type',
'AddToList' => 'add_to_list',
'NodeInitialValues' => 'node_initial_values',
'ArrayExtraKeys' => 'array_extra_keys',
'ArrayValues' => 'array_values',
];
foreach ($array as $name => $alias) {
yield $name => [$name, $alias];
}
/*
* Force load ContainerConfigurator to make env(), param() etc available
* and also check if symfony/dependency-injection is installed
*/
if (class_exists(ContainerConfigurator::class)) {
yield 'Placeholders' => ['Placeholders', 'placeholders'];
}
}
#[\PHPUnit\Framework\Attributes\DataProvider('fixtureNames')]
public function testConfig(string $name, string $alias)
{
$basePath = __DIR__.'/Fixtures/';
$configBuilder = $this->generateConfigBuilder('Symfony\\Component\\Config\\Tests\\Builder\\Fixtures\\'.$name);
$callback = include $basePath.$name.'.config.php';
$expectedOutput = include $basePath.$name.'.output.php';
$callback($configBuilder);
$this->assertInstanceOf(ConfigBuilderInterface::class, $configBuilder);
$this->assertSame($alias, $configBuilder->getExtensionAlias());
$output = $configBuilder->toArray();
if (class_exists(AbstractConfigurator::class)) {
$output = AbstractConfigurator::processValue($output);
}
$this->assertSame($expectedOutput, $output);
}
/**
* When you create a node, you can provide it with initial values. But the second
* time you call a node, it is not created, hence you cannot give it initial values.
*/
public function testSecondNodeWithInitialValuesThrowsException()
{
$configBuilder = $this->generateConfigBuilder(NodeInitialValues::class);
$configBuilder->someCleverName(['second' => 'foo']);
$this->expectException(InvalidConfigurationException::class);
$configBuilder->someCleverName(['first' => 'bar']);
}
/**
* When you create a named node, you can provide it with initial values. But
* the second time you call a node, it is not created, hence you cannot give
* it initial values.
*/
public function testSecondNamedNodeWithInitialValuesThrowsException()
{
/** @var AddToListConfig $configBuilder */
$configBuilder = $this->generateConfigBuilder(AddToList::class);
$messenger = $configBuilder->messenger();
$foo = $messenger->routing('foo', ['senders' => 'a']);
$bar = $messenger->routing('bar', ['senders' => 'b']);
$this->assertNotEquals($foo, $bar);
$foo2 = $messenger->routing('foo');
$this->assertEquals($foo, $foo2);
$this->expectException(InvalidConfigurationException::class);
$messenger->routing('foo', ['senders' => 'c']);
}
/**
* Make sure you pass values that are defined.
*/
public function testWrongInitialValues()
{
$configBuilder = $this->generateConfigBuilder(NodeInitialValues::class);
$this->expectException(InvalidConfigurationException::class);
$configBuilder->someCleverName(['not_exists' => 'foo']);
}
public function testSetExtraKeyMethodIsNotGeneratedWhenAllowExtraKeysIsFalse()
{
/** @var AddToListConfig $configBuilder */
$configBuilder = $this->generateConfigBuilder(AddToList::class);
$this->assertFalse(method_exists($configBuilder->translator(), 'set'));
$this->assertFalse(method_exists($configBuilder->messenger()->receiving(), 'set'));
}
/**
* Generate the ConfigBuilder or return an already generated instance.
*/
private function generateConfigBuilder(string $configurationClass, ?string $outputDir = null)
{
$outputDir ??= sys_get_temp_dir().\DIRECTORY_SEPARATOR.uniqid('sf_config_builder', true);
if (!str_contains($outputDir, __DIR__)) {
$this->tempDir[] = $outputDir;
}
$configuration = new $configurationClass();
$rootNode = $configuration->getConfigTreeBuilder()->buildTree();
$rootClass = new ClassBuilder('Symfony\\Config', $rootNode->getName());
if (class_exists($fqcn = $rootClass->getFqcn())) {
// Avoid generating the class again
return new $fqcn();
}
$loader = (new ConfigBuilderGenerator($outputDir))->build(new $configurationClass());
return $loader();
}
private function assertDirectorySame($expected, $current)
{
$expectedFiles = [];
foreach (new \RecursiveIteratorIterator(new RecursiveDirectoryIterator($expected, \FilesystemIterator::SKIP_DOTS)) as $file) {
if ($file->isDir()) {
continue;
}
$expectedFiles[substr($file->getPathname(), \strlen($expected))] = $file->getPathname();
}
$currentFiles = [];
foreach (new \RecursiveIteratorIterator(new RecursiveDirectoryIterator($current, \FilesystemIterator::SKIP_DOTS)) as $file) {
if ($file->isDir()) {
continue;
}
$currentFiles[substr($file->getPathname(), \strlen($current))] = $file->getPathname();
}
ksort($expectedFiles);
ksort($currentFiles);
$this->assertSame(array_keys($expectedFiles), array_keys($currentFiles));
foreach ($expectedFiles as $fileName => $filePath) {
$this->assertFileEquals($filePath, $currentFiles[$fileName]);
}
}
}
|
