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

@@ -101,6 +101,28 @@ subtree:
             src: test2
 """), "TestXMLTagConverter", converter_registry)
 
+@pytest.fixture
+def basic_xpath_xmltag_converter(converter_registry):
+    return XMLTagConverter(yaml.safe_load("""
+type: XMLTag
+match_tag: a
+match_attrib:  # default is the empty dictionary
+    "(?P<ref>(href|url))": "test(?P<number>[0-9])"  # either the "href" or the "url" attribute must be set
+    alt: (.+)  # this attribute must be present and contain at least one character
+match_text: \\s*(?P<node_text>.+)\\s*
+xpath: child::*/*
+
+subtree:
+    img:
+        type: XMLTag
+        match_name: img
+        match_attrib:
+            src: test2
+    testnode:
+        type: XMLTag
+        match_name: testnode
+"""), "TestXMLTagConverter", converter_registry)
+
 
 
 def test_simple_xml(basic_xmltag_converter):
@@ -167,7 +189,7 @@ def test_not_matching(basic_xmltag_converter):
     # TODO: how to match "  ajskdlfjaldsf ajsdklfjadkl " without the whitespaces in regexp correctly?
 
 
-def test_nested_simple_xml(basic_xmltag_converter):
+def test_nested_simple_xml(basic_xmltag_converter, basic_xpath_xmltag_converter):
     """
     Test for xml conversion including children.
     """
@@ -198,13 +220,13 @@ def test_nested_simple_xml(basic_xmltag_converter):
     """
 
     tag = XMLTagElement(fromstring(xml_text))
-    m = basic_xmltag_converter.match(tag)
+    m = basic_xpath_xmltag_converter.match(tag)
     assert m is not None
 
     general_store = GeneralStore()
-    children = basic_xmltag_converter.create_children(general_store, tag)
+    children = basic_xpath_xmltag_converter.create_children(general_store, tag)
 
     assert len(children) == 1
     assert isinstance(children[0], XMLTagElement)
-    assert children[0].name == "img"
+    assert children[0].name == "img/testnode"