X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/fbcfb25715ddbb522c8efac3faec1eca4811683d..6ce6b5a9430b1b8749d832ecabe840a7b65d74de:/tests/dtest.py

diff --git a/tests/dtest.py b/tests/dtest.py
index b5cc9c9..cd87c50 100644
--- a/tests/dtest.py
+++ b/tests/dtest.py
@@ -21,7 +21,7 @@
 
 """Utility module used by tests"""
 
-import os,os.path,subprocess,sys,re,unicodedata
+import os,os.path,subprocess,sys,re,time,unicodedata,random,socket
 
 def fatal(s):
     """Write an error message and exit"""
@@ -41,9 +41,11 @@ else:
 sys.path.insert(0, os.path.join(top_builddir, "python"))
 import disorder
 
-# Make sure the server build directory is on the executable search path
+# Make sure the build directories are on the executable search path
 ospath = os.environ["PATH"].split(os.pathsep)
 ospath.insert(0, os.path.join(top_builddir, "server"))
+ospath.insert(0, os.path.join(top_builddir, "clients"))
+ospath.insert(0, os.path.join(top_builddir, "tests"))
 os.environ["PATH"] = os.pathsep.join(ospath)
 
 # Parse the makefile in the current directory to identify the source directory
@@ -66,6 +68,17 @@ def 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)
 
@@ -78,8 +91,7 @@ Make track with relative path S exist"""
     # 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('/')
+    bits = nfc(s).split('/')
     dp = tracks
     for d in bits [0:-1]:
         dd = "%s/%s" % (dp,  d)
@@ -127,11 +139,11 @@ def stdtracks():
     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/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")
@@ -140,15 +152,37 @@ def stdtracks():
     maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg")
     maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg")
 
-def notracks():
-    pass
+def bindable(p):
+    """bindable(P)
+
+    Return True iff UDP port P is bindable, else False"""
+    s = socket.socket(socket.AF_INET,
+                      socket.SOCK_DGRAM,
+                      socket.IPPROTO_UDP)
+    try:
+        s.bind(("127.0.0.1", p))
+        s.close()
+        return True
+    except:
+        return False
 
 def common_setup():
     remove_dir(testroot)
     os.mkdir(testroot)
+    # Choose a port
+    global port
+    port = random.randint(49152, 65535)
+    while not bindable(port + 1):
+        print "port %d is not bindable, trying another" % (port + 1)
+        port = random.randint(49152, 65535)
+    # Log anything sent to that port
+    packetlog = "%s/packetlog" % testroot
+    subprocess.Popen(["disorder-udplog",
+                      "--output", packetlog,
+                      "127.0.0.1", "%d" % port])
+    # disorder-udplog will quit when its parent process terminates
     open("%s/config" % testroot, "w").write(
-    """player *.ogg shell 'echo "$TRACK" >> %s/played.log'
-home %s
+    """home %s
 collection fs UTF-8 %s/tracks
 scratch %s/scratch.ogg
 gap 0
@@ -160,7 +194,10 @@ 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
+trust fred
+plugins
+plugins %s/plugins
+plugins %s/plugins/.libs
 player *.mp3 execraw disorder-decode
 player *.ogg execraw disorder-decode
 player *.wav execraw disorder-decode
@@ -169,56 +206,108 @@ tracklength *.mp3 disorder-tracklength
 tracklength *.ogg disorder-tracklength
 tracklength *.wav disorder-tracklength
 tracklength *.flac disorder-tracklength
-""" % (testroot, testroot, testroot, testroot))
+speaker_backend network
+broadcast 127.0.0.1 %d
+broadcast_from 127.0.0.1 %d
+""" % (testroot, testroot, testroot, top_builddir, top_builddir,
+       port, port + 1))
     copyfile("%s/sounds/scratch.ogg" % top_srcdir,
              "%s/scratch.ogg" % testroot)
 
 def start_daemon():
     """start_daemon()
+
 Start the daemon."""
-    global daemon,errs
-    assert daemon is None
-    server = None
+    global daemon, errs, port
+    assert daemon == None, "no daemon running"
+    if not bindable(port + 1):
+        print "waiting for port %d to become bindable again..." % (port + 1)
+        time.sleep(1)
+        while not bindable(port + 1):
+            time.sleep(1)
     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)
+    # 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
-    assert daemon is not None
+    if daemon == None:
+        return
     rc = daemon.poll()
     if rc == None:
         print " stopping daemon"
-        os.kill(daemon.pid, 15)
+        disorder.client().shutdown()
+        print "  waiting for daemon"
         rc = daemon.wait()
-    print " daemon has stopped"
+        print "  daemon has stopped"
+    else:
+        print "  daemon already stopped"
     daemon = None
 
-def run(test, setup=None, report=True, name=None): 
-    global tests,errs
+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
-    errs = open("%s.log" % test.__name__, "w")
+    # 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()
-    setup()
+    # Create some standard tracks
+    stdtracks()
     try:
         try:
-            test()
+            module.test()
         except AssertionError, e:
             global failures
             failures += 1
-            print e
+            print "assertion failed: %s" % e.message
     finally:
-        if daemon is not None:
-            stop_daemon()
+        stop_daemon()
     if report:
         if failures:
             print " FAILED"
@@ -238,6 +327,49 @@ Recursively delete directory D"""
         else:
             os.remove(d)
 
+def lists_have_same_contents(l1, l2):
+    """lists_have_same_contents(L1, L2)
+
+    Return True if L1 and L2 have equal members, in any order; else False."""
+    s1 = []
+    s1.extend(l1)
+    s1.sort()
+    s2 = []
+    s2.extend(l2)
+    s2.sort()
+    return s1 == s2
+
+def check_files():
+    c = disorder.client()
+    failures = 0
+    for d in dirs_by_dir:
+        xdirs = dirs_by_dir[d]
+        dirs = c.directories(d)
+        if not lists_have_same_contents(xdirs, dirs):
+            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)
+        if not lists_have_same_contents(xfiles, files):
+            print
+            print "directory: %s" % d
+            print "expected:  %s" % xfiles
+            print "got:       %s" % files
+            failures += 1
+    return failures
+
+def command(args):
+    """Execute a command given as a list and return its stdout"""
+    p = subprocess.Popen(args, stdout=subprocess.PIPE)
+    lines = p.stdout.readlines()
+    rc = p.wait()
+    assert rc == 0, ("%s returned status %s" % (args, rc))
+    return lines
+
 # -----------------------------------------------------------------------------
 # Common setup