File: AttributeBasedAutowiringTest.php

package info (click to toggle)
php-di 7.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,932 kB
  • sloc: php: 10,572; makefile: 42; xml: 17; sh: 10; pascal: 5
file content (301 lines) | stat: -rw-r--r-- 12,282 bytes parent folder | download | duplicates (2)
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
<?php

declare(strict_types=1);

namespace DI\Test\UnitTest\Definition\Source;

use DI\Definition\Definition;
use DI\Definition\Exception\InvalidAttribute;
use DI\Definition\ObjectDefinition;
use DI\Definition\ObjectDefinition\MethodInjection;
use DI\Definition\ObjectDefinition\PropertyInjection;
use DI\Definition\Reference;
use DI\Definition\Source\AttributeBasedAutowiring;
use DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixture2;
use DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixture3;
use DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixture4;
use DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixture5;
use DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixtureChild;
use DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixtureScalarTypedProperty;
use DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixtureTypedProperties;
use DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationInjectableFixture;
use DI\Test\UnitTest\Definition\Source\Fixtures\AttributeFixture;
use DI\Test\UnitTest\Definition\Source\Fixtures\AttributeFixturePromotedProperty;
use PHPUnit\Framework\TestCase;

/**
 * @covers \DI\Definition\Source\AttributeBasedAutowiring
 */
#[\PHPUnit\Framework\Attributes\CoversClass(\DI\Definition\Source\AttributeBasedAutowiring::class)]
class AttributeBasedAutowiringTest extends TestCase
{
    public function testUnknownClass()
    {
        $this->assertNull((new AttributeBasedAutowiring)->autowire('foo'));
    }

    public function testProperty1()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);
        $this->assertInstanceOf(Definition::class, $definition);

        $properties = $definition->getPropertyInjections();
        $this->assertInstanceOf(PropertyInjection::class, $properties['property1']);

        $property = $properties['property1'];
        $this->assertSame('property1', $property->getPropertyName());
        $this->assertEquals(new Reference('foo'), $property->getValue());
    }

    public function testUnannotatedProperty()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);

        $this->assertNotHasPropertyInjection($definition, 'unannotatedProperty');
    }

    public function testStaticProperty()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);

        $this->assertNotHasPropertyInjection($definition, 'staticProperty');
    }

    public function testUnguessableProperty()
    {
        $this->expectException(InvalidAttribute::class);
        $this->expectExceptionMessage('#[Inject] found on property DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixture4::property but unable to guess what to inject, please add a type to the property');
        (new AttributeBasedAutowiring)->autowire(AnnotationFixture4::class);
    }

    public function testTypedProperty()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AnnotationFixtureTypedProperties::class);

        $this->assertNotHasPropertyInjection($definition, 'typeAndNoInject');
        $this->assertHasPropertyInjection($definition, 'typedAndInject', AnnotationFixture2::class);
        $this->assertHasPropertyInjection($definition, 'typedAndNamed', 'name');
    }

    public function testScalarTypedPropertiesFail()
    {
        $this->expectException(InvalidAttribute::class);
        (new AttributeBasedAutowiring)->autowire(AnnotationFixtureScalarTypedProperty::class);
    }

    public function testConstructor()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);
        $this->assertInstanceOf(Definition::class, $definition);

        $constructorInjection = $definition->getConstructorInjection();
        $this->assertInstanceOf(MethodInjection::class, $constructorInjection);

        $parameters = $constructorInjection->getParameters();
        $this->assertCount(2, $parameters);
        $this->assertEquals(new Reference('foo'), $parameters[0]);
        $this->assertEquals(new Reference('bar'), $parameters[1]);
    }

    public function testMethod1()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);
        $this->assertInstanceOf(Definition::class, $definition);

        $methodInjection = $this->getMethodInjection($definition, 'method1');
        $this->assertInstanceOf(MethodInjection::class, $methodInjection);

        $this->assertEmpty($methodInjection->getParameters());
    }

    public function testMethod2()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);
        $this->assertInstanceOf(Definition::class, $definition);

        $methodInjection = $this->getMethodInjection($definition, 'method2');
        $this->assertInstanceOf(MethodInjection::class, $methodInjection);

        $parameters = $methodInjection->getParameters();
        $this->assertCount(2, $parameters);
        $this->assertEquals(new Reference('foo'), $parameters[0]);
        $this->assertEquals(new Reference('bar'), $parameters[1]);
    }

    public function testMethod3()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);
        $this->assertInstanceOf(Definition::class, $definition);

        $methodInjection = $this->getMethodInjection($definition, 'method3');
        $this->assertInstanceOf(MethodInjection::class, $methodInjection);

        $parameters = $methodInjection->getParameters();
        $this->assertCount(1, $parameters);

        $reference = new Reference(AnnotationFixture2::class);
        $this->assertEquals($reference, $parameters[0]);
    }

    public function testMethod4()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);
        $this->assertInstanceOf(Definition::class, $definition);

        $methodInjection = $this->getMethodInjection($definition, 'method4');
        $this->assertInstanceOf(MethodInjection::class, $methodInjection);

        $parameters = $methodInjection->getParameters();
        $this->assertCount(2, $parameters);
        $this->assertEquals(new Reference('foo'), $parameters[0]);
        $this->assertEquals(new Reference('bar'), $parameters[1]);
    }

    public function testMethod5()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);
        $this->assertInstanceOf(Definition::class, $definition);

        $methodInjection = $this->getMethodInjection($definition, 'method5');
        $this->assertInstanceOf(MethodInjection::class, $methodInjection);

        $parameters = $methodInjection->getParameters();
        $this->assertCount(1, $parameters);

        // Offset is 1, not 0, because parameter 0 wasn't defined
        $this->assertEquals(new Reference('bar'), $parameters[1]);
    }

    public function testUnannotatedMethod()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);

        $this->assertNull($this->getMethodInjection($definition, 'unannotatedMethod'));
    }

    public function testOptionalParametersShouldBeIgnored()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);

        $methodInjection = $this->getMethodInjection($definition, 'optionalParameter');

        $parameters = $methodInjection->getParameters();
        $this->assertCount(1, $parameters);

        $this->assertEquals(new Reference('foo'), $parameters[0]);
        $this->assertArrayNotHasKey(1, $parameters);
    }

    public function testStaticMethod()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixture::class);

        $this->assertNull($this->getMethodInjection($definition, 'staticMethod'));
    }

    public function testInjectable()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AnnotationInjectableFixture::class);
        $this->assertInstanceOf(Definition::class, $definition);
        $this->assertTrue($definition->isLazy());
    }

    public function testMethodInjectionWithPrimitiveTypeCausesAnError()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AnnotationFixture3::class);
        $this->assertInstanceOf(Definition::class, $definition);

        $methodInjection = $this->getMethodInjection($definition, 'method1');
        $this->assertInstanceOf(MethodInjection::class, $methodInjection);

        $parameters = $methodInjection->getParameters();
        $this->assertCount(1, $parameters);
        $this->assertEquals(
            new Reference(AnnotationFixture2::class),
            $parameters[0]
        );
    }

    public function testFailWithTypeError()
    {
        $this->expectException(InvalidAttribute::class);
        $this->expectExceptionMessage('#[Inject] found on property DI\Test\UnitTest\Definition\Source\Fixtures\AnnotationFixture5::property but unable to guess what to inject, the type of the property does not look like a valid class or interface name');
        (new AttributeBasedAutowiring)->autowire(AnnotationFixture5::class);
    }

    public function testMergedWithParentDefinition()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AnnotationFixtureChild::class);

        $this->assertHasPropertyInjection($definition, 'propertyChild');
        $this->assertNotNull($this->getMethodInjection($definition, 'methodChild'));
        $this->assertHasPropertyInjection($definition, 'propertyParent');
        $this->assertNotNull($this->getMethodInjection($definition, 'methodParent'));
    }

    /**
     * It should read the private properties of the parent classes.
     *
     * @see https://github.com/mnapoli/PHP-DI/issues/257
     */
    public function testReadParentPrivateProperties()
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AnnotationFixtureChild::class);
        $this->assertHasPropertyInjection($definition, 'propertyParentPrivate');
    }

    public function testPromotedProperties(): void
    {
        $definition = (new AttributeBasedAutowiring)->autowire(AttributeFixturePromotedProperty::class);
        $this->assertNotHasPropertyInjection($definition, 'promotedProperty');

        $constructorInjection = $definition->getConstructorInjection();
        $this->assertInstanceOf(MethodInjection::class, $constructorInjection);

        $parameters = $constructorInjection->getParameters();
        $this->assertCount(1, $parameters);
        $this->assertEquals(new Reference('foo'), $parameters[0]);
    }

    private function getMethodInjection(ObjectDefinition $definition, $name) : ?MethodInjection
    {
        $methodInjections = $definition->getMethodInjections();
        foreach ($methodInjections as $methodInjection) {
            if ($methodInjection->getMethodName() === $name) {
                return $methodInjection;
            }
        }

        return null;
    }

    private function assertHasPropertyInjection(ObjectDefinition $definition, $propertyName, ?string $expectedType = null)
    {
        $propertyInjections = $definition->getPropertyInjections();
        foreach ($propertyInjections as $propertyInjection) {
            if ($propertyInjection->getPropertyName() === $propertyName) {
                if ($expectedType !== null) {
                    $this->assertInstanceOf(Reference::class, $propertyInjection->getValue());
                    $this->assertSame(
                        $expectedType,
                        $propertyInjection->getValue()->getTargetEntryName(),
                        'Property injected with the right type'
                    );
                }

                return;
            }
        }
        $this->fail('No property injection found for ' . $propertyName);
    }

    private function assertNotHasPropertyInjection(ObjectDefinition $definition, $propertyName)
    {
        $propertyInjections = $definition->getPropertyInjections();
        foreach ($propertyInjections as $propertyInjection) {
            if ($propertyInjection->getPropertyName() === $propertyName) {
                $this->fail('Unexpected property injection found for ' . $propertyName);
            }
        }
    }
}