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

@@ -84,8 +84,8 @@ def converter_registry():
 
 
 @pytest.fixture
-def basic_cfood():
-    xml_cfood = yaml.safe_load("""
+def basic_xmltag_converter(converter_registry):
+    return XMLTagConverter(yaml.safe_load("""
 type: XMLTag
 match_tag: a
 match_attrib:  # default is the empty dictionary
@@ -93,33 +93,13 @@ match_attrib:  # default is the empty dictionary
     alt: (.+)  # this attribute must be present and contain at least one character
 match_text: \\s*(?P<node_text>.+)\\s*
 
-# _*_ marks the default:
-attribs_as_children: true  # true / _false_
-text_as_children: true  # true / _false_
-tags_as_children: true  # _true_ / false
-
 subtree:
-    text:  # this would be created by the text_as_children-flag
-        type: XMLTextNode
-        match: test
-    alt:  # this would be created by the attribs_as_children-flag
-        type: TextElement
-        match_name: alt
-        match_value: ^(?P<text>.*)$
-
     img:
         type: XMLTag
         match_name: img
         match_attrib:
             src: test2
-""")
-    return xml_cfood
-
-
-@pytest.fixture
-def basic_xmltag_converter(basic_cfood, converter_registry):
-    converter = XMLTagConverter(basic_cfood, "TestXMLTagConverter", converter_registry)
-    return converter
+"""), "TestXMLTagConverter", converter_registry)
 
 
 
@@ -187,7 +167,6 @@ 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):
     """
     Test for xml conversion including children.
@@ -203,9 +182,29 @@ def test_nested_simple_xml(basic_xmltag_converter):
     assert m is not None
 
     general_store = GeneralStore()
+    children = basic_xmltag_converter.create_children(general_store, tag)
+
+    assert len(children) == 1
+    assert isinstance(children[0], XMLTagElement)
+    assert children[0].name == "img"
+
 
+
+    xml_text = """
+    <a href="test1" alt="no link">
+    test <img src="test2">
+        <testnode/> </img>
+    </a>
+    """
+
+    tag = XMLTagElement(fromstring(xml_text))
+    m = basic_xmltag_converter.match(tag)
+    assert m is not None
+
+    general_store = GeneralStore()
     children = basic_xmltag_converter.create_children(general_store, tag)
 
     assert len(children) == 1
     assert isinstance(children[0], XMLTagElement)
     assert children[0].name == "img"
+