SimpleXmlTest.php in Migrate Plus 8.5

Namespace

Drupal\Tests\migrate_plus\Kernel\Plugin\migrate_plus\data_parser

File

tests/src/Kernel/Plugin/migrate_plus/data_parser/SimpleXmlTest.php

<?php

namespace Drupal\Tests\migrate_plus\Kernel\Plugin\migrate_plus\data_parser;

use Drupal\KernelTests\KernelTestBase;
use Drupal\migrate\MigrateException;

/**
 * Test of the data_parser SimpleXml migrate_plus plugin.
 *
 * @group migrate_plus
 */
class SimpleXmlTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'migrate',
    'migrate_plus',
  ];

  /**
   * Path for the xml file.
   *
   * @var string
   */
  protected $path;

  /**
   * The plugin manager.
   *
   * @var \Drupal\migrate_plus\DataParserPluginManager
   */
  protected $pluginManager;

  /**
   * The plugin configuration.
   *
   * @var array
   */
  protected $configuration;

  /**
   * The expected result.
   *
   * @var array
   */
  protected $expected;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->path = $this->container
      ->get('module_handler')
      ->getModule('migrate_plus')
      ->getPath();
    $this->pluginManager = $this->container
      ->get('plugin.manager.migrate_plus.data_parser');
    $this->configuration = [
      'plugin' => 'url',
      'data_fetcher_plugin' => 'file',
      'data_parser_plugin' => 'simple_xml',
      'destination' => 'node',
      'urls' => [],
      'ids' => [
        'id' => [
          'type' => 'integer',
        ],
      ],
      'fields' => [
        [
          'name' => 'id',
          'label' => 'Id',
          'selector' => '@id',
        ],
        [
          'name' => 'values',
          'label' => 'Values',
          'selector' => 'values',
        ],
      ],
      'item_selector' => '/items/item',
    ];
    $this->expected = [
      [
        'Value 1',
        'Value 2',
      ],
      [
        'Value 1 (single)',
      ],
    ];
  }

  /**
   * Tests reducing single values.
   */
  public function testReduceSingleValue() : void {
    $url = $this->path . '/tests/data/simple_xml_reduce_single_value.xml';
    $this->configuration['urls'][0] = $url;
    $parser = $this->pluginManager
      ->createInstance('simple_xml', $this->configuration);
    $this
      ->assertResults($this->expected, $parser);
  }

  /**
   * Test reading non standard conforming XML.
   *
   * XML file with lots of different white spaces before the starting tag.
   */
  public function testReadNonStandardXmlWhitespace() : void {
    $url = $this->path . '/tests/data/simple_xml_invalid_multi_whitespace.xml';
    $this->configuration['urls'][0] = $url;
    $parser = $this->pluginManager
      ->createInstance('simple_xml', $this->configuration);
    $this
      ->assertResults($this->expected, $parser);
  }

  /**
   * Test reading non standard conforming XML .
   *
   * XML file with one empty line before the starting tag.
   */
  public function testReadNonStandardXml2() : void {
    $url = $this->path . '/tests/data/simple_xml_invalid_single_line.xml';
    $this->configuration['urls'][0] = $url;
    $parser = $this->pluginManager
      ->createInstance('simple_xml', $this->configuration);
    $this
      ->assertResults($this->expected, $parser);
  }

  /**
   * Test reading broken XML (missing closing tag).
   *
   * @throws \Drupal\Migrate\MigrateException
   */
  public function testReadBrokenXmlMissingTag() : void {
    $url = $this->path . '/tests/data/simple_xml_broken_missing_tag.xml';
    $this->configuration['urls'][0] = $url;
    $this
      ->expectException(MigrateException::class);

    // Newer versions of libxml mark it as an error 76, older ones as 73.
    $this
      ->expectExceptionMessageMatches('/^Fatal Error 7[0-9]/');
    $parser = $this->pluginManager
      ->createInstance('simple_xml', $this->configuration);
    $parser
      ->next();
  }

  /**
   * Test reading broken XML (tag mismatch).
   *
   * @throws \Drupal\Migrate\MigrateException
   */
  public function testReadBrokenXmlTagMismatch() : void {
    $url = $this->path . '/tests/data/simple_xml_broken_tag_mismatch.xml';
    $this->configuration['urls'][0] = $url;
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessageMatches('/^Fatal Error 76/');
    $parser = $this->pluginManager
      ->createInstance('simple_xml', $this->configuration);
    $parser
      ->next();
  }

  /**
   * Test reading non XML.
   *
   * @throws \Drupal\Migrate\MigrateException
   */
  public function testReadNonXml() : void {
    $url = $this->path . '/tests/data/simple_xml_non_xml.xml';
    $this->configuration['urls'][0] = $url;
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessageMatches('/^Fatal Error 46/');
    $parser = $this->pluginManager
      ->createInstance('simple_xml', $this->configuration);
    $parser
      ->next();
  }

  /**
   * Tests reading non-existing XML.
   *
   * @throws \Drupal\Migrate\MigrateException
   */
  public function testReadNonExistingXml() : void {
    $url = $this->path . '/tests/data/simple_xml_non_existing.xml';
    $this->configuration['urls'][0] = $url;
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage('file parser plugin: could not retrieve data from');
    $parser = $this->pluginManager
      ->createInstance('simple_xml', $this->configuration);
    $parser
      ->next();
  }

  /**
   * Parses and asserts the results match expectations.
   *
   * @param array|string $expected
   *   The expected results.
   * @param \Traversable $parser
   *   An iterable data result to parse.
   */
  protected function assertResults($expected, \Traversable $parser) {
    $data = [];
    foreach ($parser as $item) {
      $values = [];
      foreach ($item['values'] as $value) {
        $values[] = (string) $value;
      }
      $data[] = $values;
    }
    $this
      ->assertEquals($expected, $data);
  }

}

Classes

Name	Description
SimpleXmlTest	Test of the data_parser SimpleXml migrate_plus plugin.