Commit | Line | Data |
---|---|---|
c5dbcd79 | 1 | #-*-python-*- |
aa896435 RK |
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 | # | |
c5dbcd79 RK |
21 | |
22 | """Utility module used by tests""" | |
23 | ||
f0c20432 | 24 | import os,os.path,subprocess,sys,re,time,unicodedata |
3bfecfac RK |
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 | # ----------------------------------------------------------------------------- | |
c5dbcd79 RK |
63 | |
64 | def copyfile(a,b): | |
65 | """copyfile(A, B) | |
66 | Copy A to B.""" | |
67 | open(b,"w").write(open(a).read()) | |
68 | ||
de5ccb1a RK |
69 | def to_unicode(s): |
70 | """Convert UTF-8 to unicode. A no-op if already unicode.""" | |
71 | if type(s) == unicode: | |
72 | return s | |
73 | else: | |
74 | return unicode(s, "UTF-8") | |
75 | ||
76 | def nfc(s): | |
77 | """Convert UTF-8 string or unicode to NFC unicode.""" | |
78 | return unicodedata.normalize("NFC", to_unicode(s)) | |
79 | ||
c5dbcd79 RK |
80 | def maketrack(s): |
81 | """maketrack(S) | |
82 | ||
83 | Make track with relative path S exist""" | |
121e3654 | 84 | trackpath = "%s/%s" % (tracks, s) |
c5dbcd79 RK |
85 | trackdir = os.path.dirname(trackpath) |
86 | if not os.path.exists(trackdir): | |
87 | os.makedirs(trackdir) | |
3bfecfac | 88 | copyfile("%s/sounds/slap.ogg" % top_srcdir, trackpath) |
121e3654 | 89 | # We record the tracks we created so they can be tested against |
7bbe944b RK |
90 | # server responses. We put them into NFC since that's what the server |
91 | # uses internally. | |
de5ccb1a | 92 | bits = nfc(s).split('/') |
121e3654 RK |
93 | dp = tracks |
94 | for d in bits [0:-1]: | |
95 | dd = "%s/%s" % (dp, d) | |
96 | if dp not in dirs_by_dir: | |
97 | dirs_by_dir[dp] = [] | |
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])) | |
c5dbcd79 RK |
104 | |
105 | def stdtracks(): | |
f9635e06 RK |
106 | # We create some tracks with non-ASCII characters in the name and |
107 | # we (currently) force UTF-8. | |
108 | # | |
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. | |
112 | # | |
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) | |
121e3654 RK |
118 | |
119 | global dirs_by_dir, files_by_dir | |
120 | dirs_by_dir={} | |
121 | files_by_dir={} | |
f9635e06 RK |
122 | |
123 | # C3 8C = 00CC LATIN CAPITAL LETTER I WITH GRAVE | |
124 | # (in NFC) | |
125 | maketrack("Joe Bloggs/First Album/01:F\xC3\x8Crst track.ogg") | |
126 | ||
c5dbcd79 | 127 | maketrack("Joe Bloggs/First Album/02:Second track.ogg") |
f9635e06 RK |
128 | |
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 | |
c5dbcd79 RK |
133 | maketrack("Joe Bloggs/First Album/04:Fourth track.ogg") |
134 | maketrack("Joe Bloggs/First Album/05:Fifth track.ogg") | |
c5dbcd79 RK |
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") | |
de5ccb1a RK |
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") | |
c5dbcd79 RK |
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") | |
0db97c0d | 152 | |
f9635e06 RK |
153 | def common_setup(): |
154 | remove_dir(testroot) | |
155 | os.mkdir(testroot) | |
156 | open("%s/config" % testroot, "w").write( | |
157 | """player *.ogg shell 'echo "$TRACK" >> %s/played.log' | |
b6995afb RK |
158 | home %s |
159 | collection fs UTF-8 %s/tracks | |
160 | scratch %s/scratch.ogg | |
161 | gap 0 | |
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 | |
167 | username fred | |
168 | password fredpass | |
169 | allow fred fredpass | |
40c30921 | 170 | plugins |
deaaa115 | 171 | plugins %s/plugins |
40c30921 | 172 | plugins %s/plugins/.libs |
b6995afb RK |
173 | player *.mp3 execraw disorder-decode |
174 | player *.ogg execraw disorder-decode | |
175 | player *.wav execraw disorder-decode | |
176 | player *.flac execraw disorder-decode | |
177 | tracklength *.mp3 disorder-tracklength | |
178 | tracklength *.ogg disorder-tracklength | |
179 | tracklength *.wav disorder-tracklength | |
180 | tracklength *.flac disorder-tracklength | |
40c30921 | 181 | """ % (testroot, testroot, testroot, testroot, top_builddir, top_builddir)) |
fbcfb257 | 182 | copyfile("%s/sounds/scratch.ogg" % top_srcdir, |
f9635e06 RK |
183 | "%s/scratch.ogg" % testroot) |
184 | ||
1c8f3db8 RK |
185 | def start_daemon(): |
186 | """start_daemon() | |
c5dbcd79 | 187 | |
1c8f3db8 | 188 | Start the daemon.""" |
fc9c24e3 | 189 | global daemon, errs |
c5dbcd79 | 190 | assert daemon == None |
c5dbcd79 | 191 | print " starting daemon" |
1a4a6350 RK |
192 | # remove the socket if it exists |
193 | socket = "%s/socket" % testroot | |
194 | try: | |
195 | os.remove(socket) | |
196 | except: | |
197 | pass | |
c5dbcd79 RK |
198 | daemon = subprocess.Popen(["disorderd", |
199 | "--foreground", | |
200 | "--config", "%s/config" % testroot], | |
201 | stderr=errs) | |
1a4a6350 RK |
202 | # Wait for the socket to be created |
203 | waited = 0 | |
204 | while not os.path.exists(socket): | |
205 | rc = daemon.poll() | |
206 | if rc is not None: | |
207 | print "FATAL: daemon failed to start up" | |
208 | sys.exit(1) | |
209 | waited += 1 | |
210 | if waited == 1: | |
211 | print " waiting for socket..." | |
212 | elif waited >= 60: | |
213 | print "FATAL: took too long for socket to appear" | |
214 | sys.exit(1) | |
215 | time.sleep(1) | |
216 | if waited > 0: | |
217 | print " took about %ds for socket to appear" % waited | |
c5dbcd79 | 218 | |
f9635e06 RK |
219 | def stop_daemon(): |
220 | """stop_daemon() | |
c5dbcd79 RK |
221 | |
222 | Stop the daemon if it has not stopped already""" | |
223 | global daemon | |
5c07ba71 RK |
224 | if daemon == None: |
225 | return | |
c5dbcd79 RK |
226 | rc = daemon.poll() |
227 | if rc == None: | |
eee9d4b3 | 228 | print " stopping daemon" |
c5dbcd79 | 229 | os.kill(daemon.pid, 15) |
1a4a6350 | 230 | print " waiting for daemon" |
c5dbcd79 | 231 | rc = daemon.wait() |
1a4a6350 RK |
232 | print " daemon has stopped" |
233 | else: | |
234 | print " daemon already stopped" | |
c5dbcd79 RK |
235 | daemon = None |
236 | ||
5c07ba71 RK |
237 | def run(module=None, report=True): |
238 | """dtest.run(MODULE) | |
239 | ||
240 | Run the test in MODULE. This can be a string (in which case the module | |
241 | will be imported) or a module object.""" | |
c5dbcd79 RK |
242 | global tests |
243 | tests += 1 | |
deaaa115 | 244 | # Locate the test module |
5c07ba71 RK |
245 | if module is None: |
246 | # We're running a test stand-alone | |
247 | import __main__ | |
248 | module = __main__ | |
249 | name = os.path.splitext(os.path.basename(sys.argv[0]))[0] | |
250 | else: | |
251 | # We've been passed a module or a module name | |
252 | if type(module) == str: | |
253 | module = __import__(module) | |
254 | name = module.__name__ | |
deaaa115 | 255 | # Open the error log |
5c07ba71 RK |
256 | global errs |
257 | errs = open("%s.log" % name, "w") | |
deaaa115 | 258 | # Ensure that disorder.py uses the test installation |
1c8f3db8 RK |
259 | disorder._configfile = "%s/config" % testroot |
260 | disorder._userconf = False | |
3514766b | 261 | # Make config file etc |
f9635e06 | 262 | common_setup() |
deaaa115 RK |
263 | # Create some standard tracks |
264 | stdtracks() | |
c5dbcd79 | 265 | try: |
eee9d4b3 | 266 | try: |
5c07ba71 | 267 | module.test() |
eee9d4b3 RK |
268 | except AssertionError, e: |
269 | global failures | |
270 | failures += 1 | |
271 | print e | |
272 | finally: | |
7ebd22d9 | 273 | stop_daemon() |
c5dbcd79 RK |
274 | if report: |
275 | if failures: | |
276 | print " FAILED" | |
277 | sys.exit(1) | |
278 | else: | |
279 | print " OK" | |
280 | ||
281 | def remove_dir(d): | |
282 | """remove_dir(D) | |
283 | ||
284 | Recursively delete directory D""" | |
285 | if os.path.lexists(d): | |
286 | if os.path.isdir(d): | |
287 | for dd in os.listdir(d): | |
288 | remove_dir("%s/%s" % (d, dd)) | |
289 | os.rmdir(d) | |
290 | else: | |
291 | os.remove(d) | |
292 | ||
a4d8ba8f RK |
293 | def check_files(): |
294 | c = disorder.client() | |
295 | failures = 0 | |
296 | for d in dirs_by_dir: | |
297 | xdirs = dirs_by_dir[d] | |
298 | dirs = c.directories(d) | |
299 | xdirs.sort() | |
300 | dirs.sort() | |
301 | if dirs != xdirs: | |
302 | ||
303 | print "directory: %s" % d | |
304 | print "expected: %s" % xdirs | |
305 | print "got: %s" % dirs | |
306 | failures += 1 | |
307 | for d in files_by_dir: | |
308 | xfiles = files_by_dir[d] | |
309 | files = c.files(d) | |
310 | xfiles.sort() | |
311 | files.sort() | |
312 | if files != xfiles: | |
313 | ||
314 | print "directory: %s" % d | |
315 | print "expected: %s" % xfiles | |
316 | print "got: %s" % files | |
317 | failures += 1 | |
318 | return failures | |
319 | ||
c5dbcd79 RK |
320 | # ----------------------------------------------------------------------------- |
321 | # Common setup | |
322 | ||
323 | tests = 0 | |
324 | failures = 0 | |
325 | daemon = None | |
3bfecfac | 326 | testroot = "%s/tests/testroot" % top_builddir |
121e3654 | 327 | tracks = "%s/tracks" % testroot |