"""Utility module used by tests"""
-import os,os.path,subprocess,sys,re
+import os,os.path,subprocess,sys,re,unicodedata
def fatal(s):
"""Write an error message and exit"""
"""maketrack(S)
Make track with relative path S exist"""
- trackpath = "%s/tracks/%s" % (testroot, s)
+ trackpath = "%s/%s" % (tracks, s)
trackdir = os.path.dirname(trackpath)
if not os.path.exists(trackdir):
os.makedirs(trackdir)
copyfile("%s/sounds/slap.ogg" % top_srcdir, trackpath)
+ # We record the tracks we created so they can be tested against
+ # server responses. We put them into NFC since that's what the server
+ # uses internally.
+ bits = unicodedata.normalize("NFC",
+ unicode(s, "UTF-8")).split('/')
+ dp = tracks
+ for d in bits [0:-1]:
+ dd = "%s/%s" % (dp, d)
+ if dp not in dirs_by_dir:
+ dirs_by_dir[dp] = []
+ if dd not in dirs_by_dir[dp]:
+ dirs_by_dir[dp].append(dd)
+ dp = "%s/%s" % (dp, d)
+ if dp not in files_by_dir:
+ files_by_dir[dp] = []
+ files_by_dir[dp].append("%s/%s" % (dp, bits[-1]))
def stdtracks():
- maketrack("Joe Bloggs/First Album/01:First track.ogg")
+ # We create some tracks with non-ASCII characters in the name and
+ # we (currently) force UTF-8.
+ #
+ # On a traditional UNIX filesystem, that treats filenames as byte strings
+ # with special significant for '/', this should just work, though the
+ # names will look wrong to ls(1) in a non UTF-8 locale.
+ #
+ # On Apple HFS+ filenames normalized to a decomposed form that isn't quite
+ # NFD, so our attempts to have both normalized and denormalized filenames
+ # is frustrated. Provided we test on traditional filesytsems too this
+ # shouldn't be a problem.
+ # (See http://developer.apple.com/qa/qa2001/qa1173.html)
+
+ global dirs_by_dir, files_by_dir
+ dirs_by_dir={}
+ files_by_dir={}
+
+ # C3 8C = 00CC LATIN CAPITAL LETTER I WITH GRAVE
+ # (in NFC)
+ maketrack("Joe Bloggs/First Album/01:F\xC3\x8Crst track.ogg")
+
maketrack("Joe Bloggs/First Album/02:Second track.ogg")
- maketrack("Joe Bloggs/First Album/03:Third track.ogg")
+
+ # CC 81 = 0301 COMBINING ACUTE ACCENT
+ # (giving an NFD i-acute)
+ maketrack("Joe Bloggs/First Album/03:ThI\xCC\x81rd track.ogg")
+ # ...hopefuly giving C3 8D = 00CD LATIN CAPITAL LETTER I WITH ACUTE
maketrack("Joe Bloggs/First Album/04:Fourth track.ogg")
maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
- maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
maketrack("Joe Bloggs/Second Album/01:First track.ogg")
maketrack("Joe Bloggs/Second Album/02:Second track.ogg")
maketrack("Joe Bloggs/Second Album/03:Third track.ogg")
maketrack("Joe Bloggs/Second Album/04:Fourth track.ogg")
maketrack("Joe Bloggs/Second Album/05:Fifth track.ogg")
- maketrack("Joe Bloggs/Second Album/05:Fifth track.ogg")
- maketrack("Joe Bloggs/First Album/01:First track.ogg")
- maketrack("Joe Bloggs/First Album/02:Second track.ogg")
- maketrack("Joe Bloggs/First Album/03:Third track.ogg")
- maketrack("Joe Bloggs/First Album/04:Fourth track.ogg")
- maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
+ maketrack("Joe Bloggs/Third Album/01:First track.ogg")
+ maketrack("Joe Bloggs/Third Album/02:Second track.ogg")
+ maketrack("Joe Bloggs/Third Album/03:Third track.ogg")
+ maketrack("Joe Bloggs/Third Album/04:Fourth track.ogg")
+ maketrack("Joe Bloggs/Third Album/05:Fifth track.ogg")
maketrack("Fred Smith/Boring/01:Dull.ogg")
maketrack("Fred Smith/Boring/02:Tedious.ogg")
maketrack("Fred Smith/Boring/03:Drum Solo.ogg")
maketrack("misc/blahblahblah.ogg")
maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg")
maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg")
+
+def common_setup():
+ remove_dir(testroot)
+ os.mkdir(testroot)
+ open("%s/config" % testroot, "w").write(
+ """player *.ogg shell 'echo "$TRACK" >> %s/played.log'
+home %s
+collection fs UTF-8 %s/tracks
+scratch %s/scratch.ogg
+gap 0
+stopword 01 02 03 04 05 06 07 08 09 10
+stopword 1 2 3 4 5 6 7 8 9
+stopword 11 12 13 14 15 16 17 18 19 20
+stopword 21 22 23 24 25 26 27 28 29 30
+stopword the a an and to too in on of we i am as im for is
+username fred
+password fredpass
+allow fred fredpass
+plugins %s/plugins
+player *.mp3 execraw disorder-decode
+player *.ogg execraw disorder-decode
+player *.wav execraw disorder-decode
+player *.flac execraw disorder-decode
+tracklength *.mp3 disorder-tracklength
+tracklength *.ogg disorder-tracklength
+tracklength *.wav disorder-tracklength
+tracklength *.flac disorder-tracklength
+""" % (testroot, testroot, testroot, testroot, top_builddir))
+ copyfile("%s/sounds/scratch.ogg" % top_srcdir,
+ "%s/scratch.ogg" % testroot)
-def notracks():
- pass
-
-def start(test):
- """start(TEST)
+def start_daemon():
+ """start_daemon()
-Start the daemon for test called TEST."""
- global daemon
+Start the daemon."""
+ global daemon, errs
assert daemon == None
- if test == None:
- errs = sys.stderr
- else:
- errs = open("%s/%s.log" % (testroot, test), "w")
- server = None
print " starting daemon"
daemon = subprocess.Popen(["disorderd",
"--foreground",
"--config", "%s/config" % testroot],
stderr=errs)
- disorder._configfile = "%s/config" % testroot
- disorder._userconf = False
-def stop():
- """stop()
+def stop_daemon():
+ """stop_daemon()
Stop the daemon if it has not stopped already"""
global daemon
+ if daemon == None:
+ return
rc = daemon.poll()
if rc == None:
print " stopping daemon"
print " daemon has stopped"
daemon = None
-def run(test, setup=None, report=True, name=None):
+def run(module=None, report=True):
+ """dtest.run(MODULE)
+
+ Run the test in MODULE. This can be a string (in which case the module
+ will be imported) or a module object."""
global tests
tests += 1
- if setup == None:
- setup = stdtracks
- setup()
- start(name)
+ # Locate the test module
+ if module is None:
+ # We're running a test stand-alone
+ import __main__
+ module = __main__
+ name = os.path.splitext(os.path.basename(sys.argv[0]))[0]
+ else:
+ # We've been passed a module or a module name
+ if type(module) == str:
+ module = __import__(module)
+ name = module.__name__
+ # Open the error log
+ global errs
+ errs = open("%s.log" % name, "w")
+ # Ensure that disorder.py uses the test installation
+ disorder._configfile = "%s/config" % testroot
+ disorder._userconf = False
+ # Make config file etc
+ common_setup()
+ # Create some standard tracks
+ stdtracks()
try:
try:
- test()
+ module.test()
except AssertionError, e:
global failures
failures += 1
print e
finally:
- stop()
+ stop_daemon()
if report:
if failures:
print " FAILED"
failures = 0
daemon = None
testroot = "%s/tests/testroot" % top_builddir
-remove_dir(testroot)
-os.mkdir(testroot)
-open("%s/config" % testroot, "w").write(
-"""player *.ogg shell 'echo "$TRACK" >> %s/played.log'
-home %s
-collection fs ASCII %s/tracks
-scratch %s/scratch.ogg
-gap 0
-stopword 01 02 03 04 05 06 07 08 09 10
-stopword 1 2 3 4 5 6 7 8 9
-stopword 11 12 13 14 15 16 17 18 19 20
-stopword 21 22 23 24 25 26 27 28 29 30
-stopword the a an and to too in on of we i am as im for is
-username fred
-password fredpass
-allow fred fredpass
-plugins %s/plugins
-player *.mp3 execraw disorder-decode
-player *.ogg execraw disorder-decode
-player *.wav execraw disorder-decode
-player *.flac execraw disorder-decode
-tracklength *.mp3 disorder-tracklength
-tracklength *.ogg disorder-tracklength
-tracklength *.wav disorder-tracklength
-tracklength *.flac disorder-tracklength
-""" % (testroot, testroot, testroot, testroot, top_builddir))
-copyfile("%s/sounds/scratch.ogg" % top_srcdir,
- "%s/scratch.ogg" % testroot)
+tracks = "%s/tracks" % testroot
~mdw / disorder / blobdiff