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())
70 """Convert UTF-8 to unicode. A no-op if already unicode."""
71 if type(s
) == unicode:
74 return unicode(s
, "UTF-8")
77 """Convert UTF-8 string or unicode to NFC unicode."""
78 return unicodedata
.normalize("NFC", to_unicode(s
))
83 Make track with relative path S exist"""
84 trackpath
= "%s/%s" %
(tracks
, s
)
85 trackdir
= os
.path
.dirname(trackpath
)
86 if not os
.path
.exists(trackdir
):
88 copyfile("%s/sounds/slap.ogg" % top_srcdir
, trackpath
)
89 # We record the tracks we created so they can be tested against
90 # server responses. We put them into NFC since that's what the server
92 bits
= nfc(s
).split('/')
95 dd
= "%s/%s" %
(dp
, d
)
96 if dp
not in dirs_by_dir
:
98 if dd
not in dirs_by_dir
[dp
]:
99 dirs_by_dir
[dp
].append(dd
)
100 dp
= "%s/%s" %
(dp
, d
)
101 if dp
not in files_by_dir
:
102 files_by_dir
[dp
] = []
103 files_by_dir
[dp
].append("%s/%s" %
(dp
, bits
[-1]))
106 # We create some tracks with non-ASCII characters in the name and
107 # we (currently) force UTF-8.
109 # On a traditional UNIX filesystem, that treats filenames as byte strings
110 # with special significant for '/', this should just work, though the
111 # names will look wrong to ls(1) in a non UTF-8 locale.
113 # On Apple HFS+ filenames normalized to a decomposed form that isn't quite
114 # NFD, so our attempts to have both normalized and denormalized filenames
115 # is frustrated. Provided we test on traditional filesytsems too this
116 # shouldn't be a problem.
117 # (See http://developer.apple.com/qa/qa2001/qa1173.html)
119 global dirs_by_dir
, files_by_dir
123 # C3 8C = 00CC LATIN CAPITAL LETTER I WITH GRAVE
125 maketrack("Joe Bloggs/First Album/01:F\xC3\x8Crst track.ogg")
127 maketrack("Joe Bloggs/First Album/02:Second track.ogg")
129 # CC 81 = 0301 COMBINING ACUTE ACCENT
130 # (giving an NFD i-acute)
131 maketrack("Joe Bloggs/First Album/03:ThI\xCC\x81rd track.ogg")
132 # ...hopefuly giving C3 8D = 00CD LATIN CAPITAL LETTER I WITH ACUTE
133 maketrack("Joe Bloggs/First Album/04:Fourth track.ogg")
134 maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
135 maketrack("Joe Bloggs/Second Album/01:First track.ogg")
136 maketrack("Joe Bloggs/Second Album/02:Second track.ogg")
137 maketrack("Joe Bloggs/Second Album/03:Third track.ogg")
138 maketrack("Joe Bloggs/Second Album/04:Fourth track.ogg")
139 maketrack("Joe Bloggs/Second Album/05:Fifth track.ogg")
140 maketrack("Joe Bloggs/Third Album/01:First_track.ogg")
141 maketrack("Joe Bloggs/Third Album/02:Second_track.ogg")
142 maketrack("Joe Bloggs/Third Album/03:Third_track.ogg")
143 maketrack("Joe Bloggs/Third Album/04:Fourth_track.ogg")
144 maketrack("Joe Bloggs/Third Album/05:Fifth_track.ogg")
145 maketrack("Fred Smith/Boring/01:Dull.ogg")
146 maketrack("Fred Smith/Boring/02:Tedious.ogg")
147 maketrack("Fred Smith/Boring/03:Drum Solo.ogg")
148 maketrack("Fred Smith/Boring/04:Yawn.ogg")
149 maketrack("misc/blahblahblah.ogg")
150 maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg")
151 maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg")
156 open("%s/config" % testroot
, "w").write(
157 """player *.ogg shell 'echo "$TRACK" >> %s/played.log'
159 collection fs UTF-8 %s/tracks
160 scratch %s/scratch.ogg
162 stopword 01 02 03 04 05 06 07 08 09 10
163 stopword 1 2 3 4 5 6 7 8 9
164 stopword 11 12 13 14 15 16 17 18 19 20
165 stopword 21 22 23 24 25 26 27 28 29 30
166 stopword the a an and to too in on of we i am as im for is
171 player *.mp3 execraw disorder-decode
172 player *.ogg execraw disorder-decode
173 player *.wav execraw disorder-decode
174 player *.flac execraw disorder-decode
175 tracklength *.mp3 disorder-tracklength
176 tracklength *.ogg disorder-tracklength
177 tracklength *.wav disorder-tracklength
178 tracklength *.flac disorder-tracklength
179 """ %
(testroot
, testroot
, testroot
, testroot
, top_builddir
))
180 copyfile("%s/sounds/scratch.ogg" % top_srcdir
,
181 "%s/scratch.ogg" % testroot
)
188 assert daemon
== None
189 print " starting daemon"
190 # remove the socket if it exists
191 socket
= "%s/socket" % testroot
196 daemon
= subprocess
.Popen(["disorderd",
198 "--config", "%s/config" % testroot
],
200 # Wait for the socket to be created
202 while not os
.path
.exists(socket
):
205 print "FATAL: daemon failed to start up"
209 print " waiting for socket..."
211 print "FATAL: took too long for socket to appear"
215 print " took about %ds for socket to appear" % waited
220 Stop the daemon if it has not stopped already"""
226 print " stopping daemon"
227 os
.kill(daemon
.pid
, 15)
228 print " waiting for daemon"
230 print " daemon has stopped"
232 print " daemon already stopped"
235 def run(module
=None, report
=True):
238 Run the test in MODULE. This can be a string (in which case the module
239 will be imported) or a module object."""
242 # Locate the test module
244 # We're running a test stand-alone
247 name
= os
.path
.splitext(os
.path
.basename(sys
.argv
[0]))[0]
249 # We've been passed a module or a module name
250 if type(module
) == str:
251 module
= __import__(module
)
252 name
= module
.__name__
255 errs
= open("%s.log" % name
, "w")
256 # Ensure that disorder.py uses the test installation
257 disorder
._configfile
= "%s/config" % testroot
258 disorder
._userconf
= False
259 # Make config file etc
261 # Create some standard tracks
266 except AssertionError, e
:
282 Recursively delete directory D"""
283 if os
.path
.lexists(d
):
285 for dd
in os
.listdir(d
):
286 remove_dir("%s/%s" %
(d
, dd
))
292 c
= disorder
.client()
294 for d
in dirs_by_dir
:
295 xdirs
= dirs_by_dir
[d
]
296 dirs
= c
.directories(d
)
301 print "directory: %s" % d
302 print "expected: %s" % xdirs
303 print "got: %s" % dirs
305 for d
in files_by_dir
:
306 xfiles
= files_by_dir
[d
]
312 print "directory: %s" % d
313 print "expected: %s" % xfiles
314 print "got: %s" % files
318 # -----------------------------------------------------------------------------
324 testroot
= "%s/tests/testroot" % top_builddir
325 tracks
= "%s/tracks" % testroot