unit tests for XML RPC

Author: jabez007

src/odoolib/connector/_connector.py

@@ -42,8 +42,13 @@ class Connector(Sender):
     The base abstract class representing a connection to an Odoo Server.
     """
 
+    PROTOCOL: Optional[str] = None
+
     def __init__(self):
-        self._logger = logging.getLogger(f"{str.join('.', __name__.split('.')[:-1])}")
+        self._logger = logging.getLogger(
+            f"{str.join('.', __name__.split('.')[:-1])}"
+            + (f".{self.PROTOCOL}" if self.PROTOCOL is not None else "")
+        )
         self.url: Optional[str] = None
 
     def get_service(self, service_name: str) -> Service:

src/odoolib/connector/_sender.py

@@ -27,16 +27,14 @@
 ##############################################################################
 
 import asyncio
-from typing import Any, Optional
+from typing import Any
 
 
 class Sender(object):
     """
     The base abstract class for sending RPC requests
     """
 
-    PROTOCOL: Optional[str] = None
-
     def send(self, service_name: str, method: str, *args) -> Any:
         """
         stub out method for children to override

src/odoolib/connector/xml_rpc.py

@@ -30,7 +30,6 @@
 #
 ##############################################################################
 
-import logging
 from typing import Optional
 from xmlrpc.client import ServerProxy, Transport
 
@@ -56,8 +55,7 @@ def __init__(
         :param hostname: The hostname of the computer holding the instance of Odoo.
         :param port: The port used by the Odoo instance for XMLRPC (default to 8069).
         """
-        super().__init__()
-        self._logger = logging.getLogger(f"{self._logger.name}.xmlrpc")
+        super(XmlRpcConnector, self).__init__()
         self.url = (
             "http://%s:%d/xmlrpc" % (hostname, port)
             if version is None

src/odoolib/connector/xml_rpcs.py

@@ -30,7 +30,6 @@
 #
 ##############################################################################
 
-import logging
 from typing import Optional
 from xmlrpc.client import SafeTransport
 
@@ -52,9 +51,6 @@ def __init__(
         transport: Optional[SafeTransport] = None,
     ):
         super(XmlRpcsConnector, self).__init__(hostname, port, version, transport)
-        self._logger = logging.getLogger(
-            f"{str.join('.', self._logger.name.split('.')[:-1])}.xmlrpcs"
-        )
         self.url = (
             "https://%s:%d/xmlrpc" % (hostname, port)
             if version is None

tests/test_xml_rpc.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (C) 2025 Jimmy McCann
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+##############################################################################
+
+import unittest
+from unittest.mock import MagicMock, patch
+
+from odoolib import XmlRpcConnector
+
+
+class TestXmlRpcConnector(unittest.TestCase):
+    def setUp(self):
+        self.hostname = "localhost"
+        self.port = 8069
+        self.version = "2"
+        self.connector = XmlRpcConnector(self.hostname)
+
+    def test_initialization(self):
+        self.assertEqual(
+            self.connector.url,
+            f"http://{self.hostname}:{self.port}/xmlrpc/{self.version}",
+        )
+        self.assertEqual(self.connector._logger.name, "odoolib.connector.xmlrpc")
+        self.assertIsNone(self.connector._transport)
+
+    @patch("odoolib.connector.xml_rpc.ServerProxy")
+    def test_send(self, mock_server_proxy):
+        mock_service = MagicMock()
+        mock_method = MagicMock(return_value="mock_response")
+        mock_service.some_method = mock_method
+        mock_server_proxy.return_value = mock_service
+
+        response = self.connector.send("common", "some_method", "arg1", "arg2")
+
+        mock_server_proxy.assert_called_once_with(
+            f"http://{self.hostname}:{self.port}/xmlrpc/{self.version}/common",
+            transport=None,
+        )
+        mock_method.assert_called_once_with("arg1", "arg2")
+        self.assertEqual(response, "mock_response")
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_xml_rpcs.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (C) 2025 Jimmy McCann
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+##############################################################################
+
+import unittest
+from unittest.mock import MagicMock, patch
+
+from odoolib import XmlRpcsConnector
+
+
+class TestXmlRpcsConnector(unittest.TestCase):
+    def setUp(self):
+        self.hostname = "localhost"
+        self.port = 8069
+        self.version = "2"
+        self.connector = XmlRpcsConnector(self.hostname)
+
+    def test_initialization(self):
+        self.assertEqual(
+            self.connector.url,
+            f"https://{self.hostname}:{self.port}/xmlrpc/{self.version}",
+        )
+        self.assertEqual(self.connector._logger.name, "odoolib.connector.xmlrpcs")
+        self.assertIsNone(self.connector._transport)
+
+    @patch("odoolib.connector.xml_rpc.ServerProxy")
+    def test_send(self, mock_server_proxy):
+        mock_service = MagicMock()
+        mock_method = MagicMock(return_value="mock_response")
+        mock_service.some_method = mock_method
+        mock_server_proxy.return_value = mock_service
+
+        response = self.connector.send("common", "some_method", "arg1", "arg2")
+
+        mock_server_proxy.assert_called_once_with(
+            f"https://{self.hostname}:{self.port}/xmlrpc/{self.version}/common",
+            transport=None,
+        )
+        mock_method.assert_called_once_with("arg1", "arg2")
+        self.assertEqual(response, "mock_response")
+
+
+if __name__ == "__main__":
+    unittest.main()