tests/dtest.py: Refer to the home directory via a symlink.

[disorder] / tests / dtest.py

#-*-python-*-
#
# This file is part of DisOrder.
# Copyright (C) 2007-2012 Richard Kettlewell
#
# 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 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.
# 
# You should have received a copy of the GNU General Public License
# 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,random,socket,traceback
import atexit,base64,errno

homelink = None

def fatal(s):
    """Write an error message and exit"""
    sys.stderr.write("ERROR: %s\n" % s)
    sys.exit(1)

@atexit.register
def cleanup():
    if homelink is not None:
        os.unlink(homelink)

# Identify the top build directory
cwd = os.getcwd()
if os.path.exists("config.h"):
    top_builddir = cwd
elif os.path.exists("../config.h"):
    top_builddir = os.path.dirname(cwd)
else:
    fatal("cannot identify build directory")

# Make sure the Python build directory is on the module search path
sys.path.insert(0, os.path.join(top_builddir, "python"))
import disorder

# 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
top_srcdir = None
for l in file("Makefile"):
    r = re.match("top_srcdir *= *(.*)",  l)
    if r:
        top_srcdir = r.group(1)
        break
if not top_srcdir:
    fatal("cannot identify source directory")

# The tests source directory must be on the module search path already since
# we found dtest.py

# -----------------------------------------------------------------------------

def copyfile(a,b):
    """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)

Make track with relative path S exist"""
    trackpath = "%s/%s" % (tracks, s)
    trackdir = os.path.dirname(trackpath)
    if not os.path.exists(trackdir):
        os.makedirs(trackdir)
    copyfile("%s/sounds/long.ogg" % top_srcdir, 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.
    bits = nfc(s).split('/')
    dp = tracks
    for d in bits [0:-1]:
        dd = "%s/%s" % (dp,  d)
        if dp not in dirs_by_dir:
            dirs_by_dir[dp] = []
        if dd not in dirs_by_dir[dp]:
            dirs_by_dir[dp].append(dd)
        dp = "%s/%s" % (dp, d)
    if dp not in files_by_dir:
        files_by_dir[dp] = []
    files_by_dir[dp].append("%s/%s" % (dp, bits[-1]))

def stdtracks():
    # We create some tracks with non-ASCII characters in the name and
    # we (currently) force UTF-8.
    #
    # On a traditional UNIX filesystem, that treats filenames as byte strings
    # with special significant for '/', this should just work, though the
    # names will look wrong to ls(1) in a non UTF-8 locale.
    #
    # On Apple HFS+ filenames normalized to a decomposed form that isn't quite
    # NFD, so our attempts to have both normalized and denormalized filenames
    # is frustrated.  Provided we test on traditional filesytsems too this
    # shouldn't be a problem.
    # (See http://developer.apple.com/qa/qa2001/qa1173.html)

    global dirs_by_dir, files_by_dir
    dirs_by_dir={}
    files_by_dir={}
    
    # C3 8C = 00CC LATIN CAPITAL LETTER I WITH GRAVE
    # (in NFC)
    maketrack("Joe Bloggs/First Album/01:F\xC3\x8Crst track.ogg")

    maketrack("Joe Bloggs/First Album/02:Second track.ogg")

    # CC 81 = 0301 COMBINING ACUTE ACCENT
    # (giving an NFD i-acute)
    maketrack("Joe Bloggs/First Album/03:ThI\xCC\x81rd track.ogg")
    # ...hopefuly giving C3 8D = 00CD LATIN CAPITAL LETTER I WITH ACUTE
    maketrack("Joe Bloggs/First Album/04:Fourth track.ogg")
    maketrack("Joe Bloggs/First Album/05:Fifth track.ogg")
    maketrack("Joe Bloggs/Second Album/01:First track.ogg")
    maketrack("Joe Bloggs/Second Album/02:Second track.ogg")
    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("Fred Smith/Boring/01:Dull.ogg")
    maketrack("Fred Smith/Boring/02:Tedious.ogg")
    maketrack("Fred Smith/Boring/03:Drum Solo.ogg")
    maketrack("Fred Smith/Boring/04:Yawn.ogg")
    maketrack("misc/blahblahblah.ogg")
    maketrack("Various/Greatest Hits/01:Jim Whatever - Spong.ogg")
    maketrack("Various/Greatest Hits/02:Joe Bloggs - Yadda.ogg")

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(
    """home %s
collection fs %s %s/tracks
scratch %s/scratch.ogg
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
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
plugins
plugins %s/plugins
plugins %s/plugins/.libs
player *.mp3 execraw disorder-decode
player *.ogg execraw disorder-decode
player *.wav execraw disorder-decode
player *.flac execraw disorder-decode
tracklength *.mp3 disorder-tracklength
tracklength *.ogg disorder-tracklength
tracklength *.wav disorder-tracklength
tracklength *.flac disorder-tracklength
api rtp
broadcast 127.0.0.1 %d
broadcast_from 127.0.0.1 %d
mail_sender no.such.user.sorry@greenend.org.uk
""" % (homelink, encoding, testroot, testroot, top_builddir, top_builddir,
       port, port + 1))

def common_setup():
    global homelink
    remove_dir(testroot)
    os.makedirs(testroot)
    os.makedirs("%s/home" % testroot)
    # Establish a symlink to the home directory, to keep the socket pathnames
    # short enough.
    tmpdir = "/tmp"
    for v in ["TMPDIR", "TMP"]:
        try: tmpdir = os.environ[v]
        except KeyError: pass
        else: break
    for i in xrange(1024):
        r = base64.b64encode(os.urandom(9)).replace("/", "_")
        f = "%s/disorder-home.%s" % (tmpdir, r)
        try:
            os.symlink("%s/home" % testroot, f)
        except OSError, e:
            if e.errno != errno.EEXIST: raise
        else:
            homelink = f
            break
    else:
        fatal("failed to make home link")
    # Choose a port
    global port
    port = random.randint(49152, 65530)
    while not bindable(port + 1):
        print "port %d is not bindable, trying another" % (port + 1)
        port = random.randint(49152, 65530)
    # 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, 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" % homelink
    if os.path.exists(socket):
        os.remove(socket)
    daemon = subprocess.Popen(["disorderd",
                               "--foreground",
                               "--config", "%s/config" % testroot],
                              stderr=errs)
    # Wait for the socket to be created
    waited = 0
    sleep_resolution = 0.125
    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 += sleep_resolution
        if sleep_resolution < 1:
            sleep_resolution *= 2
        if waited == 1:
            print "  waiting for socket..."
        elif waited >= 60:
            print "FATAL: took too long for socket to appear"
            sys.exit(1)
        time.sleep(sleep_resolution)
    if waited > 0:
        print "  took about %ss for socket to appear" % waited
    # Wait for root user to be created
    command(["disorderd",
             "--config", disorder._configfile,
             "--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()

Stop the daemon if it has not stopped already"""
    global daemon
    if daemon == None:
        print " (daemon not running)"
        return
    rc = daemon.poll()
    if rc == None:
        print " stopping daemon"
        os.kill(daemon.pid, 15)
        print "  waiting for daemon"
        rc = daemon.wait()
        print "  daemon has stopped (rc=%d)" % rc
    else:
        print "  daemon already stopped"
    daemon = None

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, failures
    tests += 1
    # 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__
    print "--- %s ---" % name
    # Open the error log
    global errs
    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
    # Make config file etc
    common_setup()
    # Create some standard tracks
    stdtracks()
    try:
        module.test()
    except Exception, e:
        traceback.print_exc(None, sys.stderr)
        failures += 1
    finally:
        stop_daemon()
        os.system("ps -ef | grep disorderd")
    if report:
        if failures:
            print " FAILED"
            sys.exit(1)
        else:
            print " OK"

def remove_dir(d):
    """remove_dir(D)

Recursively delete directory D"""
    if os.path.lexists(d):
        if os.path.isdir(d):
            for dd in os.listdir(d):
                remove_dir("%s/%s" % (d, dd))
            os.rmdir(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 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)
        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)
        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

tests = 0
failures = 0
daemon = None
testroot = "%s/tests/testroot/%s" % \
           (top_builddir, os.path.basename(sys.argv[0]))
tracks = "%s/tracks" % testroot