Synnefo » snf-ganeti

#!/usr/bin/python

#

# Copyright (C) 2006, 2007, 2010 Google Inc.

#

# 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

# (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, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA

# 02110-1301, USA.

"""Script for unittesting the utils module"""

import distutils.version

import errno

import fcntl

import glob

import os

import os.path

import re

import shutil

import signal

import socket

import stat

import string

import tempfile

import time

import unittest

import warnings

import OpenSSL

from cStringIO import StringIO

import testutils

from ganeti import constants

from ganeti import compat

from ganeti import utils

from ganeti import errors

from ganeti.utils import RunCmd, RemoveFile, MatchNameComponent, FormatUnit, \

     ParseUnit, ShellQuote, ShellQuoteArgs, ListVisibleFiles, FirstFree, \

     TailFile, SafeEncode, FormatTime, UnescapeAndSplit, RunParts, PathJoin, \

     ReadOneLineFile, SetEtcHostsEntry, RemoveEtcHostsEntry

class TestIsProcessAlive(unittest.TestCase):

  """Testing case for IsProcessAlive"""

  def testExists(self):

    mypid = os.getpid()

    self.assert_(utils.IsProcessAlive(mypid), "can't find myself running")

  def testNotExisting(self):

    pid_non_existing = os.fork()

    if pid_non_existing == 0:

      os._exit(0)

    elif pid_non_existing < 0:

      raise SystemError("can't fork")

    os.waitpid(pid_non_existing, 0)

    self.assertFalse(utils.IsProcessAlive(pid_non_existing),

                     "nonexisting process detected")

class TestGetProcStatusPath(unittest.TestCase):

  def test(self):

    self.assert_("/1234/" in utils._GetProcStatusPath(1234))

    self.assertNotEqual(utils._GetProcStatusPath(1),

                        utils._GetProcStatusPath(2))

class TestIsProcessHandlingSignal(unittest.TestCase):

  def setUp(self):

    self.tmpdir = tempfile.mkdtemp()

  def tearDown(self):

    shutil.rmtree(self.tmpdir)

  def testParseSigsetT(self):

    self.assertEqual(len(utils._ParseSigsetT("0")), 0)

    self.assertEqual(utils._ParseSigsetT("1"), set([1]))

    self.assertEqual(utils._ParseSigsetT("1000a"), set([2, 4, 17]))

    self.assertEqual(utils._ParseSigsetT("810002"), set([2, 17, 24, ]))

    self.assertEqual(utils._ParseSigsetT("0000000180000202"),

                     set([2, 10, 32, 33]))

    self.assertEqual(utils._ParseSigsetT("0000000180000002"),

                     set([2, 32, 33]))

    self.assertEqual(utils._ParseSigsetT("0000000188000002"),

                     set([2, 28, 32, 33]))

    self.assertEqual(utils._ParseSigsetT("000000004b813efb"),

                     set([1, 2, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 17,

                          24, 25, 26, 28, 31]))

    self.assertEqual(utils._ParseSigsetT("ffffff"), set(range(1, 25)))

  def testGetProcStatusField(self):

    for field in ["SigCgt", "Name", "FDSize"]:

      for value in ["", "0", "cat", "  1234 KB"]:

        pstatus = "\n".join([

          "VmPeak: 999 kB",

          "%s: %s" % (field, value),

          "TracerPid: 0",

          ])

        result = utils._GetProcStatusField(pstatus, field)

        self.assertEqual(result, value.strip())

  def test(self):

    sp = PathJoin(self.tmpdir, "status")

    utils.WriteFile(sp, data="\n".join([

      "Name:   bash",

      "State:  S (sleeping)",

      "SleepAVG:       98%",

      "Pid:    22250",

      "PPid:   10858",

      "TracerPid:      0",

      "SigBlk: 0000000000010000",

      "SigIgn: 0000000000384004",

      "SigCgt: 000000004b813efb",

      "CapEff: 0000000000000000",

      ]))

    self.assert_(utils.IsProcessHandlingSignal(1234, 10, status_path=sp))

  def testNoSigCgt(self):

    sp = PathJoin(self.tmpdir, "status")

    utils.WriteFile(sp, data="\n".join([

      "Name:   bash",

      ]))

    self.assertRaises(RuntimeError, utils.IsProcessHandlingSignal,

                      1234, 10, status_path=sp)

  def testNoSuchFile(self):

    sp = PathJoin(self.tmpdir, "notexist")

    self.assertFalse(utils.IsProcessHandlingSignal(1234, 10, status_path=sp))

  @staticmethod

  def _TestRealProcess():

    signal.signal(signal.SIGUSR1, signal.SIG_DFL)

    if utils.IsProcessHandlingSignal(os.getpid(), signal.SIGUSR1):

      raise Exception("SIGUSR1 is handled when it should not be")

    signal.signal(signal.SIGUSR1, lambda signum, frame: None)

    if not utils.IsProcessHandlingSignal(os.getpid(), signal.SIGUSR1):

      raise Exception("SIGUSR1 is not handled when it should be")

    signal.signal(signal.SIGUSR1, signal.SIG_IGN)

    if utils.IsProcessHandlingSignal(os.getpid(), signal.SIGUSR1):

      raise Exception("SIGUSR1 is not handled when it should be")

    signal.signal(signal.SIGUSR1, signal.SIG_DFL)

    if utils.IsProcessHandlingSignal(os.getpid(), signal.SIGUSR1):

      raise Exception("SIGUSR1 is handled when it should not be")

    return True

  def testRealProcess(self):

    self.assert_(utils.RunInSeparateProcess(self._TestRealProcess))

class TestPidFileFunctions(unittest.TestCase):

  """Tests for WritePidFile, RemovePidFile and ReadPidFile"""

  def setUp(self):

    self.dir = tempfile.mkdtemp()

    self.f_dpn = lambda name: os.path.join(self.dir, "%s.pid" % name)

    utils.DaemonPidFileName = self.f_dpn

  def testPidFileFunctions(self):

    pid_file = self.f_dpn('test')

    fd = utils.WritePidFile(self.f_dpn('test'))

    self.failUnless(os.path.exists(pid_file),

                    "PID file should have been created")

    read_pid = utils.ReadPidFile(pid_file)

    self.failUnlessEqual(read_pid, os.getpid())

    self.failUnless(utils.IsProcessAlive(read_pid))

    self.failUnlessRaises(errors.LockError, utils.WritePidFile,

                          self.f_dpn('test'))

    os.close(fd)

    utils.RemovePidFile('test')

    self.failIf(os.path.exists(pid_file),

                "PID file should not exist anymore")

    self.failUnlessEqual(utils.ReadPidFile(pid_file), 0,

                         "ReadPidFile should return 0 for missing pid file")

    fh = open(pid_file, "w")

    fh.write("blah\n")

    fh.close()

    self.failUnlessEqual(utils.ReadPidFile(pid_file), 0,

                         "ReadPidFile should return 0 for invalid pid file")

    # but now, even with the file existing, we should be able to lock it

    fd = utils.WritePidFile(self.f_dpn('test'))

    os.close(fd)

    utils.RemovePidFile('test')

    self.failIf(os.path.exists(pid_file),

                "PID file should not exist anymore")

  def testKill(self):

    pid_file = self.f_dpn('child')

    r_fd, w_fd = os.pipe()

    new_pid = os.fork()

    if new_pid == 0: #child

      utils.WritePidFile(self.f_dpn('child'))

      os.write(w_fd, 'a')

      signal.pause()

      os._exit(0)

      return

    # else we are in the parent

    # wait until the child has written the pid file

    os.read(r_fd, 1)

    read_pid = utils.ReadPidFile(pid_file)

    self.failUnlessEqual(read_pid, new_pid)

    self.failUnless(utils.IsProcessAlive(new_pid))

    utils.KillProcess(new_pid, waitpid=True)

    self.failIf(utils.IsProcessAlive(new_pid))

    utils.RemovePidFile('child')

    self.failUnlessRaises(errors.ProgrammerError, utils.KillProcess, 0)

  def tearDown(self):

    for name in os.listdir(self.dir):

      os.unlink(os.path.join(self.dir, name))

    os.rmdir(self.dir)

class TestRunCmd(testutils.GanetiTestCase):

  """Testing case for the RunCmd function"""

  def setUp(self):

    testutils.GanetiTestCase.setUp(self)

    self.magic = time.ctime() + " ganeti test"

    self.fname = self._CreateTempFile()

  def testOk(self):

    """Test successful exit code"""

    result = RunCmd("/bin/sh -c 'exit 0'")

    self.assertEqual(result.exit_code, 0)

    self.assertEqual(result.output, "")

  def testFail(self):

    """Test fail exit code"""

    result = RunCmd("/bin/sh -c 'exit 1'")

    self.assertEqual(result.exit_code, 1)

    self.assertEqual(result.output, "")

  def testStdout(self):

    """Test standard output"""

    cmd = 'echo -n "%s"' % self.magic

    result = RunCmd("/bin/sh -c '%s'" % cmd)

    self.assertEqual(result.stdout, self.magic)

    result = RunCmd("/bin/sh -c '%s'" % cmd, output=self.fname)

    self.assertEqual(result.output, "")

    self.assertFileContent(self.fname, self.magic)

  def testStderr(self):

    """Test standard error"""

    cmd = 'echo -n "%s"' % self.magic

    result = RunCmd("/bin/sh -c '%s' 1>&2" % cmd)

    self.assertEqual(result.stderr, self.magic)

    result = RunCmd("/bin/sh -c '%s' 1>&2" % cmd, output=self.fname)

    self.assertEqual(result.output, "")

    self.assertFileContent(self.fname, self.magic)

  def testCombined(self):

    """Test combined output"""

    cmd = 'echo -n "A%s"; echo -n "B%s" 1>&2' % (self.magic, self.magic)

    expected = "A" + self.magic + "B" + self.magic

    result = RunCmd("/bin/sh -c '%s'" % cmd)

    self.assertEqual(result.output, expected)

    result = RunCmd("/bin/sh -c '%s'" % cmd, output=self.fname)

    self.assertEqual(result.output, "")

    self.assertFileContent(self.fname, expected)

  def testSignal(self):

    """Test signal"""

    result = RunCmd(["python", "-c", "import os; os.kill(os.getpid(), 15)"])

    self.assertEqual(result.signal, 15)

    self.assertEqual(result.output, "")

  def testListRun(self):

    """Test list runs"""

    result = RunCmd(["true"])

    self.assertEqual(result.signal, None)

    self.assertEqual(result.exit_code, 0)

    result = RunCmd(["/bin/sh", "-c", "exit 1"])

    self.assertEqual(result.signal, None)

    self.assertEqual(result.exit_code, 1)

    result = RunCmd(["echo", "-n", self.magic])

    self.assertEqual(result.signal, None)

    self.assertEqual(result.exit_code, 0)

    self.assertEqual(result.stdout, self.magic)

  def testFileEmptyOutput(self):

    """Test file output"""

    result = RunCmd(["true"], output=self.fname)

    self.assertEqual(result.signal, None)

    self.assertEqual(result.exit_code, 0)

    self.assertFileContent(self.fname, "")

  def testLang(self):

    """Test locale environment"""

    old_env = os.environ.copy()

    try:

      os.environ["LANG"] = "en_US.UTF-8"

      os.environ["LC_ALL"] = "en_US.UTF-8"

      result = RunCmd(["locale"])

      for line in result.output.splitlines():

        key, value = line.split("=", 1)

        # Ignore these variables, they're overridden by LC_ALL

        if key == "LANG" or key == "LANGUAGE":

          continue

        self.failIf(value and value != "C" and value != '"C"',

            "Variable %s is set to the invalid value '%s'" % (key, value))

    finally:

      os.environ = old_env

  def testDefaultCwd(self):

    """Test default working directory"""

    self.failUnlessEqual(RunCmd(["pwd"]).stdout.strip(), "/")

  def testCwd(self):

    """Test default working directory"""

    self.failUnlessEqual(RunCmd(["pwd"], cwd="/").stdout.strip(), "/")

    self.failUnlessEqual(RunCmd(["pwd"], cwd="/tmp").stdout.strip(), "/tmp")

    cwd = os.getcwd()

    self.failUnlessEqual(RunCmd(["pwd"], cwd=cwd).stdout.strip(), cwd)

  def testResetEnv(self):

    """Test environment reset functionality"""

    self.failUnlessEqual(RunCmd(["env"], reset_env=True).stdout.strip(), "")

    self.failUnlessEqual(RunCmd(["env"], reset_env=True,

                                env={"FOO": "bar",}).stdout.strip(), "FOO=bar")

class TestRunParts(unittest.TestCase):

  """Testing case for the RunParts function"""

  def setUp(self):

    self.rundir = tempfile.mkdtemp(prefix="ganeti-test", suffix=".tmp")

  def tearDown(self):

    shutil.rmtree(self.rundir)

  def testEmpty(self):

    """Test on an empty dir"""

    self.failUnlessEqual(RunParts(self.rundir, reset_env=True), [])

  def testSkipWrongName(self):

    """Test that wrong files are skipped"""

    fname = os.path.join(self.rundir, "00test.dot")

    utils.WriteFile(fname, data="")

    os.chmod(fname, stat.S_IREAD | stat.S_IEXEC)

    relname = os.path.basename(fname)

    self.failUnlessEqual(RunParts(self.rundir, reset_env=True),

                         [(relname, constants.RUNPARTS_SKIP, None)])

  def testSkipNonExec(self):

    """Test that non executable files are skipped"""

    fname = os.path.join(self.rundir, "00test")

    utils.WriteFile(fname, data="")

    relname = os.path.basename(fname)

    self.failUnlessEqual(RunParts(self.rundir, reset_env=True),

                         [(relname, constants.RUNPARTS_SKIP, None)])

  def testError(self):

    """Test error on a broken executable"""

    fname = os.path.join(self.rundir, "00test")

    utils.WriteFile(fname, data="")

    os.chmod(fname, stat.S_IREAD | stat.S_IEXEC)

    (relname, status, error) = RunParts(self.rundir, reset_env=True)[0]

    self.failUnlessEqual(relname, os.path.basename(fname))

    self.failUnlessEqual(status, constants.RUNPARTS_ERR)

    self.failUnless(error)

  def testSorted(self):

    """Test executions are sorted"""

    files = []

    files.append(os.path.join(self.rundir, "64test"))

    files.append(os.path.join(self.rundir, "00test"))

    files.append(os.path.join(self.rundir, "42test"))

    for fname in files:

      utils.WriteFile(fname, data="")

    results = RunParts(self.rundir, reset_env=True)

    for fname in sorted(files):

      self.failUnlessEqual(os.path.basename(fname), results.pop(0)[0])

  def testOk(self):

    """Test correct execution"""

    fname = os.path.join(self.rundir, "00test")

    utils.WriteFile(fname, data="#!/bin/sh\n\necho -n ciao")

    os.chmod(fname, stat.S_IREAD | stat.S_IEXEC)

    (relname, status, runresult) = RunParts(self.rundir, reset_env=True)[0]

    self.failUnlessEqual(relname, os.path.basename(fname))

    self.failUnlessEqual(status, constants.RUNPARTS_RUN)

    self.failUnlessEqual(runresult.stdout, "ciao")

  def testRunFail(self):

    """Test correct execution, with run failure"""

    fname = os.path.join(self.rundir, "00test")

    utils.WriteFile(fname, data="#!/bin/sh\n\nexit 1")

    os.chmod(fname, stat.S_IREAD | stat.S_IEXEC)

    (relname, status, runresult) = RunParts(self.rundir, reset_env=True)[0]

    self.failUnlessEqual(relname, os.path.basename(fname))

    self.failUnlessEqual(status, constants.RUNPARTS_RUN)

    self.failUnlessEqual(runresult.exit_code, 1)

    self.failUnless(runresult.failed)

  def testRunMix(self):

    files = []

    files.append(os.path.join(self.rundir, "00test"))

    files.append(os.path.join(self.rundir, "42test"))

    files.append(os.path.join(self.rundir, "64test"))

    files.append(os.path.join(self.rundir, "99test"))

    files.sort()

    # 1st has errors in execution

    utils.WriteFile(files[0], data="#!/bin/sh\n\nexit 1")

    os.chmod(files[0], stat.S_IREAD | stat.S_IEXEC)

    # 2nd is skipped

    utils.WriteFile(files[1], data="")

    # 3rd cannot execute properly

    utils.WriteFile(files[2], data="")

    os.chmod(files[2], stat.S_IREAD | stat.S_IEXEC)

    # 4th execs

    utils.WriteFile(files[3], data="#!/bin/sh\n\necho -n ciao")

    os.chmod(files[3], stat.S_IREAD | stat.S_IEXEC)

    results = RunParts(self.rundir, reset_env=True)

    (relname, status, runresult) = results[0]

    self.failUnlessEqual(relname, os.path.basename(files[0]))

    self.failUnlessEqual(status, constants.RUNPARTS_RUN)

    self.failUnlessEqual(runresult.exit_code, 1)

    self.failUnless(runresult.failed)

    (relname, status, runresult) = results[1]

    self.failUnlessEqual(relname, os.path.basename(files[1]))

    self.failUnlessEqual(status, constants.RUNPARTS_SKIP)

    self.failUnlessEqual(runresult, None)

    (relname, status, runresult) = results[2]

    self.failUnlessEqual(relname, os.path.basename(files[2]))

    self.failUnlessEqual(status, constants.RUNPARTS_ERR)

    self.failUnless(runresult)

    (relname, status, runresult) = results[3]

    self.failUnlessEqual(relname, os.path.basename(files[3]))

    self.failUnlessEqual(status, constants.RUNPARTS_RUN)

    self.failUnlessEqual(runresult.output, "ciao")

    self.failUnlessEqual(runresult.exit_code, 0)

    self.failUnless(not runresult.failed)

class TestStartDaemon(testutils.GanetiTestCase):

  def setUp(self):

    self.tmpdir = tempfile.mkdtemp(prefix="ganeti-test")

    self.tmpfile = os.path.join(self.tmpdir, "test")

  def tearDown(self):

    shutil.rmtree(self.tmpdir)

  def testShell(self):

    utils.StartDaemon("echo Hello World > %s" % self.tmpfile)

    self._wait(self.tmpfile, 60.0, "Hello World")

  def testShellOutput(self):

    utils.StartDaemon("echo Hello World", output=self.tmpfile)

    self._wait(self.tmpfile, 60.0, "Hello World")

  def testNoShellNoOutput(self):

    utils.StartDaemon(["pwd"])

  def testNoShellNoOutputTouch(self):

    testfile = os.path.join(self.tmpdir, "check")

    self.failIf(os.path.exists(testfile))

    utils.StartDaemon(["touch", testfile])

    self._wait(testfile, 60.0, "")

  def testNoShellOutput(self):

    utils.StartDaemon(["pwd"], output=self.tmpfile)

    self._wait(self.tmpfile, 60.0, "/")

  def testNoShellOutputCwd(self):

    utils.StartDaemon(["pwd"], output=self.tmpfile, cwd=os.getcwd())

    self._wait(self.tmpfile, 60.0, os.getcwd())

  def testShellEnv(self):

    utils.StartDaemon("echo \"$GNT_TEST_VAR\"", output=self.tmpfile,

                      env={ "GNT_TEST_VAR": "Hello World", })

    self._wait(self.tmpfile, 60.0, "Hello World")

  def testNoShellEnv(self):

    utils.StartDaemon(["printenv", "GNT_TEST_VAR"], output=self.tmpfile,

                      env={ "GNT_TEST_VAR": "Hello World", })

    self._wait(self.tmpfile, 60.0, "Hello World")

  def testOutputFd(self):

    fd = os.open(self.tmpfile, os.O_WRONLY | os.O_CREAT)

    try:

      utils.StartDaemon(["pwd"], output_fd=fd, cwd=os.getcwd())

    finally:

      os.close(fd)

    self._wait(self.tmpfile, 60.0, os.getcwd())

  def testPid(self):

    pid = utils.StartDaemon("echo $$ > %s" % self.tmpfile)

    self._wait(self.tmpfile, 60.0, str(pid))

  def testPidFile(self):

    pidfile = os.path.join(self.tmpdir, "pid")

    checkfile = os.path.join(self.tmpdir, "abort")

    pid = utils.StartDaemon("while sleep 5; do :; done", pidfile=pidfile,

                            output=self.tmpfile)

    try:

      fd = os.open(pidfile, os.O_RDONLY)

      try:

        # Check file is locked

        self.assertRaises(errors.LockError, utils.LockFile, fd)

        pidtext = os.read(fd, 100)

      finally:

        os.close(fd)

      self.assertEqual(int(pidtext.strip()), pid)

      self.assert_(utils.IsProcessAlive(pid))

    finally:

      # No matter what happens, kill daemon

      utils.KillProcess(pid, timeout=5.0, waitpid=False)

      self.failIf(utils.IsProcessAlive(pid))

    self.assertEqual(utils.ReadFile(self.tmpfile), "")

  def _wait(self, path, timeout, expected):

    # Due to the asynchronous nature of daemon processes, polling is necessary.

    # A timeout makes sure the test doesn't hang forever.

    def _CheckFile():

      if not (os.path.isfile(path) and

              utils.ReadFile(path).strip() == expected):

        raise utils.RetryAgain()

    try:

      utils.Retry(_CheckFile, (0.01, 1.5, 1.0), timeout)

    except utils.RetryTimeout:

      self.fail("Apparently the daemon didn't run in %s seconds and/or"

                " didn't write the correct output" % timeout)

  def testError(self):

    self.assertRaises(errors.OpExecError, utils.StartDaemon,

                      ["./does-NOT-EXIST/here/0123456789"])

    self.assertRaises(errors.OpExecError, utils.StartDaemon,

                      ["./does-NOT-EXIST/here/0123456789"],

                      output=os.path.join(self.tmpdir, "DIR/NOT/EXIST"))

    self.assertRaises(errors.OpExecError, utils.StartDaemon,

                      ["./does-NOT-EXIST/here/0123456789"],

                      cwd=os.path.join(self.tmpdir, "DIR/NOT/EXIST"))

    self.assertRaises(errors.OpExecError, utils.StartDaemon,

                      ["./does-NOT-EXIST/here/0123456789"],

                      output=os.path.join(self.tmpdir, "DIR/NOT/EXIST"))

    fd = os.open(self.tmpfile, os.O_WRONLY | os.O_CREAT)

    try:

      self.assertRaises(errors.ProgrammerError, utils.StartDaemon,

                        ["./does-NOT-EXIST/here/0123456789"],

                        output=self.tmpfile, output_fd=fd)

    finally:

      os.close(fd)

class TestSetCloseOnExecFlag(unittest.TestCase):

  """Tests for SetCloseOnExecFlag"""

  def setUp(self):

    self.tmpfile = tempfile.TemporaryFile()

  def testEnable(self):

    utils.SetCloseOnExecFlag(self.tmpfile.fileno(), True)

    self.failUnless(fcntl.fcntl(self.tmpfile.fileno(), fcntl.F_GETFD) &

                    fcntl.FD_CLOEXEC)

  def testDisable(self):

    utils.SetCloseOnExecFlag(self.tmpfile.fileno(), False)

    self.failIf(fcntl.fcntl(self.tmpfile.fileno(), fcntl.F_GETFD) &

                fcntl.FD_CLOEXEC)

class TestSetNonblockFlag(unittest.TestCase):

  def setUp(self):

    self.tmpfile = tempfile.TemporaryFile()

  def testEnable(self):

    utils.SetNonblockFlag(self.tmpfile.fileno(), True)

    self.failUnless(fcntl.fcntl(self.tmpfile.fileno(), fcntl.F_GETFL) &

                    os.O_NONBLOCK)

  def testDisable(self):

    utils.SetNonblockFlag(self.tmpfile.fileno(), False)

    self.failIf(fcntl.fcntl(self.tmpfile.fileno(), fcntl.F_GETFL) &

                os.O_NONBLOCK)

class TestRemoveFile(unittest.TestCase):

  """Test case for the RemoveFile function"""

  def setUp(self):

    """Create a temp dir and file for each case"""

    self.tmpdir = tempfile.mkdtemp('', 'ganeti-unittest-')

    fd, self.tmpfile = tempfile.mkstemp('', '', self.tmpdir)

    os.close(fd)

  def tearDown(self):

    if os.path.exists(self.tmpfile):

      os.unlink(self.tmpfile)

    os.rmdir(self.tmpdir)

  def testIgnoreDirs(self):

    """Test that RemoveFile() ignores directories"""

    self.assertEqual(None, RemoveFile(self.tmpdir))

  def testIgnoreNotExisting(self):

    """Test that RemoveFile() ignores non-existing files"""

    RemoveFile(self.tmpfile)

    RemoveFile(self.tmpfile)

  def testRemoveFile(self):

    """Test that RemoveFile does remove a file"""

    RemoveFile(self.tmpfile)

    if os.path.exists(self.tmpfile):

      self.fail("File '%s' not removed" % self.tmpfile)

  def testRemoveSymlink(self):

    """Test that RemoveFile does remove symlinks"""

    symlink = self.tmpdir + "/symlink"

    os.symlink("no-such-file", symlink)

    RemoveFile(symlink)

    if os.path.exists(symlink):

      self.fail("File '%s' not removed" % symlink)

    os.symlink(self.tmpfile, symlink)

    RemoveFile(symlink)

    if os.path.exists(symlink):

      self.fail("File '%s' not removed" % symlink)

class TestRename(unittest.TestCase):

  """Test case for RenameFile"""

  def setUp(self):

    """Create a temporary directory"""

    self.tmpdir = tempfile.mkdtemp()

    self.tmpfile = os.path.join(self.tmpdir, "test1")

    # Touch the file

    open(self.tmpfile, "w").close()

  def tearDown(self):

    """Remove temporary directory"""

    shutil.rmtree(self.tmpdir)

  def testSimpleRename1(self):

    """Simple rename 1"""

    utils.RenameFile(self.tmpfile, os.path.join(self.tmpdir, "xyz"))

    self.assert_(os.path.isfile(os.path.join(self.tmpdir, "xyz")))

  def testSimpleRename2(self):

    """Simple rename 2"""

    utils.RenameFile(self.tmpfile, os.path.join(self.tmpdir, "xyz"),

                     mkdir=True)

    self.assert_(os.path.isfile(os.path.join(self.tmpdir, "xyz")))

  def testRenameMkdir(self):

    """Rename with mkdir"""

    utils.RenameFile(self.tmpfile, os.path.join(self.tmpdir, "test/xyz"),

                     mkdir=True)

    self.assert_(os.path.isdir(os.path.join(self.tmpdir, "test")))

    self.assert_(os.path.isfile(os.path.join(self.tmpdir, "test/xyz")))

    utils.RenameFile(os.path.join(self.tmpdir, "test/xyz"),

                     os.path.join(self.tmpdir, "test/foo/bar/baz"),

                     mkdir=True)

    self.assert_(os.path.isdir(os.path.join(self.tmpdir, "test")))

    self.assert_(os.path.isdir(os.path.join(self.tmpdir, "test/foo/bar")))

    self.assert_(os.path.isfile(os.path.join(self.tmpdir, "test/foo/bar/baz")))

class TestMatchNameComponent(unittest.TestCase):

  """Test case for the MatchNameComponent function"""

  def testEmptyList(self):

    """Test that there is no match against an empty list"""

    self.failUnlessEqual(MatchNameComponent("", []), None)

    self.failUnlessEqual(MatchNameComponent("test", []), None)

  def testSingleMatch(self):

    """Test that a single match is performed correctly"""

    mlist = ["test1.example.com", "test2.example.com", "test3.example.com"]

    for key in "test2", "test2.example", "test2.example.com":

      self.failUnlessEqual(MatchNameComponent(key, mlist), mlist[1])

  def testMultipleMatches(self):

    """Test that a multiple match is returned as None"""

    mlist = ["test1.example.com", "test1.example.org", "test1.example.net"]

    for key in "test1", "test1.example":

      self.failUnlessEqual(MatchNameComponent(key, mlist), None)

  def testFullMatch(self):

    """Test that a full match is returned correctly"""

    key1 = "test1"

    key2 = "test1.example"

    mlist = [key2, key2 + ".com"]

    self.failUnlessEqual(MatchNameComponent(key1, mlist), None)