#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
+# coding: utf-8
+# SPDX-FileCopyrightText: 2012-2024 kaliko <kaliko@azylum.org>
+# SPDX-License-Identifier: LGPL-3.0-or-later
# pylint: disable=missing-docstring
"""
Test suite highly borrowed^Wsteal from python-mpd2 [0] project.
import os
import types
import unittest
-import unittest.mock as mock
+import unittest.mock
import warnings
import musicpd
+mock = unittest.mock
# show deprecation warnings
warnings.simplefilter('default')
TEST_MPD_HOST, TEST_MPD_PORT = ('example.com', 10000)
-class testEnvVar(unittest.TestCase):
+class TestEnvVar(unittest.TestCase):
def test_envvar(self):
# mock "os.path.exists" here to ensure there are no socket in
self.client.send_status()
self.assertRaises(musicpd.CommandError, self.client.noidle)
+ def test_send_noidle_calls_noidle(self):
+ self.MPDWillReturn('OK\n') # nothing changed after idle
+ self.client.send_idle()
+ self.client.send_noidle()
+ self.assertMPDReceived('noidle\n')
+
def test_client_to_client(self):
self.MPDWillReturn('OK\n')
self.assertIsNone(self.client.subscribe("monty"))
with self.assertRaises(AttributeError):
self.client.foo_bar()
-class testConnection(unittest.TestCase):
+class TestConnection(unittest.TestCase):
def test_exposing_fileno(self):
with mock.patch('musicpd.socket') as socket_mock:
cli.connect()
sock.connect.assert_called_with('/run/mpd/socket')
+ def test_sockettimeout(self):
+ with mock.patch('musicpd.socket') as socket_mock:
+ sock = mock.MagicMock(name='socket')
+ socket_mock.socket.return_value = sock
+ cli = musicpd.MPDClient()
+ # Default is no socket timeout
+ cli.connect()
+ sock.settimeout.assert_called_with(None)
+ cli.disconnect()
+ # set a socket timeout before connection
+ cli.socket_timeout = 10
+ cli.connect()
+ sock.settimeout.assert_called_with(10)
+ # Set socket timeout while already connected
+ cli.socket_timeout = 42
+ sock.settimeout.assert_called_with(42)
+ # set a socket timeout using str
+ cli.socket_timeout = '10'
+ sock.settimeout.assert_called_with(10)
+ # Set socket timeout to None
+ cli.socket_timeout = None
+ sock.settimeout.assert_called_with(None)
+ # Set socket timeout Raises Exception
+ with self.assertRaises(ValueError):
+ cli.socket_timeout = 'foo'
+ with self.assertRaises(ValueError,
+ msg='socket_timeout expects a non zero positive integer'):
+ cli.socket_timeout = '0'
+ with self.assertRaises(ValueError,
+ msg='socket_timeout expects a non zero positive integer'):
+ cli.socket_timeout = '-1'
+
+
+class TestConnectionError(unittest.TestCase):
+
+ @mock.patch('socket.socket')
+ def test_connect_unix(self, socket_mock):
+ """Unix socket socket.error should raise a musicpd.ConnectionError"""
+ mocked_socket = socket_mock.return_value
+ mocked_socket.connect.side_effect = musicpd.socket.error(42, 'err 42')
+ os.environ['MPD_HOST'] = '/run/mpd/socket'
+ cli = musicpd.MPDClient()
+ with self.assertRaises(musicpd.ConnectionError) as cme:
+ cli.connect()
+ self.assertEqual('[Errno 42] err 42', str(cme.exception))
-class testException(unittest.TestCase):
-
- def test_CommandError_on_newline(self):
+ def test_non_available_unix_socket(self):
+ delattr(musicpd.socket, 'AF_UNIX')
+ os.environ['MPD_HOST'] = '/run/mpd/socket'
+ cli = musicpd.MPDClient()
+ with self.assertRaises(musicpd.ConnectionError) as cme:
+ cli.connect()
+ self.assertEqual('Unix domain sockets not supported on this platform',
+ str(cme.exception))
+
+ @mock.patch('socket.getaddrinfo')
+ def test_connect_tcp_getaddrinfo(self, gai_mock):
+ """TCP socket.gaierror should raise a musicpd.ConnectionError"""
+ gai_mock.side_effect = musicpd.socket.error(42, 'gaierr 42')
+ cli = musicpd.MPDClient()
+ with self.assertRaises(musicpd.ConnectionError) as cme:
+ cli.connect(host=TEST_MPD_HOST)
+ self.assertEqual('[Errno 42] gaierr 42', str(cme.exception))
+
+ @mock.patch('socket.getaddrinfo')
+ @mock.patch('socket.socket')
+ def test_connect_tcp_connect(self, socket_mock, gai_mock):
+ """A socket.error should raise a musicpd.ConnectionError
+ Mocking getaddrinfo to prevent network access (DNS)
+ """
+ gai_mock.return_value = [range(5)]
+ mocked_socket = socket_mock.return_value
+ mocked_socket.connect.side_effect = musicpd.socket.error(42, 'tcp conn err 42')
+ cli = musicpd.MPDClient()
+ with self.assertRaises(musicpd.ConnectionError) as cme:
+ cli.connect(host=TEST_MPD_HOST)
+ self.assertEqual('[Errno 42] tcp conn err 42', str(cme.exception))
+
+ @mock.patch('socket.getaddrinfo')
+ def test_connect_tcp_connect_empty_gai(self, gai_mock):
+ """An empty getaddrinfo should raise a musicpd.ConnectionError"""
+ gai_mock.return_value = []
+ cli = musicpd.MPDClient()
+ with self.assertRaises(musicpd.ConnectionError) as cme:
+ cli.connect(host=TEST_MPD_HOST)
+ self.assertEqual('getaddrinfo returns an empty list', str(cme.exception))
+
+
+class TestCommandErrorException(unittest.TestCase):
+
+ def test_error_on_newline(self):
os.environ['MPD_HOST'] = '/run/mpd/socket'
with mock.patch('musicpd.socket') as socket_mock:
sock = mock.MagicMock(name='socket')
with self.assertRaises(musicpd.CommandError):
cli.find('(album == "foo\nbar")')
+class testContextManager(unittest.TestCase):
+
+ def test_enter_exit(self):
+ os.environ['MPD_HOST'] = '@abstract'
+ with mock.patch('musicpd.socket') as socket_mock:
+ sock = mock.MagicMock(name='socket')
+ socket_mock.socket.return_value = sock
+ cli = musicpd.MPDClient()
+ with cli as c:
+ sock.connect.assert_called_with('\0abstract')
+ sock.close.assert_not_called()
+ sock.close.assert_called()
+
+class testRange(unittest.TestCase):
+
+ def test_range(self):
+ tests = [
+ ((), ':'),
+ ((None,None), ':'),
+ (('',''), ':'),
+ (('',), ':'),
+ ((42,42), '42:42'),
+ ((42,), '42:'),
+ (('42',), '42:'),
+ (('42',None), '42:'),
+ (('42',''), '42:'),
+ ]
+ for tpl, result in tests:
+ self.assertEqual(str(musicpd.Range(tpl)), result)
+ with self.assertRaises(musicpd.CommandError):
+ #CommandError: Integer expected to start the range: (None, 42)
+ musicpd.Range((None,'42'))
+ with self.assertRaises(musicpd.CommandError):
+ # CommandError: Not an integer: "foo"
+ musicpd.Range(('foo',))
+ with self.assertRaises(musicpd.CommandError):
+ # CommandError: Wrong range: 42 > 41
+ musicpd.Range(('42',41))
+ with self.assertRaises(musicpd.CommandError):
+ # CommandError: Wrong range: 42 > 41
+ musicpd.Range(('42','42','42'))
+
if __name__ == '__main__':
unittest.main()
home / dev / repositories / python-musicpd.git / blobdiff