chiark / gitweb /
sync with disorder.dev
[disorder] / tests / dtest.py
index a6db3e3010f8321e58afa7871b8c5ca4b50223f8..b5cc9c9f16dd0674ae652362a367241c926d9aef 100644 (file)
@@ -1,8 +1,65 @@
 #-*-python-*-
+#
+# This file is part of DisOrder.
+# Copyright (C) 2007 Richard Kettlewell
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+# USA
+#
 
 """Utility module used by tests"""
 
-import os,os.path,subprocess,sys,disorder
+import os,os.path,subprocess,sys,re,unicodedata
+
+def fatal(s):
+    """Write an error message and exit"""
+    sys.stderr.write("ERROR: %s\n" % s)
+    sys.exit(1)
+
+# Identify the top build directory
+cwd = os.getcwd()
+if os.path.exists("config.h"):
+    top_builddir = cwd
+elif os.path.exists("alltests"):
+    top_builddir = os.path.dirname(cwd)
+else:
+    fatal("cannot identify build directory")
+
+# Make sure the Python build directory is on the module search path
+sys.path.insert(0, os.path.join(top_builddir, "python"))
+import disorder
+
+# Make sure the server build directory is on the executable search path
+ospath = os.environ["PATH"].split(os.pathsep)
+ospath.insert(0, os.path.join(top_builddir, "server"))
+os.environ["PATH"] = os.pathsep.join(ospath)
+
+# Parse the makefile in the current directory to identify the source directory
+top_srcdir = None
+for l in file("Makefile"):
+    r = re.match("top_srcdir *= *(.*)",  l)
+    if r:
+        top_srcdir = r.group(1)
+        break
+if not top_srcdir:
+    fatal("cannot identify source directory")
+
+# The tests source directory must be on the module search path already since
+# we found dtest.py
+
+# -----------------------------------------------------------------------------
 
 def copyfile(a,b):
     """copyfile(A, B)
@@ -13,11 +70,27 @@ def maketrack(s):
     """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" % topsrcdir, trackpath)
+    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():
     # We create some tracks with non-ASCII characters in the name and
@@ -32,6 +105,10 @@ def stdtracks():
     # 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)
@@ -45,13 +122,11 @@ def stdtracks():
     # ...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/Third Album/01:First track.ogg")
     maketrack("Joe Bloggs/Third Album/02:Second track.ogg")
     maketrack("Joe Bloggs/Third Album/03:Third track.ogg")
@@ -73,54 +148,49 @@ def common_setup():
     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 ../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))
-    copyfile("%s/sounds/scratch.ogg" % topsrcdir,
+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 ../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))
+    copyfile("%s/sounds/scratch.ogg" % top_srcdir,
              "%s/scratch.ogg" % testroot)
 
-def start_daemon(test):
-    """start_daemon(TEST)
-Start the daemon for test called TEST."""
-    global daemon
-    assert daemon == None
-    if test == None:
-        errs = sys.stderr
-    else:
-        errs = open("%s.log" % test, "w")
+def start_daemon():
+    """start_daemon()
+Start the daemon."""
+    global daemon,errs
+    assert daemon is None
     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_daemon():
     """stop_daemon()
 
 Stop the daemon if it has not stopped already"""
     global daemon
+    assert daemon is not None
     rc = daemon.poll()
     if rc == None:
         print " stopping daemon"
@@ -130,13 +200,15 @@ Stop the daemon if it has not stopped already"""
     daemon = None
 
 def run(test, setup=None, report=True, name=None): 
-    global tests
+    global tests,errs
     tests += 1
     if setup == None:
         setup = stdtracks
+    errs = open("%s.log" % test.__name__, "w")
+    disorder._configfile = "%s/config" % testroot
+    disorder._userconf = False
     common_setup()
     setup()
-    start_daemon(name)
     try:
         try:
             test()
@@ -145,7 +217,8 @@ def run(test, setup=None, report=True, name=None):
             failures += 1
             print e
     finally:
-        stop_daemon()
+        if daemon is not None:
+            stop_daemon()
     if report:
         if failures:
             print " FAILED"
@@ -171,5 +244,5 @@ Recursively delete directory D"""
 tests = 0
 failures = 0
 daemon = None
-testroot = "%s/testroot" % os.getcwd()
-topsrcdir = os.path.abspath(os.getenv("topsrcdir"))
+testroot = "%s/tests/testroot" % top_builddir
+tracks = "%s/tracks" % testroot