Commit | Line | Data |
---|---|---|
c5dbcd79 | 1 | #-*-python-*- |
aa896435 RK |
2 | # |
3 | # This file is part of DisOrder. | |
8a886602 | 4 | # Copyright (C) 2007-2012 Richard Kettlewell |
aa896435 | 5 | # |
e7eb3a27 | 6 | # This program is free software: you can redistribute it and/or modify |
aa896435 | 7 | # it under the terms of the GNU General Public License as published by |
e7eb3a27 | 8 | # the Free Software Foundation, either version 3 of the License, or |
aa896435 RK |
9 | # (at your option) any later version. |
10 | # | |
e7eb3a27 RK |
11 | # This program is distributed in the hope that it will be useful, |
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | # GNU General Public License for more details. | |
15 | # | |
aa896435 | 16 | # You should have received a copy of the GNU General Public License |
e7eb3a27 | 17 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
aa896435 | 18 | # |
c5dbcd79 RK |
19 | |
20 | """Utility module used by tests""" | |
21 | ||
e663c61b | 22 | import os,os.path,subprocess,sys,re,time,unicodedata,random,socket,traceback |
3bfecfac RK |
23 | |
24 | def fatal(s): | |
25 | """Write an error message and exit""" | |
26 | sys.stderr.write("ERROR: %s\n" % s) | |
27 | sys.exit(1) | |
28 | ||
29 | # Identify the top build directory | |
30 | cwd = os.getcwd() | |
31 | if os.path.exists("config.h"): | |
32 | top_builddir = cwd | |
22cd3411 | 33 | elif os.path.exists("../config.h"): |
3bfecfac RK |
34 | top_builddir = os.path.dirname(cwd) |
35 | else: | |
36 | fatal("cannot identify build directory") | |
37 | ||
38 | # Make sure the Python build directory is on the module search path | |
39 | sys.path.insert(0, os.path.join(top_builddir, "python")) | |
40 | import disorder | |
41 | ||
d48eab4d | 42 | # Make sure the build directories are on the executable search path |
3bfecfac RK |
43 | ospath = os.environ["PATH"].split(os.pathsep) |
44 | ospath.insert(0, os.path.join(top_builddir, "server")) | |
d48eab4d | 45 | ospath.insert(0, os.path.join(top_builddir, "clients")) |
6ce6b5a9 | 46 | ospath.insert(0, os.path.join(top_builddir, "tests")) |
3bfecfac RK |
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) | |
f07e139b | 88 | copyfile("%s/sounds/long.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") | |
31773020 RK |
152 | |
153 | def bindable(p): | |
154 | """bindable(P) | |
155 | ||
156 | Return True iff UDP port P is bindable, else False""" | |
157 | s = socket.socket(socket.AF_INET, | |
158 | socket.SOCK_DGRAM, | |
159 | socket.IPPROTO_UDP) | |
160 | try: | |
161 | s.bind(("127.0.0.1", p)) | |
162 | s.close() | |
163 | return True | |
164 | except: | |
165 | return False | |
166 | ||
031f8feb | 167 | def default_config(encoding="UTF-8"): |
f0feb22e | 168 | """Write the default config""" |
f9635e06 | 169 | open("%s/config" % testroot, "w").write( |
a0ead2ba | 170 | """home %s/home |
031f8feb | 171 | collection fs %s %s/tracks |
b6995afb | 172 | scratch %s/scratch.ogg |
61192f93 | 173 | queue_pad 5 |
b6995afb RK |
174 | stopword 01 02 03 04 05 06 07 08 09 10 |
175 | stopword 1 2 3 4 5 6 7 8 9 | |
176 | stopword 11 12 13 14 15 16 17 18 19 20 | |
177 | stopword 21 22 23 24 25 26 27 28 29 30 | |
178 | stopword the a an and to too in on of we i am as im for is | |
179 | username fred | |
180 | password fredpass | |
40c30921 | 181 | plugins |
deaaa115 | 182 | plugins %s/plugins |
40c30921 | 183 | plugins %s/plugins/.libs |
b6995afb RK |
184 | player *.mp3 execraw disorder-decode |
185 | player *.ogg execraw disorder-decode | |
186 | player *.wav execraw disorder-decode | |
187 | player *.flac execraw disorder-decode | |
188 | tracklength *.mp3 disorder-tracklength | |
189 | tracklength *.ogg disorder-tracklength | |
190 | tracklength *.wav disorder-tracklength | |
191 | tracklength *.flac disorder-tracklength | |
655f7563 | 192 | api rtp |
213b4064 RK |
193 | broadcast 127.0.0.1 %d |
194 | broadcast_from 127.0.0.1 %d | |
f1592969 | 195 | mail_sender no.such.user.sorry@greenend.org.uk |
031f8feb | 196 | """ % (testroot, encoding, testroot, testroot, top_builddir, top_builddir, |
213b4064 | 197 | port, port + 1)) |
f0feb22e RK |
198 | |
199 | def common_setup(): | |
200 | remove_dir(testroot) | |
201 | os.mkdir(testroot) | |
202 | # Choose a port | |
203 | global port | |
263ed9c1 | 204 | port = random.randint(49152, 65530) |
f0feb22e RK |
205 | while not bindable(port + 1): |
206 | print "port %d is not bindable, trying another" % (port + 1) | |
263ed9c1 | 207 | port = random.randint(49152, 65530) |
f0feb22e RK |
208 | # Log anything sent to that port |
209 | packetlog = "%s/packetlog" % testroot | |
210 | subprocess.Popen(["disorder-udplog", | |
211 | "--output", packetlog, | |
212 | "127.0.0.1", "%d" % port]) | |
213 | # disorder-udplog will quit when its parent process terminates | |
fbcfb257 | 214 | copyfile("%s/sounds/scratch.ogg" % top_srcdir, |
f9635e06 | 215 | "%s/scratch.ogg" % testroot) |
f0feb22e | 216 | default_config() |
f9635e06 | 217 | |
1c8f3db8 RK |
218 | def start_daemon(): |
219 | """start_daemon() | |
c5dbcd79 | 220 | |
1c8f3db8 | 221 | Start the daemon.""" |
31773020 | 222 | global daemon, errs, port |
213b4064 | 223 | assert daemon == None, "no daemon running" |
6ce6b5a9 RK |
224 | if not bindable(port + 1): |
225 | print "waiting for port %d to become bindable again..." % (port + 1) | |
31773020 | 226 | time.sleep(1) |
6ce6b5a9 | 227 | while not bindable(port + 1): |
31773020 | 228 | time.sleep(1) |
c5dbcd79 | 229 | print " starting daemon" |
1a4a6350 | 230 | # remove the socket if it exists |
a0ead2ba | 231 | socket = "%s/home/socket" % testroot |
abf64ff8 | 232 | if os.path.exists(socket): |
1a4a6350 | 233 | os.remove(socket) |
c5dbcd79 RK |
234 | daemon = subprocess.Popen(["disorderd", |
235 | "--foreground", | |
236 | "--config", "%s/config" % testroot], | |
237 | stderr=errs) | |
1a4a6350 RK |
238 | # Wait for the socket to be created |
239 | waited = 0 | |
ae1c9228 | 240 | sleep_resolution = 0.125 |
1a4a6350 RK |
241 | while not os.path.exists(socket): |
242 | rc = daemon.poll() | |
243 | if rc is not None: | |
244 | print "FATAL: daemon failed to start up" | |
245 | sys.exit(1) | |
ae1c9228 RK |
246 | waited += sleep_resolution |
247 | if sleep_resolution < 1: | |
248 | sleep_resolution *= 2 | |
1a4a6350 RK |
249 | if waited == 1: |
250 | print " waiting for socket..." | |
251 | elif waited >= 60: | |
252 | print "FATAL: took too long for socket to appear" | |
253 | sys.exit(1) | |
ae1c9228 | 254 | time.sleep(sleep_resolution) |
1a4a6350 | 255 | if waited > 0: |
ae1c9228 | 256 | print " took about %ss for socket to appear" % waited |
abf64ff8 | 257 | # Wait for root user to be created |
bcef8d6f RK |
258 | command(["disorderd", |
259 | "--config", disorder._configfile, | |
abf64ff8 | 260 | "--wait-for-root"]) |
c5dbcd79 | 261 | |
f0feb22e RK |
262 | def create_user(username="fred", password="fredpass"): |
263 | """create_user(USERNAME, PASSWORD) | |
264 | ||
eb5dc014 RK |
265 | Create a user, abusing direct database access to do so. Gives the |
266 | user rights 'all', allowing them to do anything.""" | |
f0feb22e RK |
267 | print " creating user %s" % username |
268 | command(["disorder", | |
269 | "--config", disorder._configfile, "--no-per-user-config", | |
270 | "--user", "root", "adduser", username, password]) | |
eb5dc014 RK |
271 | command(["disorder", |
272 | "--config", disorder._configfile, "--no-per-user-config", | |
273 | "--user", "root", "edituser", username, "rights", "all"]) | |
f0feb22e | 274 | |
d8055dc4 | 275 | def rescan(c=None): |
dd9af5cb | 276 | print " initiating rescan" |
d8055dc4 RK |
277 | if c is None: |
278 | c = disorder.client() | |
dd9af5cb | 279 | c.rescan('wait') |
d8055dc4 RK |
280 | print " rescan completed" |
281 | ||
f9635e06 RK |
282 | def stop_daemon(): |
283 | """stop_daemon() | |
c5dbcd79 RK |
284 | |
285 | Stop the daemon if it has not stopped already""" | |
286 | global daemon | |
5c07ba71 | 287 | if daemon == None: |
53e8f9c5 | 288 | print " (daemon not running)" |
5c07ba71 | 289 | return |
c5dbcd79 RK |
290 | rc = daemon.poll() |
291 | if rc == None: | |
eee9d4b3 | 292 | print " stopping daemon" |
12746062 | 293 | os.kill(daemon.pid, 15) |
1a4a6350 | 294 | print " waiting for daemon" |
c5dbcd79 | 295 | rc = daemon.wait() |
12746062 | 296 | print " daemon has stopped (rc=%d)" % rc |
1a4a6350 RK |
297 | else: |
298 | print " daemon already stopped" | |
c5dbcd79 RK |
299 | daemon = None |
300 | ||
5c07ba71 RK |
301 | def run(module=None, report=True): |
302 | """dtest.run(MODULE) | |
303 | ||
304 | Run the test in MODULE. This can be a string (in which case the module | |
305 | will be imported) or a module object.""" | |
e663c61b | 306 | global tests, failures |
c5dbcd79 | 307 | tests += 1 |
deaaa115 | 308 | # Locate the test module |
5c07ba71 RK |
309 | if module is None: |
310 | # We're running a test stand-alone | |
311 | import __main__ | |
312 | module = __main__ | |
313 | name = os.path.splitext(os.path.basename(sys.argv[0]))[0] | |
314 | else: | |
315 | # We've been passed a module or a module name | |
316 | if type(module) == str: | |
317 | module = __import__(module) | |
318 | name = module.__name__ | |
05438e89 | 319 | print "--- %s ---" % name |
deaaa115 | 320 | # Open the error log |
5c07ba71 | 321 | global errs |
7b32e917 RK |
322 | logfile = "%s.log" % name |
323 | try: | |
324 | os.remove(logfile) | |
325 | except: | |
326 | pass | |
327 | errs = open(logfile, "a") | |
deaaa115 | 328 | # Ensure that disorder.py uses the test installation |
1c8f3db8 RK |
329 | disorder._configfile = "%s/config" % testroot |
330 | disorder._userconf = False | |
3514766b | 331 | # Make config file etc |
f9635e06 | 332 | common_setup() |
deaaa115 RK |
333 | # Create some standard tracks |
334 | stdtracks() | |
c5dbcd79 | 335 | try: |
b12be54a | 336 | module.test() |
4b37a75e | 337 | except Exception, e: |
e663c61b RK |
338 | traceback.print_exc(None, sys.stderr) |
339 | failures += 1 | |
4692cf6a RK |
340 | finally: |
341 | stop_daemon() | |
53e8f9c5 | 342 | os.system("ps -ef | grep disorderd") |
c5dbcd79 RK |
343 | if report: |
344 | if failures: | |
345 | print " FAILED" | |
346 | sys.exit(1) | |
347 | else: | |
348 | print " OK" | |
349 | ||
350 | def remove_dir(d): | |
351 | """remove_dir(D) | |
352 | ||
353 | Recursively delete directory D""" | |
354 | if os.path.lexists(d): | |
355 | if os.path.isdir(d): | |
356 | for dd in os.listdir(d): | |
357 | remove_dir("%s/%s" % (d, dd)) | |
358 | os.rmdir(d) | |
359 | else: | |
360 | os.remove(d) | |
361 | ||
31773020 RK |
362 | def lists_have_same_contents(l1, l2): |
363 | """lists_have_same_contents(L1, L2) | |
364 | ||
365 | Return True if L1 and L2 have equal members, in any order; else False.""" | |
366 | s1 = [] | |
367 | s1.extend(l1) | |
368 | s1.sort() | |
369 | s2 = [] | |
370 | s2.extend(l2) | |
371 | s2.sort() | |
d8055dc4 | 372 | return map(nfc, s1) == map(nfc, s2) |
31773020 | 373 | |
d8055dc4 | 374 | def check_files(chatty=True): |
a4d8ba8f RK |
375 | c = disorder.client() |
376 | failures = 0 | |
377 | for d in dirs_by_dir: | |
378 | xdirs = dirs_by_dir[d] | |
379 | dirs = c.directories(d) | |
31773020 | 380 | if not lists_have_same_contents(xdirs, dirs): |
d8055dc4 RK |
381 | if chatty: |
382 | ||
383 | print "directory: %s" % d | |
384 | print "expected: %s" % xdirs | |
385 | print "got: %s" % dirs | |
a4d8ba8f RK |
386 | failures += 1 |
387 | for d in files_by_dir: | |
388 | xfiles = files_by_dir[d] | |
389 | files = c.files(d) | |
31773020 | 390 | if not lists_have_same_contents(xfiles, files): |
d8055dc4 RK |
391 | if chatty: |
392 | ||
393 | print "directory: %s" % d | |
394 | print "expected: %s" % xfiles | |
395 | print "got: %s" % files | |
a4d8ba8f RK |
396 | failures += 1 |
397 | return failures | |
398 | ||
d48eab4d RK |
399 | def command(args): |
400 | """Execute a command given as a list and return its stdout""" | |
401 | p = subprocess.Popen(args, stdout=subprocess.PIPE) | |
402 | lines = p.stdout.readlines() | |
403 | rc = p.wait() | |
404 | assert rc == 0, ("%s returned status %s" % (args, rc)) | |
405 | return lines | |
406 | ||
c5dbcd79 RK |
407 | # ----------------------------------------------------------------------------- |
408 | # Common setup | |
409 | ||
410 | tests = 0 | |
411 | failures = 0 | |
412 | daemon = None | |
3bfecfac | 413 | testroot = "%s/tests/testroot" % top_builddir |
121e3654 | 414 | tracks = "%s/tracks" % testroot |