feat(xml_rpc): add response serialization

Author: paulschwoerer

sipgate_e2e_test_utils/xml_rpc.py

@@ -45,6 +45,9 @@ def __repr__(self) -> str:
     def parse(body: str | bytes) -> 'XmlRpcResponse':
         return _parse_xml_rpc_response(body)
 
+    def serialize(self) -> str:
+        return _serialize_xml_rpc_response(self)
+
 
 def _parse_xml_rpc_request(body: str | bytes) -> XmlRpcRequest:
     root = ElementTree.fromstring(body)
@@ -90,6 +93,23 @@ def _parse_xml_rpc_response(body: str | bytes) -> XmlRpcResponse:
     return XmlRpcResponse(int(members.pop('faultCode')), str(members.pop('faultString')), members)
 
 
+def _serialize_xml_rpc_response(response: XmlRpcResponse) -> str:
+    params = dict(response.members, **{
+        'faultCode': response.fault_code,
+        'faultString': response.fault_string,
+    })
+
+    if response.fault_code == 200:
+        wrapper = '<params><param><value>{}</value></param></params>'
+    else:
+        wrapper = '<fault><value>{}</value></fault>'
+
+    return f"""<?xml version="1.0"?>
+            <methodResponse>
+                {wrapper.format(__serialize_struct(params))}
+            </methodResponse>"""
+
+
 def __parse_member(node: Element) -> tuple[str, Any]:
     assert node.tag == 'member', f"expected 'member', but got {node.tag=}"
 

tests/test_xml_rpc_response.py

@@ -141,3 +141,77 @@ def test_call_has_string_representation(self) -> None:
 
         parsed = XmlRpcResponse.parse(body)
         self.assertRegex(f"{parsed}", '^<XmlRpcResponse.*faultCode.*200.*>$')
+
+    def test_serialization_success_response(self) -> None:
+        response = XmlRpcResponse(200, 'OK')
+
+        expected_body = """<?xml version="1.0"?>
+            <methodResponse>
+                <params>
+                    <param><value>
+                        <struct>
+                            <member><name>faultCode</name><value><i4>200</i4></value></member>
+                            <member><name>faultString</name><value><string>OK</string></value></member>
+                        </struct>
+                    </value></param>
+                </params>
+            </methodResponse>"""
+
+        # TODO: use better comparison
+        #  this would ignore spaces in values and does not ignore order of params
+        self.assertEqual(''.join(expected_body.split()), ''.join(response.serialize().split()))
+
+    def test_serialization_fault_response(self) -> None:
+        response = XmlRpcResponse(407, 'NOT SO OKAY')
+
+        expected_body = """<?xml version="1.0"?>
+            <methodResponse>
+                <fault><value>
+                    <struct>
+                        <member><name>faultCode</name><value><i4>407</i4></value></member>
+                        <member><name>faultString</name><value><string>NOT SO OKAY</string></value></member>
+                    </struct>
+                </value></fault>
+            </methodResponse>"""
+
+        # TODO: use better comparison
+        #  this would ignore spaces in values and does not ignore order of params
+        self.assertEqual(''.join(expected_body.split()), ''.join(response.serialize().split()))
+
+    def test_serialization(self) -> None:
+        response = XmlRpcResponse(200, 'OK', {
+            'an_int': 42,
+            'a_string': 'the_value',
+            'a_struct': {
+                'another_int': 23
+            },
+            'an_array': [{
+                'another_str': 'the_other_value'
+            }]
+        })
+
+        expected_body = """<?xml version="1.0"?>
+            <methodResponse>
+                <params><param><value>
+                    <struct>
+                        <member><name>an_int</name><value><i4>42</i4></value></member>
+                        <member><name>a_string</name><value><string>the_value</string></value></member>
+                        <member><name>a_struct</name><value><struct>
+                            <member><name>another_int</name><value><i4>23</i4></value></member>
+                        </struct></value></member>
+                        <member><name>an_array</name><value><array>
+                            <data>
+                                <value><struct>
+                                    <member><name>another_str</name><value><string>the_other_value</string></value></member>
+                                </struct></value>
+                            </data>
+                        </array></value></member>
+                        <member><name>faultCode</name><value><i4>200</i4></value></member>
+                        <member><name>faultString</name><value><string>OK</string></value></member>
+                    </struct>
+                </value></param></params>
+            </methodResponse>"""
+
+        # TODO: use better comparison
+        #  this would ignore spaces in values and does not ignore order of params
+        self.assertEqual(''.join(expected_body.split()), ''.join(response.serialize().split()))