composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-05-19 23:32:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°9066 - Split XML serializer into normalizer and encoder

Browse Source
This commit is contained in:
Eric Espie
2026-01-08 17:23:06 +01:00
parent 60bcf0c85f
commit be6a8abdf4
15 changed files with 468 additions and 277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

171
tests/php-unit-tests/unitary-tests/sources/PropertyType/Serializer/XMLSerializerTest.php
View File

@@ -15,14 +15,14 @@ class XMLSerializerTest extends ItopDataTestCase
/**
* @dataProvider XMLSerializerProvider
*
* @param $inputContent
* @param $normalizedValue
* @param string $sPropertyTypeXML
* @param string $sExpectedXMLContent
* @param string $sXMLContent
*
* @return void
* @throws \DOMException
*/
public function testSerializeXML($inputContent, string $sPropertyTypeXML, string $sExpectedXMLContent)
public function testSerializeXML($normalizedValue, string $sPropertyTypeXML, string $sXMLContent)
{
ServiceLocator::GetInstance()->RegisterService('ModelReflection', new ModelReflectionRuntime());
@@ -34,18 +34,18 @@ class XMLSerializerTest extends ItopDataTestCase
$oRootNode = $oDOMDocument->createElement('root');
$oDOMDocument->appendChild($oRootNode);
Combodo\iTop\PropertyType\Serializer\XMLSerializer::GetInstance()->SerializeForPropertyType($inputContent, $oRootNode, $sPropertyTypeXML);
Combodo\iTop\PropertyType\Serializer\XMLSerializer::GetInstance()->SerializeForPropertyType($normalizedValue, $oRootNode, $sPropertyTypeXML);
$sActualXML = $oDOMDocument->saveXML();
$this->AssertEqualiTopXML($sExpectedXMLContent, $sActualXML);
$this->AssertEqualiTopXML($sXMLContent, $sActualXML);
}
public function XMLSerializerProvider()
{
return [
'Basic test should serialize to XML' => [
'inputContent' => 'text',
'normalizedValue' => 'text',
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="basic_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
@@ -54,13 +54,13 @@ class XMLSerializerTest extends ItopDataTestCase
</definition>
</property_type>
XML,
'sExpectedXMLContent' => <<<XML
'sXMLContent' => <<<XML
<?xml version="1.0"?>
<root>text</root>
XML,
],
'Collection of values as CSV' => [
'inputContent' => ['Contact', 'Organization'],
'normalizedValue' => ['Contact', 'Organization'],
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="basic_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
@@ -72,13 +72,13 @@ XML,
</definition>
</property_type>
XML,
'sExpectedXMLContent' => <<<XML
'sXMLContent' => <<<XML
<?xml version="1.0"?>
<root>Contact,Organization</root>
XML,
],
'Collection of values as id attribute' => [
'inputContent' => ['Contact', 'Organization'],
'normalizedValue' => ['Contact', 'Organization'],
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="class_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
@@ -92,7 +92,7 @@ XML,
</definition>
</property_type>
XML,
'sExpectedXMLContent' => <<<XML
'sXMLContent' => <<<XML
<?xml version="1.0"?>
<root>
<item id="Contact"/>
@@ -101,7 +101,7 @@ XML,
XML,
],
'Collection of tree as flat array' => [
'inputContent' => [
'normalizedValue' => [
[
'title_property' => 'title_a',
'class_property' => 'class_a',
@@ -132,7 +132,7 @@ XML,
</definition>
</property_type>
XML,
'sExpectedXMLContent' => <<<XML
'sXMLContent' => <<<XML
<?xml version="1.0"?>
<root>
<item_count>2</item_count>
@@ -144,7 +144,7 @@ XML,
XML,
],
'Property tree' => [
'inputContent' => ['title_property' => 'title', 'class_property' => 'class'],
'normalizedValue' => ['title_property' => 'title', 'class_property' => 'class'],
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="property_tree_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
@@ -162,7 +162,7 @@ XML,
</definition>
</property_type>
XML,
'sExpectedXMLContent' => <<<XML
'sXMLContent' => <<<XML
<?xml version="1.0"?>
<root>
<title_property>title</title_property>
@@ -174,7 +174,7 @@ XML,
}
/**
* @dataProvider XMLUnserializerProvider
* @dataProvider XMLSerializerProvider
*
* @param $sInputXMLContent
* @param string $sPropertyTypeXML
@@ -182,150 +182,17 @@ XML,
*
* @return void
*/
public function testUnserializeXML($sInputXMLContent, string $sPropertyTypeXML, $expectedValue)
public function testUnserializeXML($normalizedValue, string $sPropertyTypeXML, string $sXMLContent)
{
ServiceLocator::GetInstance()->RegisterService('ModelReflection', new ModelReflectionRuntime());
$oDoc = new PropertyTypeDesign();
$oDoc->loadXML($sInputXMLContent);
$oDoc->loadXML($sXMLContent);
/** @var \Combodo\iTop\DesignElement $oRoot */
$oRoot = $oDoc->firstChild;
$aActualValue = Combodo\iTop\PropertyType\Serializer\XMLSerializer::GetInstance()->UnserializeForPropertyType($oRoot, $sPropertyTypeXML);
$this->assertEquals($expectedValue, $aActualValue);
$this->assertEquals($normalizedValue, $aActualValue);
}
public function XMLUnserializerProvider()
{
return [
'Basic test should unserialize from XML' => [
'sInputXMLContent' => <<<XML
<?xml version="1.0"?>
<root>text</root>
XML,
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="basic_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
<extends>Dashlet</extends>
<definition xsi:type="Combodo-ValueType-Label">
</definition>
</property_type>
XML,
'expectedValue' => 'text',
],
'Collection of values as CSV' => [
'sInputXMLContent' => <<<XML
<?xml version="1.0"?>
<root>Contact,Organization</root>
XML,
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="basic_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
<extends>Dashlet</extends>
<definition xsi:type="Combodo-ValueType-CollectionOfValues">
<xml-format xsi:type="Combodo-XMLFormat-CSV"/>
<value-type xsi:type="Combodo-ValueType-Class">
</value-type>
</definition>
</property_type>
XML,
'expectedValue' => ['Contact', 'Organization'],
],
'Collection of values as id attribute' => [
'sInputXMLContent' => <<<XML
<?xml version="1.0"?>
<root>
<item id="Contact"/>
<item id="Organization"/>
</root>
XML,
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="class_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
<extends>Dashlet</extends>
<definition xsi:type="Combodo-ValueType-CollectionOfValues">
<xml-format xsi:type="Combodo-XMLFormat-ValueAsId">
<tag-name>item</tag-name>
</xml-format>
<value-type xsi:type="Combodo-ValueType-Class">
</value-type>
</definition>
</property_type>
XML,
'expectedValue' => ['Contact', 'Organization'],
],
'Collection of tree as flat array' => [
'sInputXMLContent' => <<<XML
<?xml version="1.0"?>
<root>
<item_count>2</item_count>
<item_0_title_property>title_a</item_0_title_property>
<item_0_class_property>class_a</item_0_class_property>
<item_1_title_property>title_b</item_1_title_property>
<item_1_class_property>class_b</item_1_class_property>
</root>
XML,
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="collection_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
<extends>Dashlet</extends>
<definition xsi:type="Combodo-ValueType-Collection">
<xml-format xsi:type="Combodo-XMLFormat-FlatArray">
<count-tag>item_count</count-tag>
<tag-format>item_\$rank\$_\$id\$</tag-format>
</xml-format>
<prototype>
<node id="title_property" xsi:type="Combodo-ValueType-Label">
<label>UI:BasicTest:Prop-Title</label>
</node>
<node id="class_property" xsi:type="Combodo-ValueType-Class">
<label>UI:BasicTest:Prop-Class</label>
<categories-csv>test</categories-csv>
</node>
</prototype>
</definition>
</property_type>
XML,
'expectedValue' => [
[
'title_property' => 'title_a',
'class_property' => 'class_a',
],
[
'title_property' => 'title_b',
'class_property' => 'class_b',
],
],
],
'Property tree' => [
'sInputXMLContent' => <<<XML
<?xml version="1.0"?>
<root>
<title_property>title</title_property>
<class_property>class</class_property>
</root>
XML,
'sPropertyTypeXML' => <<<XML
<?xml version="1.0" encoding="UTF-8"?>
<property_type id="property_tree_test" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Combodo-PropertyType" xsi:noNamespaceSchemaLocation = "https://www.combodo.com/itop-schema/3.3">
<extends>Dashlet</extends>
<definition xsi:type="Combodo-ValueType-PropertyTree">
<nodes>
<node id="title_property" xsi:type="Combodo-ValueType-Label">
<label>UI:BasicTest:Prop-Title</label>
</node>
<node id="class_property" xsi:type="Combodo-ValueType-Class">
<label>UI:BasicTest:Prop-Class</label>
<categories-csv>test</categories-csv>
</node>
</nodes>
</definition>
</property_type>
XML,
'expectedValue' => ['title_property' => 'title', 'class_property' => 'class'],
],
];
}
}