]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blobdiff - src/allmydata/test/test_runner.py
tests: bump up the timeout in this test that fails on FreeStorm's CentOS in order...
[tahoe-lafs/tahoe-lafs.git] / src / allmydata / test / test_runner.py
index d42b1e226419ac98fe79eff784746a119dcbcce5..b2b57dfd57e877b831f05fea8920d32019b7e3da 100644 (file)
-
 from twisted.trial import unittest
 
+from twisted.python import usage, runtime
+from twisted.internet import threads
+
+import os.path, re, sys, subprocess
 from cStringIO import StringIO
-from twisted.python import usage
-import os.path
+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.util import fileutil
+
+from allmydata.test import common_util
+import allmydata
+
+timeout = 240
+
+def get_root_from_file(src):
+    srcdir = os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(src))))
+
+    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)
+
+    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):
+            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)
+
+        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)
+
+            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(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 CentOS:
+    # http://tahoe-lafs.org/buildbot/builders/FreeStorm%20CentOS5-i386/builds/503/steps/test/logs/stdio
+    test_import_in_repl.timeout = 480
+
+    def test_path(self):
+        d = self.run_bintahoe(["--version-and-path"])
+        def _cb(res):
+            from allmydata import normalized_version
+
+            out, err, rc_or_sig = res
+            self.failUnlessEqual(rc_or_sig, 0, str(res))
+
+            # Fail unless the allmydata-tahoe package is *this* version *and*
+            # was loaded from *this* source directory.
+
+            required_verstr = str(allmydata.__version__)
+
+            self.failIfEqual(required_verstr, "unknown",
+                             "We don't know our version, because this distribution didn't come "
+                             "with a _version.py and 'setup.py darcsver' hasn't been run.")
+
+            srcdir = os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(srcfile))))
+            info = (res, allmydata.__appname__, required_verstr, srcdir)
+
+            appverpath = out.split(')')[0]
+            (appver, path) = appverpath.split(' (')
+            (app, ver) = appver.split(': ')
+
+            self.failUnlessEqual(app, allmydata.__appname__, info)
+            self.failUnlessEqual(normalized_version(ver), normalized_version(required_verstr), info)
+            self.failUnlessEqual(path, srcdir, info)
+        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, str(res))
+            self.failUnlessIn("Unknown command: "+tricky_out, out)
+        d.addCallback(_cb)
+        return d
+
+    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(rc_or_sig, 0, str(res))
+            self.failUnless(out.startswith(allmydata.__appname__+':'), str(res))
+        d.addCallback(_cb)
+        return d
+
+    def test_version_no_noise(self):
+        self.skip_if_cannot_run_bintahoe()
+
+        from allmydata import get_package_versions, normalized_version
+        twisted_ver = get_package_versions()['Twisted']
+
+        if not normalized_version(twisted_ver) >= normalized_version('9.0.0'):
+            raise unittest.SkipTest("We pass this test only with Twisted >= v9.0.0")
+
+        d = self.run_bintahoe(["--version"])
+        def _cb(res):
+            out, err, rc_or_sig = res
+            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
+
 
 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 workdir(self, name):
-        basedir = os.path.join("test_runner", name)
+        basedir = os.path.join("test_runner", "CreateNode", name)
         fileutil.make_dirs(basedir)
         return basedir
 
-    def test_client(self):
-        basedir = self.workdir("test_client")
-        c1 = os.path.join(basedir, "c1")
-        argv = ["--quiet", "create-client", "--basedir", c1]
+    def run_tahoe(self, argv):
         out,err = StringIO(), StringIO()
         rc = runner.runner(argv, stdout=out, stderr=err)
-        self.failUnlessEqual(err.getvalue(), "")
-        self.failUnlessEqual(out.getvalue(), "")
+        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(c1))
-        self.failUnless(os.path.exists(os.path.join(c1, "client.tac")))
+        self.failUnless(os.path.exists(n1))
+        self.failUnless(os.path.exists(os.path.join(n1, tac)))
 
-        # creating the client a second time should throw an exception
-        out,err = StringIO(), StringIO()
-        rc = runner.runner(argv, stdout=out, stderr=err)
-        self.failIfEqual(rc, 0)
-        self.failUnlessEqual(out.getvalue(), "")
-        self.failUnless("The base directory already exists" in err.getvalue())
+        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)
 
-        c2 = os.path.join(basedir, "c2")
-        argv = ["--quiet", "create-client", c2]
-        runner.runner(argv)
-        self.failUnless(os.path.exists(c2))
-        self.failUnless(os.path.exists(os.path.join(c2, "client.tac")))
+            self.failUnless(re.search(r"\n\[drop_upload\]\n#.*\nenabled = 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", command, "--node-directory", n3]
+        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)))
+
+        # make sure it rejects too many arguments
+        argv = [command, "basedir", "extraarg"]
         self.failUnlessRaises(usage.UsageError,
-                              runner.runner,
-                              ["create-client", "basedir", "extraarg"],
+                              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 test_client(self):
+        # create-client should behave like create-node --no-storage.
+        self.do_create("client")
+
+    def test_introducer(self):
+        self.do_create("introducer")
+
+    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,
-                              ["create-client"],
+                              [],
                               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.
+
+    def workdir(self, name):
+        basedir = os.path.join("test_runner", "RunNode", name)
+        fileutil.make_dirs(basedir)
+        return basedir
+
     def test_introducer(self):
+        self.skip_if_cannot_daemonize()
         basedir = self.workdir("test_introducer")
         c1 = os.path.join(basedir, "c1")
-        argv = ["--quiet", "create-introducer", "--basedir", c1]
-        out,err = StringIO(), StringIO()
-        rc = runner.runner(argv, stdout=out, stderr=err)
-        self.failUnlessEqual(err.getvalue(), "")
-        self.failUnlessEqual(out.getvalue(), "")
-        self.failUnlessEqual(rc, 0)
-        self.failUnless(os.path.exists(c1))
-        self.failUnless(os.path.exists(os.path.join(c1, "introducer.tac")))
+        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")
+        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")
 
-        # creating the introducer a second time should throw an exception
-        out,err = StringIO(), StringIO()
-        rc = runner.runner(argv, stdout=out, stderr=err)
-        self.failIfEqual(rc, 0)
-        self.failUnlessEqual(out.getvalue(), "")
-        self.failUnless("The base directory already exists" in err.getvalue())
+        d = self.run_bintahoe(["--quiet", "create-introducer", "--basedir", c1])
+        def _cb(res):
+            out, err, rc_or_sig = res
+            self.failUnlessEqual(rc_or_sig, 0)
 
-        c2 = os.path.join(basedir, "c2")
-        argv = ["--quiet", "create-introducer", c2]
-        runner.runner(argv)
-        self.failUnless(os.path.exists(c2))
-        self.failUnless(os.path.exists(os.path.join(c2, "introducer.tac")))
+            # 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'))
 
-        self.failUnlessRaises(usage.UsageError,
-                              runner.runner,
-                              ["create-introducer", "basedir", "extraarg"],
-                              run_by_human=False)
+            # 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.
+            fileutil.write(HOTLINE_FILE, "")
+            # now it's safe to start the node
+        d.addCallback(_cb)
 
-        self.failUnlessRaises(usage.UsageError,
-                              runner.runner,
-                              ["create-introducer"],
-                              run_by_human=False)
+        def _then_start_the_node(res):
+            return self.run_bintahoe(["--quiet", "start", c1])
+        d.addCallback(_then_start_the_node)
 
-    def test_subcommands(self):
-        self.failUnlessRaises(usage.UsageError,
-                              runner.runner,
-                              [],
-                              run_by_human=False)
+        def _cb2(res):
+            out, err, rc_or_sig = res
+
+            fileutil.write(HOTLINE_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) # 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
+            # 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 _node_has_started():
+            return os.path.exists(INTRODUCER_FURL_FILE)
+        d.addCallback(lambda res: self.poll(_node_has_started))
+
+        def _started(res):
+            # 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(HOTLINE_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(NODE_URL_FILE)
+            return self.run_bintahoe(["--quiet", "restart", c1])
+        d.addCallback(_started)
+
+        def _then(res):
+            out, err, rc_or_sig = res
+            fileutil.write(HOTLINE_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) # 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. 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):
+            fileutil.write(HOTLINE_FILE, "")
+            self.failUnless(os.path.exists(TWISTD_PID_FILE))
+
+            return self.run_bintahoe(["--quiet", "stop", c1])
+        d.addCallback(_stop)
+
+        def _after_stopping(res):
+            out, err, rc_or_sig = res
+            fileutil.write(HOTLINE_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) # 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))
+        d.addCallback(_after_stopping)
+        d.addBoth(self._remove, HOTLINE_FILE)
+        return d
+    test_introducer.timeout = 960
+
+    # This test hit the 120-second timeout on "Francois Lenny-armv5tel", then it hit a 240-second timeout on our feisty2.5 buildslave: http://allmydata.org/buildbot/builders/feisty2.5/builds/2381/steps/test/logs/test.log
+    # Then it hit the 480 second timeout on Francois's machine: http://tahoe-lafs.org/buildbot/builders/FranXois%20lenny-armv5tel/builds/449/steps/test/logs/stdio
+
+    def test_client_no_noise(self):
+        self.skip_if_cannot_daemonize()
+
+        from allmydata import get_package_versions, normalized_version
+        twisted_ver = get_package_versions()['Twisted']
+
+        if not normalized_version(twisted_ver) >= normalized_version('9.0.0'):
+            raise unittest.SkipTest("We pass this test only with Twisted >= v9.0.0")
+
+        basedir = self.workdir("test_client_no_noise")
+        c1 = os.path.join(basedir, "c1")
+        HOTLINE_FILE = os.path.join(c1, "suicide_prevention_hotline")
+        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(HOTLINE_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(HOTLINE_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 _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, HOTLINE_FILE)
+        return d
+
+    def test_client(self):
+        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")
+        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 = 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)
+
+            # 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.
+            fileutil.write(HOTLINE_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
+            fileutil.write(HOTLINE_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) # 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
+            # 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 _node_has_started():
+            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):
+            # read the client.port file so we can check that its contents
+            # don't change on restart
+            self.portnum = fileutil.read(PORTNUM_FILE)
+
+            fileutil.write(HOTLINE_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
+
+            fileutil.write(HOTLINE_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) # 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 to, especially if spawning the
+        # 'tahoe stop' command takes a while.
+        def _stop(res):
+            fileutil.write(HOTLINE_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
+
+            fileutil.write(HOTLINE_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) # 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))
+        d.addCallback(_cb4)
+        d.addBoth(self._remove, HOTLINE_FILE)
+        return d
+
+    def _remove(self, res, file):
+        fileutil.remove(file)
+        return res
+
+    def test_baddir(self):
+        self.skip_if_cannot_daemonize()
+        basedir = self.workdir("test_baddir")
+        fileutil.make_dirs(basedir)
+
+        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, err)
+        d.addCallback(_cb)
+
+        def _then_stop_it(res):
+            return self.run_bintahoe(["--quiet", "stop", "--basedir", basedir])
+        d.addCallback(_then_stop_it)
+
+        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)
+
+        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.failUnless("does not look like a directory at all" in err, err)
+        d.addCallback(_cb3)
+        return d
+
+    def test_keygen(self):
+        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")
+
+        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 self.run_bintahoe(["--quiet", "start", c1])
+        d.addCallback(_start)
+
+        def _cb2(res):
+            out, err, rc_or_sig = 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) # 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
+            # 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 _node_has_started():
+            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))
+            # rm this so we can detect when the second incarnation is ready
+            os.unlink(KEYGEN_FURL_FILE)
+            return self.run_bintahoe(["--quiet", "restart", c1])
+        d.addCallback(_started)
+
+        def _cb3(res):
+            out, err, rc_or_sig = 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) # 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))
+
+        # 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
+        # 'tahoe stop' command takes a while.
+        def _stop(res):
+            self.failUnless(os.path.exists(TWISTD_PID_FILE))
+            return self.run_bintahoe(["--quiet", "stop", c1])
+        d.addCallback(_stop)
 
-class Diagnostics(unittest.TestCase):
-    def test_dump_root_dirnode_failure(self):
-        s = StringIO()
-        rc = runner.dump_root_dirnode("missing_basedir", {}, s)
-        output = s.getvalue()
-        self.failUnless("unable to read root dirnode file from" in output)
-        self.failIfEqual(rc, 0)
+        def _cb4(res):
+            out, err, rc_or_sig = res
+            # 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) # 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))
+        d.addCallback(_cb4)
+        return d