test search

[disorder] / tests / dtest.py

diff --git a/tests/dtest.py b/tests/dtest.py
index d9f6788384ac36dd0847a2bb674eaed15dad1b18..68a130d8b4b501c8f5ddf494e2ed64e1ab41a798 100644 (file)
--- a/tests/dtest.py
+++ b/tests/dtest.py
@@ -1,23 +1,106 @@
 #-*-python-*-
 #-*-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"""
 
 
 """Utility module used by tests"""
 

-import os,os.path,subprocess,sys,disorder
+import os,os.path,subprocess,sys,re,time,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)
 Copy A to B."""
     open(b,"w").write(open(a).read())
 
 
 def copyfile(a,b):
     """copyfile(A, B)
 Copy A to B."""
     open(b,"w").write(open(a).read())
 

+def to_unicode(s):
+    """Convert UTF-8 to unicode.  A no-op if already unicode."""
+    if type(s) == unicode:
+        return s
+    else:
+        return unicode(s, "UTF-8")
+
+def nfc(s):
+    """Convert UTF-8 string or unicode to NFC unicode."""
+    return  unicodedata.normalize("NFC", to_unicode(s))
+

 def maketrack(s):
     """maketrack(S)
 
 Make track with relative path S exist"""
 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)
     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 = nfc(s).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
 
 def stdtracks():
     # We create some tracks with non-ASCII characters in the name and


@@ -32,6 +115,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)
     # 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)
     
     # C3 8C = 00CC LATIN CAPITAL LETTER I WITH GRAVE
     # (in NFC)


@@ -45,18 +132,16 @@ 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")
     # ...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/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")
-    maketrack("Joe Bloggs/Third Album/04:Fourth track.ogg")
-    maketrack("Joe Bloggs/Third 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("Fred Smith/Boring/01:Dull.ogg")
     maketrack("Fred Smith/Boring/02:Tedious.ogg")
     maketrack("Fred Smith/Boring/03:Drum Solo.ogg")


@@ -64,10 +149,7 @@ def stdtracks():
     maketrack("misc/blahblahblah.ogg")
     maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg")
     maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg")
     maketrack("misc/blahblahblah.ogg")
     maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg")
     maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg")

-
-def notracks():
-    pass
-
+ 

 def common_setup():
     remove_dir(testroot)
     os.mkdir(testroot)
 def common_setup():
     remove_dir(testroot)
     os.mkdir(testroot)


@@ -85,7 +167,7 @@ stopword the a an and to too in on of we i am as im for is
 username fred
 password fredpass
 allow fred fredpass
 username fred
 password fredpass
 allow fred fredpass

-plugins ../plugins
+plugins %s/plugins

 player *.mp3 execraw disorder-decode
 player *.ogg execraw disorder-decode
 player *.wav execraw disorder-decode
 player *.mp3 execraw disorder-decode
 player *.ogg execraw disorder-decode
 player *.wav execraw disorder-decode


@@ -94,52 +176,93 @@ tracklength *.mp3 disorder-tracklength
 tracklength *.ogg disorder-tracklength
 tracklength *.wav disorder-tracklength
 tracklength *.flac disorder-tracklength
 tracklength *.ogg disorder-tracklength
 tracklength *.wav disorder-tracklength
 tracklength *.flac disorder-tracklength

-""" % (testroot, testroot, testroot, testroot))
-    copyfile("%s/sounds/scratch.ogg" % topsrcdir,
+""" % (testroot, testroot, testroot, testroot, top_builddir))
+    copyfile("%s/sounds/scratch.ogg" % top_srcdir,

              "%s/scratch.ogg" % testroot)
 
              "%s/scratch.ogg" % testroot)
 

-def start_daemon(test):
-    """start_daemon(TEST)
-Start the daemon for test called TEST."""
-    global daemon
+def start_daemon():
+    """start_daemon()
+
+Start the daemon."""
+    global daemon, errs

     assert daemon == None
     assert daemon == None

-    if test == None:
-        errs = sys.stderr
-    else:
-        errs = open("%s.log" % test, "w")
-    server = None

     print " starting daemon"
     print " starting daemon"

+    # remove the socket if it exists
+    socket = "%s/socket" % testroot
+    try:
+        os.remove(socket)
+    except:
+        pass

     daemon = subprocess.Popen(["disorderd",
                                "--foreground",
                                "--config", "%s/config" % testroot],
                               stderr=errs)
     daemon = subprocess.Popen(["disorderd",
                                "--foreground",
                                "--config", "%s/config" % testroot],
                               stderr=errs)

-    disorder._configfile = "%s/config" % testroot
-    disorder._userconf = False
+    # Wait for the socket to be created
+    waited = 0
+    while not os.path.exists(socket):
+        rc = daemon.poll()
+        if rc is not None:
+            print "FATAL: daemon failed to start up"
+            sys.exit(1)
+        waited += 1
+        if waited == 1:
+            print "  waiting for socket..."
+        elif waited >= 60:
+            print "FATAL: took too long for socket to appear"
+            sys.exit(1)
+        time.sleep(1)
+    if waited > 0:
+        print "  took about %ds for socket to appear" % waited

 
 def stop_daemon():
     """stop_daemon()
 
 Stop the daemon if it has not stopped already"""
     global daemon
 
 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"
         os.kill(daemon.pid, 15)
     rc = daemon.poll()
     if rc == None:
         print " stopping daemon"
         os.kill(daemon.pid, 15)

+        print "  waiting for daemon"

         rc = daemon.wait()
         rc = daemon.wait()

-    print " daemon has stopped"
+        print "  daemon has stopped"
+    else:
+        print "  daemon already stopped"

     daemon = None
 
     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
     global tests
     tests += 1

-    if setup == None:
-        setup = stdtracks
+    # 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()
     common_setup()

-    setup()
-    start_daemon(name)
+    # Create some standard tracks
+    stdtracks()

     try:
         try:
     try:
         try:

-            test()
+            module.test()

         except AssertionError, e:
             global failures
             failures += 1
         except AssertionError, e:
             global failures
             failures += 1


@@ -165,11 +288,38 @@ Recursively delete directory D"""
         else:
             os.remove(d)
 
         else:
             os.remove(d)
 

+def check_files():
+    c = disorder.client()
+    failures = 0
+    for d in dirs_by_dir:
+        xdirs = dirs_by_dir[d]
+        dirs = c.directories(d)
+        xdirs.sort()
+        dirs.sort()
+        if dirs != xdirs:
+            print
+            print "directory: %s" % d
+            print "expected:  %s" % xdirs
+            print "got:       %s" % dirs
+            failures += 1
+    for d in files_by_dir:
+        xfiles = files_by_dir[d]
+        files = c.files(d)
+        xfiles.sort()
+        files.sort()
+        if files != xfiles:
+            print
+            print "directory: %s" % d
+            print "expected:  %s" % xfiles
+            print "got:       %s" % files
+            failures += 1
+    return failures
+

 # -----------------------------------------------------------------------------
 # Common setup
 
 tests = 0
 failures = 0
 daemon = None
 # -----------------------------------------------------------------------------
 # Common setup
 
 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