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

@@ -83,15 +83,8 @@ def converter_registry():
     return converter_registry
 
 
-def test_simple_xml(converter_registry):
-    xml_text = """
-    <a href="test1" alt="no link">
-    test <img src="test2"/>
-    </a>
-    """
-
-    tag = XMLTagElement("tag", lxml.etree.fromstring(xml_text))
-
+@pytest.fixture
+def basic_cfood():
     xml_cfood = yaml.safe_load("""
 type: XMLTag
 match_tag: a
@@ -114,10 +107,33 @@ subtree:
         match_name: alt
         match_value: ^(?P<text>.*)$
 """)
+    return xml_cfood
+
+
+@pytest.fixture
+def basic_xmltag_converter(basic_cfood, converter_registry):
+    converter = XMLTagConverter(basic_cfood, "TestXMLTagConverter", converter_registry)
+    return converter
+
 
-    converter = XMLTagConverter(xml_cfood, "TestXMLTagConverter", converter_registry)
-    m = converter.match(tag)
+
+def test_simple_xml(basic_xmltag_converter):
+    """
+    Test for basic xml conversion functionality.
+    """
+    xml_text = """
+    <a href="test1" alt="no link">
+    test <img src="test2"/>
+    </a>
+    """
+
+    tag = XMLTagElement("tag", lxml.etree.fromstring(xml_text))
+    m = basic_xmltag_converter.match(tag)
 
     assert m is not None
     assert m["ref"] == "href"
     assert m["number"] == "1"
+
+
+def test_not_matching(basic_xmltag_converter):
+    pass