XML Converter

Summary

Base functionality for matching and converting XML trees is implemented.

See: #145 (closed)

This should be reviewed and merged relatively soon. Follow-up issues will be created for the following tasks:

• user and API documentation (#159)
• design and implement more unit tests (#160)
• integration tests (#161)
• issue for creating attribute node converter and completing the text node converter (#158 (closed))

Focus

Have a look at #145 (closed) and check whether the requirements are met.

Test Environment

There are unit tests.

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

unittests/test_xml_converter.py

@@ -239,10 +239,10 @@ def test_namespace_xml(converter_registry):
 
     xml_text = """
     <root xmlns="default-namespace" xmlns:test="alternative-namespace">
-        <node1>
+        <node1 active="true">
             Bla
         </node1>
-        <node1>
+        <node1 active="true" size="45">
         text
             <node2 xmlns="sub-namespace">
                 <node3>
@@ -256,6 +256,7 @@ def test_namespace_xml(converter_registry):
     </root>
 """
 
+    # Test unsupported xpath (containing text()):
     converter = XMLTagConverter(yaml.safe_load("""
 type: XMLTag
 match_tag: "{default-namespace}root"
@@ -270,6 +271,7 @@ default_namespace: default
     with pytest.raises(RuntimeError, match="Only standard xml nodes.*"):
         converter.create_children(GeneralStore(), tag)
 
+    # Test complex xml using namespaces and text nodes:
     converter = XMLTagConverter(yaml.safe_load("""
 type: XMLTag
 match_tag: "{default-namespace}root"
@@ -285,3 +287,36 @@ tags_as_children: false
     assert children[0].value.strip() == "Bla"
     assert children[1].name == "{default-namespace}node1[2]/text()"
     assert children[1].value.strip() == "text"
+
+    # Check child generation of attributes:
+    converter = XMLTagConverter(yaml.safe_load("""
+type: XMLTag
+match_tag: "{default-namespace}root"
+xpath: "default:node1"
+default_namespace: default
+attribs_as_children: true
+text_as_children: false
+tags_as_children: false
+"""), "TestXMLTagConverter", converter_registry)
+    children = converter.create_children(GeneralStore(), tag)
+
+    assert len(children) == 3
+    assert children[0].name == "{default-namespace}node1[1]@active"
+    assert children[0].value.strip() == "true"
+    assert children[1].name == "{default-namespace}node1[2]@active"
+    assert children[1].value.strip() == "true"
+    assert children[2].name == "{default-namespace}node1[2]@size"
+    assert children[2].value.strip() == "45"
+
+    # Test setting nsmap entries:
+    converter = XMLTagConverter(yaml.safe_load("""
+type: XMLTag
+match_tag: "{default-namespace}root"
+xpath: "//s:node2"
+default_namespace: default
+nsmap:
+  s: sub-namespace
+"""), "TestXMLTagConverter", converter_registry)
+    children = converter.create_children(GeneralStore(), tag)
+    assert len(children) == 1
+    assert children[0].name == "{default-namespace}node1[2]/{sub-namespace}node2"