test.py

# -*- coding: utf-8 -*-=

from os       import environ, listdir
from os.path  import join
from platform import system
from sys      import version
from time     import sleep, time

import logging

logging.basicConfig(format = '%(asctime)s %(message)s', level = logging.DEBUG)

system = system()
isTravis = environ.get('TRAVIS', 'false') == 'true'

if isTravis and system == 'Windows':
    print('\n>>> Will be mocking instead of using the real MciSendStringW function for most tests.\n')
    from ctypes import windll
    originalMCISendStringW = windll.winmm.mciSendStringW
    try:
        from unittest.mock import patch
    except ImportError:
        try:
            from pip import main as pipmain
        except ImportError:
            from pip._internal import main as pipmain

        # Before python 3.3 (including python 2.7.20 and earlier),
        # mocking/patching wasn't part of the standard library. So you need
        # to get those via pip. You specifically need version 2.0.0 - newer
        # versions require python 3.3, utterly defeating the purpose of making
        # the library available on pypi.
        pipmain(['install', 'mock==2.0.0'])
        from mock   import patch

from playsound import playsound, PlaysoundException
import unittest

durationMarginLow  = 0.2
duratingMarginHigh = 2.0
expectedDuration   = None
testCase           = None

def mockMciSendStringW(command, buf, bufLen, bufStart):
    # Error code 305 ("Cannot specify extra characters after a string enclosed in quotation marks.") should never be tolerated.
    
    if command.startswith(u'close '):
        global sawClose
        sawClose = True
        testCase.assertIn(originalMCISendStringW(command, buf, bufLen, bufStart), [0, 263])  # 263 indicates it's not opened or not recognized. It's fine.
        return 0

    if command.endswith(u' wait'):
        sleep(expectedDuration)

    if command.startswith(u'open ') or command.startswith(u'play '):
        testCase.assertIn(originalMCISendStringW(command, buf, bufLen, bufStart), [0, 306])  # 306 indicates drivers are missing. It's fine.
        return 0

class PlaysoundTests(unittest.TestCase):
    def get_full_path(self, file):
        path = join('test_media', file)
        print(path.encode('utf-8'))
        return path

    def helper(self, file, approximateDuration, block = True):
        startTime = time()
        path = self.get_full_path(file)

        if isTravis and system == 'Windows':
            with patch('ctypes.windll.winmm.mciSendStringW', side_effect = mockMciSendStringW):
                global expectedDuration, sawClose, testCase
                testCase = self
                sawClose = False
                expectedDuration = approximateDuration
                playsound(path, block = block)
                self.assertTrue(sawClose)
        else:
            playsound(path, block = block)
        duration = time() - startTime
        self.assertTrue(approximateDuration - durationMarginLow <= duration <= approximateDuration + duratingMarginHigh, 'File "{}" took an unexpected amount of time: {:.2f} - expected ~{:.2f}'.format(file.encode('utf-8'), duration, approximateDuration))

    testBlockingASCII_MP3 = lambda self: self.helper('Damonte.mp3', 1.1)
    testBlockingASCII_WAV = lambda self: self.helper('Sound4.wav',  1.3)
    testBlockingCYRIL_WAV = lambda self: self.helper(u'Буква_Я.wav', 1.6)
    testBlockingSPACE_MP3 = lambda self: self.helper('Discovery - Go at throttle up (2).mp3', 2.3)
    testNonBlockingRepeat = lambda self: self.helper(u'Буква_Я.wav', 0.0, block = False)

    def testMissing(self):
        with self.assertRaises(PlaysoundException) as context:
            playsound(self.get_full_path('fakefile.wav'))

        message = str(context.exception).lower()
            
        for sub in ['not', 'fakefile.wav']:
            self.assertIn(sub, message, '"{}" was expected in the exception message, but instead got: "{}"'.format(sub, message))

# Run the same tests as above, but pass pathlib.Path objects to playsound instead of strings.
try:
    from pathlib import Path
except ImportError:
    pass
else:
    class PlaysoundTestsWithPathlib(PlaysoundTests):
        def get_full_path(self, file):
            return Path('test_media') / file

if __name__ == '__main__':
    print(version)
    import sys
    print(sys.executable)
    print(sys.path)
    unittest.main()