* @since 2.0 * @group di */ class ContainerTest extends TestCase { protected function tearDown() { parent::tearDown(); Yii::$container = new Container(); } public function testDefault() { $namespace = __NAMESPACE__ . '\stubs'; $QuxInterface = "$namespace\\QuxInterface"; $Foo = Foo::className(); $Bar = Bar::className(); $Qux = Qux::className(); // automatic wiring $container = new Container(); $container->set($QuxInterface, $Qux); $foo = $container->get($Foo); $this->assertInstanceOf($Foo, $foo); $this->assertInstanceOf($Bar, $foo->bar); $this->assertInstanceOf($Qux, $foo->bar->qux); $foo2 = $container->get($Foo); $this->assertNotSame($foo, $foo2); // full wiring $container = new Container(); $container->set($QuxInterface, $Qux); $container->set($Bar); $container->set($Qux); $container->set($Foo); $foo = $container->get($Foo); $this->assertInstanceOf($Foo, $foo); $this->assertInstanceOf($Bar, $foo->bar); $this->assertInstanceOf($Qux, $foo->bar->qux); // wiring by closure $container = new Container(); $container->set('foo', function () { $qux = new Qux(); $bar = new Bar($qux); return new Foo($bar); }); $foo = $container->get('foo'); $this->assertInstanceOf($Foo, $foo); $this->assertInstanceOf($Bar, $foo->bar); $this->assertInstanceOf($Qux, $foo->bar->qux); // wiring by closure which uses container $container = new Container(); $container->set($QuxInterface, $Qux); $container->set('foo', function (Container $c, $params, $config) { return $c->get(Foo::className()); }); $foo = $container->get('foo'); $this->assertInstanceOf($Foo, $foo); $this->assertInstanceOf($Bar, $foo->bar); $this->assertInstanceOf($Qux, $foo->bar->qux); // predefined constructor parameters $container = new Container(); $container->set('foo', $Foo, [Instance::of('bar')]); $container->set('bar', $Bar, [Instance::of('qux')]); $container->set('qux', $Qux); $foo = $container->get('foo'); $this->assertInstanceOf($Foo, $foo); $this->assertInstanceOf($Bar, $foo->bar); $this->assertInstanceOf($Qux, $foo->bar->qux); // predefined property parameters $fooSetter = FooProperty::className(); $barSetter = BarSetter::className(); $container = new Container(); $container->set('foo', ['class' => $fooSetter, 'bar' => Instance::of('bar')]); $container->set('bar', ['class' => $barSetter, 'qux' => Instance::of('qux')]); $container->set('qux', $Qux); $foo = $container->get('foo'); $this->assertInstanceOf($fooSetter, $foo); $this->assertInstanceOf($barSetter, $foo->bar); $this->assertInstanceOf($Qux, $foo->bar->qux); // wiring by closure $container = new Container(); $container->set('qux', new Qux()); $qux1 = $container->get('qux'); $qux2 = $container->get('qux'); $this->assertSame($qux1, $qux2); // config $container = new Container(); $container->set('qux', $Qux); $qux = $container->get('qux', [], ['a' => 2]); $this->assertEquals(2, $qux->a); $qux = $container->get('qux', [3]); $this->assertEquals(3, $qux->a); $qux = $container->get('qux', [3, ['a' => 4]]); $this->assertEquals(4, $qux->a); } public function testInvoke() { $this->mockApplication([ 'components' => [ 'qux' => [ 'class' => 'yiiunit\framework\di\stubs\Qux', 'a' => 'belongApp', ], 'qux2' => [ 'class' => 'yiiunit\framework\di\stubs\Qux', 'a' => 'belongAppQux2', ], ], ]); Yii::$container->set('yiiunit\framework\di\stubs\QuxInterface', [ 'class' => 'yiiunit\framework\di\stubs\Qux', 'a' => 'independent', ]); // use component of application $callback = function ($param, stubs\QuxInterface $qux, Bar $bar) { return [$param, $qux instanceof Qux, $qux->a, $bar->qux->a]; }; $result = Yii::$container->invoke($callback, ['D426']); $this->assertEquals(['D426', true, 'belongApp', 'independent'], $result); // another component of application $callback = function ($param, stubs\QuxInterface $qux2, $other = 'default') { return [$param, $qux2 instanceof Qux, $qux2->a, $other]; }; $result = Yii::$container->invoke($callback, ['M2792684']); $this->assertEquals(['M2792684', true, 'belongAppQux2', 'default'], $result); // component not belong application $callback = function ($param, stubs\QuxInterface $notBelongApp, $other) { return [$param, $notBelongApp instanceof Qux, $notBelongApp->a, $other]; }; $result = Yii::$container->invoke($callback, ['MDM', 'not_default']); $this->assertEquals(['MDM', true, 'independent', 'not_default'], $result); $myFunc = function ($a, NumberValidator $b, $c = 'default') { return [$a, \get_class($b), $c]; }; $result = Yii::$container->invoke($myFunc, ['a']); $this->assertEquals(['a', 'yii\validators\NumberValidator', 'default'], $result); $result = Yii::$container->invoke($myFunc, ['ok', 'value_of_c']); $this->assertEquals(['ok', 'yii\validators\NumberValidator', 'value_of_c'], $result); // use native php function $this->assertEquals(Yii::$container->invoke('trim', [' M2792684 ']), 'M2792684'); // use helper function $array = ['M36', 'D426', 'Y2684']; $this->assertFalse(Yii::$container->invoke(['yii\helpers\ArrayHelper', 'isAssociative'], [$array])); $myFunc = function (\yii\console\Request $request, \yii\console\Response $response) { return [$request, $response]; }; list($request, $response) = Yii::$container->invoke($myFunc); $this->assertEquals($request, Yii::$app->request); $this->assertEquals($response, Yii::$app->response); } public function testAssociativeInvoke() { $this->mockApplication([ 'components' => [ 'qux' => [ 'class' => 'yiiunit\framework\di\stubs\Qux', 'a' => 'belongApp', ], 'qux2' => [ 'class' => 'yiiunit\framework\di\stubs\Qux', 'a' => 'belongAppQux2', ], ], ]); $closure = function ($a, $b, $x = 5) { return $a > $b; }; $this->assertFalse(Yii::$container->invoke($closure, ['b' => 5, 'a' => 1])); $this->assertTrue(Yii::$container->invoke($closure, ['b' => 1, 'a' => 5])); } public function testResolveCallableDependencies() { $this->mockApplication([ 'components' => [ 'qux' => [ 'class' => 'yiiunit\framework\di\stubs\Qux', 'a' => 'belongApp', ], 'qux2' => [ 'class' => 'yiiunit\framework\di\stubs\Qux', 'a' => 'belongAppQux2', ], ], ]); $closure = function ($a, $b) { return $a > $b; }; $this->assertEquals([1, 5], Yii::$container->resolveCallableDependencies($closure, ['b' => 5, 'a' => 1])); $this->assertEquals([1, 5], Yii::$container->resolveCallableDependencies($closure, ['a' => 1, 'b' => 5])); $this->assertEquals([1, 5], Yii::$container->resolveCallableDependencies($closure, [1, 5])); } public function testOptionalDependencies() { $container = new Container(); // Test optional unresolvable dependency. $closure = function (QuxInterface $test = null) { return $test; }; $this->assertNull($container->invoke($closure)); } public function testSetDependencies() { $container = new Container(); $container->setDefinitions([ 'model.order' => Order::className(), Cat::className() => Type::className(), 'test\TraversableInterface' => [ ['class' => 'yiiunit\data\base\TraversableObject'], [['item1', 'item2']], ], 'qux.using.closure' => function () { return new Qux(); }, 'rollbar', 'baibaratsky\yii\rollbar\Rollbar' ]); $container->setDefinitions([]); $this->assertInstanceOf(Order::className(), $container->get('model.order')); $this->assertInstanceOf(Type::className(), $container->get(Cat::className())); $traversable = $container->get('test\TraversableInterface'); $this->assertInstanceOf('yiiunit\data\base\TraversableObject', $traversable); $this->assertEquals('item1', $traversable->current()); $this->assertInstanceOf('yiiunit\framework\di\stubs\Qux', $container->get('qux.using.closure')); try { $container->get('rollbar'); $this->fail('InvalidConfigException was not thrown'); } catch (\Exception $e) { $this->assertInstanceOf('yii\base\InvalidConfigException', $e); } } public function testStaticCall() { $container = new Container(); $container->setDefinitions([ 'qux' => [QuxFactory::className(), 'create'], ]); $qux = $container->get('qux'); $this->assertInstanceOf(Qux::className(), $qux); $this->assertSame(42, $qux->a); } public function testObject() { $container = new Container(); $container->setDefinitions([ 'qux' => new Qux(42), ]); $qux = $container->get('qux'); $this->assertInstanceOf(Qux::className(), $qux); $this->assertSame(42, $qux->a); } public function testDi3Compatibility() { $container = new Container(); $container->setDefinitions([ 'test\TraversableInterface' => [ '__class' => 'yiiunit\data\base\TraversableObject', '__construct()' => [['item1', 'item2']], ], 'qux' => [ '__class' => Qux::className(), 'a' => 42, ], ]); $qux = $container->get('qux'); $this->assertInstanceOf(Qux::className(), $qux); $this->assertSame(42, $qux->a); $traversable = $container->get('test\TraversableInterface'); $this->assertInstanceOf('yiiunit\data\base\TraversableObject', $traversable); $this->assertEquals('item1', $traversable->current()); } public function testInstanceOf() { $container = new Container(); $container->setDefinitions([ 'qux' => [ 'class' => Qux::className(), 'a' => 42, ], 'bar' => [ '__class' => Bar::className(), '__construct()' => [ Instance::of('qux') ], ], ]); $bar = $container->get('bar'); $this->assertInstanceOf(Bar::className(), $bar); $qux = $bar->qux; $this->assertInstanceOf(Qux::className(), $qux); $this->assertSame(42, $qux->a); } public function testReferencesInArrayInDependencies() { $quxInterface = 'yiiunit\framework\di\stubs\QuxInterface'; $container = new Container(); $container->resolveArrays = true; $container->setSingletons([ $quxInterface => [ 'class' => Qux::className(), 'a' => 42, ], 'qux' => Instance::of($quxInterface), 'bar' => [ 'class' => Bar::className(), ], 'corge' => [ '__class' => Corge::className(), '__construct()' => [ [ 'qux' => Instance::of('qux'), 'bar' => Instance::of('bar'), 'q33' => new Qux(33), ], ], ], ]); $corge = $container->get('corge'); $this->assertInstanceOf(Corge::className(), $corge); $qux = $corge->map['qux']; $this->assertInstanceOf(Qux::className(), $qux); $this->assertSame(42, $qux->a); $bar = $corge->map['bar']; $this->assertInstanceOf(Bar::className(), $bar); $this->assertSame($qux, $bar->qux); $q33 = $corge->map['q33']; $this->assertInstanceOf(Qux::className(), $q33); $this->assertSame(33, $q33->a); } public function testGetByInstance() { $container = new Container(); $container->setSingletons([ 'one' => Qux::className(), 'two' => Instance::of('one'), ]); $one = $container->get(Instance::of('one')); $two = $container->get(Instance::of('two')); $this->assertInstanceOf(Qux::className(), $one); $this->assertSame($one, $two); $this->assertSame($one, $container->get('one')); $this->assertSame($one, $container->get('two')); } public function testWithoutDefinition() { $container = new Container(); $one = $container->get(Qux::className()); $two = $container->get(Qux::className()); $this->assertInstanceOf(Qux::className(), $one); $this->assertInstanceOf(Qux::className(), $two); $this->assertSame(1, $one->a); $this->assertSame(1, $two->a); $this->assertNotSame($one, $two); } public function testGetByClassIndirectly() { $container = new Container(); $container->setSingletons([ 'qux' => Qux::className(), Qux::className() => [ 'a' => 42, ], ]); $qux = $container->get('qux'); $this->assertInstanceOf(Qux::className(), $qux); $this->assertSame(42, $qux->a); } /** * @expectedException \yii\base\InvalidConfigException */ public function testThrowingNotFoundException() { $container = new Container(); $container->get('non_existing'); } public function testContainerSingletons() { $container = new Container(); $container->setSingletons([ 'model.order' => Order::className(), 'test\TraversableInterface' => [ ['class' => 'yiiunit\data\base\TraversableObject'], [['item1', 'item2']], ], 'qux.using.closure' => function () { return new Qux(); }, ]); $container->setSingletons([]); $order = $container->get('model.order'); $sameOrder = $container->get('model.order'); $this->assertSame($order, $sameOrder); $traversable = $container->get('test\TraversableInterface'); $sameTraversable = $container->get('test\TraversableInterface'); $this->assertSame($traversable, $sameTraversable); $foo = $container->get('qux.using.closure'); $sameFoo = $container->get('qux.using.closure'); $this->assertSame($foo, $sameFoo); } /** * @requires PHP 5.6 */ public function testVariadicConstructor() { if (\defined('HHVM_VERSION')) { static::markTestSkipped('Can not test on HHVM because it does not support variadics.'); } $container = new Container(); $container->get('yiiunit\framework\di\stubs\Variadic'); } /** * @requires PHP 5.6 */ public function testVariadicCallable() { if (\defined('HHVM_VERSION')) { static::markTestSkipped('Can not test on HHVM because it does not support variadics.'); } require __DIR__ . '/testContainerWithVariadicCallable.php'; } /** * @see https://github.com/yiisoft/yii2/issues/18245 */ public function testDelayedInitializationOfSubArray() { $definitions = [ 'test' => [ 'class' => Corge::className(), '__construct()' => [ [Instance::of('setLater')], ], ], ]; $application = Yii::createObject([ '__class' => \yii\web\Application::className(), 'basePath' => __DIR__, 'id' => 'test', 'components' => [ 'request' => [ 'baseUrl' => '123' ], ], 'container' => [ 'definitions' => $definitions, ], ]); Yii::$container->set('setLater', new Qux()); Yii::$container->get('test'); } /** * @see https://github.com/yiisoft/yii2/issues/18304 */ public function testNulledConstructorParameters() { $alpha = (new Container())->get(Alpha::className()); $this->assertInstanceOf(Beta::className(), $alpha->beta); $this->assertNull($alpha->omega); $QuxInterface = __NAMESPACE__ . '\stubs\QuxInterface'; $container = new Container(); $container->set($QuxInterface, Qux::className()); $alpha = $container->get(Alpha::className()); $this->assertInstanceOf(Beta::className(), $alpha->beta); $this->assertInstanceOf($QuxInterface, $alpha->omega); $this->assertNull($alpha->unknown); $this->assertNull($alpha->color); $container = new Container(); $container->set(__NAMESPACE__ . '\stubs\AbstractColor', __NAMESPACE__ . '\stubs\Color'); $alpha = $container->get(Alpha::className()); $this->assertInstanceOf(__NAMESPACE__ . '\stubs\Color', $alpha->color); } /** * @see https://github.com/yiisoft/yii2/issues/18284 */ public function testNamedConstructorParameters() { $test = (new Container())->get(Car::className(), [ 'name' => 'Hello', 'color' => 'red', ]); $this->assertSame('Hello', $test->name); $this->assertSame('red', $test->color); } /** * @see https://github.com/yiisoft/yii2/issues/18284 */ public function testInvalidConstructorParameters() { $this->expectException('yii\base\InvalidConfigException'); $this->expectExceptionMessage('Dependencies indexed by name and by position in the same array are not allowed.'); (new Container())->get(Car::className(), [ 'color' => 'red', 'Hello', ]); } public function dataNotInstantiableException() { return [ [Bar::className()], [Kappa::className()], ]; } /** * @dataProvider dataNotInstantiableException * * @see https://github.com/yiisoft/yii2/pull/18379 * * @param string $class */ public function testNotInstantiableException($class) { $this->expectException('yii\di\NotInstantiableException'); (new Container())->get($class); } public function testNullTypeConstructorParameters() { if (PHP_VERSION_ID < 70100) { $this->markTestSkipped('Can not be tested on PHP < 7.1'); return; } $zeta = (new Container())->get(Zeta::className()); $this->assertInstanceOf(Beta::className(), $zeta->beta); $this->assertInstanceOf(Beta::className(), $zeta->betaNull); $this->assertNull($zeta->color); $this->assertNull($zeta->colorNull); $this->assertNull($zeta->qux); $this->assertNull($zeta->quxNull); $this->assertNull($zeta->unknown); $this->assertNull($zeta->unknownNull); } public function testUnionTypeWithNullConstructorParameters() { if (PHP_VERSION_ID < 80000) { $this->markTestSkipped('Can not be tested on PHP < 8.0'); return; } $unionType = (new Container())->get(UnionTypeNull::className()); $this->assertInstanceOf(UnionTypeNull::className(), $unionType); } public function testUnionTypeWithoutNullConstructorParameters() { if (PHP_VERSION_ID < 80000) { $this->markTestSkipped('Can not be tested on PHP < 8.0'); return; } $unionType = (new Container())->get(UnionTypeNotNull::className(), ['value' => 'a']); $this->assertInstanceOf(UnionTypeNotNull::className(), $unionType); $unionType = (new Container())->get(UnionTypeNotNull::className(), ['value' => 1]); $this->assertInstanceOf(UnionTypeNotNull::className(), $unionType); $unionType = (new Container())->get(UnionTypeNotNull::className(), ['value' => 2.3]); $this->assertInstanceOf(UnionTypeNotNull::className(), $unionType); $unionType = (new Container())->get(UnionTypeNotNull::className(), ['value' => true]); $this->assertInstanceOf(UnionTypeNotNull::className(), $unionType); $this->expectException('TypeError'); (new Container())->get(UnionTypeNotNull::className()); } public function testUnionTypeWithClassConstructorParameters() { if (PHP_VERSION_ID < 80000) { $this->markTestSkipped('Can not be tested on PHP < 8.0'); return; } $unionType = (new Container())->get(UnionTypeWithClass::className(), ['value' => new Beta()]); $this->assertInstanceOf(UnionTypeWithClass::className(), $unionType); $this->assertInstanceOf(Beta::className(), $unionType->value); $this->expectException('TypeError'); (new Container())->get(UnionTypeNotNull::className()); } public function testResolveCallableDependenciesUnionTypes() { if (PHP_VERSION_ID < 80000) { $this->markTestSkipped('Can not be tested on PHP < 8.0'); return; } $this->mockApplication([ 'components' => [ Beta::className(), ], ]); Yii::$container->set('yiiunit\framework\di\stubs\QuxInterface', [ 'class' => Qux::className(), ]); $className = 'yiiunit\framework\di\stubs\StaticMethodsWithUnionTypes'; $params = Yii::$container->resolveCallableDependencies([$className, 'withBetaUnion']); $this->assertInstanceOf(Beta::classname(), $params[0]); $params = Yii::$container->resolveCallableDependencies([$className, 'withBetaUnionInverse']); $this->assertInstanceOf(Beta::classname(), $params[0]); $params = Yii::$container->resolveCallableDependencies([$className, 'withBetaAndQuxUnion']); $this->assertInstanceOf(Beta::classname(), $params[0]); $params = Yii::$container->resolveCallableDependencies([$className, 'withQuxAndBetaUnion']); $this->assertInstanceOf(Qux::classname(), $params[0]); } public function testResolveCallableDependenciesIntersectionTypes() { if (PHP_VERSION_ID < 80100) { $this->markTestSkipped('Can not be tested on PHP < 8.1'); return; } Yii::$container->set('yiiunit\framework\di\stubs\QuxInterface', [ 'class' => Qux::className(), ]); $className = 'yiiunit\framework\di\stubs\StaticMethodsWithIntersectionTypes'; $params = Yii::$container->resolveCallableDependencies([$className, 'withQuxInterfaceAndQuxAnotherIntersection']); $this->assertInstanceOf(Qux::classname(), $params[0]); $params = Yii::$container->resolveCallableDependencies([$className, 'withQuxAnotherAndQuxInterfaceIntersection']); $this->assertInstanceOf(QuxAnother::classname(), $params[0]); } }