test_osc_server.py

import socket
import unittest
import unittest.mock

from pythonosc import dispatcher, osc_server

_SIMPLE_PARAM_INT_MSG = b"/SYNC\x00\x00\x00,i\x00\x00\x00\x00\x00\x04"

# Regression test for a datagram that should NOT be stripped, ever...
_SIMPLE_PARAM_INT_9 = b"/debug\x00\x00,i\x00\x00\x00\x00\x00\t"

_SIMPLE_MSG_NO_PARAMS = b"/SYNC\x00\x00\x00"


class TestOscServer(unittest.TestCase):
    def test_is_valid_request(self):
        self.assertTrue(osc_server._is_valid_request((b"#bundle\x00foobar",)))
        self.assertTrue(osc_server._is_valid_request((b"/address/1/2/3,foobar",)))
        self.assertFalse(osc_server._is_valid_request((b"",)))


class TestUDPHandler(unittest.TestCase):
    def setUp(self):
        super().setUp()
        self.dispatcher = dispatcher.Dispatcher()
        # We do not want to create real UDP connections during unit tests.
        self.server = unittest.mock.Mock(spec=osc_server.BlockingOSCUDPServer)
        # Need to attach property mocks to types, not objects... weird.
        type(self.server).dispatcher = unittest.mock.PropertyMock(
            return_value=self.dispatcher
        )
        self.client_address = ("127.0.0.1", 8080)

    def test_no_match(self):
        mock_meth = unittest.mock.MagicMock()
        mock_meth.return_value = None
        self.dispatcher.map("/foobar", mock_meth)
        osc_server._UDPHandler(
            [_SIMPLE_PARAM_INT_MSG, None], self.client_address, self.server
        )
        self.assertFalse(mock_meth.called)

    def test_match_with_args(self):
        mock_meth = unittest.mock.MagicMock()
        mock_meth.return_value = None
        self.dispatcher.map("/SYNC", mock_meth, 1, 2, 3)
        osc_server._UDPHandler(
            [_SIMPLE_PARAM_INT_MSG, None], self.client_address, self.server
        )
        mock_meth.assert_called_with("/SYNC", [1, 2, 3], 4)

    def test_match_int9(self):
        mock_meth = unittest.mock.MagicMock()
        mock_meth.return_value = None
        self.dispatcher.map("/debug", mock_meth)
        osc_server._UDPHandler(
            [_SIMPLE_PARAM_INT_9, None], self.client_address, self.server
        )
        self.assertTrue(mock_meth.called)
        mock_meth.assert_called_with("/debug", 9)

    def test_match_without_args(self):
        mock_meth = unittest.mock.MagicMock()
        mock_meth.return_value = None
        self.dispatcher.map("/SYNC", mock_meth)
        osc_server._UDPHandler(
            [_SIMPLE_MSG_NO_PARAMS, None], self.client_address, self.server
        )
        mock_meth.assert_called_with("/SYNC")

    def test_match_default_handler(self):
        mock_meth = unittest.mock.MagicMock()
        mock_meth.return_value = None
        self.dispatcher.set_default_handler(mock_meth)
        osc_server._UDPHandler(
            [_SIMPLE_MSG_NO_PARAMS, None], self.client_address, self.server
        )
        mock_meth.assert_called_with("/SYNC")

    def test_response_no_args(self):
        def respond(*args, **kwargs):
            return "/SYNC"

        mock_sock = unittest.mock.Mock()
        mock_sock.sendto = unittest.mock.Mock()
        self.dispatcher.map("/SYNC", respond)
        osc_server._UDPHandler(
            (_SIMPLE_PARAM_INT_MSG, mock_sock), self.client_address, self.server
        )
        mock_sock.sendto.assert_called_with(
            b"/SYNC\00\00\00,\00\00\00", ("127.0.0.1", 8080)
        )

    def test_response_with_args(self):
        def respond(*args, **kwargs):
            return (
                "/SYNC",
                1,
                "2",
                3.0,
            )

        self.dispatcher.map("/SYNC", respond)
        mock_sock = unittest.mock.Mock()
        mock_sock.sendto = unittest.mock.Mock()
        self.dispatcher.map("/SYNC", respond)
        osc_server._UDPHandler(
            (_SIMPLE_PARAM_INT_MSG, mock_sock), self.client_address, self.server
        )
        mock_sock.sendto.assert_called_with(
            b"/SYNC\00\00\00,isf\x00\x00\x00\x00\x00\x00\x00\x012\x00\x00\x00@@\x00\x00",
            ("127.0.0.1", 8080),
        )


class TestOscUdpServer(unittest.TestCase):
    @unittest.mock.patch("socket.socket")
    def test_init_timeout(self, mock_socket_ctor):
        dispatcher = unittest.mock.Mock()
        server = osc_server.OSCUDPServer(("127.0.0.1", 0), dispatcher, timeout=10.0)
        self.assertEqual(server.timeout, 10.0)

    @unittest.mock.patch("socket.socket")
    def test_init_family_inference_ipv4(self, mock_socket_ctor):
        dispatcher = unittest.mock.Mock()
        server = osc_server.OSCUDPServer(("127.0.0.1", 0), dispatcher)
        self.assertEqual(server.address_family, socket.AF_INET)

    @unittest.mock.patch("socket.socket")
    def test_init_family_inference_ipv6(self, mock_socket_ctor):
        dispatcher = unittest.mock.Mock()
        # Mock getaddrinfo to return IPv6 for this test to be environment-independent
        with unittest.mock.patch("socket.getaddrinfo") as mock_getaddrinfo:
            mock_getaddrinfo.return_value = [(socket.AF_INET6, None, None, None, None)]
            server = osc_server.OSCUDPServer(("::1", 0), dispatcher)
            self.assertEqual(server.address_family, socket.AF_INET6)


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