ed6267d562
This PR was merged into the 3.2-dev branch.
Discussion
----------
[DependencyInjection] deprecate access to private shared services.
| Q | A
| ------------- | ---
| Branch? | master
| Bug fix? | no
| New feature? | no
| BC breaks? | no
| Deprecations? | yes
| Tests pass? | yes
| Fixed tickets | #19117
| License | MIT
| Doc PR | ~
Commits
-------
4ed70c4
[DependencyInjection] deprecate access to private shared services. Fixes issue #19117.
420 lines
17 KiB
PHP
420 lines
17 KiB
PHP
<?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\DependencyInjection\Tests;
|
|
|
|
use Symfony\Bridge\PhpUnit\ErrorAssert;
|
|
use Symfony\Component\DependencyInjection\Container;
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
|
|
|
|
class ContainerTest extends \PHPUnit_Framework_TestCase
|
|
{
|
|
public function testConstructor()
|
|
{
|
|
$sc = new Container();
|
|
$this->assertSame($sc, $sc->get('service_container'), '__construct() automatically registers itself as a service');
|
|
|
|
$sc = new Container(new ParameterBag(array('foo' => 'bar')));
|
|
$this->assertEquals(array('foo' => 'bar'), $sc->getParameterBag()->all(), '__construct() takes an array of parameters as its first argument');
|
|
}
|
|
|
|
/**
|
|
* @dataProvider dataForTestCamelize
|
|
*/
|
|
public function testCamelize($id, $expected)
|
|
{
|
|
$this->assertEquals($expected, Container::camelize($id), sprintf('Container::camelize("%s")', $id));
|
|
}
|
|
|
|
public function dataForTestCamelize()
|
|
{
|
|
return array(
|
|
array('foo_bar', 'FooBar'),
|
|
array('foo.bar', 'Foo_Bar'),
|
|
array('foo.bar_baz', 'Foo_BarBaz'),
|
|
array('foo._bar', 'Foo_Bar'),
|
|
array('foo_.bar', 'Foo_Bar'),
|
|
array('_foo', 'Foo'),
|
|
array('.foo', '_Foo'),
|
|
array('foo_', 'Foo'),
|
|
array('foo.', 'Foo_'),
|
|
array('foo\bar', 'Foo_Bar'),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider dataForTestUnderscore
|
|
*/
|
|
public function testUnderscore($id, $expected)
|
|
{
|
|
$this->assertEquals($expected, Container::underscore($id), sprintf('Container::underscore("%s")', $id));
|
|
}
|
|
|
|
public function dataForTestUnderscore()
|
|
{
|
|
return array(
|
|
array('FooBar', 'foo_bar'),
|
|
array('Foo_Bar', 'foo.bar'),
|
|
array('Foo_BarBaz', 'foo.bar_baz'),
|
|
array('FooBar_BazQux', 'foo_bar.baz_qux'),
|
|
array('_Foo', '.foo'),
|
|
array('Foo_', 'foo.'),
|
|
);
|
|
}
|
|
|
|
public function testCompile()
|
|
{
|
|
$sc = new Container(new ParameterBag(array('foo' => 'bar')));
|
|
$this->assertFalse($sc->getParameterBag()->isResolved(), '->compile() resolves the parameter bag');
|
|
$sc->compile();
|
|
$this->assertTrue($sc->getParameterBag()->isResolved(), '->compile() resolves the parameter bag');
|
|
$this->assertInstanceOf('Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag', $sc->getParameterBag(), '->compile() changes the parameter bag to a FrozenParameterBag instance');
|
|
$this->assertEquals(array('foo' => 'bar'), $sc->getParameterBag()->all(), '->compile() copies the current parameters to the new parameter bag');
|
|
}
|
|
|
|
public function testIsFrozen()
|
|
{
|
|
$sc = new Container(new ParameterBag(array('foo' => 'bar')));
|
|
$this->assertFalse($sc->isFrozen(), '->isFrozen() returns false if the parameters are not frozen');
|
|
$sc->compile();
|
|
$this->assertTrue($sc->isFrozen(), '->isFrozen() returns true if the parameters are frozen');
|
|
}
|
|
|
|
public function testGetParameterBag()
|
|
{
|
|
$sc = new Container();
|
|
$this->assertEquals(array(), $sc->getParameterBag()->all(), '->getParameterBag() returns an empty array if no parameter has been defined');
|
|
}
|
|
|
|
public function testGetSetParameter()
|
|
{
|
|
$sc = new Container(new ParameterBag(array('foo' => 'bar')));
|
|
$sc->setParameter('bar', 'foo');
|
|
$this->assertEquals('foo', $sc->getParameter('bar'), '->setParameter() sets the value of a new parameter');
|
|
|
|
$sc->setParameter('foo', 'baz');
|
|
$this->assertEquals('baz', $sc->getParameter('foo'), '->setParameter() overrides previously set parameter');
|
|
|
|
$sc->setParameter('Foo', 'baz1');
|
|
$this->assertEquals('baz1', $sc->getParameter('foo'), '->setParameter() converts the key to lowercase');
|
|
$this->assertEquals('baz1', $sc->getParameter('FOO'), '->getParameter() converts the key to lowercase');
|
|
|
|
try {
|
|
$sc->getParameter('baba');
|
|
$this->fail('->getParameter() thrown an \InvalidArgumentException if the key does not exist');
|
|
} catch (\Exception $e) {
|
|
$this->assertInstanceOf('\InvalidArgumentException', $e, '->getParameter() thrown an \InvalidArgumentException if the key does not exist');
|
|
$this->assertEquals('You have requested a non-existent parameter "baba".', $e->getMessage(), '->getParameter() thrown an \InvalidArgumentException if the key does not exist');
|
|
}
|
|
}
|
|
|
|
public function testGetServiceIds()
|
|
{
|
|
$sc = new Container();
|
|
$sc->set('foo', $obj = new \stdClass());
|
|
$sc->set('bar', $obj = new \stdClass());
|
|
$this->assertEquals(array('service_container', 'foo', 'bar'), $sc->getServiceIds(), '->getServiceIds() returns all defined service ids');
|
|
|
|
$sc = new ProjectServiceContainer();
|
|
$sc->set('foo', $obj = new \stdClass());
|
|
$this->assertEquals(array('internal', 'bar', 'foo_bar', 'foo.baz', 'circular', 'throw_exception', 'throws_exception_on_service_configuration', 'service_container', 'foo'), $sc->getServiceIds(), '->getServiceIds() returns defined service ids by getXXXService() methods, followed by service ids defined by set()');
|
|
}
|
|
|
|
public function testSet()
|
|
{
|
|
$sc = new Container();
|
|
$sc->set('foo', $foo = new \stdClass());
|
|
$this->assertEquals($foo, $sc->get('foo'), '->set() sets a service');
|
|
}
|
|
|
|
public function testSetWithNullResetTheService()
|
|
{
|
|
$sc = new Container();
|
|
$sc->set('foo', null);
|
|
$this->assertFalse($sc->has('foo'), '->set() with null service resets the service');
|
|
}
|
|
|
|
public function testSetReplacesAlias()
|
|
{
|
|
$c = new ProjectServiceContainer();
|
|
|
|
$c->set('alias', $foo = new \stdClass());
|
|
$this->assertSame($foo, $c->get('alias'), '->set() replaces an existing alias');
|
|
}
|
|
|
|
public function testGet()
|
|
{
|
|
$sc = new ProjectServiceContainer();
|
|
$sc->set('foo', $foo = new \stdClass());
|
|
$this->assertEquals($foo, $sc->get('foo'), '->get() returns the service for the given id');
|
|
$this->assertEquals($foo, $sc->get('Foo'), '->get() returns the service for the given id, and converts id to lowercase');
|
|
$this->assertEquals($sc->__bar, $sc->get('bar'), '->get() returns the service for the given id');
|
|
$this->assertEquals($sc->__foo_bar, $sc->get('foo_bar'), '->get() returns the service if a get*Method() is defined');
|
|
$this->assertEquals($sc->__foo_baz, $sc->get('foo.baz'), '->get() returns the service if a get*Method() is defined');
|
|
$this->assertEquals($sc->__foo_baz, $sc->get('foo\\baz'), '->get() returns the service if a get*Method() is defined');
|
|
|
|
$sc->set('bar', $bar = new \stdClass());
|
|
$this->assertEquals($bar, $sc->get('bar'), '->get() prefers to return a service defined with set() than one defined with a getXXXMethod()');
|
|
|
|
try {
|
|
$sc->get('');
|
|
$this->fail('->get() throws a \InvalidArgumentException exception if the service is empty');
|
|
} catch (\Exception $e) {
|
|
$this->assertInstanceOf('Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException', $e, '->get() throws a ServiceNotFoundException exception if the service is empty');
|
|
}
|
|
$this->assertNull($sc->get('', ContainerInterface::NULL_ON_INVALID_REFERENCE), '->get() returns null if the service is empty');
|
|
}
|
|
|
|
public function testGetThrowServiceNotFoundException()
|
|
{
|
|
$sc = new ProjectServiceContainer();
|
|
$sc->set('foo', $foo = new \stdClass());
|
|
$sc->set('bar', $foo = new \stdClass());
|
|
$sc->set('baz', $foo = new \stdClass());
|
|
|
|
try {
|
|
$sc->get('foo1');
|
|
$this->fail('->get() throws an Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException if the key does not exist');
|
|
} catch (\Exception $e) {
|
|
$this->assertInstanceOf('Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException', $e, '->get() throws an Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException if the key does not exist');
|
|
$this->assertEquals('You have requested a non-existent service "foo1". Did you mean this: "foo"?', $e->getMessage(), '->get() throws an Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException with some advices');
|
|
}
|
|
|
|
try {
|
|
$sc->get('bag');
|
|
$this->fail('->get() throws an Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException if the key does not exist');
|
|
} catch (\Exception $e) {
|
|
$this->assertInstanceOf('Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException', $e, '->get() throws an Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException if the key does not exist');
|
|
$this->assertEquals('You have requested a non-existent service "bag". Did you mean one of these: "bar", "baz"?', $e->getMessage(), '->get() throws an Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException with some advices');
|
|
}
|
|
}
|
|
|
|
public function testGetCircularReference()
|
|
{
|
|
$sc = new ProjectServiceContainer();
|
|
try {
|
|
$sc->get('circular');
|
|
$this->fail('->get() throws a ServiceCircularReferenceException if it contains circular reference');
|
|
} catch (\Exception $e) {
|
|
$this->assertInstanceOf('\Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException', $e, '->get() throws a ServiceCircularReferenceException if it contains circular reference');
|
|
$this->assertStringStartsWith('Circular reference detected for service "circular"', $e->getMessage(), '->get() throws a \LogicException if it contains circular reference');
|
|
}
|
|
}
|
|
|
|
public function testHas()
|
|
{
|
|
$sc = new ProjectServiceContainer();
|
|
$sc->set('foo', new \stdClass());
|
|
$this->assertFalse($sc->has('foo1'), '->has() returns false if the service does not exist');
|
|
$this->assertTrue($sc->has('foo'), '->has() returns true if the service exists');
|
|
$this->assertTrue($sc->has('bar'), '->has() returns true if a get*Method() is defined');
|
|
$this->assertTrue($sc->has('foo_bar'), '->has() returns true if a get*Method() is defined');
|
|
$this->assertTrue($sc->has('foo.baz'), '->has() returns true if a get*Method() is defined');
|
|
$this->assertTrue($sc->has('foo\\baz'), '->has() returns true if a get*Method() is defined');
|
|
}
|
|
|
|
public function testInitialized()
|
|
{
|
|
$sc = new ProjectServiceContainer();
|
|
$sc->set('foo', new \stdClass());
|
|
$this->assertTrue($sc->initialized('foo'), '->initialized() returns true if service is loaded');
|
|
$this->assertFalse($sc->initialized('foo1'), '->initialized() returns false if service is not loaded');
|
|
$this->assertFalse($sc->initialized('bar'), '->initialized() returns false if a service is defined, but not currently loaded');
|
|
$this->assertFalse($sc->initialized('alias'), '->initialized() returns false if an aliased service is not initialized');
|
|
|
|
$sc->set('bar', new \stdClass());
|
|
$this->assertTrue($sc->initialized('alias'), '->initialized() returns true for alias if aliased service is initialized');
|
|
}
|
|
|
|
public function testReset()
|
|
{
|
|
$c = new Container();
|
|
$c->set('bar', new \stdClass());
|
|
|
|
$c->reset();
|
|
|
|
$this->assertNull($c->get('bar', ContainerInterface::NULL_ON_INVALID_REFERENCE));
|
|
}
|
|
|
|
/**
|
|
* @expectedException \Exception
|
|
* @expectedExceptionMessage Something went terribly wrong!
|
|
*/
|
|
public function testGetThrowsException()
|
|
{
|
|
$c = new ProjectServiceContainer();
|
|
|
|
try {
|
|
$c->get('throw_exception');
|
|
} catch (\Exception $e) {
|
|
// Do nothing.
|
|
}
|
|
|
|
// Retry, to make sure that get*Service() will be called.
|
|
$c->get('throw_exception');
|
|
}
|
|
|
|
public function testGetThrowsExceptionOnServiceConfiguration()
|
|
{
|
|
$c = new ProjectServiceContainer();
|
|
|
|
try {
|
|
$c->get('throws_exception_on_service_configuration');
|
|
} catch (\Exception $e) {
|
|
// Do nothing.
|
|
}
|
|
|
|
$this->assertFalse($c->initialized('throws_exception_on_service_configuration'));
|
|
|
|
// Retry, to make sure that get*Service() will be called.
|
|
try {
|
|
$c->get('throws_exception_on_service_configuration');
|
|
} catch (\Exception $e) {
|
|
// Do nothing.
|
|
}
|
|
$this->assertFalse($c->initialized('throws_exception_on_service_configuration'));
|
|
}
|
|
|
|
protected function getField($obj, $field)
|
|
{
|
|
$reflection = new \ReflectionProperty($obj, $field);
|
|
$reflection->setAccessible(true);
|
|
|
|
return $reflection->getValue($obj);
|
|
}
|
|
|
|
public function testAlias()
|
|
{
|
|
$c = new ProjectServiceContainer();
|
|
|
|
$this->assertTrue($c->has('alias'));
|
|
$this->assertSame($c->get('alias'), $c->get('bar'));
|
|
}
|
|
|
|
public function testThatCloningIsNotSupported()
|
|
{
|
|
$class = new \ReflectionClass('Symfony\Component\DependencyInjection\Container');
|
|
$clone = $class->getMethod('__clone');
|
|
$this->assertFalse($class->isCloneable());
|
|
$this->assertTrue($clone->isPrivate());
|
|
}
|
|
|
|
/** @group legacy */
|
|
public function testUnsetInternalPrivateServiceIsDeprecated()
|
|
{
|
|
$deprecations = array(
|
|
'Unsetting the "internal" private service is deprecated since Symfony 3.2 and won\'t be supported anymore in Symfony 4.0.',
|
|
);
|
|
|
|
ErrorAssert::assertDeprecationsAreTriggered($deprecations, function () {
|
|
$c = new ProjectServiceContainer();
|
|
$c->set('internal', null);
|
|
});
|
|
}
|
|
|
|
/** @group legacy */
|
|
public function testChangeInternalPrivateServiceIsDeprecated()
|
|
{
|
|
$deprecations = array(
|
|
'Setting the "internal" private service is deprecated since Symfony 3.2 and won\'t be supported anymore in Symfony 4.0. A new public service will be created instead.',
|
|
);
|
|
|
|
ErrorAssert::assertDeprecationsAreTriggered($deprecations, function () {
|
|
$c = new ProjectServiceContainer();
|
|
$c->set('internal', new \stdClass());
|
|
});
|
|
}
|
|
|
|
/** @group legacy */
|
|
public function testCheckExistenceOfAnInternalPrivateServiceIsDeprecated()
|
|
{
|
|
$deprecations = array(
|
|
'Checking for the existence of the "internal" private service is deprecated since Symfony 3.2 and won\'t be supported anymore in Symfony 4.0.',
|
|
);
|
|
|
|
ErrorAssert::assertDeprecationsAreTriggered($deprecations, function () {
|
|
$c = new ProjectServiceContainer();
|
|
$c->has('internal');
|
|
});
|
|
}
|
|
|
|
/** @group legacy */
|
|
public function testRequestAnInternalSharedPrivateServiceIsDeprecated()
|
|
{
|
|
$deprecations = array(
|
|
'Requesting the "internal" private service is deprecated since Symfony 3.2 and won\'t be supported anymore in Symfony 4.0.',
|
|
);
|
|
|
|
ErrorAssert::assertDeprecationsAreTriggered($deprecations, function () {
|
|
$c = new ProjectServiceContainer();
|
|
$c->get('internal');
|
|
});
|
|
}
|
|
}
|
|
|
|
class ProjectServiceContainer extends Container
|
|
{
|
|
public $__bar;
|
|
public $__foo_bar;
|
|
public $__foo_baz;
|
|
public $__internal;
|
|
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
|
|
$this->__bar = new \stdClass();
|
|
$this->__foo_bar = new \stdClass();
|
|
$this->__foo_baz = new \stdClass();
|
|
$this->__internal = new \stdClass();
|
|
$this->privates = array('internal' => true);
|
|
$this->aliases = array('alias' => 'bar');
|
|
}
|
|
|
|
protected function getInternalService()
|
|
{
|
|
return $this->__internal;
|
|
}
|
|
|
|
protected function getBarService()
|
|
{
|
|
return $this->__bar;
|
|
}
|
|
|
|
protected function getFooBarService()
|
|
{
|
|
return $this->__foo_bar;
|
|
}
|
|
|
|
protected function getFoo_BazService()
|
|
{
|
|
return $this->__foo_baz;
|
|
}
|
|
|
|
protected function getCircularService()
|
|
{
|
|
return $this->get('circular');
|
|
}
|
|
|
|
protected function getThrowExceptionService()
|
|
{
|
|
throw new \Exception('Something went terribly wrong!');
|
|
}
|
|
|
|
protected function getThrowsExceptionOnServiceConfigurationService()
|
|
{
|
|
$this->services['throws_exception_on_service_configuration'] = $instance = new \stdClass();
|
|
|
|
throw new \Exception('Something was terribly wrong while trying to configure the service!');
|
|
}
|
|
}
|