borrow some test naming conventions from disorder.unicode
[disorder] / 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 notracks():
106 pass
107
108 def start_daemon():
109 """start_daemon()
110
111 Start the daemon."""
112 global daemon
113 assert daemon == None
114 print " starting daemon"
115 daemon = subprocess.Popen(["disorderd",
116 "--foreground",
117 "--config", "%s/config" % testroot],
118 stderr=errs)
119 disorder._configfile = "%s/config" % testroot
120 disorder._userconf = False
121
122 def stop_daemon():
123 """stop_daemon()
124
125 Stop the daemon if it has not stopped already"""
126 global daemon
127 if daemon == None:
128 return
129 rc = daemon.poll()
130 if rc == None:
131 print " stopping daemon"
132 os.kill(daemon.pid, 15)
133 rc = daemon.wait()
134 print " daemon has stopped"
135 daemon = None
136
137 def run(module=None, report=True):
138 """dtest.run(MODULE)
139
140 Run the test in MODULE. This can be a string (in which case the module
141 will be imported) or a module object."""
142 global tests
143 tests += 1
144 if module is None:
145 # We're running a test stand-alone
146 import __main__
147 module = __main__
148 name = os.path.splitext(os.path.basename(sys.argv[0]))[0]
149 else:
150 # We've been passed a module or a module name
151 if type(module) == str:
152 module = __import__(module)
153 name = module.__name__
154 global errs
155 errs = open("%s.log" % name, "w")
156 setup = stdtracks
157 setup()
158 try:
159 try:
160 module.test()
161 except AssertionError, e:
162 global failures
163 failures += 1
164 print e
165 finally:
166 stop_daemon()
167 if report:
168 if failures:
169 print " FAILED"
170 sys.exit(1)
171 else:
172 print " OK"
173
174 def remove_dir(d):
175 """remove_dir(D)
176
177 Recursively delete directory D"""
178 if os.path.lexists(d):
179 if os.path.isdir(d):
180 for dd in os.listdir(d):
181 remove_dir("%s/%s" % (d, dd))
182 os.rmdir(d)
183 else:
184 os.remove(d)
185
186 # -----------------------------------------------------------------------------
187 # Common setup
188
189 tests = 0
190 failures = 0
191 daemon = None
192 testroot = "%s/tests/testroot" % top_builddir
193 remove_dir(testroot)
194 os.mkdir(testroot)
195 open("%s/config" % testroot, "w").write(
196 """player *.ogg shell 'echo "$TRACK" >> %s/played.log'
197 home %s
198 collection fs ASCII %s/tracks
199 scratch %s/scratch.ogg
200 gap 0
201 stopword 01 02 03 04 05 06 07 08 09 10
202 stopword 1 2 3 4 5 6 7 8 9
203 stopword 11 12 13 14 15 16 17 18 19 20
204 stopword 21 22 23 24 25 26 27 28 29 30
205 stopword the a an and to too in on of we i am as im for is
206 username fred
207 password fredpass
208 allow fred fredpass
209 plugins %s/plugins
210 player *.mp3 execraw disorder-decode
211 player *.ogg execraw disorder-decode
212 player *.wav execraw disorder-decode
213 player *.flac execraw disorder-decode
214 tracklength *.mp3 disorder-tracklength
215 tracklength *.ogg disorder-tracklength
216 tracklength *.wav disorder-tracklength
217 tracklength *.flac disorder-tracklength
218 """ % (testroot, testroot, testroot, testroot, top_builddir))
219 copyfile("%s/sounds/scratch.ogg" % top_srcdir,
220 "%s/scratch.ogg" % testroot)