chiark / gitweb /
tests/udplog: new program to log packets sent by speaker during
[disorder] / tests / dtest.py
CommitLineData
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
31773020 24import os,os.path,subprocess,sys,re,time,unicodedata,random,socket
3bfecfac
RK
25
26def 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
32cwd = os.getcwd()
33if os.path.exists("config.h"):
34 top_builddir = cwd
35elif os.path.exists("alltests"):
36 top_builddir = os.path.dirname(cwd)
37else:
38 fatal("cannot identify build directory")
39
40# Make sure the Python build directory is on the module search path
41sys.path.insert(0, os.path.join(top_builddir, "python"))
42import disorder
43
d48eab4d 44# Make sure the build directories are on the executable search path
3bfecfac
RK
45ospath = os.environ["PATH"].split(os.pathsep)
46ospath.insert(0, os.path.join(top_builddir, "server"))
d48eab4d 47ospath.insert(0, os.path.join(top_builddir, "clients"))
6ce6b5a9 48ospath.insert(0, os.path.join(top_builddir, "tests"))
3bfecfac
RK
49os.environ["PATH"] = os.pathsep.join(ospath)
50
51# Parse the makefile in the current directory to identify the source directory
52top_srcdir = None
53for l in file("Makefile"):
54 r = re.match("top_srcdir *= *(.*)", l)
55 if r:
56 top_srcdir = r.group(1)
57 break
58if not top_srcdir:
59 fatal("cannot identify source directory")
60
61# The tests source directory must be on the module search path already since
62# we found dtest.py
63
64# -----------------------------------------------------------------------------
c5dbcd79
RK
65
66def copyfile(a,b):
67 """copyfile(A, B)
68Copy A to B."""
69 open(b,"w").write(open(a).read())
70
de5ccb1a
RK
71def to_unicode(s):
72 """Convert UTF-8 to unicode. A no-op if already unicode."""
73 if type(s) == unicode:
74 return s
75 else:
76 return unicode(s, "UTF-8")
77
78def nfc(s):
79 """Convert UTF-8 string or unicode to NFC unicode."""
80 return unicodedata.normalize("NFC", to_unicode(s))
81
c5dbcd79
RK
82def maketrack(s):
83 """maketrack(S)
84
85Make track with relative path S exist"""
121e3654 86 trackpath = "%s/%s" % (tracks, s)
c5dbcd79
RK
87 trackdir = os.path.dirname(trackpath)
88 if not os.path.exists(trackdir):
89 os.makedirs(trackdir)
3bfecfac 90 copyfile("%s/sounds/slap.ogg" % top_srcdir, trackpath)
121e3654 91 # We record the tracks we created so they can be tested against
7bbe944b
RK
92 # server responses. We put them into NFC since that's what the server
93 # uses internally.
de5ccb1a 94 bits = nfc(s).split('/')
121e3654
RK
95 dp = tracks
96 for d in bits [0:-1]:
97 dd = "%s/%s" % (dp, d)
98 if dp not in dirs_by_dir:
99 dirs_by_dir[dp] = []
100 if dd not in dirs_by_dir[dp]:
101 dirs_by_dir[dp].append(dd)
102 dp = "%s/%s" % (dp, d)
103 if dp not in files_by_dir:
104 files_by_dir[dp] = []
105 files_by_dir[dp].append("%s/%s" % (dp, bits[-1]))
c5dbcd79
RK
106
107def stdtracks():
f9635e06
RK
108 # We create some tracks with non-ASCII characters in the name and
109 # we (currently) force UTF-8.
110 #
111 # On a traditional UNIX filesystem, that treats filenames as byte strings
112 # with special significant for '/', this should just work, though the
113 # names will look wrong to ls(1) in a non UTF-8 locale.
114 #
115 # On Apple HFS+ filenames normalized to a decomposed form that isn't quite
116 # NFD, so our attempts to have both normalized and denormalized filenames
117 # is frustrated. Provided we test on traditional filesytsems too this
118 # shouldn't be a problem.
119 # (See http://developer.apple.com/qa/qa2001/qa1173.html)
121e3654
RK
120
121 global dirs_by_dir, files_by_dir
122 dirs_by_dir={}
123 files_by_dir={}
f9635e06
RK
124
125 # C3 8C = 00CC LATIN CAPITAL LETTER I WITH GRAVE
126 # (in NFC)
127 maketrack("Joe Bloggs/First Album/01:F\xC3\x8Crst track.ogg")
128
c5dbcd79 129 maketrack("Joe Bloggs/First Album/02:Second track.ogg")
f9635e06
RK
130
131 # CC 81 = 0301 COMBINING ACUTE ACCENT
132 # (giving an NFD i-acute)
133 maketrack("Joe Bloggs/First Album/03:ThI\xCC\x81rd track.ogg")
134 # ...hopefuly giving C3 8D = 00CD LATIN CAPITAL LETTER I WITH ACUTE
c5dbcd79
RK
135 maketrack("Joe Bloggs/First Album/04:Fourth track.ogg")
136 maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
c5dbcd79
RK
137 maketrack("Joe Bloggs/Second Album/01:First track.ogg")
138 maketrack("Joe Bloggs/Second Album/02:Second track.ogg")
139 maketrack("Joe Bloggs/Second Album/03:Third track.ogg")
140 maketrack("Joe Bloggs/Second Album/04:Fourth track.ogg")
141 maketrack("Joe Bloggs/Second Album/05:Fifth track.ogg")
de5ccb1a
RK
142 maketrack("Joe Bloggs/Third Album/01:First_track.ogg")
143 maketrack("Joe Bloggs/Third Album/02:Second_track.ogg")
144 maketrack("Joe Bloggs/Third Album/03:Third_track.ogg")
145 maketrack("Joe Bloggs/Third Album/04:Fourth_track.ogg")
146 maketrack("Joe Bloggs/Third Album/05:Fifth_track.ogg")
c5dbcd79
RK
147 maketrack("Fred Smith/Boring/01:Dull.ogg")
148 maketrack("Fred Smith/Boring/02:Tedious.ogg")
149 maketrack("Fred Smith/Boring/03:Drum Solo.ogg")
150 maketrack("Fred Smith/Boring/04:Yawn.ogg")
151 maketrack("misc/blahblahblah.ogg")
152 maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg")
153 maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg")
31773020
RK
154
155def bindable(p):
156 """bindable(P)
157
158 Return True iff UDP port P is bindable, else False"""
159 s = socket.socket(socket.AF_INET,
160 socket.SOCK_DGRAM,
161 socket.IPPROTO_UDP)
162 try:
163 s.bind(("127.0.0.1", p))
164 s.close()
165 return True
166 except:
167 return False
168
f9635e06
RK
169def common_setup():
170 remove_dir(testroot)
171 os.mkdir(testroot)
6ce6b5a9 172 # Choose a port
213b4064
RK
173 global port
174 port = random.randint(49152, 65535)
6ce6b5a9
RK
175 while not bindable(port + 1):
176 print "port %d is not bindable, trying another" % (port + 1)
31773020 177 port = random.randint(49152, 65535)
6ce6b5a9
RK
178 # Log anything sent to that port
179 packetlog = "%s/packetlog" % testroot
180 subprocess.Popen(["disorder-udplog",
181 "--output", packetlog,
182 "127.0.0.1", "%d" % port])
183 # disorder-udplog will quit when its parent process terminates
f9635e06 184 open("%s/config" % testroot, "w").write(
213b4064 185 """home %s
b6995afb
RK
186collection fs UTF-8 %s/tracks
187scratch %s/scratch.ogg
188gap 0
189stopword 01 02 03 04 05 06 07 08 09 10
190stopword 1 2 3 4 5 6 7 8 9
191stopword 11 12 13 14 15 16 17 18 19 20
192stopword 21 22 23 24 25 26 27 28 29 30
193stopword the a an and to too in on of we i am as im for is
194username fred
195password fredpass
196allow fred fredpass
445a0f66 197trust fred
40c30921 198plugins
deaaa115 199plugins %s/plugins
40c30921 200plugins %s/plugins/.libs
b6995afb
RK
201player *.mp3 execraw disorder-decode
202player *.ogg execraw disorder-decode
203player *.wav execraw disorder-decode
204player *.flac execraw disorder-decode
205tracklength *.mp3 disorder-tracklength
206tracklength *.ogg disorder-tracklength
207tracklength *.wav disorder-tracklength
208tracklength *.flac disorder-tracklength
213b4064
RK
209speaker_backend network
210broadcast 127.0.0.1 %d
211broadcast_from 127.0.0.1 %d
212""" % (testroot, testroot, testroot, top_builddir, top_builddir,
213 port, port + 1))
fbcfb257 214 copyfile("%s/sounds/scratch.ogg" % top_srcdir,
f9635e06
RK
215 "%s/scratch.ogg" % testroot)
216
1c8f3db8
RK
217def start_daemon():
218 """start_daemon()
c5dbcd79 219
1c8f3db8 220Start the daemon."""
31773020 221 global daemon, errs, port
213b4064 222 assert daemon == None, "no daemon running"
6ce6b5a9
RK
223 if not bindable(port + 1):
224 print "waiting for port %d to become bindable again..." % (port + 1)
31773020 225 time.sleep(1)
6ce6b5a9 226 while not bindable(port + 1):
31773020 227 time.sleep(1)
c5dbcd79 228 print " starting daemon"
1a4a6350
RK
229 # remove the socket if it exists
230 socket = "%s/socket" % testroot
231 try:
232 os.remove(socket)
233 except:
234 pass
c5dbcd79
RK
235 daemon = subprocess.Popen(["disorderd",
236 "--foreground",
237 "--config", "%s/config" % testroot],
238 stderr=errs)
1a4a6350
RK
239 # Wait for the socket to be created
240 waited = 0
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)
246 waited += 1
247 if waited == 1:
248 print " waiting for socket..."
249 elif waited >= 60:
250 print "FATAL: took too long for socket to appear"
251 sys.exit(1)
252 time.sleep(1)
253 if waited > 0:
254 print " took about %ds for socket to appear" % waited
c5dbcd79 255
f9635e06
RK
256def stop_daemon():
257 """stop_daemon()
c5dbcd79
RK
258
259Stop the daemon if it has not stopped already"""
260 global daemon
5c07ba71
RK
261 if daemon == None:
262 return
c5dbcd79
RK
263 rc = daemon.poll()
264 if rc == None:
eee9d4b3 265 print " stopping daemon"
445a0f66 266 disorder.client().shutdown()
1a4a6350 267 print " waiting for daemon"
c5dbcd79 268 rc = daemon.wait()
1a4a6350
RK
269 print " daemon has stopped"
270 else:
271 print " daemon already stopped"
c5dbcd79
RK
272 daemon = None
273
5c07ba71
RK
274def run(module=None, report=True):
275 """dtest.run(MODULE)
276
277 Run the test in MODULE. This can be a string (in which case the module
278 will be imported) or a module object."""
c5dbcd79
RK
279 global tests
280 tests += 1
deaaa115 281 # Locate the test module
5c07ba71
RK
282 if module is None:
283 # We're running a test stand-alone
284 import __main__
285 module = __main__
286 name = os.path.splitext(os.path.basename(sys.argv[0]))[0]
287 else:
288 # We've been passed a module or a module name
289 if type(module) == str:
290 module = __import__(module)
291 name = module.__name__
deaaa115 292 # Open the error log
5c07ba71
RK
293 global errs
294 errs = open("%s.log" % name, "w")
deaaa115 295 # Ensure that disorder.py uses the test installation
1c8f3db8
RK
296 disorder._configfile = "%s/config" % testroot
297 disorder._userconf = False
3514766b 298 # Make config file etc
f9635e06 299 common_setup()
deaaa115
RK
300 # Create some standard tracks
301 stdtracks()
c5dbcd79 302 try:
eee9d4b3 303 try:
5c07ba71 304 module.test()
eee9d4b3
RK
305 except AssertionError, e:
306 global failures
307 failures += 1
213b4064 308 print "assertion failed: %s" % e.message
eee9d4b3 309 finally:
7ebd22d9 310 stop_daemon()
c5dbcd79
RK
311 if report:
312 if failures:
313 print " FAILED"
314 sys.exit(1)
315 else:
316 print " OK"
317
318def remove_dir(d):
319 """remove_dir(D)
320
321Recursively delete directory D"""
322 if os.path.lexists(d):
323 if os.path.isdir(d):
324 for dd in os.listdir(d):
325 remove_dir("%s/%s" % (d, dd))
326 os.rmdir(d)
327 else:
328 os.remove(d)
329
31773020
RK
330def lists_have_same_contents(l1, l2):
331 """lists_have_same_contents(L1, L2)
332
333 Return True if L1 and L2 have equal members, in any order; else False."""
334 s1 = []
335 s1.extend(l1)
336 s1.sort()
337 s2 = []
338 s2.extend(l2)
339 s2.sort()
340 return s1 == s2
341
a4d8ba8f
RK
342def check_files():
343 c = disorder.client()
344 failures = 0
345 for d in dirs_by_dir:
346 xdirs = dirs_by_dir[d]
347 dirs = c.directories(d)
31773020 348 if not lists_have_same_contents(xdirs, dirs):
a4d8ba8f
RK
349 print
350 print "directory: %s" % d
351 print "expected: %s" % xdirs
352 print "got: %s" % dirs
353 failures += 1
354 for d in files_by_dir:
355 xfiles = files_by_dir[d]
356 files = c.files(d)
31773020 357 if not lists_have_same_contents(xfiles, files):
a4d8ba8f
RK
358 print
359 print "directory: %s" % d
360 print "expected: %s" % xfiles
361 print "got: %s" % files
362 failures += 1
363 return failures
364
d48eab4d
RK
365def command(args):
366 """Execute a command given as a list and return its stdout"""
367 p = subprocess.Popen(args, stdout=subprocess.PIPE)
368 lines = p.stdout.readlines()
369 rc = p.wait()
370 assert rc == 0, ("%s returned status %s" % (args, rc))
371 return lines
372
c5dbcd79
RK
373# -----------------------------------------------------------------------------
374# Common setup
375
376tests = 0
377failures = 0
378daemon = None
3bfecfac 379testroot = "%s/tests/testroot" % top_builddir
121e3654 380tracks = "%s/tracks" % testroot