chiark / gitweb /
update copyright date
[disorder] / tests / dtest.py
CommitLineData
c5dbcd79 1#-*-python-*-
aa896435
RK
2#
3# This file is part of DisOrder.
22cd3411 4# Copyright (C) 2007, 2008 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
31773020 22import os,os.path,subprocess,sys,re,time,unicodedata,random,socket
3bfecfac
RK
23
24def 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
30cwd = os.getcwd()
31if os.path.exists("config.h"):
32 top_builddir = cwd
22cd3411 33elif os.path.exists("../config.h"):
3bfecfac
RK
34 top_builddir = os.path.dirname(cwd)
35else:
36 fatal("cannot identify build directory")
37
38# Make sure the Python build directory is on the module search path
39sys.path.insert(0, os.path.join(top_builddir, "python"))
40import disorder
41
d48eab4d 42# Make sure the build directories are on the executable search path
3bfecfac
RK
43ospath = os.environ["PATH"].split(os.pathsep)
44ospath.insert(0, os.path.join(top_builddir, "server"))
d48eab4d 45ospath.insert(0, os.path.join(top_builddir, "clients"))
6ce6b5a9 46ospath.insert(0, os.path.join(top_builddir, "tests"))
3bfecfac
RK
47os.environ["PATH"] = os.pathsep.join(ospath)
48
49# Parse the makefile in the current directory to identify the source directory
50top_srcdir = None
51for l in file("Makefile"):
52 r = re.match("top_srcdir *= *(.*)", l)
53 if r:
54 top_srcdir = r.group(1)
55 break
56if 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
64def copyfile(a,b):
65 """copyfile(A, B)
66Copy A to B."""
67 open(b,"w").write(open(a).read())
68
de5ccb1a
RK
69def 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
76def nfc(s):
77 """Convert UTF-8 string or unicode to NFC unicode."""
78 return unicodedata.normalize("NFC", to_unicode(s))
79
c5dbcd79
RK
80def maketrack(s):
81 """maketrack(S)
82
83Make 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)
22cd3411 88 copyfile("%s/sounds/long.ogg" % top_builddir, 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
105def 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
153def 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 167def 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 171collection fs %s %s/tracks
b6995afb
RK
172scratch %s/scratch.ogg
173gap 0
61192f93 174queue_pad 5
b6995afb
RK
175stopword 01 02 03 04 05 06 07 08 09 10
176stopword 1 2 3 4 5 6 7 8 9
177stopword 11 12 13 14 15 16 17 18 19 20
178stopword 21 22 23 24 25 26 27 28 29 30
179stopword the a an and to too in on of we i am as im for is
180username fred
181password fredpass
40c30921 182plugins
deaaa115 183plugins %s/plugins
40c30921 184plugins %s/plugins/.libs
b6995afb
RK
185player *.mp3 execraw disorder-decode
186player *.ogg execraw disorder-decode
187player *.wav execraw disorder-decode
188player *.flac execraw disorder-decode
189tracklength *.mp3 disorder-tracklength
190tracklength *.ogg disorder-tracklength
191tracklength *.wav disorder-tracklength
192tracklength *.flac disorder-tracklength
655f7563 193api rtp
213b4064
RK
194broadcast 127.0.0.1 %d
195broadcast_from 127.0.0.1 %d
f1592969 196mail_sender no.such.user.sorry@greenend.org.uk
031f8feb 197""" % (testroot, encoding, testroot, testroot, top_builddir, top_builddir,
213b4064 198 port, port + 1))
f0feb22e
RK
199
200def common_setup():
201 remove_dir(testroot)
202 os.mkdir(testroot)
203 # Choose a port
204 global port
205 port = random.randint(49152, 65535)
206 while not bindable(port + 1):
207 print "port %d is not bindable, trying another" % (port + 1)
208 port = random.randint(49152, 65535)
209 # Log anything sent to that port
210 packetlog = "%s/packetlog" % testroot
211 subprocess.Popen(["disorder-udplog",
212 "--output", packetlog,
213 "127.0.0.1", "%d" % port])
214 # disorder-udplog will quit when its parent process terminates
fbcfb257 215 copyfile("%s/sounds/scratch.ogg" % top_srcdir,
f9635e06 216 "%s/scratch.ogg" % testroot)
f0feb22e 217 default_config()
f9635e06 218
1c8f3db8
RK
219def start_daemon():
220 """start_daemon()
c5dbcd79 221
1c8f3db8 222Start the daemon."""
31773020 223 global daemon, errs, port
213b4064 224 assert daemon == None, "no daemon running"
6ce6b5a9
RK
225 if not bindable(port + 1):
226 print "waiting for port %d to become bindable again..." % (port + 1)
31773020 227 time.sleep(1)
6ce6b5a9 228 while not bindable(port + 1):
31773020 229 time.sleep(1)
c5dbcd79 230 print " starting daemon"
1a4a6350 231 # remove the socket if it exists
a0ead2ba 232 socket = "%s/home/socket" % testroot
1a4a6350
RK
233 try:
234 os.remove(socket)
235 except:
236 pass
c5dbcd79
RK
237 daemon = subprocess.Popen(["disorderd",
238 "--foreground",
239 "--config", "%s/config" % testroot],
240 stderr=errs)
1a4a6350
RK
241 # Wait for the socket to be created
242 waited = 0
243 while not os.path.exists(socket):
244 rc = daemon.poll()
245 if rc is not None:
246 print "FATAL: daemon failed to start up"
247 sys.exit(1)
248 waited += 1
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)
254 time.sleep(1)
255 if waited > 0:
256 print " took about %ds for socket to appear" % waited
c5dbcd79 257
f0feb22e
RK
258def create_user(username="fred", password="fredpass"):
259 """create_user(USERNAME, PASSWORD)
260
eb5dc014
RK
261 Create a user, abusing direct database access to do so. Gives the
262 user rights 'all', allowing them to do anything."""
f0feb22e
RK
263 print " creating user %s" % username
264 command(["disorder",
265 "--config", disorder._configfile, "--no-per-user-config",
266 "--user", "root", "adduser", username, password])
eb5dc014
RK
267 command(["disorder",
268 "--config", disorder._configfile, "--no-per-user-config",
269 "--user", "root", "edituser", username, "rights", "all"])
f0feb22e 270
d8055dc4 271def rescan(c=None):
dd9af5cb 272 print " initiating rescan"
d8055dc4
RK
273 if c is None:
274 c = disorder.client()
dd9af5cb 275 c.rescan('wait')
d8055dc4
RK
276 print " rescan completed"
277
f9635e06
RK
278def stop_daemon():
279 """stop_daemon()
c5dbcd79
RK
280
281Stop the daemon if it has not stopped already"""
282 global daemon
5c07ba71
RK
283 if daemon == None:
284 return
c5dbcd79
RK
285 rc = daemon.poll()
286 if rc == None:
eee9d4b3 287 print " stopping daemon"
445a0f66 288 disorder.client().shutdown()
1a4a6350 289 print " waiting for daemon"
c5dbcd79 290 rc = daemon.wait()
1a4a6350
RK
291 print " daemon has stopped"
292 else:
293 print " daemon already stopped"
c5dbcd79 294 daemon = None
030723a8 295 # Wait a bit for subprocess to finish too, to try to avoid stupid races
61366360 296 time.sleep(2)
c5dbcd79 297
5c07ba71
RK
298def run(module=None, report=True):
299 """dtest.run(MODULE)
300
301 Run the test in MODULE. This can be a string (in which case the module
302 will be imported) or a module object."""
c5dbcd79
RK
303 global tests
304 tests += 1
deaaa115 305 # Locate the test module
5c07ba71
RK
306 if module is None:
307 # We're running a test stand-alone
308 import __main__
309 module = __main__
310 name = os.path.splitext(os.path.basename(sys.argv[0]))[0]
311 else:
312 # We've been passed a module or a module name
313 if type(module) == str:
314 module = __import__(module)
315 name = module.__name__
05438e89 316 print "--- %s ---" % name
deaaa115 317 # Open the error log
5c07ba71 318 global errs
7b32e917
RK
319 logfile = "%s.log" % name
320 try:
321 os.remove(logfile)
322 except:
323 pass
324 errs = open(logfile, "a")
deaaa115 325 # Ensure that disorder.py uses the test installation
1c8f3db8
RK
326 disorder._configfile = "%s/config" % testroot
327 disorder._userconf = False
3514766b 328 # Make config file etc
f9635e06 329 common_setup()
deaaa115
RK
330 # Create some standard tracks
331 stdtracks()
c5dbcd79 332 try:
b12be54a 333 module.test()
eee9d4b3 334 finally:
7ebd22d9 335 stop_daemon()
c5dbcd79
RK
336 if report:
337 if failures:
338 print " FAILED"
339 sys.exit(1)
340 else:
341 print " OK"
342
343def remove_dir(d):
344 """remove_dir(D)
345
346Recursively delete directory D"""
347 if os.path.lexists(d):
348 if os.path.isdir(d):
349 for dd in os.listdir(d):
350 remove_dir("%s/%s" % (d, dd))
351 os.rmdir(d)
352 else:
353 os.remove(d)
354
31773020
RK
355def lists_have_same_contents(l1, l2):
356 """lists_have_same_contents(L1, L2)
357
358 Return True if L1 and L2 have equal members, in any order; else False."""
359 s1 = []
360 s1.extend(l1)
361 s1.sort()
362 s2 = []
363 s2.extend(l2)
364 s2.sort()
d8055dc4 365 return map(nfc, s1) == map(nfc, s2)
31773020 366
d8055dc4 367def check_files(chatty=True):
a4d8ba8f
RK
368 c = disorder.client()
369 failures = 0
370 for d in dirs_by_dir:
371 xdirs = dirs_by_dir[d]
372 dirs = c.directories(d)
31773020 373 if not lists_have_same_contents(xdirs, dirs):
d8055dc4
RK
374 if chatty:
375 print
376 print "directory: %s" % d
377 print "expected: %s" % xdirs
378 print "got: %s" % dirs
a4d8ba8f
RK
379 failures += 1
380 for d in files_by_dir:
381 xfiles = files_by_dir[d]
382 files = c.files(d)
31773020 383 if not lists_have_same_contents(xfiles, files):
d8055dc4
RK
384 if chatty:
385 print
386 print "directory: %s" % d
387 print "expected: %s" % xfiles
388 print "got: %s" % files
a4d8ba8f
RK
389 failures += 1
390 return failures
391
d48eab4d
RK
392def command(args):
393 """Execute a command given as a list and return its stdout"""
394 p = subprocess.Popen(args, stdout=subprocess.PIPE)
395 lines = p.stdout.readlines()
396 rc = p.wait()
397 assert rc == 0, ("%s returned status %s" % (args, rc))
398 return lines
399
c5dbcd79
RK
400# -----------------------------------------------------------------------------
401# Common setup
402
403tests = 0
404failures = 0
405daemon = None
3bfecfac 406testroot = "%s/tests/testroot" % top_builddir
121e3654 407tracks = "%s/tracks" % testroot