chiark / gitweb /
Horrible bodge to wait for root user to be created before attempting to
[disorder] / tests / dtest.py
index 68a130d..38eadf8 100644 (file)
@@ -1,27 +1,25 @@
 #-*-python-*-
 #
 # This file is part of DisOrder.
-# Copyright (C) 2007 Richard Kettlewell
+# Copyright (C) 2007, 2008 Richard Kettlewell
 #
-# This program is free software; you can redistribute it and/or modify
+# 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
+# the Free Software Foundation, either version 3 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.
-#
+# 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
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """Utility module used by tests"""
 
-import os,os.path,subprocess,sys,re,time,unicodedata
+import os,os.path,subprocess,sys,re,time,unicodedata,random,socket
 
 def fatal(s):
     """Write an error message and exit"""
@@ -32,7 +30,7 @@ def fatal(s):
 cwd = os.getcwd()
 if os.path.exists("config.h"):
     top_builddir = cwd
-elif os.path.exists("alltests"):
+elif os.path.exists("../config.h"):
     top_builddir = os.path.dirname(cwd)
 else:
     fatal("cannot identify build directory")
@@ -41,9 +39,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
@@ -85,7 +85,7 @@ Make track with relative path S exist"""
     trackdir = os.path.dirname(trackpath)
     if not os.path.exists(trackdir):
         os.makedirs(trackdir)
-    copyfile("%s/sounds/slap.ogg" % top_srcdir, trackpath)
+    copyfile("%s/sounds/long.ogg" % top_builddir, 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.
@@ -149,16 +149,29 @@ def stdtracks():
     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)
+
+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 default_config(encoding="UTF-8"):
+    """Write the default config"""
     open("%s/config" % testroot, "w").write(
-    """player *.ogg shell 'echo "$TRACK" >> %s/played.log'
-home %s
-collection fs UTF-8 %s/tracks
+    """home %s/home
+collection fs %s %s/tracks
 scratch %s/scratch.ogg
 gap 0
+queue_pad 5
 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
@@ -166,8 +179,9 @@ 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 %s/plugins
+plugins %s/plugins/.libs
 player *.mp3 execraw disorder-decode
 player *.ogg execraw disorder-decode
 player *.wav execraw disorder-decode
@@ -176,23 +190,48 @@ tracklength *.mp3 disorder-tracklength
 tracklength *.ogg disorder-tracklength
 tracklength *.wav disorder-tracklength
 tracklength *.flac disorder-tracklength
-""" % (testroot, testroot, testroot, testroot, top_builddir))
+api rtp
+broadcast 127.0.0.1 %d
+broadcast_from 127.0.0.1 %d
+mail_sender no.such.user.sorry@greenend.org.uk
+""" % (testroot, encoding, testroot, testroot, top_builddir, top_builddir,
+       port, port + 1))
+
+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
     copyfile("%s/sounds/scratch.ogg" % top_srcdir,
              "%s/scratch.ogg" % testroot)
+    default_config()
 
 def start_daemon():
     """start_daemon()
 
 Start the daemon."""
-    global daemon, errs
-    assert daemon == 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:
+    socket = "%s/home/socket" % testroot
+    if os.path.exists(socket):
         os.remove(socket)
-    except:
-        pass
     daemon = subprocess.Popen(["disorderd",
                                "--foreground",
                                "--config", "%s/config" % testroot],
@@ -213,6 +252,30 @@ Start the daemon."""
         time.sleep(1)
     if waited > 0:
         print "  took about %ds for socket to appear" % waited
+    # Wait for root user to be created
+    command(["disorder",
+             "--config", disorder._configfile, "--no-per-user-config",
+             "--wait-for-root"])
+
+def create_user(username="fred", password="fredpass"):
+    """create_user(USERNAME, PASSWORD)
+
+    Create a user, abusing direct database access to do so.  Gives the
+    user rights 'all', allowing them to do anything."""
+    print " creating user %s" % username
+    command(["disorder",
+             "--config", disorder._configfile, "--no-per-user-config",
+             "--user", "root", "adduser", username, password])
+    command(["disorder",
+             "--config", disorder._configfile, "--no-per-user-config",
+             "--user", "root", "edituser", username, "rights", "all"])
+
+def rescan(c=None):
+    print " initiating rescan"
+    if c is None:
+        c = disorder.client()
+    c.rescan('wait')
+    print " rescan completed"
 
 def stop_daemon():
     """stop_daemon()
@@ -224,13 +287,15 @@ Stop the daemon if it has not stopped already"""
     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"
     else:
         print "  daemon already stopped"
     daemon = None
+    # Wait a bit for subprocess to finish too, to try to avoid stupid races
+    time.sleep(2)
 
 def run(module=None, report=True):
     """dtest.run(MODULE)
@@ -250,9 +315,15 @@ def run(module=None, report=True):
         if type(module) == str:
             module = __import__(module)
         name = module.__name__
+    print "--- %s ---" % name
     # Open the error log
     global errs
-    errs = open("%s.log" % name, "w")
+    logfile = "%s.log" % name
+    try:
+        os.remove(logfile)
+    except:
+        pass
+    errs = open(logfile, "a")
     # Ensure that disorder.py uses the test installation
     disorder._configfile = "%s/config" % testroot
     disorder._userconf = False
@@ -261,12 +332,7 @@ def run(module=None, report=True):
     # Create some standard tracks
     stdtracks()
     try:
-        try:
-            module.test()
-        except AssertionError, e:
-            global failures
-            failures += 1
-            print e
+        module.test()
     finally:
         stop_daemon()
     if report:
@@ -288,33 +354,51 @@ Recursively delete directory D"""
         else:
             os.remove(d)
 
-def check_files():
+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 map(nfc, s1) == map(nfc, s2)
+
+def check_files(chatty=True):
     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
+        if not lists_have_same_contents(xdirs, dirs):
+            if chatty:
+                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
+        if not lists_have_same_contents(xfiles, files):
+            if chatty:
+                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