chiark - git - mdw - disorder/blob - tests/dtest.py

   1 #-*-python-*-
   2 #
   3 # This file is part of DisOrder.
   4 # Copyright (C) 2007 Richard Kettlewell
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19 # USA
  20 #
  21
  22 """Utility module used by tests"""
  23
  24 import os,os.path,subprocess,sys,re
  25
  26 def fatal(s):
  27     """Write an error message and exit"""
  28     sys.stderr.write("ERROR: %s\n" % s)
  29     sys.exit(1)
  30
  31 # Identify the top build directory
  32 cwd = os.getcwd()
  33 if os.path.exists("config.h"):
  34     top_builddir = cwd
  35 elif os.path.exists("alltests"):
  36     top_builddir = os.path.dirname(cwd)
  37 else:
  38     fatal("cannot identify build directory")
  39
  40 # Make sure the Python build directory is on the module search path
  41 sys.path.insert(0, os.path.join(top_builddir, "python"))
  42 import disorder
  43
  44 # Make sure the server build directory is on the executable search path
  45 ospath = os.environ["PATH"].split(os.pathsep)
  46 ospath.insert(0, os.path.join(top_builddir, "server"))
  47 os.environ["PATH"] = os.pathsep.join(ospath)
  48
  49 # Parse the makefile in the current directory to identify the source directory
  50 top_srcdir = None
  51 for l in file("Makefile"):
  52     r = re.match("top_srcdir *= *(.*)",  l)
  53     if r:
  54         top_srcdir = r.group(1)
  55         break
  56 if not top_srcdir:
  57     fatal("cannot identify source directory")
  58
  59 # The tests source directory must be on the module search path already since
  60 # we found dtest.py
  61
  62 # -----------------------------------------------------------------------------
  63
  64 def copyfile(a,b):
  65     """copyfile(A, B)
  66 Copy A to B."""
  67     open(b,"w").write(open(a).read())
  68
  69 def maketrack(s):
  70     """maketrack(S)
  71
  72 Make track with relative path S exist"""
  73     trackpath = "%s/tracks/%s" % (testroot, s)
  74     trackdir = os.path.dirname(trackpath)
  75     if not os.path.exists(trackdir):
  76         os.makedirs(trackdir)
  77     copyfile("%s/sounds/slap.ogg" % top_srcdir, trackpath)
  78
  79 def stdtracks():
  80     maketrack("Joe Bloggs/First Album/01:First track.ogg")
  81     maketrack("Joe Bloggs/First Album/02:Second track.ogg")
  82     maketrack("Joe Bloggs/First Album/03:Third track.ogg")
  83     maketrack("Joe Bloggs/First Album/04:Fourth track.ogg")
  84     maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
  85     maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
  86     maketrack("Joe Bloggs/Second Album/01:First track.ogg")
  87     maketrack("Joe Bloggs/Second Album/02:Second track.ogg")
  88     maketrack("Joe Bloggs/Second Album/03:Third track.ogg")
  89     maketrack("Joe Bloggs/Second Album/04:Fourth track.ogg")
  90     maketrack("Joe Bloggs/Second Album/05:Fifth track.ogg")
  91     maketrack("Joe Bloggs/Second Album/05:Fifth track.ogg")
  92     maketrack("Joe Bloggs/First Album/01:First track.ogg")
  93     maketrack("Joe Bloggs/First Album/02:Second track.ogg")
  94     maketrack("Joe Bloggs/First Album/03:Third track.ogg")
  95     maketrack("Joe Bloggs/First Album/04:Fourth track.ogg")
  96     maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
  97     maketrack("Fred Smith/Boring/01:Dull.ogg")
  98     maketrack("Fred Smith/Boring/02:Tedious.ogg")
  99     maketrack("Fred Smith/Boring/03:Drum Solo.ogg")
 100     maketrack("Fred Smith/Boring/04:Yawn.ogg")
 101     maketrack("misc/blahblahblah.ogg")
 102     maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg")
 103     maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg")
 104
 105 def common_setup():
 106     remove_dir(testroot)
 107     os.mkdir(testroot)
 108     open("%s/config" % testroot, "w").write(
 109     """player *.ogg shell 'echo "$TRACK" >> %s/played.log'
 110 home %s
 111 collection fs UTF-8 %s/tracks
 112 scratch %s/scratch.ogg
 113 gap 0
 114 stopword 01 02 03 04 05 06 07 08 09 10
 115 stopword 1 2 3 4 5 6 7 8 9
 116 stopword 11 12 13 14 15 16 17 18 19 20
 117 stopword 21 22 23 24 25 26 27 28 29 30
 118 stopword the a an and to too in on of we i am as im for is
 119 username fred
 120 password fredpass
 121 allow fred fredpass
 122 plugins %s/plugins
 123 player *.mp3 execraw disorder-decode
 124 player *.ogg execraw disorder-decode
 125 player *.wav execraw disorder-decode
 126 player *.flac execraw disorder-decode
 127 tracklength *.mp3 disorder-tracklength
 128 tracklength *.ogg disorder-tracklength
 129 tracklength *.wav disorder-tracklength
 130 tracklength *.flac disorder-tracklength
 131 """ % (testroot, testroot, testroot, testroot, top_builddir))
 132     copyfile("%s/sounds/scratch.ogg" % top_srcdir,
 133              "%s/scratch.ogg" % testroot)
 134
 135 def start_daemon():
 136     """start_daemon()
 137
 138 Start the daemon."""
 139     global daemon
 140     assert daemon == None
 141     print " starting daemon"
 142     daemon = subprocess.Popen(["disorderd",
 143                                "--foreground",
 144                                "--config", "%s/config" % testroot],
 145                               stderr=errs)
 146     disorder._configfile = "%s/config" % testroot
 147     disorder._userconf = False
 148
 149 def stop_daemon():
 150     """stop_daemon()
 151
 152 Stop the daemon if it has not stopped already"""
 153     global daemon
 154     if daemon == None:
 155         return
 156     rc = daemon.poll()
 157     if rc == None:
 158         print " stopping daemon"
 159         os.kill(daemon.pid, 15)
 160         rc = daemon.wait()
 161     print " daemon has stopped"
 162     daemon = None
 163
 164 def run(module=None, report=True):
 165     """dtest.run(MODULE)
 166
 167     Run the test in MODULE.  This can be a string (in which case the module
 168     will be imported) or a module object."""
 169     global tests
 170     tests += 1
 171     # Locate the test module
 172     if module is None:
 173         # We're running a test stand-alone
 174         import __main__
 175         module = __main__
 176         name = os.path.splitext(os.path.basename(sys.argv[0]))[0]
 177     else:
 178         # We've been passed a module or a module name
 179         if type(module) == str:
 180             module = __import__(module)
 181         name = module.__name__
 182     # Open the error log
 183     global errs
 184     errs = open("%s.log" % name, "w")
 185     # Ensure that disorder.py uses the test installation
 186     disorder._configfile = "%s/config" % testroot
 187     disorder._userconf = False
 188     # Make config file etc
 189     common_setup()
 190     # Create some standard tracks
 191     stdtracks()
 192     try:
 193         try:
 194             module.test()
 195         except AssertionError, e:
 196             global failures
 197             failures += 1
 198             print e
 199     finally:
 200         stop_daemon()
 201     if report:
 202         if failures:
 203             print " FAILED"
 204             sys.exit(1)
 205         else:
 206             print " OK"
 207
 208 def remove_dir(d):
 209     """remove_dir(D)
 210
 211 Recursively delete directory D"""
 212     if os.path.lexists(d):
 213         if os.path.isdir(d):
 214             for dd in os.listdir(d):
 215                 remove_dir("%s/%s" % (d, dd))
 216             os.rmdir(d)
 217         else:
 218             os.remove(d)
 219
 220 # -----------------------------------------------------------------------------
 221 # Common setup
 222
 223 tests = 0
 224 failures = 0
 225 daemon = None
 226 testroot = "%s/tests/testroot" % top_builddir
 227 tracks = "%s/tracks" % testroot