PhpDumperTest.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\Dumper;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\DependencyInjection\Definition;
class PhpDumperTest extends \PHPUnit_Framework_TestCase {
  protected static $fixturesPath;
  protected function setUp() {
    if (!class_exists('Symfony\\Component\\Config\\Loader\\Loader')) {
      $this
        ->markTestSkipped('The "Config" component is not available');
    }
  }
  public static function setUpBeforeClass() {
    self::$fixturesPath = realpath(__DIR__ . '/../Fixtures/');
  }
  public function testDump() {
    $dumper = new PhpDumper($container = new ContainerBuilder());
    $this
      ->assertStringEqualsFile(self::$fixturesPath . '/php/services1.php', $dumper
      ->dump(), '->dump() dumps an empty container as an empty PHP class');
    $this
      ->assertStringEqualsFile(self::$fixturesPath . '/php/services1-1.php', $dumper
      ->dump(array(
      'class' => 'Container',
      'base_class' => 'AbstractContainer',
    )), '->dump() takes a class and a base_class options');
    $container = new ContainerBuilder();
    new PhpDumper($container);
  }
  public function testDumpFrozenContainerWithNoParameter() {
    $container = new ContainerBuilder();
    $container
      ->register('foo', 'stdClass');
    $container
      ->compile();
    $dumper = new PhpDumper($container);
    $dumpedString = $dumper
      ->dump();
    $this
      ->assertStringEqualsFile(self::$fixturesPath . '/php/services11.php', $dumpedString, '->dump() does not add getDefaultParameters() method call if container have no parameters.');
    $this
      ->assertNotRegexp("/function getDefaultParameters\\(/", $dumpedString, '->dump() does not add getDefaultParameters() method definition.');
  }
  public function testDumpOptimizationString() {
    $definition = new Definition();
    $definition
      ->setClass('stdClass');
    $definition
      ->addArgument(array(
      'only dot' => '.',
      'concatenation as value' => '.\'\'.',
      'concatenation from the start value' => '\'\'.',
      '.' => 'dot as a key',
      '.\'\'.' => 'concatenation as a key',
      '\'\'.' => 'concatenation from the start key',
      'optimize concatenation' => "string1%some_string%string2",
      'optimize concatenation with empty string' => "string1%empty_value%string2",
      'optimize concatenation from the start' => '%empty_value%start',
      'optimize concatenation at the end' => 'end%empty_value%',
    ));
    $container = new ContainerBuilder();
    $container
      ->setDefinition('test', $definition);
    $container
      ->setParameter('empty_value', '');
    $container
      ->setParameter('some_string', '-');
    $container
      ->compile();
    $dumper = new PhpDumper($container);
    $this
      ->assertStringEqualsFile(self::$fixturesPath . '/php/services10.php', $dumper
      ->dump(), '->dump() dumps an empty container as an empty PHP class');
  }

  /**
   * @expectedException InvalidArgumentException
   */
  public function testExportParameters() {
    $dumper = new PhpDumper(new ContainerBuilder(new ParameterBag(array(
      'foo' => new Reference('foo'),
    ))));
    $dumper
      ->dump();
  }
  public function testAddParameters() {
    $container = (include self::$fixturesPath . '/containers/container8.php');
    $dumper = new PhpDumper($container);
    $this
      ->assertStringEqualsFile(self::$fixturesPath . '/php/services8.php', $dumper
      ->dump(), '->dump() dumps parameters');
  }
  public function testAddService() {
    $container = (include self::$fixturesPath . '/containers/container9.php');
    $dumper = new PhpDumper($container);
    $this
      ->assertEquals(str_replace('%path%', str_replace('\\', '\\\\', self::$fixturesPath . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR), file_get_contents(self::$fixturesPath . '/php/services9.php')), $dumper
      ->dump(), '->dump() dumps services');
    $dumper = new PhpDumper($container = new ContainerBuilder());
    $container
      ->register('foo', 'FooClass')
      ->addArgument(new \stdClass());
    try {
      $dumper
        ->dump();
      $this
        ->fail('->dump() throws a RuntimeException if the container to be dumped has reference to objects or resources');
    } catch (\Exception $e) {
      $this
        ->assertInstanceOf('\\Symfony\\Component\\DependencyInjection\\Exception\\RuntimeException', $e, '->dump() throws a RuntimeException if the container to be dumped has reference to objects or resources');
      $this
        ->assertEquals('Unable to dump a service container if a parameter is an object or a resource.', $e
        ->getMessage(), '->dump() throws a RuntimeException if the container to be dumped has reference to objects or resources');
    }
  }
  public function testOverrideServiceWhenUsingADumpedContainer() {
    require_once self::$fixturesPath . '/php/services9.php';
    require_once self::$fixturesPath . '/includes/foo.php';
    $container = new \ProjectServiceContainer();
    $container
      ->set('bar', $bar = new \stdClass());
    $container
      ->setParameter('foo_bar', 'foo_bar');
    $this
      ->assertEquals($bar, $container
      ->get('bar'), '->set() overrides an already defined service');
  }
  public function testOverrideServiceWhenUsingADumpedContainerAndServiceIsUsedFromAnotherOne() {
    require_once self::$fixturesPath . '/php/services9.php';
    require_once self::$fixturesPath . '/includes/foo.php';
    require_once self::$fixturesPath . '/includes/classes.php';
    $container = new \ProjectServiceContainer();
    $container
      ->set('bar', $bar = new \stdClass());
    $this
      ->assertSame($bar, $container
      ->get('foo')->bar, '->set() overrides an already defined service');
  }

}