3 # This file is part of DisOrder.
4 # Copyright (C) 2007 Richard Kettlewell
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.
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.
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
22 """Utility module used by tests"""
24 import os,os.path,subprocess,sys,re,time,unicodedata
27 """Write an error message and exit"""
28 sys.stderr.write("ERROR: %s\n" % s)
31 # Identify the top build directory
33 if os.path.exists("config.h"):
35 elif os.path.exists("alltests"):
36 top_builddir = os.path.dirname(cwd)
38 fatal("cannot identify build directory")
40 # Make sure the Python build directory is on the module search path
41 sys.path.insert(0, os.path.join(top_builddir, "python"))
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)
49 # Parse the makefile in the current directory to identify the source directory
51 for l in file("Makefile"):
52 r = re.match("top_srcdir *= *(.*)", l)
54 top_srcdir = r.group(1)
57 fatal("cannot identify source directory")
59 # The tests source directory must be on the module search path already since
62 # -----------------------------------------------------------------------------
67 open(b,"w").write(open(a).read())
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):
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
81 bits = unicodedata.normalize("NFC",
82 unicode(s, "UTF-8")).split('/')
85 dd = "%s/%s" % (dp, d)
86 if dp not in dirs_by_dir:
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:
93 files_by_dir[dp].append("%s/%s" % (dp, bits[-1]))
96 # We create some tracks with non-ASCII characters in the name and
97 # we (currently) force UTF-8.
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.
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)
109 global dirs_by_dir, files_by_dir
113 # C3 8C = 00CC LATIN CAPITAL LETTER I WITH GRAVE
115 maketrack("Joe Bloggs/First Album/01:F\xC3\x8Crst track.ogg")
117 maketrack("Joe Bloggs/First Album/02:Second track.ogg")
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")
146 open("%s/config" % testroot, "w").write(
147 """player *.ogg shell 'echo "$TRACK" >> %s/played.log'
149 collection fs UTF-8 %s/tracks
150 scratch %s/scratch.ogg
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
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)
178 assert daemon == None
179 print " starting daemon"
180 # remove the socket if it exists
181 socket = "%s/socket" % testroot
186 daemon = subprocess.Popen(["disorderd",
188 "--config", "%s/config" % testroot],
190 # Wait for the socket to be created
192 while not os.path.exists(socket):
195 print "FATAL: daemon failed to start up"
199 print " waiting for socket..."
201 print "FATAL: took too long for socket to appear"
205 print " took about %ds for socket to appear" % waited
210 Stop the daemon if it has not stopped already"""
216 print " stopping daemon"
217 os.kill(daemon.pid, 15)
218 print " waiting for daemon"
220 print " daemon has stopped"
222 print " daemon already stopped"
225 def run(module=None, report=True):
228 Run the test in MODULE. This can be a string (in which case the module
229 will be imported) or a module object."""
232 # Locate the test module
234 # We're running a test stand-alone
237 name = os.path.splitext(os.path.basename(sys.argv[0]))[0]
239 # We've been passed a module or a module name
240 if type(module) == str:
241 module = __import__(module)
242 name = module.__name__
245 errs = open("%s.log" % name, "w")
246 # Ensure that disorder.py uses the test installation
247 disorder._configfile = "%s/config" % testroot
248 disorder._userconf = False
249 # Make config file etc
251 # Create some standard tracks
256 except AssertionError, e:
272 Recursively delete directory D"""
273 if os.path.lexists(d):
275 for dd in os.listdir(d):
276 remove_dir("%s/%s" % (d, dd))
282 c = disorder.client()
284 for d in dirs_by_dir:
285 xdirs = dirs_by_dir[d]
286 dirs = c.directories(d)
291 print "directory: %s" % d
292 print "expected: %s" % xdirs
293 print "got: %s" % dirs
295 for d in files_by_dir:
296 xfiles = files_by_dir[d]
302 print "directory: %s" % d
303 print "expected: %s" % xfiles
304 print "got: %s" % files
308 # -----------------------------------------------------------------------------
314 testroot = "%s/tests/testroot" % top_builddir
315 tracks = "%s/tracks" % testroot