"""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"""
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
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():
+ """Write the default config"""
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
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
tracklength *.ogg disorder-tracklength
tracklength *.wav disorder-tracklength
tracklength *.flac disorder-tracklength
-""" % (testroot, testroot, testroot, testroot, top_builddir))
+speaker_backend network
+broadcast 127.0.0.1 %d
+broadcast_from 127.0.0.1 %d
+mail_sender no.such.user.sorry@greenend.org.uk
+""" % (testroot, 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
if waited > 0:
print " took about %ds for socket to appear" % waited
+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 stop_daemon():
"""stop_daemon()
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"
name = module.__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
# 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:
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)
- xdirs.sort()
- dirs.sort()
- if dirs != xdirs:
+ if not lists_have_same_contents(xdirs, dirs):
print
print "directory: %s" % d
print "expected: %s" % xdirs
for d in files_by_dir:
xfiles = files_by_dir[d]
files = c.files(d)
- xfiles.sort()
- files.sort()
- if files != xfiles:
+ if not lists_have_same_contents(xfiles, files):
print
print "directory: %s" % d
print "expected: %s" % xfiles
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