| 1 | #-*-python-*- |
| 2 | # |
| 3 | # This file is part of DisOrder. |
| 4 | # Copyright (C) 2007 Richard Kettlewell |
| 5 | # |
| 6 | # This program is free software; you can redistribute it and/or modify |
| 7 | # it under the terms of the GNU General Public License as published by |
| 8 | # the Free Software Foundation; either version 2 of the License, or |
| 9 | # (at your option) any later version. |
| 10 | # |
| 11 | # This program is distributed in the hope that it will be useful, but |
| 12 | # WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 14 | # General Public License for more details. |
| 15 | # |
| 16 | # You should have received a copy of the GNU General Public License |
| 17 | # along with this program; if not, write to the Free Software |
| 18 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 |
| 19 | # USA |
| 20 | # |
| 21 | |
| 22 | """Utility module used by tests""" |
| 23 | |
| 24 | import os,os.path,subprocess,sys,re,unicodedata |
| 25 | |
| 26 | def fatal(s): |
| 27 | """Write an error message and exit""" |
| 28 | sys.stderr.write("ERROR: %s\n" % s) |
| 29 | sys.exit(1) |
| 30 | |
| 31 | # Identify the top build directory |
| 32 | cwd = os.getcwd() |
| 33 | if os.path.exists("config.h"): |
| 34 | top_builddir = cwd |
| 35 | elif os.path.exists("alltests"): |
| 36 | top_builddir = os.path.dirname(cwd) |
| 37 | else: |
| 38 | fatal("cannot identify build directory") |
| 39 | |
| 40 | # Make sure the Python build directory is on the module search path |
| 41 | sys.path.insert(0, os.path.join(top_builddir, "python")) |
| 42 | import disorder |
| 43 | |
| 44 | # Make sure the server build directory is on the executable search path |
| 45 | ospath = os.environ["PATH"].split(os.pathsep) |
| 46 | ospath.insert(0, os.path.join(top_builddir, "server")) |
| 47 | os.environ["PATH"] = os.pathsep.join(ospath) |
| 48 | |
| 49 | # Parse the makefile in the current directory to identify the source directory |
| 50 | top_srcdir = None |
| 51 | for l in file("Makefile"): |
| 52 | r = re.match("top_srcdir *= *(.*)", l) |
| 53 | if r: |
| 54 | top_srcdir = r.group(1) |
| 55 | break |
| 56 | if not top_srcdir: |
| 57 | fatal("cannot identify source directory") |
| 58 | |
| 59 | # The tests source directory must be on the module search path already since |
| 60 | # we found dtest.py |
| 61 | |
| 62 | # ----------------------------------------------------------------------------- |
| 63 | |
| 64 | def copyfile(a,b): |
| 65 | """copyfile(A, B) |
| 66 | Copy A to B.""" |
| 67 | open(b,"w").write(open(a).read()) |
| 68 | |
| 69 | def maketrack(s): |
| 70 | """maketrack(S) |
| 71 | |
| 72 | Make track with relative path S exist""" |
| 73 | trackpath = "%s/%s" % (tracks, s) |
| 74 | trackdir = os.path.dirname(trackpath) |
| 75 | if not os.path.exists(trackdir): |
| 76 | os.makedirs(trackdir) |
| 77 | copyfile("%s/sounds/slap.ogg" % top_srcdir, trackpath) |
| 78 | # We record the tracks we created so they can be tested against |
| 79 | # server responses. We put them into NFC since that's what the server |
| 80 | # uses internally. |
| 81 | bits = unicodedata.normalize("NFC", |
| 82 | unicode(s, "UTF-8")).split('/') |
| 83 | dp = tracks |
| 84 | for d in bits [0:-1]: |
| 85 | dd = "%s/%s" % (dp, d) |
| 86 | if dp not in dirs_by_dir: |
| 87 | dirs_by_dir[dp] = [] |
| 88 | if dd not in dirs_by_dir[dp]: |
| 89 | dirs_by_dir[dp].append(dd) |
| 90 | dp = "%s/%s" % (dp, d) |
| 91 | if dp not in files_by_dir: |
| 92 | files_by_dir[dp] = [] |
| 93 | files_by_dir[dp].append("%s/%s" % (dp, bits[-1])) |
| 94 | |
| 95 | def stdtracks(): |
| 96 | # We create some tracks with non-ASCII characters in the name and |
| 97 | # we (currently) force UTF-8. |
| 98 | # |
| 99 | # On a traditional UNIX filesystem, that treats filenames as byte strings |
| 100 | # with special significant for '/', this should just work, though the |
| 101 | # names will look wrong to ls(1) in a non UTF-8 locale. |
| 102 | # |
| 103 | # On Apple HFS+ filenames normalized to a decomposed form that isn't quite |
| 104 | # NFD, so our attempts to have both normalized and denormalized filenames |
| 105 | # is frustrated. Provided we test on traditional filesytsems too this |
| 106 | # shouldn't be a problem. |
| 107 | # (See http://developer.apple.com/qa/qa2001/qa1173.html) |
| 108 | |
| 109 | global dirs_by_dir, files_by_dir |
| 110 | dirs_by_dir={} |
| 111 | files_by_dir={} |
| 112 | |
| 113 | # C3 8C = 00CC LATIN CAPITAL LETTER I WITH GRAVE |
| 114 | # (in NFC) |
| 115 | maketrack("Joe Bloggs/First Album/01:F\xC3\x8Crst track.ogg") |
| 116 | |
| 117 | maketrack("Joe Bloggs/First Album/02:Second track.ogg") |
| 118 | |
| 119 | # CC 81 = 0301 COMBINING ACUTE ACCENT |
| 120 | # (giving an NFD i-acute) |
| 121 | maketrack("Joe Bloggs/First Album/03:ThI\xCC\x81rd track.ogg") |
| 122 | # ...hopefuly giving C3 8D = 00CD LATIN CAPITAL LETTER I WITH ACUTE |
| 123 | maketrack("Joe Bloggs/First Album/04:Fourth track.ogg") |
| 124 | maketrack("Joe Bloggs/First Album/05:Fifth track.ogg") |
| 125 | maketrack("Joe Bloggs/Second Album/01:First track.ogg") |
| 126 | maketrack("Joe Bloggs/Second Album/02:Second track.ogg") |
| 127 | maketrack("Joe Bloggs/Second Album/03:Third track.ogg") |
| 128 | maketrack("Joe Bloggs/Second Album/04:Fourth track.ogg") |
| 129 | maketrack("Joe Bloggs/Second Album/05:Fifth track.ogg") |
| 130 | maketrack("Joe Bloggs/Third Album/01:First track.ogg") |
| 131 | maketrack("Joe Bloggs/Third Album/02:Second track.ogg") |
| 132 | maketrack("Joe Bloggs/Third Album/03:Third track.ogg") |
| 133 | maketrack("Joe Bloggs/Third Album/04:Fourth track.ogg") |
| 134 | maketrack("Joe Bloggs/Third Album/05:Fifth track.ogg") |
| 135 | maketrack("Fred Smith/Boring/01:Dull.ogg") |
| 136 | maketrack("Fred Smith/Boring/02:Tedious.ogg") |
| 137 | maketrack("Fred Smith/Boring/03:Drum Solo.ogg") |
| 138 | maketrack("Fred Smith/Boring/04:Yawn.ogg") |
| 139 | maketrack("misc/blahblahblah.ogg") |
| 140 | maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg") |
| 141 | maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg") |
| 142 | |
| 143 | def common_setup(): |
| 144 | remove_dir(testroot) |
| 145 | os.mkdir(testroot) |
| 146 | open("%s/config" % testroot, "w").write( |
| 147 | """player *.ogg shell 'echo "$TRACK" >> %s/played.log' |
| 148 | home %s |
| 149 | collection fs UTF-8 %s/tracks |
| 150 | scratch %s/scratch.ogg |
| 151 | gap 0 |
| 152 | stopword 01 02 03 04 05 06 07 08 09 10 |
| 153 | stopword 1 2 3 4 5 6 7 8 9 |
| 154 | stopword 11 12 13 14 15 16 17 18 19 20 |
| 155 | stopword 21 22 23 24 25 26 27 28 29 30 |
| 156 | stopword the a an and to too in on of we i am as im for is |
| 157 | username fred |
| 158 | password fredpass |
| 159 | allow fred fredpass |
| 160 | plugins %s/plugins |
| 161 | player *.mp3 execraw disorder-decode |
| 162 | player *.ogg execraw disorder-decode |
| 163 | player *.wav execraw disorder-decode |
| 164 | player *.flac execraw disorder-decode |
| 165 | tracklength *.mp3 disorder-tracklength |
| 166 | tracklength *.ogg disorder-tracklength |
| 167 | tracklength *.wav disorder-tracklength |
| 168 | tracklength *.flac disorder-tracklength |
| 169 | """ % (testroot, testroot, testroot, testroot, top_builddir)) |
| 170 | copyfile("%s/sounds/scratch.ogg" % top_srcdir, |
| 171 | "%s/scratch.ogg" % testroot) |
| 172 | |
| 173 | def start_daemon(): |
| 174 | """start_daemon() |
| 175 | |
| 176 | Start the daemon.""" |
| 177 | global daemon, errs |
| 178 | assert daemon == None |
| 179 | print " starting daemon" |
| 180 | daemon = subprocess.Popen(["disorderd", |
| 181 | "--foreground", |
| 182 | "--config", "%s/config" % testroot], |
| 183 | stderr=errs) |
| 184 | |
| 185 | def stop_daemon(): |
| 186 | """stop_daemon() |
| 187 | |
| 188 | Stop the daemon if it has not stopped already""" |
| 189 | global daemon |
| 190 | if daemon == None: |
| 191 | return |
| 192 | rc = daemon.poll() |
| 193 | if rc == None: |
| 194 | print " stopping daemon" |
| 195 | os.kill(daemon.pid, 15) |
| 196 | rc = daemon.wait() |
| 197 | print " daemon has stopped" |
| 198 | daemon = None |
| 199 | |
| 200 | def run(module=None, report=True): |
| 201 | """dtest.run(MODULE) |
| 202 | |
| 203 | Run the test in MODULE. This can be a string (in which case the module |
| 204 | will be imported) or a module object.""" |
| 205 | global tests |
| 206 | tests += 1 |
| 207 | # Locate the test module |
| 208 | if module is None: |
| 209 | # We're running a test stand-alone |
| 210 | import __main__ |
| 211 | module = __main__ |
| 212 | name = os.path.splitext(os.path.basename(sys.argv[0]))[0] |
| 213 | else: |
| 214 | # We've been passed a module or a module name |
| 215 | if type(module) == str: |
| 216 | module = __import__(module) |
| 217 | name = module.__name__ |
| 218 | # Open the error log |
| 219 | global errs |
| 220 | errs = open("%s.log" % name, "w") |
| 221 | # Ensure that disorder.py uses the test installation |
| 222 | disorder._configfile = "%s/config" % testroot |
| 223 | disorder._userconf = False |
| 224 | # Make config file etc |
| 225 | common_setup() |
| 226 | # Create some standard tracks |
| 227 | stdtracks() |
| 228 | try: |
| 229 | try: |
| 230 | module.test() |
| 231 | except AssertionError, e: |
| 232 | global failures |
| 233 | failures += 1 |
| 234 | print e |
| 235 | finally: |
| 236 | stop_daemon() |
| 237 | if report: |
| 238 | if failures: |
| 239 | print " FAILED" |
| 240 | sys.exit(1) |
| 241 | else: |
| 242 | print " OK" |
| 243 | |
| 244 | def remove_dir(d): |
| 245 | """remove_dir(D) |
| 246 | |
| 247 | Recursively delete directory D""" |
| 248 | if os.path.lexists(d): |
| 249 | if os.path.isdir(d): |
| 250 | for dd in os.listdir(d): |
| 251 | remove_dir("%s/%s" % (d, dd)) |
| 252 | os.rmdir(d) |
| 253 | else: |
| 254 | os.remove(d) |
| 255 | |
| 256 | # ----------------------------------------------------------------------------- |
| 257 | # Common setup |
| 258 | |
| 259 | tests = 0 |
| 260 | failures = 0 |
| 261 | daemon = None |
| 262 | testroot = "%s/tests/testroot" % top_builddir |
| 263 | tracks = "%s/tracks" % testroot |