Skip to content
Snippets Groups Projects
Commit 6d017f71 authored by Ivan Doroshenko's avatar Ivan Doroshenko
Browse files

Issue #2947711 by Matroskeen, Frank Ralf: XML parsers: Unit tests

parent 6b6c11f3
No related branches found
No related tags found
1 merge request!61Issue #2947711: XML parsers: Combined some unit tests.
Hide whitespace changes
Inline Side-by-side
Showing
with 193 additions and 191 deletions
tests/src/Kernel/Plugin/migrate_plus/data_parser/BaseXmlTest.php 0 → 100644
+ 174
− 0
View file @ 6d017f71
<?php
declare(strict_types = 1);
namespace Drupal\Tests\migrate_plus\Kernel\Plugin\migrate_plus\data_parser;
use Drupal\KernelTests\KernelTestBase;
use Drupal\migrate_plus\DataParserPluginInterface;
use Drupal\migrate_plus\DataParserPluginManager;
/**
* Test of the data_parser SimpleXml migrate_plus plugin.
*
* @group migrate_plus
*/
abstract class BaseXmlTest extends KernelTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = ['migrate', 'migrate_plus'];
/**
* Path for the xml file.
*/
protected ?string $path;
/**
* The plugin manager.
*/
protected ?DataParserPluginManager $pluginManager = NULL;
/**
* The plugin configuration.
*/
protected ?array $configuration;
/**
* The expected result.
*/
protected ?array $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 current URL of parsed XML item.
*/
public function testCurrentUrl(): void {
$urls = [
$this->path . '/tests/data/xml_current_url1.xml',
$this->path . '/tests/data/xml_current_url2.xml',
];
$this->configuration['urls'] = $urls;
$parser = $this->getParser();
// First 2 items available in the first URL.
$parser->rewind();
$this->assertEquals($urls[0], $parser->currentUrl());
$parser->next();
$this->assertEquals($urls[0], $parser->currentUrl());
// Third item available in the second URL.
$parser->next();
$this->assertEquals($urls[1], $parser->currentUrl());
}
/**
* Tests reducing single values.
*/
public function testReduceSingleValue(): void {
$url = $this->path . '/tests/data/xml_reduce_single_value.xml';
$this->configuration['urls'][0] = $url;
$this->assertResults($this->expected, $this->getParser());
}
/**
* Tests retrieving single value from element with attributes.
*/
public function testSingleValueWithAttributes() {
$urls = [
$this->path . '/tests/data/xml_data_parser.xml',
];
$this->configuration['urls'] = $urls;
$this->configuration['item_selector'] = '/persons/person';
$this->configuration['fields'] = [
[
'name' => 'id',
'label' => 'Id',
'selector' => 'id',
],
[
'name' => 'child',
'label' => 'child',
'selector' => 'children/child',
],
];
$names = [];
foreach ($this->getParser() as $item) {
$names[] = (string) $item['child']->name;
}
$expected_names = ['Elizabeth Junior', 'George Junior', 'Lucy'];
$this->assertEquals($expected_names, $names);
}
/**
* 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): void {
$data = [];
foreach ($parser as $item) {
$values = [];
foreach ($item['values'] as $value) {
$values[] = (string) $value;
}
$data[] = $values;
}
$this->assertEquals($expected, $data);
}
/**
* Returns a parse object with active configuration.
*
* @return \Drupal\migrate_plus\DataParserPluginInterface
* Data parser object.
*/
abstract protected function getParser(): DataParserPluginInterface;
}
tests/src/Kernel/Plugin/migrate_plus/data_parser/SimpleXmlTest.php
+ 14
− 144
View file @ 6d017f71
...@@ -4,146 +4,40 @@ declare(strict_types = 1); ...@@ -4,146 +4,40 @@ declare(strict_types = 1);
namespace Drupal\Tests\migrate_plus\Kernel\Plugin\migrate_plus\data_parser; namespace Drupal\Tests\migrate_plus\Kernel\Plugin\migrate_plus\data_parser;
use Drupal\KernelTests\KernelTestBase;
use Drupal\migrate\MigrateException; use Drupal\migrate\MigrateException;
use Drupal\migrate_plus\DataParserPluginManager; use Drupal\migrate_plus\DataParserPluginInterface;
/** /**
* Test of the data_parser SimpleXml migrate_plus plugin. * Test of the data_parser SimpleXml migrate_plus plugin.
* *
* @group migrate_plus * @group migrate_plus
*/ */
final class SimpleXmlTest extends KernelTestBase { class SimpleXmlTest extends BaseXmlTest {
/** /**
* {@inheritdoc} * Test reading non-standard conforming XML.
*/
protected static $modules = ['migrate', 'migrate_plus'];
/**
* Path for the xml file.
*/
protected ?string $path;
/**
* The plugin manager.
*/
protected ?DataParserPluginManager $pluginManager = NULL;
/**
* The plugin configuration.
*/
protected ?array $configuration;
/**
* The expected result.
*/
protected ?array $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 current URL of parsed XML item.
*/
public function testCurrentUrl(): void {
$urls = [
$this->path . '/tests/data/simple_xml_current_url1.xml',
$this->path . '/tests/data/simple_xml_current_url2.xml',
];
$this->configuration['urls'] = $urls;
/** @var \Drupal\migrate_plus\DataParserPluginInterface $parser */
$parser = $this->pluginManager->createInstance('simple_xml', $this->configuration);
// First 2 items available in the first URL.
$parser->rewind();
$this->assertEquals($urls[0], $parser->currentUrl());
$parser->next();
$this->assertEquals($urls[0], $parser->currentUrl());
// Third item available in the second URL.
$parser->next();
$this->assertEquals($urls[1], $parser->currentUrl());
}
/**
* 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. * XML file with lots of different white spaces before the starting tag.
*/ */
public function testReadNonStandardXmlWhitespace(): void { public function testReadNonStandardXmlWhitespace(): void {
$url = $this->path . '/tests/data/simple_xml_invalid_multi_whitespace.xml'; $url = $this->path . '/tests/data/simple_xml_invalid_multi_whitespace.xml';
$this->configuration['urls'][0] = $url; $this->configuration['urls'][0] = $url;
$this->assertResults($this->expected, $this->getParser());
$parser = $this->pluginManager->createInstance('simple_xml', $this->configuration);
$this->assertResults($this->expected, $parser);
} }
/** /**
* Test reading non standard conforming XML . * Test reading non-standard conforming XML .
* *
* XML file with one empty line before the starting tag. * XML file with one empty line before the starting tag.
*/ */
public function testReadNonStandardXml2(): void { public function testReadNonStandardXml2(): void {
$url = $this->path . '/tests/data/simple_xml_invalid_single_line.xml'; $url = $this->path . '/tests/data/simple_xml_invalid_single_line.xml';
$this->configuration['urls'][0] = $url; $this->configuration['urls'][0] = $url;
$this->assertResults($this->expected, $this->getParser());
$parser = $this->pluginManager->createInstance('simple_xml', $this->configuration);
$this->assertResults($this->expected, $parser);
} }
/** /**
* Test reading broken XML (missing closing tag). * Test reading broken XML (missing closing tag).
*
* @throws \Drupal\Migrate\MigrateException
*/ */
public function testReadBrokenXmlMissingTag(): void { public function testReadBrokenXmlMissingTag(): void {
$url = $this->path . '/tests/data/simple_xml_broken_missing_tag.xml'; $url = $this->path . '/tests/data/simple_xml_broken_missing_tag.xml';
...@@ -151,14 +45,11 @@ final class SimpleXmlTest extends KernelTestBase { ...@@ -151,14 +45,11 @@ final class SimpleXmlTest extends KernelTestBase {
$this->expectException(MigrateException::class); $this->expectException(MigrateException::class);
// Newer versions of libxml mark it as an error 76, older ones as 73. // Newer versions of libxml mark it as an error 76, older ones as 73.
$this->expectExceptionMessageMatches('/^Fatal Error 7[0-9]/'); $this->expectExceptionMessageMatches('/^Fatal Error 7[0-9]/');
$parser = $this->pluginManager->createInstance('simple_xml', $this->configuration); $this->getParser()->next();
$parser->next();
} }
/** /**
* Test reading broken XML (tag mismatch). * Test reading broken XML (tag mismatch).
*
* @throws \Drupal\Migrate\MigrateException
*/ */
public function testReadBrokenXmlTagMismatch(): void { public function testReadBrokenXmlTagMismatch(): void {
$url = $this->path . '/tests/data/simple_xml_broken_tag_mismatch.xml'; $url = $this->path . '/tests/data/simple_xml_broken_tag_mismatch.xml';
...@@ -166,15 +57,11 @@ final class SimpleXmlTest extends KernelTestBase { ...@@ -166,15 +57,11 @@ final class SimpleXmlTest extends KernelTestBase {
$this->expectException(MigrateException::class); $this->expectException(MigrateException::class);
$this->expectExceptionMessageMatches('/^Fatal Error 76/'); $this->expectExceptionMessageMatches('/^Fatal Error 76/');
$this->getParser()->next();
$parser = $this->pluginManager->createInstance('simple_xml', $this->configuration);
$parser->next();
} }
/** /**
* Test reading non XML. * Test reading non XML.
*
* @throws \Drupal\Migrate\MigrateException
*/ */
public function testReadNonXml(): void { public function testReadNonXml(): void {
$url = $this->path . '/tests/data/simple_xml_non_xml.xml'; $url = $this->path . '/tests/data/simple_xml_non_xml.xml';
...@@ -182,43 +69,26 @@ final class SimpleXmlTest extends KernelTestBase { ...@@ -182,43 +69,26 @@ final class SimpleXmlTest extends KernelTestBase {
$this->expectException(MigrateException::class); $this->expectException(MigrateException::class);
$this->expectExceptionMessageMatches('/^Fatal Error 46/'); $this->expectExceptionMessageMatches('/^Fatal Error 46/');
$parser = $this->pluginManager->createInstance('simple_xml', $this->configuration); $this->getParser()->next();
$parser->next();
} }
/** /**
* Tests reading non-existing XML. * Tests reading non-existing XML.
*
* @throws \Drupal\Migrate\MigrateException
*/ */
public function testReadNonExistingXml(): void { public function testReadNonExistingXml(): void {
$url = $this->path . '/tests/data/simple_xml_non_existing.xml'; $url = $this->path . '/tests/data/xml_non_existing.xml';
$this->configuration['urls'][0] = $url; $this->configuration['urls'][0] = $url;
$this->expectException(MigrateException::class); $this->expectException(MigrateException::class);
$this->expectExceptionMessage('file parser plugin: could not retrieve data from'); $this->expectExceptionMessage('file parser plugin: could not retrieve data from');
$parser = $this->pluginManager->createInstance('simple_xml', $this->configuration); $this->getParser()->next();
$parser->next();
} }
/** /**
* Parses and asserts the results match expectations. * {@inheritdoc}
*
* @param array|string $expected
* The expected results.
* @param \Traversable $parser
* An iterable data result to parse.
*/ */
protected function assertResults($expected, \Traversable $parser): void { protected function getParser(): DataParserPluginInterface {
$data = []; return $this->pluginManager->createInstance('simple_xml', $this->configuration);
foreach ($parser as $item) {
$values = [];
foreach ($item['values'] as $value) {
$values[] = (string) $value;
}
$data[] = $values;
}
$this->assertEquals($expected, $data);
} }
} }
tests/src/Kernel/Plugin/migrate_plus/data_parser/XmlTest.php
+ 5
− 47
View file @ 6d017f71
...@@ -4,62 +4,20 @@ declare(strict_types = 1); ...@@ -4,62 +4,20 @@ declare(strict_types = 1);
namespace Drupal\Tests\migrate_plus\Kernel\Plugin\migrate_plus\data_parser; namespace Drupal\Tests\migrate_plus\Kernel\Plugin\migrate_plus\data_parser;
use Drupal\KernelTests\KernelTestBase; use Drupal\migrate_plus\DataParserPluginInterface;
/** /**
* Test of the data_parser Xml migrate_plus plugin. * Test of the data_parser Xml migrate_plus plugin.
* *
* @group migrate_plus * @group migrate_plus
*/ */
final class XmlTest extends KernelTestBase { final class XmlTest extends BaseXmlTest {
protected static $modules = ['migrate', 'migrate_plus'];
/** /**
* Tests retrieving single value from element with attributes. * {@inheritdoc}
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* @throws \Exception
*/ */
public function testSingleValue(): void { protected function getParser(): DataParserPluginInterface {
$path = $this->container return $this->pluginManager->createInstance('xml', $this->configuration);
->get('module_handler')
->getModule('migrate_plus')
->getPath();
$fileUrl = $path . '/tests/data/xml_data_parser.xml';
$conf = [
'plugin' => 'url',
'data_fetcher_plugin' => 'file',
'data_parser_plugin' => 'xml',
'destination' => 'node',
'urls' => [$fileUrl],
'ids' => ['id' => ['type' => 'integer']],
'fields' => [
[
'name' => 'id',
'label' => 'Id',
'selector' => 'id',
],
[
'name' => 'child',
'label' => 'child',
'selector' => 'children/child',
],
],
'item_selector' => '/persons/person',
];
/** @var \Drupal\migrate_plus\DataParserPluginManager $plugin_manager */
$plugin_manager = $this->container->get('plugin.manager.migrate_plus.data_parser');
$parser = $plugin_manager->createInstance('xml', $conf);
$names = [];
foreach ($parser as $item) {
$names[] = (string) $item['child']->name;
}
$expectedNames = ['Elizabeth Junior', 'George Junior', 'Lucy'];
$this->assertEquals($expectedNames, $names);
} }
} }
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment