]> kaliko git repositories - python-musicpd.git/blobdiff - test.py
Improved socket timeout setter, add tests
[python-musicpd.git] / test.py
diff --git a/test.py b/test.py
index 3da30bbed90d44dfdf8902007fb1871b19efe55c..033fe061d54b3fa793315a5ba658e0538ffa5106 100755 (executable)
--- a/test.py
+++ b/test.py
@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
+# coding: utf-8
+# SPDX-FileCopyrightText: 2012-2023  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.
@@ -10,21 +12,13 @@ Test suite highly borrowed^Wsteal from python-mpd2 [0] project.
 
 import itertools
 import os
-import sys
 import types
 import unittest
+import unittest.mock as mock
 import warnings
 
 import musicpd
 
-try:
-    import unittest.mock as mock
-except ImportError:
-    try:
-        import mock
-    except ImportError:
-        print("Please install mock from PyPI to run tests!")
-        sys.exit(1)
 
 # show deprecation warnings
 warnings.simplefilter('default')
@@ -123,7 +117,7 @@ class testEnvVar(unittest.TestCase):
         client = musicpd.MPDClient()
         self.assertEqual(client.mpd_timeout,
                          musicpd.CONNECTION_TIMEOUT,
-                         'Garbage\'s not silently ignore to use default value')
+                         'Garbage is silently ignore to use default value')
         os.environ['MPD_TIMEOUT'] = '42'
         client = musicpd.MPDClient()
         self.assertEqual(client.mpd_timeout, 42)
@@ -351,6 +345,16 @@ class TestMPDClient(unittest.TestCase):
         self.assertMPDReceived('stats\n')
         self.assertIsInstance(stats, dict)
 
+        output = ['outputid: 0\n',
+                  'outputname: default detected output\n',
+                  'plugin: sndio\n',
+                  'outputenabled: 1\n']
+        self.MPDWillReturn(*output, 'OK\n')
+        outputs = self.client.outputs()
+        self.assertMPDReceived('outputs\n')
+        self.assertIsInstance(outputs, list)
+        self.assertEqual([{'outputid': '0', 'outputname': 'default detected output', 'plugin': 'sndio', 'outputenabled': '1'}], outputs)
+
     def test_fetch_songs(self):
         self.MPDWillReturn('file: my-song.ogg\n', 'Pos: 0\n', 'Id: 66\n', 'OK\n')
         playlist = self.client.playlistinfo()
@@ -415,9 +419,13 @@ class TestMPDClient(unittest.TestCase):
         self.client.send_status()
         self.assertRaises(musicpd.CommandError, self.client.noidle)
 
-    def test_client_to_client(self):
-        # client to client is at this time in beta!
+    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"))
         self.assertMPDReceived('subscribe "monty"\n')
@@ -522,6 +530,12 @@ class TestMPDClient(unittest.TestCase):
         res = self.client.albumart('muse/Raised Fist/2002-Dedication/', 0)
         self.assertEqual(res.get('data'), data)
 
+    def test_reading_binary(self):
+        # readpicture when there are no picture returns empty object
+        self.MPDWillReturnBinary([b'OK\n'])
+        res = self.client.readpicture('muse/Raised Fist/2002-Dedication/', 0)
+        self.assertEqual(res, {})
+
     def test_command_list(self):
         self.MPDWillReturn('updating_db: 42\n',
                            f'{musicpd.NEXT}\n',
@@ -537,6 +551,127 @@ class TestMPDClient(unittest.TestCase):
         self.client.command_list_end()
         self.assertMPDReceived('command_list_end\n')
 
+    def test_two_word_commands(self):
+        self.MPDWillReturn('OK\n')
+        self.client.tagtypes_clear()
+        self.assertMPDReceived('tagtypes clear\n')
+        self.MPDWillReturn('OK\n')
+        with self.assertRaises(AttributeError):
+            self.client.foo_bar()
+
+class testConnection(unittest.TestCase):
+
+    def test_exposing_fileno(self):
+        with mock.patch('musicpd.socket') as socket_mock:
+            sock = mock.MagicMock(name='socket')
+            socket_mock.socket.return_value = sock
+            cli = musicpd.MPDClient()
+            cli.connect()
+            cli.fileno()
+            cli._sock.fileno.assert_called_with()
+
+    def test_connect_abstract(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()
+            cli.connect()
+            sock.connect.assert_called_with('\0abstract')
+
+    def test_connect_unix(self):
+        os.environ['MPD_HOST'] = '/run/mpd/socket'
+        with mock.patch('musicpd.socket') as socket_mock:
+            sock = mock.MagicMock(name='socket')
+            socket_mock.socket.return_value = sock
+            cli = musicpd.MPDClient()
+            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 testException(unittest.TestCase):
+
+    def test_CommandError_on_newline(self):
+        os.environ['MPD_HOST'] = '/run/mpd/socket'
+        with mock.patch('musicpd.socket') as socket_mock:
+            sock = mock.MagicMock(name='socket')
+            socket_mock.socket.return_value = sock
+            cli = musicpd.MPDClient()
+            cli.connect()
+            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()