+import os.path, re, sys, subprocess
+from cStringIO import StringIO
from twisted.trial import unittest
-from cStringIO import StringIO
-from twisted.python import runtime
-from twisted.internet import utils
-import os.path, re
-from allmydata.scripts import runner
-from allmydata.util import fileutil, pollmixin
+from twisted.python import usage, runtime
+from twisted.internet import threads
+from allmydata.util import fileutil, pollmixin
+from allmydata.util.encodingutil import unicode_to_argv, unicode_to_output, get_filesystem_encoding
+from allmydata.scripts import runner
+from allmydata.client import Client
from allmydata.test import common_util
import allmydata
-bintahoe = os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(allmydata.__file__))), 'bin', 'tahoe')
-class TheRightCode(unittest.TestCase, common_util.SignalMixin):
- def test_path(self):
- if not os.path.exists(bintahoe):
- raise unittest.SkipTest("The bin/tahoe script isn't to be found in the expected location, and I don't want to test a 'tahoe' executable that I find somewhere else, in case it isn't the right executable for this version of tahoe.")
- d = utils.getProcessOutputAndValue(bintahoe, args=["--version-and-path"], env=os.environ)
- def _cb(res):
- out, err, rc_or_sig = res
- self.failUnlessEqual(rc_or_sig, 0)
+timeout = 240
- # Fail unless the allmydata-tahoe package is *this* version *and* was loaded from *this* source directory.
- required_ver_and_path = "allmydata-tahoe: %s (%s)" % (allmydata.__version__, os.path.dirname(os.path.dirname(allmydata.__file__)))
- self.failUnless(out.startswith(required_ver_and_path), (out, err, rc_or_sig))
- d.addCallback(_cb)
- return d
+def get_root_from_file(src):
+ srcdir = os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(src))))
-class CreateNode(unittest.TestCase, common_util.SignalMixin):
- def workdir(self, name):
- basedir = os.path.join("test_runner", "CreateNode", name)
- fileutil.make_dirs(basedir)
- return basedir
+ root = os.path.dirname(srcdir)
+ if os.path.basename(srcdir) == 'site-packages':
+ if re.search(r'python.+\..+', os.path.basename(root)):
+ root = os.path.dirname(root)
+ root = os.path.dirname(root)
+ elif os.path.basename(root) == 'src':
+ root = os.path.dirname(root)
- def test_client(self):
+ return root
+
+srcfile = allmydata.__file__
+rootdir = get_root_from_file(srcfile)
+
+if hasattr(sys, 'frozen'):
+ bintahoe = os.path.join(rootdir, 'tahoe')
+ if sys.platform == "win32" and os.path.exists(bintahoe + '.exe'):
+ bintahoe += '.exe'
+else:
+ bintahoe = os.path.join(rootdir, 'bin', 'tahoe')
+ if sys.platform == "win32":
+ bintahoe += '.pyscript'
if not os.path.exists(bintahoe):
- raise unittest.SkipTest("The bin/tahoe script isn't to be found in the expected location, and I don't want to test a 'tahoe' executable that I find somewhere else, in case it isn't the right executable for this version of tahoe.")
- basedir = self.workdir("test_client")
- c1 = os.path.join(basedir, "c1")
- d = utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-client", "--basedir", c1], env=os.environ)
+ alt_bintahoe = os.path.join(rootdir, 'Scripts', 'tahoe.pyscript')
+ if os.path.exists(alt_bintahoe):
+ bintahoe = alt_bintahoe
+
+
+class RunBinTahoeMixin:
+ def skip_if_cannot_run_bintahoe(self):
+ if not os.path.exists(bintahoe):
+ raise unittest.SkipTest("The bin/tahoe script isn't to be found in the expected location (%s), and I don't want to test a 'tahoe' executable that I find somewhere else, in case it isn't the right executable for this version of Tahoe. Perhaps running 'setup.py build' again will help." % (bintahoe,))
+
+ def skip_if_cannot_daemonize(self):
+ self.skip_if_cannot_run_bintahoe()
+ if runtime.platformType == "win32":
+ # twistd on windows doesn't daemonize. cygwin should work normally.
+ raise unittest.SkipTest("twistd does not fork under windows")
+
+ def run_bintahoe(self, args, stdin=None, python_options=[], env=None):
+ self.skip_if_cannot_run_bintahoe()
+
+ if hasattr(sys, 'frozen'):
+ if python_options:
+ raise unittest.SkipTest("This test doesn't apply to frozen builds.")
+ command = [bintahoe] + args
+ else:
+ command = [sys.executable] + python_options + [bintahoe] + args
+
+ if stdin is None:
+ stdin_stream = None
+ else:
+ stdin_stream = subprocess.PIPE
+
+ def _run():
+ p = subprocess.Popen(command, stdin=stdin_stream, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env)
+ (out, err) = p.communicate(stdin)
+ return (out, err, p.returncode)
+ return threads.deferToThread(_run)
+
+
+class BinTahoe(common_util.SignalMixin, unittest.TestCase, RunBinTahoeMixin):
+ def _check_right_code(self, file_to_check):
+ root_to_check = get_root_from_file(file_to_check)
+ if os.path.basename(root_to_check) == 'dist':
+ root_to_check = os.path.dirname(root_to_check)
+
+ cwd = os.path.normcase(os.path.realpath("."))
+ root_from_cwd = os.path.dirname(cwd)
+ if os.path.basename(root_from_cwd) == 'src':
+ root_from_cwd = os.path.dirname(root_from_cwd)
+
+ # This is needed if we are running in a temporary directory created by 'make tmpfstest'.
+ if os.path.basename(root_from_cwd).startswith('tmp'):
+ root_from_cwd = os.path.dirname(root_from_cwd)
+
+ same = (root_from_cwd == root_to_check)
+ if not same:
+ try:
+ same = os.path.samefile(root_from_cwd, root_to_check)
+ except AttributeError, e:
+ e # hush pyflakes
+
+ if not same:
+ msg = ("We seem to be testing the code at %r,\n"
+ "(according to the source filename %r),\n"
+ "but expected to be testing the code at %r.\n"
+ % (root_to_check, file_to_check, root_from_cwd))
+
+ root_from_cwdu = os.path.dirname(os.path.normcase(os.path.normpath(os.getcwdu())))
+ if os.path.basename(root_from_cwdu) == u'src':
+ root_from_cwdu = os.path.dirname(root_from_cwdu)
+
+ # This is needed if we are running in a temporary directory created by 'make tmpfstest'.
+ if os.path.basename(root_from_cwdu).startswith(u'tmp'):
+ root_from_cwdu = os.path.dirname(root_from_cwdu)
+
+ if not isinstance(root_from_cwd, unicode) and root_from_cwd.decode(get_filesystem_encoding(), 'replace') != root_from_cwdu:
+ msg += ("However, this may be a false alarm because the current directory path\n"
+ "is not representable in the filesystem encoding. Please run the tests\n"
+ "from the root of the Tahoe-LAFS distribution at a non-Unicode path.")
+ raise unittest.SkipTest(msg)
+ else:
+ msg += "Please run the tests from the root of the Tahoe-LAFS distribution."
+ self.fail(msg)
+
+ def test_the_right_code(self):
+ self._check_right_code(srcfile)
+
+ def test_import_in_repl(self):
+ d = self.run_bintahoe(["debug", "repl"],
+ stdin="import allmydata; print; print allmydata.__file__")
def _cb(res):
out, err, rc_or_sig = res
- self.failUnlessEqual(err, "")
- self.failUnlessEqual(out, "")
- self.failUnlessEqual(rc_or_sig, 0)
- self.failUnless(os.path.exists(c1))
- self.failUnless(os.path.exists(os.path.join(c1, "tahoe-client.tac")))
+ self.failUnlessEqual(rc_or_sig, 0, str(res))
+ lines = out.splitlines()
+ self.failUnlessIn('>>>', lines[0], str(res))
+ self._check_right_code(lines[1])
d.addCallback(_cb)
+ return d
+ # The timeout was exceeded on FreeStorm's CentOS5-i386.
+ test_import_in_repl.timeout = 480
- def _then_try_again(unused=None):
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-client", "--basedir", c1], env=os.environ)
- d.addCallback(_then_try_again)
+ def test_path(self):
+ d = self.run_bintahoe(["--version-and-path"])
+ def _cb(res):
+ from allmydata import normalized_version
- def _cb2(res):
out, err, rc_or_sig = res
- # creating the client a second time should throw an exception
- self.failIfEqual(rc_or_sig, 0, str((out, err, rc_or_sig)))
- self.failUnlessEqual(out, "")
- self.failUnless("is not empty." in err)
+ self.failUnlessEqual(rc_or_sig, 0, str(res))
- # Fail if there is a line that doesn't end with a PUNCTUATION MARK.
- self.failIf(re.search("[^\.!?]\n", err), err)
- d.addCallback(_cb2)
+ # Fail unless the __appname__ package is *this* version *and*
+ # was loaded from *this* source directory.
- c2 = os.path.join(basedir, "c2")
- def _then_try_new_dir(unused=None):
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-client", c2], env=os.environ)
- d.addCallback(_then_try_new_dir)
+ required_verstr = str(allmydata.__version__)
- def _cb3(res):
- out, err, rc_or_sig = res
- self.failUnless(os.path.exists(c2))
- self.failUnless(os.path.exists(os.path.join(c2, "tahoe-client.tac")))
- d.addCallback(_cb3)
+ self.failIfEqual(required_verstr, "unknown",
+ "We don't know our version, because this distribution didn't come "
+ "with a _version.py and 'setup.py update_version' hasn't been run.")
- def _then_try_badarg(unused=None):
- return utils.getProcessOutputAndValue(bintahoe, args=["create-client", "basedir", "extraarg"], env=os.environ)
- d.addCallback(_then_try_badarg)
+ srcdir = os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(srcfile))))
+ info = repr((res, allmydata.__appname__, required_verstr, srcdir))
- def _cb4(res):
+ appverpath = out.split(')')[0]
+ (appverfull, path) = appverpath.split('] (')
+ (appver, comment) = appverfull.split(' [')
+ (branch, full_version) = comment.split(': ')
+ (app, ver) = appver.split(': ')
+
+ self.failUnlessEqual(app, allmydata.__appname__, info)
+ norm_ver = normalized_version(ver)
+ norm_required = normalized_version(required_verstr)
+ self.failUnlessEqual(norm_ver, norm_required, info)
+ self.failUnlessEqual(path, srcdir, info)
+ self.failUnlessEqual(branch, allmydata.branch)
+ self.failUnlessEqual(full_version, allmydata.full_version)
+ d.addCallback(_cb)
+ return d
+
+ def test_unicode_arguments_and_output(self):
+ self.skip_if_cannot_run_bintahoe()
+
+ tricky = u"\u2621"
+ try:
+ tricky_arg = unicode_to_argv(tricky, mangle=True)
+ tricky_out = unicode_to_output(tricky)
+ except UnicodeEncodeError:
+ raise unittest.SkipTest("A non-ASCII argument/output could not be encoded on this platform.")
+
+ d = self.run_bintahoe([tricky_arg])
+ def _cb(res):
out, err, rc_or_sig = res
- self.failUnlessEqual(rc_or_sig, 1)
- self.failUnless(out.startswith("Usage"), out)
- d.addCallback(_cb4)
+ self.failUnlessEqual(rc_or_sig, 1, str(res))
+ self.failUnlessIn("Unknown command: "+tricky_out, out)
+ d.addCallback(_cb)
return d
- def test_introducer(self):
- if not os.path.exists(bintahoe):
- raise unittest.SkipTest("The bin/tahoe script isn't to be found in the expected location, and I don't want to test a 'tahoe' executable that I find somewhere else, in case it isn't the right executable for this version of tahoe.")
- basedir = self.workdir("test_introducer")
- c1 = os.path.join(basedir, "c1")
- d = utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-introducer", "--basedir", c1], env=os.environ)
+ def test_run_with_python_options(self):
+ # -t is a harmless option that warns about tabs.
+ d = self.run_bintahoe(["--version"], python_options=["-t"])
def _cb(res):
out, err, rc_or_sig = res
- self.failUnlessEqual(err, "")
- self.failUnlessEqual(out, "")
- self.failUnlessEqual(rc_or_sig, 0)
- self.failUnless(os.path.exists(c1))
- self.failUnless(os.path.exists(os.path.join(c1,
- "tahoe-introducer.tac")))
+ self.failUnlessEqual(rc_or_sig, 0, str(res))
+ self.failUnless(out.startswith(allmydata.__appname__+':'), str(res))
d.addCallback(_cb)
+ return d
- def _then_try_again(unused=None):
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-introducer", "--basedir", c1], env=os.environ)
- d.addCallback(_then_try_again)
+ def test_version_no_noise(self):
+ self.skip_if_cannot_run_bintahoe()
- def _cb2(res):
+ d = self.run_bintahoe(["--version"])
+ def _cb(res):
out, err, rc_or_sig = res
- # creating the introducer a second time should throw an exception
- self.failIfEqual(rc_or_sig, 0)
- self.failUnlessEqual(out, "")
- self.failUnless("is not empty" in err)
+ self.failUnlessEqual(rc_or_sig, 0, str(res))
+ self.failUnless(out.startswith(allmydata.__appname__+':'), str(res))
+ self.failIfIn("DeprecationWarning", out, str(res))
+ errlines = err.split("\n")
+ self.failIf([True for line in errlines if (line != "" and "UserWarning: Unbuilt egg for setuptools" not in line
+ and "from pkg_resources import load_entry_point" not in line)], str(res))
+ if err != "":
+ raise unittest.SkipTest("This test is known not to pass on Ubuntu Lucid; see #1235.")
+ d.addCallback(_cb)
+ return d
- # Fail if there is a line that doesn't end with a PUNCTUATION MARK.
- self.failIf(re.search("[^\.!?]\n", err), err)
- d.addCallback(_cb2)
- c2 = os.path.join(basedir, "c2")
- def _then_try_new_dir(unused=None):
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-introducer", c2], env=os.environ)
- d.addCallback(_then_try_new_dir)
+class CreateNode(unittest.TestCase):
+ # exercise "tahoe create-node", create-introducer,
+ # create-key-generator, and create-stats-gatherer, by calling the
+ # corresponding code as a subroutine.
- def _cb3(res):
- out, err, rc_or_sig = res
- self.failUnless(os.path.exists(c2))
- self.failUnless(os.path.exists(os.path.join(c2,
- "tahoe-introducer.tac")))
- d.addCallback(_cb3)
+ def workdir(self, name):
+ basedir = os.path.join("test_runner", "CreateNode", name)
+ fileutil.make_dirs(basedir)
+ return basedir
- def _then_try_badarg(unused=None):
- return utils.getProcessOutputAndValue(bintahoe, args=["create-introducer", "basedir", "extraarg"], env=os.environ)
- d.addCallback(_then_try_badarg)
+ def run_tahoe(self, argv):
+ out,err = StringIO(), StringIO()
+ rc = runner.runner(argv, stdout=out, stderr=err)
+ return rc, out.getvalue(), err.getvalue()
+
+ def do_create(self, kind):
+ basedir = self.workdir("test_" + kind)
+ command = "create-" + kind
+ is_client = kind in ("node", "client")
+ tac = is_client and "tahoe-client.tac" or ("tahoe-" + kind + ".tac")
+
+ n1 = os.path.join(basedir, command + "-n1")
+ argv = ["--quiet", command, "--basedir", n1]
+ rc, out, err = self.run_tahoe(argv)
+ self.failUnlessEqual(err, "")
+ self.failUnlessEqual(out, "")
+ self.failUnlessEqual(rc, 0)
+ self.failUnless(os.path.exists(n1))
+ self.failUnless(os.path.exists(os.path.join(n1, tac)))
+
+ if is_client:
+ # tahoe.cfg should exist, and should have storage enabled for
+ # 'create-node', and disabled for 'create-client'.
+ tahoe_cfg = os.path.join(n1, "tahoe.cfg")
+ self.failUnless(os.path.exists(tahoe_cfg))
+ content = fileutil.read(tahoe_cfg).replace('\r\n', '\n')
+ if kind == "client":
+ self.failUnless(re.search(r"\n\[storage\]\n#.*\nenabled = false\n", content), content)
+ else:
+ self.failUnless(re.search(r"\n\[storage\]\n#.*\nenabled = true\n", content), content)
+ self.failUnless("\nreserved_space = 1G\n" in content)
+
+ self.failUnless(re.search(r"\n\[magic_folder\]\n#.*\n#enabled = false\n", content), content)
+
+ # creating the node a second time should be rejected
+ rc, out, err = self.run_tahoe(argv)
+ self.failIfEqual(rc, 0, str((out, err, rc)))
+ self.failUnlessEqual(out, "")
+ self.failUnless("is not empty." in err)
+
+ # Fail if there is a non-empty line that doesn't end with a
+ # punctuation mark.
+ for line in err.splitlines():
+ self.failIf(re.search("[\S][^\.!?]$", line), (line,))
+
+ # test that the non --basedir form works too
+ n2 = os.path.join(basedir, command + "-n2")
+ argv = ["--quiet", command, n2]
+ rc, out, err = self.run_tahoe(argv)
+ self.failUnlessEqual(err, "")
+ self.failUnlessEqual(out, "")
+ self.failUnlessEqual(rc, 0)
+ self.failUnless(os.path.exists(n2))
+ self.failUnless(os.path.exists(os.path.join(n2, tac)))
+
+ # test the --node-directory form
+ n3 = os.path.join(basedir, command + "-n3")
+ argv = ["--quiet", "--node-directory", n3, command]
+ rc, out, err = self.run_tahoe(argv)
+ self.failUnlessEqual(err, "")
+ self.failUnlessEqual(out, "")
+ self.failUnlessEqual(rc, 0)
+ self.failUnless(os.path.exists(n3))
+ self.failUnless(os.path.exists(os.path.join(n3, tac)))
+
+ if kind in ("client", "node", "introducer"):
+ # test that the output (without --quiet) includes the base directory
+ n4 = os.path.join(basedir, command + "-n4")
+ argv = [command, n4]
+ rc, out, err = self.run_tahoe(argv)
+ self.failUnlessEqual(err, "")
+ self.failUnlessIn(" created in ", out)
+ self.failUnlessIn(n4, out)
+ self.failIfIn("\\\\?\\", out)
+ self.failUnlessEqual(rc, 0)
+ self.failUnless(os.path.exists(n4))
+ self.failUnless(os.path.exists(os.path.join(n4, tac)))
+
+ # make sure it rejects too many arguments
+ argv = [command, "basedir", "extraarg"]
+ self.failUnlessRaises(usage.UsageError,
+ runner.runner, argv,
+ run_by_human=False)
+
+ # when creating a non-client, there is no default for the basedir
+ if not is_client:
+ argv = [command]
+ self.failUnlessRaises(usage.UsageError,
+ runner.runner, argv,
+ run_by_human=False)
+
+
+ def test_node(self):
+ self.do_create("node")
- def _cb4(res):
- out, err, rc_or_sig = res
- self.failUnlessEqual(rc_or_sig, 1)
- self.failUnless(out.startswith("Usage"), out)
- d.addCallback(_cb4)
+ def test_client(self):
+ # create-client should behave like create-node --no-storage.
+ self.do_create("client")
- def _then_try_badarg_again(unused=None):
- return utils.getProcessOutputAndValue(bintahoe, args=["create-introducer"], env=os.environ)
- d.addCallback(_then_try_badarg_again)
+ def test_introducer(self):
+ self.do_create("introducer")
- def _cb5(res):
- out, err, rc_or_sig = res
- self.failUnlessEqual(rc_or_sig, 1)
- self.failUnless(out.startswith("Usage"), out)
- d.addCallback(_cb5)
- return d
+ def test_key_generator(self):
+ self.do_create("key-generator")
+
+ def test_stats_gatherer(self):
+ self.do_create("stats-gatherer")
+
+ def test_subcommands(self):
+ # no arguments should trigger a command listing, via UsageError
+ self.failUnlessRaises(usage.UsageError,
+ runner.runner,
+ [],
+ run_by_human=False)
+
+
+class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
+ RunBinTahoeMixin):
+ # exercise "tahoe start", for both introducer, client node, and
+ # key-generator, by spawning "tahoe start" as a subprocess. This doesn't
+ # get us figleaf-based line-level coverage, but it does a better job of
+ # confirming that the user can actually run "./bin/tahoe start" and
+ # expect it to work. This verifies that bin/tahoe sets up PYTHONPATH and
+ # the like correctly.
+
+ # This doesn't work on cygwin (it hangs forever), so we skip this test
+ # when we're on cygwin. It is likely that "tahoe start" itself doesn't
+ # work on cygwin: twisted seems unable to provide a version of
+ # spawnProcess which really works there.
-class RunNode(unittest.TestCase, pollmixin.PollMixin, common_util.SignalMixin):
def workdir(self, name):
basedir = os.path.join("test_runner", "RunNode", name)
fileutil.make_dirs(basedir)
return basedir
def test_introducer(self):
- if not os.path.exists(bintahoe):
- raise unittest.SkipTest("The bin/tahoe script isn't to be found in the expected location, and I don't want to test a 'tahoe' executable that I find somewhere else, in case it isn't the right executable for this version of tahoe.")
- if runtime.platformType == "win32":
- # twistd on windows doesn't daemonize. cygwin works normally.
- raise unittest.SkipTest("twistd does not fork under windows")
+ self.skip_if_cannot_daemonize()
+
basedir = self.workdir("test_introducer")
c1 = os.path.join(basedir, "c1")
- HOTLINE_FILE = os.path.join(c1, "suicide_prevention_hotline")
- TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
- INTRODUCER_FURL_FILE = os.path.join(c1, "introducer.furl")
-
- d = utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-introducer", "--basedir", c1], env=os.environ)
+ exit_trigger_file = os.path.join(c1, Client.EXIT_TRIGGER_FILE)
+ twistd_pid_file = os.path.join(c1, "twistd.pid")
+ introducer_furl_file = os.path.join(c1, "private", "introducer.furl")
+ portnum_file = os.path.join(c1, "introducer.port")
+ node_url_file = os.path.join(c1, "node.url")
+ config_file = os.path.join(c1, "tahoe.cfg")
+
+ d = self.run_bintahoe(["--quiet", "create-introducer", "--basedir", c1])
def _cb(res):
out, err, rc_or_sig = res
self.failUnlessEqual(rc_or_sig, 0)
+
+ # This makes sure that node.url is written, which allows us to
+ # detect when the introducer restarts in _node_has_restarted below.
+ config = fileutil.read(config_file)
+ self.failUnlessIn('\nweb.port = \n', config)
+ fileutil.write(config_file, config.replace('\nweb.port = \n', '\nweb.port = 0\n'))
+
# by writing this file, we get ten seconds before the node will
# exit. This insures that even if the test fails (and the 'stop'
# command doesn't work), the client should still terminate.
- open(HOTLINE_FILE, "w").write("")
+ fileutil.write(exit_trigger_file, "")
# now it's safe to start the node
d.addCallback(_cb)
def _then_start_the_node(res):
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "start", c1], env=os.environ)
+ return self.run_bintahoe(["--quiet", "start", c1])
d.addCallback(_then_start_the_node)
def _cb2(res):
out, err, rc_or_sig = res
- open(HOTLINE_FILE, "w").write("")
+ fileutil.write(exit_trigger_file, "")
errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
# the parent (twistd) has exited. However, twistd writes the pid
# from the child, not the parent, so we can't expect twistd.pid
d.addCallback(_cb2)
def _node_has_started():
- return os.path.exists(INTRODUCER_FURL_FILE)
+ return os.path.exists(introducer_furl_file)
d.addCallback(lambda res: self.poll(_node_has_started))
def _started(res):
- open(HOTLINE_FILE, "w").write("")
- self.failUnless(os.path.exists(TWISTD_PID_FILE))
+ # read the introducer.furl and introducer.port files so we can
+ # check that their contents don't change on restart
+ self.furl = fileutil.read(introducer_furl_file)
+ self.failUnless(os.path.exists(portnum_file))
+ self.portnum = fileutil.read(portnum_file)
+
+ fileutil.write(exit_trigger_file, "")
+ self.failUnless(os.path.exists(twistd_pid_file))
+ self.failUnless(os.path.exists(node_url_file))
+
# rm this so we can detect when the second incarnation is ready
- os.unlink(INTRODUCER_FURL_FILE)
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "restart", c1], env=os.environ)
+ os.unlink(node_url_file)
+ return self.run_bintahoe(["--quiet", "restart", c1])
d.addCallback(_started)
def _then(res):
out, err, rc_or_sig = res
- open(HOTLINE_FILE, "w").write("")
+ fileutil.write(exit_trigger_file, "")
errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
d.addCallback(_then)
- # again, the second incarnation of the node might not be ready yet,
- # so poll until it is
- d.addCallback(lambda res: self.poll(_node_has_started))
-
- # now we can kill it. TODO: On a slow machine, the node might kill
- # itself before we get a chance too, especially if spawning the
+ # Again, the second incarnation of the node might not be ready yet,
+ # so poll until it is. This time introducer_furl_file already
+ # exists, so we check for the existence of node_url_file instead.
+ def _node_has_restarted():
+ return os.path.exists(node_url_file) and os.path.exists(portnum_file)
+ d.addCallback(lambda res: self.poll(_node_has_restarted))
+
+ def _check_same_furl_and_port(res):
+ self.failUnless(os.path.exists(introducer_furl_file))
+ self.failUnlessEqual(self.furl, fileutil.read(introducer_furl_file))
+ self.failUnlessEqual(self.portnum, fileutil.read(portnum_file))
+ d.addCallback(_check_same_furl_and_port)
+
+ # Now we can kill it. TODO: On a slow machine, the node might kill
+ # itself before we get a chance to, especially if spawning the
# 'tahoe stop' command takes a while.
def _stop(res):
- open(HOTLINE_FILE, "w").write("")
- self.failUnless(os.path.exists(TWISTD_PID_FILE))
+ fileutil.write(exit_trigger_file, "")
+ self.failUnless(os.path.exists(twistd_pid_file))
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "stop", c1], env=os.environ)
+ return self.run_bintahoe(["--quiet", "stop", c1])
d.addCallback(_stop)
def _after_stopping(res):
out, err, rc_or_sig = res
- open(HOTLINE_FILE, "w").write("")
+ fileutil.write(exit_trigger_file, "")
# the parent has exited by now
errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
# the parent was supposed to poll and wait until it sees
# twistd.pid go away before it exits, so twistd.pid should be
# gone by now.
- self.failIf(os.path.exists(TWISTD_PID_FILE))
+ self.failIf(os.path.exists(twistd_pid_file))
d.addCallback(_after_stopping)
+ d.addBoth(self._remove, exit_trigger_file)
+ return d
+ # This test has hit a 240-second timeout on our feisty2.5 buildslave, and a 480-second timeout
+ # on Francois's Lenny-armv5tel buildslave.
+ test_introducer.timeout = 960
+
+ def test_client_no_noise(self):
+ self.skip_if_cannot_daemonize()
+
+ basedir = self.workdir("test_client_no_noise")
+ c1 = os.path.join(basedir, "c1")
+ exit_trigger_file = os.path.join(c1, Client.EXIT_TRIGGER_FILE)
+ twistd_pid_file = os.path.join(c1, "twistd.pid")
+ portnum_file = os.path.join(c1, "client.port")
+
+ d = self.run_bintahoe(["--quiet", "create-client", "--basedir", c1, "--webport", "0"])
+ def _cb(res):
+ out, err, rc_or_sig = res
+ errstr = "cc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
+ assert rc_or_sig == 0, errstr
+ self.failUnlessEqual(rc_or_sig, 0)
+
+ # By writing this file, we get two minutes before the client will exit. This ensures
+ # that even if the 'stop' command doesn't work (and the test fails), the client should
+ # still terminate.
+ fileutil.write(exit_trigger_file, "")
+ # now it's safe to start the node
+ d.addCallback(_cb)
+
+ def _start(res):
+ return self.run_bintahoe(["--quiet", "start", c1])
+ d.addCallback(_start)
+
+ def _cb2(res):
+ out, err, rc_or_sig = res
+ errstr = "cc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
+ fileutil.write(exit_trigger_file, "")
+ self.failUnlessEqual(rc_or_sig, 0, errstr)
+ self.failUnlessEqual(out, "", errstr) # If you emit noise, you fail this test.
+ errlines = err.split("\n")
+ self.failIf([True for line in errlines if (line != "" and "UserWarning: Unbuilt egg for setuptools" not in line
+ and "from pkg_resources import load_entry_point" not in line)], errstr)
+ if err != "":
+ raise unittest.SkipTest("This test is known not to pass on Ubuntu Lucid; see #1235.")
+
+ # the parent (twistd) has exited. However, twistd writes the pid
+ # from the child, not the parent, so we can't expect twistd.pid
+ # to exist quite yet.
+
+ # the node is running, but it might not have made it past the
+ # first reactor turn yet, and if we kill it too early, it won't
+ # remove the twistd.pid file. So wait until it does something
+ # that we know it won't do until after the first turn.
+ d.addCallback(_cb2)
- def _remove_hotline(res):
- os.unlink(HOTLINE_FILE)
- return res
- d.addBoth(_remove_hotline)
+ def _node_has_started():
+ return os.path.exists(portnum_file)
+ d.addCallback(lambda res: self.poll(_node_has_started))
+
+ # now we can kill it. TODO: On a slow machine, the node might kill
+ # itself before we get a chance to, especially if spawning the
+ # 'tahoe stop' command takes a while.
+ def _stop(res):
+ self.failUnless(os.path.exists(twistd_pid_file),
+ (twistd_pid_file, os.listdir(os.path.dirname(twistd_pid_file))))
+ return self.run_bintahoe(["--quiet", "stop", c1])
+ d.addCallback(_stop)
+ d.addBoth(self._remove, exit_trigger_file)
return d
def test_client(self):
- if not os.path.exists(bintahoe):
- raise unittest.SkipTest("The bin/tahoe script isn't to be found in the expected location, and I don't want to test a 'tahoe' executable that I find somewhere else, in case it isn't the right executable for this version of tahoe.")
- if runtime.platformType == "win32":
- # twistd on windows doesn't daemonize. cygwin works normally.
- raise unittest.SkipTest("twistd does not fork under windows")
+ self.skip_if_cannot_daemonize()
+
basedir = self.workdir("test_client")
c1 = os.path.join(basedir, "c1")
- HOTLINE_FILE = os.path.join(c1, "suicide_prevention_hotline")
- TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
- PORTNUMFILE = os.path.join(c1, "client.port")
+ exit_trigger_file = os.path.join(c1, Client.EXIT_TRIGGER_FILE)
+ twistd_pid_file = os.path.join(c1, "twistd.pid")
+ portnum_file = os.path.join(c1, "client.port")
+ node_url_file = os.path.join(c1, "node.url")
+ config_file = os.path.join(c1, "tahoe.cfg")
- d = utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-client", "--basedir", c1, "--webport", "0"], env=os.environ)
+ d = self.run_bintahoe(["--quiet", "create-node", "--basedir", c1, "--webport", "0"])
def _cb(res):
out, err, rc_or_sig = res
self.failUnlessEqual(rc_or_sig, 0)
- # By writing this file, we get forty seconds before the client will exit. This insures
+
+ # Check that the --webport option worked.
+ config = fileutil.read(config_file)
+ self.failUnlessIn('\nweb.port = 0\n', config)
+
+ # By writing this file, we get two minutes before the client will exit. This ensures
# that even if the 'stop' command doesn't work (and the test fails), the client should
# still terminate.
- open(HOTLINE_FILE, "w").write("")
- open(os.path.join(c1, "introducer.furl"), "w").write("pb://xrndsskn2zuuian5ltnxrte7lnuqdrkz@127.0.0.1:55617/introducer\n")
+ fileutil.write(exit_trigger_file, "")
# now it's safe to start the node
d.addCallback(_cb)
def _start(res):
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "start", c1], env=os.environ)
+ return self.run_bintahoe(["--quiet", "start", c1])
d.addCallback(_start)
def _cb2(res):
out, err, rc_or_sig = res
- open(HOTLINE_FILE, "w").write("")
- errstr = "cc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
+ fileutil.write(exit_trigger_file, "")
+ errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
# the parent (twistd) has exited. However, twistd writes the pid
# from the child, not the parent, so we can't expect twistd.pid
d.addCallback(_cb2)
def _node_has_started():
- return os.path.exists(PORTNUMFILE)
+ # this depends upon both files being created atomically
+ return os.path.exists(node_url_file) and os.path.exists(portnum_file)
d.addCallback(lambda res: self.poll(_node_has_started))
def _started(res):
- open(HOTLINE_FILE, "w").write("")
- self.failUnless(os.path.exists(TWISTD_PID_FILE))
- # rm this so we can detect when the second incarnation is ready
- os.unlink(PORTNUMFILE)
+ # read the client.port file so we can check that its contents
+ # don't change on restart
+ self.portnum = fileutil.read(portnum_file)
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "restart", c1], env=os.environ)
+ fileutil.write(exit_trigger_file, "")
+ self.failUnless(os.path.exists(twistd_pid_file))
+
+ # rm this so we can detect when the second incarnation is ready
+ os.unlink(node_url_file)
+ return self.run_bintahoe(["--quiet", "restart", c1])
d.addCallback(_started)
def _cb3(res):
out, err, rc_or_sig = res
- open(HOTLINE_FILE, "w").write("")
+ fileutil.write(exit_trigger_file, "")
errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
d.addCallback(_cb3)
# again, the second incarnation of the node might not be ready yet,
# so poll until it is
d.addCallback(lambda res: self.poll(_node_has_started))
+ def _check_same_port(res):
+ self.failUnlessEqual(self.portnum, fileutil.read(portnum_file))
+ d.addCallback(_check_same_port)
+
# now we can kill it. TODO: On a slow machine, the node might kill
- # itself before we get a chance too, especially if spawning the
+ # itself before we get a chance to, especially if spawning the
# 'tahoe stop' command takes a while.
def _stop(res):
- open(HOTLINE_FILE, "w").write("")
- self.failUnless(os.path.exists(TWISTD_PID_FILE), (TWISTD_PID_FILE, os.listdir(os.path.dirname(TWISTD_PID_FILE))))
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "stop", c1], env=os.environ)
+ fileutil.write(exit_trigger_file, "")
+ self.failUnless(os.path.exists(twistd_pid_file),
+ (twistd_pid_file, os.listdir(os.path.dirname(twistd_pid_file))))
+ return self.run_bintahoe(["--quiet", "stop", c1])
d.addCallback(_stop)
def _cb4(res):
out, err, rc_or_sig = res
- open(HOTLINE_FILE, "w").write("")
+ fileutil.write(exit_trigger_file, "")
# the parent has exited by now
errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
# the parent was supposed to poll and wait until it sees
# twistd.pid go away before it exits, so twistd.pid should be
# gone by now.
- self.failIf(os.path.exists(TWISTD_PID_FILE))
+ self.failIf(os.path.exists(twistd_pid_file))
d.addCallback(_cb4)
- def _remove_hotline(res):
- os.unlink(HOTLINE_FILE)
- return res
- d.addBoth(_remove_hotline)
+ d.addBoth(self._remove, exit_trigger_file)
return d
+ def _remove(self, res, file):
+ fileutil.remove(file)
+ return res
+
def test_baddir(self):
- if not os.path.exists(bintahoe):
- raise unittest.SkipTest("The bin/tahoe script isn't to be found in the expected location, and I don't want to test a 'tahoe' executable that I find somewhere else, in case it isn't the right executable for this version of tahoe.")
+ self.skip_if_cannot_daemonize()
basedir = self.workdir("test_baddir")
fileutil.make_dirs(basedir)
- d = utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "start", "--basedir", basedir], env=os.environ)
+ d = self.run_bintahoe(["--quiet", "start", "--basedir", basedir])
def _cb(res):
out, err, rc_or_sig = res
self.failUnlessEqual(rc_or_sig, 1)
- self.failUnless("does not look like a node directory" in err)
+ self.failUnless("is not a recognizable node directory" in err, err)
d.addCallback(_cb)
- d.addCallback
+ def _then_stop_it(res):
+ return self.run_bintahoe(["--quiet", "stop", "--basedir", basedir])
+ d.addCallback(_then_stop_it)
- argv = ["--quiet", "stop", "--basedir", basedir]
- out,err = StringIO(), StringIO()
- rc = runner.runner(argv, stdout=out, stderr=err)
- self.failUnlessEqual(rc, 2)
- self.failUnless("does not look like a running node directory"
- in err.getvalue())
+ def _cb2(res):
+ out, err, rc_or_sig = res
+ self.failUnlessEqual(rc_or_sig, 2)
+ self.failUnless("does not look like a running node directory" in err)
+ d.addCallback(_cb2)
- not_a_dir = os.path.join(basedir, "bogus")
- argv = ["--quiet", "start", "--basedir", not_a_dir]
- out,err = StringIO(), StringIO()
- rc = runner.runner(argv, stdout=out, stderr=err)
- self.failUnlessEqual(rc, 1)
- self.failUnless("does not look like a directory at all"
- in err.getvalue(), err.getvalue())
+ def _then_start_in_bogus_basedir(res):
+ not_a_dir = os.path.join(basedir, "bogus")
+ return self.run_bintahoe(["--quiet", "start", "--basedir", not_a_dir])
+ d.addCallback(_then_start_in_bogus_basedir)
+
+ def _cb3(res):
+ out, err, rc_or_sig = res
+ self.failUnlessEqual(rc_or_sig, 1)
+ self.failUnlessIn("does not look like a directory at all", err)
+ d.addCallback(_cb3)
+ return d
def test_keygen(self):
- if not os.path.exists(bintahoe):
- raise unittest.SkipTest("The bin/tahoe script isn't to be found in the expected location, and I don't want to test a 'tahoe' executable that I find somewhere else, in case it isn't the right executable for this version of tahoe.")
- if runtime.platformType == "win32":
- # twistd on windows doesn't daemonize. cygwin works normally.
- raise unittest.SkipTest("twistd does not fork under windows")
+ self.skip_if_cannot_daemonize()
+
basedir = self.workdir("test_keygen")
c1 = os.path.join(basedir, "c1")
- TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
- KEYGEN_FURL_FILE = os.path.join(c1, "key_generator.furl")
+ twistd_pid_file = os.path.join(c1, "twistd.pid")
+ keygen_furl_file = os.path.join(c1, "key_generator.furl")
- d = utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "create-key-generator", "--basedir", c1], env=os.environ)
+ d = self.run_bintahoe(["--quiet", "create-key-generator", "--basedir", c1])
def _cb(res):
out, err, rc_or_sig = res
self.failUnlessEqual(rc_or_sig, 0)
d.addCallback(_cb)
def _start(res):
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "start", c1], env=os.environ)
+ return self.run_bintahoe(["--quiet", "start", c1])
d.addCallback(_start)
def _cb2(res):
errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
# the parent (twistd) has exited. However, twistd writes the pid
# from the child, not the parent, so we can't expect twistd.pid
d.addCallback(_cb2)
def _node_has_started():
- return os.path.exists(KEYGEN_FURL_FILE)
+ return os.path.exists(keygen_furl_file)
d.addCallback(lambda res: self.poll(_node_has_started))
def _started(res):
- self.failUnless(os.path.exists(TWISTD_PID_FILE))
+ self.failUnless(os.path.exists(twistd_pid_file))
# rm this so we can detect when the second incarnation is ready
- os.unlink(KEYGEN_FURL_FILE)
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "restart", c1], env=os.environ)
+ os.unlink(keygen_furl_file)
+ return self.run_bintahoe(["--quiet", "restart", c1])
d.addCallback(_started)
def _cb3(res):
errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
d.addCallback(_cb3)
# again, the second incarnation of the node might not be ready yet,
# itself before we get a chance too, especially if spawning the
# 'tahoe stop' command takes a while.
def _stop(res):
- self.failUnless(os.path.exists(TWISTD_PID_FILE))
- return utils.getProcessOutputAndValue(bintahoe, args=["--quiet", "stop", c1], env=os.environ)
+ self.failUnless(os.path.exists(twistd_pid_file))
+ return self.run_bintahoe(["--quiet", "stop", c1])
d.addCallback(_stop)
def _cb4(res):
errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
self.failUnlessEqual(rc_or_sig, 0, errstr)
self.failUnlessEqual(out, "", errstr)
- self.failUnlessEqual(err, "", errstr)
+ # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
# the parent was supposed to poll and wait until it sees
# twistd.pid go away before it exits, so twistd.pid should be
# gone by now.
- self.failIf(os.path.exists(TWISTD_PID_FILE))
+ self.failIf(os.path.exists(twistd_pid_file))
d.addCallback(_cb4)
return d