github.com_openSUSE_osc/tests/test_models_xmlmodel.py

import io
import textwrap
import unittest

from osc.util.models import *


class TestXmlModel(unittest.TestCase):
    def test_attribute(self):
        class TestModel(XmlModel):
            XML_TAG = "tag"
            value: str = Field(xml_attribute=True)

        m = TestModel(value="FOO")
        self.assertEqual(m.dict(), {"value": "FOO"})
        expected = """<tag value="FOO" />"""
        self.assertEqual(m.to_string(), expected)

        # verify that we can also load the serialized data
        m = TestModel.from_string(expected)
        self.assertEqual(m.to_string(), expected)

    def test_element(self):
        class TestModel(XmlModel):
            XML_TAG = "tag"
            value: str = Field()

        m = TestModel(value="FOO")
        self.assertEqual(m.dict(), {"value": "FOO"})
        expected = textwrap.dedent(
            """
            <tag>
              <value>FOO</value>
            </tag>
            """
        ).strip()
        self.assertEqual(m.to_string(), expected)

        # verify that we can also load the serialized data
        m = TestModel.from_string(expected)
        self.assertEqual(m.to_string(), expected)

    def test_element_list(self):
        class TestModel(XmlModel):
            XML_TAG = "tag"
            value_list: List[str] = Field(xml_name="value")

        m = TestModel(value_list=["FOO", "BAR"])
        self.assertEqual(m.dict(), {"value_list": ["FOO", "BAR"]})
        expected = textwrap.dedent(
            """
            <tag>
              <value>FOO</value>
              <value>BAR</value>
            </tag>
            """
        ).strip()
        self.assertEqual(m.to_string(), expected)

        # verify that we can also load the serialized data
        m = TestModel.from_string(expected)
        self.assertEqual(m.to_string(), expected)

    def test_child_model(self):
        class ChildModel(XmlModel):
            XML_TAG = "child"
            value: str = Field()

        class ParentModel(XmlModel):
            XML_TAG = "parent"
            text: str = Field()
            child: ChildModel = Field()

        m = ParentModel(text="TEXT", child={"value": "FOO"})
        expected = textwrap.dedent(
            """
            <parent>
              <text>TEXT</text>
              <child>
                <value>FOO</value>
              </child>
            </parent>
            """
        ).strip()
        self.assertEqual(m.to_string(), expected)

        # verify that we can also load the serialized data
        m = ParentModel.from_string(expected)
        self.assertEqual(m.to_string(), expected)

    def test_child_model_list(self):
        class ChildModel(XmlModel):
            XML_TAG = "child"
            value: str = Field()

        class ParentModel(XmlModel):
            XML_TAG = "parent"
            text: str = Field()
            child: List[ChildModel] = Field()

        m = ParentModel(text="TEXT", child=[{"value": "FOO"}, {"value": "BAR"}])
        expected = textwrap.dedent(
            """
            <parent>
              <text>TEXT</text>
              <child>
                <value>FOO</value>
              </child>
              <child>
                <value>BAR</value>
              </child>
            </parent>
            """
        ).strip()
        self.assertEqual(m.to_string(), expected)

        # verify that we can also load the serialized data
        m = ParentModel.from_string(expected)
        self.assertEqual(m.to_string(), expected)

    def test_child_model_list_wrapped(self):
        class ChildModel(XmlModel):
            XML_TAG = "child"
            value: str = Field()

        class ParentModel(XmlModel):
            XML_TAG = "parent"
            text: str = Field()
            child: List[ChildModel] = Field(xml_wrapped=True, xml_name="children")

        m = ParentModel(text="TEXT", child=[{"value": "FOO"}, {"value": "BAR"}])
        expected = textwrap.dedent(
            """
            <parent>
              <text>TEXT</text>
              <children>
                <child>
                  <value>FOO</value>
                </child>
                <child>
                  <value>BAR</value>
                </child>
              </children>
            </parent>
            """
        ).strip()
        self.assertEqual(m.to_string(), expected)

        # verify that we can also load the serialized data
        m = ParentModel.from_string(expected)
        self.assertEqual(m.to_string(), expected)

    def test_apiurl(self):
        class ChildModel(XmlModel):
            XML_TAG = "child"
            value: str = Field()

        class ParentModel(XmlModel):
            XML_TAG = "parent"
            text: str = Field()
            child: List[ChildModel] = Field(xml_wrapped=True, xml_name="children")

        # serialize the model and load it with apiurl set
        m = ParentModel(text="TEXT", child=[{"value": "FOO"}, {"value": "BAR"}])
        xml = m.to_string()

        apiurl = "https://api.example.com"

        m = ParentModel.from_string(xml, apiurl=apiurl)
        m.child.append({"value": "BAZ"})

        self.assertEqual(m._apiurl, apiurl)
        self.assertEqual(m.child[0]._apiurl, apiurl)
        self.assertEqual(m.child[1]._apiurl, apiurl)
        self.assertEqual(m.child[2]._apiurl, apiurl)

        # test the same as above but with a file
        f = io.StringIO(xml)

        m = ParentModel.from_file(f, apiurl=apiurl)
        m.child.append({"value": "BAZ"})

        self.assertEqual(m._apiurl, apiurl)
        self.assertEqual(m.child[0]._apiurl, apiurl)
        self.assertEqual(m.child[1]._apiurl, apiurl)
        self.assertEqual(m.child[2]._apiurl, apiurl)

    def test_empty_int_optional(self):
        class TestModel(XmlModel):
            XML_TAG = "model"
            num_attr: Optional[int] = Field(xml_attribute=True)
            num_elem: Optional[int] = Field()

        data = textwrap.dedent(
            """
            <model num_attr="">
              <num_elem> </num_elem>
            </model>
            """
        ).strip()
        m = TestModel.from_string(data)
        self.assertEqual(m.num_attr, None)
        self.assertEqual(m.num_elem, None)

    def test_empty_int(self):
        class TestModel(XmlModel):
            XML_TAG = "model"
            num_attr: int = Field(xml_attribute=True)
            num_elem: int = Field()

        data = textwrap.dedent(
            """
            <model num_attr="">
              <num_elem> </num_elem>
            </model>
            """
        ).strip()
        self.assertRaises(TypeError, TestModel.from_string, data)


if __name__ == "__main__":
    unittest.main()