class XmlFileLoaderTest

1. 9.x drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php \Symfony\Component\Routing\Tests\Loader\XmlFileLoaderTest
2. 9.x drupal/core/vendor/symfony/dependency-injection/Symfony/Component/DependencyInjection/Tests/Loader/XmlFileLoaderTest.php \Symfony\Component\DependencyInjection\Tests\Loader\XmlFileLoaderTest

class XmlFileLoaderTest 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/');
    require_once self::$fixturesPath . '/includes/foo.php';
    require_once self::$fixturesPath . '/includes/ProjectExtension.php';
    require_once self::$fixturesPath . '/includes/ProjectWithXsdExtension.php';
  }
  public function testLoad() {
    $loader = new XmlFileLoader(new ContainerBuilder(), new FileLocator(self::$fixturesPath . '/ini'));
    try {
      $loader
        ->load('foo.xml');
      $this
        ->fail('->load() throws an InvalidArgumentException if the loaded file does not exist');
    } catch (\Exception $e) {
      $this
        ->assertInstanceOf('\\InvalidArgumentException', $e, '->load() throws an InvalidArgumentException if the loaded file does not exist');
      $this
        ->assertStringStartsWith('The file "foo.xml" does not exist (in:', $e
        ->getMessage(), '->load() throws an InvalidArgumentException if the loaded file does not exist');
    }
  }
  public function testParseFile() {
    $loader = new XmlFileLoader(new ContainerBuilder(), new FileLocator(self::$fixturesPath . '/ini'));
    $r = new \ReflectionObject($loader);
    $m = $r
      ->getMethod('parseFile');
    $m
      ->setAccessible(true);
    try {
      $m
        ->invoke($loader, self::$fixturesPath . '/ini/parameters.ini');
      $this
        ->fail('->parseFile() throws an InvalidArgumentException if the loaded file is not a valid XML file');
    } catch (\Exception $e) {
      $this
        ->assertInstanceOf('\\InvalidArgumentException', $e, '->parseFile() throws an InvalidArgumentException if the loaded file is not a valid XML file');
      $this
        ->assertStringStartsWith('[ERROR 4] Start tag expected, \'<\' not found (in', $e
        ->getMessage(), '->parseFile() throws an InvalidArgumentException if the loaded file is not a valid XML file');
    }
    $loader = new XmlFileLoader(new ContainerBuilder(), new FileLocator(self::$fixturesPath . '/xml'));
    try {
      $m
        ->invoke($loader, self::$fixturesPath . '/xml/nonvalid.xml');
      $this
        ->fail('->parseFile() throws an InvalidArgumentException if the loaded file does not validate the XSD');
    } catch (\Exception $e) {
      $this
        ->assertInstanceOf('\\InvalidArgumentException', $e, '->parseFile() throws an InvalidArgumentException if the loaded file does not validate the XSD');
      $this
        ->assertStringStartsWith('[ERROR 1845] Element \'nonvalid\': No matching global declaration available for the validation root. (in', $e
        ->getMessage(), '->parseFile() throws an InvalidArgumentException if the loaded file does not validate the XSD');
    }
    $xml = $m
      ->invoke($loader, self::$fixturesPath . '/xml/services1.xml');
    $this
      ->assertEquals('Symfony\\Component\\DependencyInjection\\SimpleXMLElement', get_class($xml), '->parseFile() returns an SimpleXMLElement object');
  }
  public function testLoadParameters() {
    $container = new ContainerBuilder();
    $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml'));
    $loader
      ->load('services2.xml');
    $actual = $container
      ->getParameterBag()
      ->all();
    $expected = array(
      'a string',
      'foo' => 'bar',
      'values' => array(
        0,
        'integer' => 4,
        100 => null,
        'true',
        true,
        false,
        'on',
        'off',
        'float' => 1.3,
        1000.3,
        'a string',
        array(
          'foo',
          'bar',
        ),
      ),
      'foo_bar' => new Reference('foo_bar'),
      'mixedcase' => array(
        'MixedCaseKey' => 'value',
      ),
    );
    $this
      ->assertEquals($expected, $actual, '->load() converts XML values to PHP ones');
  }
  public function testLoadImports() {
    $container = new ContainerBuilder();
    $resolver = new LoaderResolver(array(
      new IniFileLoader($container, new FileLocator(self::$fixturesPath . '/xml')),
      new YamlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml')),
      $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml')),
    ));
    $loader
      ->setResolver($resolver);
    $loader
      ->load('services4.xml');
    $actual = $container
      ->getParameterBag()
      ->all();
    $expected = array(
      'a string',
      'foo' => 'bar',
      'values' => array(
        true,
        false,
      ),
      'foo_bar' => new Reference('foo_bar'),
      'mixedcase' => array(
        'MixedCaseKey' => 'value',
      ),
      'bar' => '%foo%',
      'imported_from_ini' => true,
      'imported_from_yaml' => true,
    );
    $this
      ->assertEquals(array_keys($expected), array_keys($actual), '->load() imports and merges imported files');

    // Bad import throws no exception due to ignore_errors value.
    $loader
      ->load('services4_bad_import.xml');
  }
  public function testLoadAnonymousServices() {
    $container = new ContainerBuilder();
    $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml'));
    $loader
      ->load('services5.xml');
    $services = $container
      ->getDefinitions();
    $this
      ->assertEquals(4, count($services), '->load() attributes unique ids to anonymous services');

    // anonymous service as an argument
    $args = $services['foo']
      ->getArguments();
    $this
      ->assertEquals(1, count($args), '->load() references anonymous services as "normal" ones');
    $this
      ->assertEquals('Symfony\\Component\\DependencyInjection\\Reference', get_class($args[0]), '->load() converts anonymous services to references to "normal" services');
    $this
      ->assertTrue(isset($services[(string) $args[0]]), '->load() makes a reference to the created ones');
    $inner = $services[(string) $args[0]];
    $this
      ->assertEquals('BarClass', $inner
      ->getClass(), '->load() uses the same configuration as for the anonymous ones');

    // inner anonymous services
    $args = $inner
      ->getArguments();
    $this
      ->assertEquals(1, count($args), '->load() references anonymous services as "normal" ones');
    $this
      ->assertEquals('Symfony\\Component\\DependencyInjection\\Reference', get_class($args[0]), '->load() converts anonymous services to references to "normal" services');
    $this
      ->assertTrue(isset($services[(string) $args[0]]), '->load() makes a reference to the created ones');
    $inner = $services[(string) $args[0]];
    $this
      ->assertEquals('BazClass', $inner
      ->getClass(), '->load() uses the same configuration as for the anonymous ones');

    // anonymous service as a property
    $properties = $services['foo']
      ->getProperties();
    $property = $properties['p'];
    $this
      ->assertEquals('Symfony\\Component\\DependencyInjection\\Reference', get_class($property), '->load() converts anonymous services to references to "normal" services');
    $this
      ->assertTrue(isset($services[(string) $property]), '->load() makes a reference to the created ones');
    $inner = $services[(string) $property];
    $this
      ->assertEquals('BazClass', $inner
      ->getClass(), '->load() uses the same configuration as for the anonymous ones');
  }
  public function testLoadServices() {
    $container = new ContainerBuilder();
    $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml'));
    $loader
      ->load('services6.xml');
    $services = $container
      ->getDefinitions();
    $this
      ->assertTrue(isset($services['foo']), '->load() parses <service> elements');
    $this
      ->assertEquals('Symfony\\Component\\DependencyInjection\\Definition', get_class($services['foo']), '->load() converts <service> element to Definition instances');
    $this
      ->assertEquals('FooClass', $services['foo']
      ->getClass(), '->load() parses the class attribute');
    $this
      ->assertEquals('container', $services['scope.container']
      ->getScope());
    $this
      ->assertEquals('custom', $services['scope.custom']
      ->getScope());
    $this
      ->assertEquals('prototype', $services['scope.prototype']
      ->getScope());
    $this
      ->assertEquals('getInstance', $services['constructor']
      ->getFactoryMethod(), '->load() parses the factory-method attribute');
    $this
      ->assertEquals('%path%/foo.php', $services['file']
      ->getFile(), '->load() parses the file tag');
    $this
      ->assertEquals(array(
      'foo',
      new Reference('foo'),
      array(
        true,
        false,
      ),
    ), $services['arguments']
      ->getArguments(), '->load() parses the argument tags');
    $this
      ->assertEquals('sc_configure', $services['configurator1']
      ->getConfigurator(), '->load() parses the configurator tag');
    $this
      ->assertEquals(array(
      new Reference('baz', ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE, false),
      'configure',
    ), $services['configurator2']
      ->getConfigurator(), '->load() parses the configurator tag');
    $this
      ->assertEquals(array(
      'BazClass',
      'configureStatic',
    ), $services['configurator3']
      ->getConfigurator(), '->load() parses the configurator tag');
    $this
      ->assertEquals(array(
      array(
        'setBar',
        array(),
      ),
    ), $services['method_call1']
      ->getMethodCalls(), '->load() parses the method_call tag');
    $this
      ->assertEquals(array(
      array(
        'setBar',
        array(
          'foo',
          new Reference('foo'),
          array(
            true,
            false,
          ),
        ),
      ),
    ), $services['method_call2']
      ->getMethodCalls(), '->load() parses the method_call tag');
    $this
      ->assertNull($services['factory_service']
      ->getClass());
    $this
      ->assertEquals('getInstance', $services['factory_service']
      ->getFactoryMethod());
    $this
      ->assertEquals('baz_factory', $services['factory_service']
      ->getFactoryService());
    $aliases = $container
      ->getAliases();
    $this
      ->assertTrue(isset($aliases['alias_for_foo']), '->load() parses <service> elements');
    $this
      ->assertEquals('foo', (string) $aliases['alias_for_foo'], '->load() parses aliases');
    $this
      ->assertTrue($aliases['alias_for_foo']
      ->isPublic());
    $this
      ->assertTrue(isset($aliases['another_alias_for_foo']));
    $this
      ->assertEquals('foo', (string) $aliases['another_alias_for_foo']);
    $this
      ->assertFalse($aliases['another_alias_for_foo']
      ->isPublic());
  }
  public function testConvertDomElementToArray() {
    $doc = new \DOMDocument("1.0");
    $doc
      ->loadXML('<foo>bar</foo>');
    $this
      ->assertEquals('bar', XmlFileLoader::convertDomElementToArray($doc->documentElement), '::convertDomElementToArray() converts a \\DomElement to an array');
    $doc = new \DOMDocument("1.0");
    $doc
      ->loadXML('<foo foo="bar" />');
    $this
      ->assertEquals(array(
      'foo' => 'bar',
    ), XmlFileLoader::convertDomElementToArray($doc->documentElement), '::convertDomElementToArray() converts a \\DomElement to an array');
    $doc = new \DOMDocument("1.0");
    $doc
      ->loadXML('<foo><foo>bar</foo></foo>');
    $this
      ->assertEquals(array(
      'foo' => 'bar',
    ), XmlFileLoader::convertDomElementToArray($doc->documentElement), '::convertDomElementToArray() converts a \\DomElement to an array');
    $doc = new \DOMDocument("1.0");
    $doc
      ->loadXML('<foo><foo>bar<foo>bar</foo></foo></foo>');
    $this
      ->assertEquals(array(
      'foo' => array(
        'value' => 'bar',
        'foo' => 'bar',
      ),
    ), XmlFileLoader::convertDomElementToArray($doc->documentElement), '::convertDomElementToArray() converts a \\DomElement to an array');
    $doc = new \DOMDocument("1.0");
    $doc
      ->loadXML('<foo><foo></foo></foo>');
    $this
      ->assertEquals(array(
      'foo' => null,
    ), XmlFileLoader::convertDomElementToArray($doc->documentElement), '::convertDomElementToArray() converts a \\DomElement to an array');
    $doc = new \DOMDocument("1.0");
    $doc
      ->loadXML('<foo><foo><!-- foo --></foo></foo>');
    $this
      ->assertEquals(array(
      'foo' => null,
    ), XmlFileLoader::convertDomElementToArray($doc->documentElement), '::convertDomElementToArray() converts a \\DomElement to an array');
    $doc = new \DOMDocument("1.0");
    $doc
      ->loadXML('<foo><foo foo="bar"/><foo foo="bar"/></foo>');
    $this
      ->assertEquals(array(
      'foo' => array(
        array(
          'foo' => 'bar',
        ),
        array(
          'foo' => 'bar',
        ),
      ),
    ), XmlFileLoader::convertDomElementToArray($doc->documentElement), '::convertDomElementToArray() converts a \\DomElement to an array');
  }
  public function testExtensions() {
    $container = new ContainerBuilder();
    $container
      ->registerExtension(new \ProjectExtension());
    $container
      ->registerExtension(new \ProjectWithXsdExtension());
    $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml'));

    // extension without an XSD
    $loader
      ->load('extensions/services1.xml');
    $container
      ->compile();
    $services = $container
      ->getDefinitions();
    $parameters = $container
      ->getParameterBag()
      ->all();
    $this
      ->assertTrue(isset($services['project.service.bar']), '->load() parses extension elements');
    $this
      ->assertTrue(isset($parameters['project.parameter.bar']), '->load() parses extension elements');
    $this
      ->assertEquals('BAR', $services['project.service.foo']
      ->getClass(), '->load() parses extension elements');
    $this
      ->assertEquals('BAR', $parameters['project.parameter.foo'], '->load() parses extension elements');

    // extension with an XSD
    $container = new ContainerBuilder();
    $container
      ->registerExtension(new \ProjectExtension());
    $container
      ->registerExtension(new \ProjectWithXsdExtension());
    $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml'));
    $loader
      ->load('extensions/services2.xml');
    $container
      ->compile();
    $services = $container
      ->getDefinitions();
    $parameters = $container
      ->getParameterBag()
      ->all();
    $this
      ->assertTrue(isset($services['project.service.bar']), '->load() parses extension elements');
    $this
      ->assertTrue(isset($parameters['project.parameter.bar']), '->load() parses extension elements');
    $this
      ->assertEquals('BAR', $services['project.service.foo']
      ->getClass(), '->load() parses extension elements');
    $this
      ->assertEquals('BAR', $parameters['project.parameter.foo'], '->load() parses extension elements');
    $container = new ContainerBuilder();
    $container
      ->registerExtension(new \ProjectExtension());
    $container
      ->registerExtension(new \ProjectWithXsdExtension());
    $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml'));

    // extension with an XSD (does not validate)
    try {
      $loader
        ->load('extensions/services3.xml');
      $this
        ->fail('->load() throws an InvalidArgumentException if the configuration does not validate the XSD');
    } catch (\Exception $e) {
      $this
        ->assertInstanceOf('\\InvalidArgumentException', $e, '->load() throws an InvalidArgumentException if the configuration does not validate the XSD');
      $this
        ->assertRegexp('/The attribute \'bar\' is not allowed/', $e
        ->getMessage(), '->load() throws an InvalidArgumentException if the configuration does not validate the XSD');
    }

    // non-registered extension
    try {
      $loader
        ->load('extensions/services4.xml');
      $this
        ->fail('->load() throws an InvalidArgumentException if the tag is not valid');
    } catch (\Exception $e) {
      $this
        ->assertInstanceOf('\\InvalidArgumentException', $e, '->load() throws an InvalidArgumentException if the tag is not valid');
      $this
        ->assertStringStartsWith('There is no extension able to load the configuration for "project:bar" (in', $e
        ->getMessage(), '->load() throws an InvalidArgumentException if the tag is not valid');
    }
  }
  public function testExtensionInPhar() {
    if (extension_loaded('suhosin') && false === strpos(ini_get('suhosin.executor.include.whitelist'), 'phar')) {
      $this
        ->markTestSkipped('To run this test, add "phar" to the "suhosin.executor.include.whitelist" settings in your php.ini file.');
    }
    require_once self::$fixturesPath . '/includes/ProjectWithXsdExtensionInPhar.phar';

    // extension with an XSD in PHAR archive
    $container = new ContainerBuilder();
    $container
      ->registerExtension(new \ProjectWithXsdExtensionInPhar());
    $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml'));
    $loader
      ->load('extensions/services6.xml');

    // extension with an XSD in PHAR archive (does not validate)
    try {
      $loader
        ->load('extensions/services7.xml');
      $this
        ->fail('->load() throws an InvalidArgumentException if the configuration does not validate the XSD');
    } catch (\Exception $e) {
      $this
        ->assertInstanceOf('\\InvalidArgumentException', $e, '->load() throws an InvalidArgumentException if the configuration does not validate the XSD');
      $this
        ->assertRegexp('/The attribute \'bar\' is not allowed/', $e
        ->getMessage(), '->load() throws an InvalidArgumentException if the configuration does not validate the XSD');
    }
  }

  /**
   * @covers Symfony\Component\DependencyInjection\Loader\XmlFileLoader::supports
   */
  public function testSupports() {
    $loader = new XmlFileLoader(new ContainerBuilder(), new FileLocator());
    $this
      ->assertTrue($loader
      ->supports('foo.xml'), '->supports() returns true if the resource is loadable');
    $this
      ->assertFalse($loader
      ->supports('foo.foo'), '->supports() returns true if the resource is loadable');
  }
  public function testNoNamingConflictsForAnonymousServices() {
    $container = new ContainerBuilder();
    $loader1 = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml/extension1'));
    $loader1
      ->load('services.xml');
    $services = $container
      ->getDefinitions();
    $this
      ->assertEquals(2, count($services), '->load() attributes unique ids to anonymous services');
    $loader2 = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml/extension2'));
    $loader2
      ->load('services.xml');
    $services = $container
      ->getDefinitions();
    $this
      ->assertEquals(4, count($services), '->load() attributes unique ids to anonymous services');
    $services = $container
      ->getDefinitions();
    $args1 = $services['extension1.foo']
      ->getArguments();
    $inner1 = $services[(string) $args1[0]];
    $this
      ->assertEquals('BarClass1', $inner1
      ->getClass(), '->load() uses the same configuration as for the anonymous ones');
    $args2 = $services['extension2.foo']
      ->getArguments();
    $inner2 = $services[(string) $args2[0]];
    $this
      ->assertEquals('BarClass2', $inner2
      ->getClass(), '->load() uses the same configuration as for the anonymous ones');
  }

  /**
   * @expectedException \InvalidArgumentException
   * @expectedExceptionMessage Document types are not allowed.
   */
  public function testDocTypeIsNotAllowed() {
    $container = new ContainerBuilder();
    $loader1 = new XmlFileLoader($container, new FileLocator(self::$fixturesPath . '/xml'));
    $loader1
      ->load('withdoctype.xml');
  }

}