src/allmydata/test/test_runner.py

   1 from twisted.trial import unittest
   2
   3 from twisted.python import usage, runtime
   4 from twisted.internet import threads
   5
   6 import os.path, re, sys, subprocess
   7 from cStringIO import StringIO
   8 from allmydata.util import fileutil, pollmixin
   9 from allmydata.util.encodingutil import unicode_to_argv, unicode_to_output, get_filesystem_encoding
  10 from allmydata.scripts import runner
  11
  12 from allmydata.test import common_util
  13 import allmydata
  14
  15 timeout = 240
  16
  17 def get_root_from_file(src):
  18     srcdir = os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(src))))
  19
  20     root = os.path.dirname(srcdir)
  21     if os.path.basename(srcdir) == 'site-packages':
  22         if re.search(r'python.+\..+', os.path.basename(root)):
  23             root = os.path.dirname(root)
  24         root = os.path.dirname(root)
  25     elif os.path.basename(root) == 'src':
  26         root = os.path.dirname(root)
  27
  28     return root
  29
  30 srcfile = allmydata.__file__
  31 rootdir = get_root_from_file(srcfile)
  32
  33 if hasattr(sys, 'frozen'):
  34     bintahoe = os.path.join(rootdir, 'tahoe')
  35     if sys.platform == "win32" and os.path.exists(bintahoe + '.exe'):
  36         bintahoe += '.exe'
  37 else:
  38     bintahoe = os.path.join(rootdir, 'bin', 'tahoe')
  39     if sys.platform == "win32":
  40         bintahoe += '.pyscript'
  41         if not os.path.exists(bintahoe):
  42             alt_bintahoe = os.path.join(rootdir, 'Scripts', 'tahoe.pyscript')
  43             if os.path.exists(alt_bintahoe):
  44                 bintahoe = alt_bintahoe
  45
  46
  47 class RunBinTahoeMixin:
  48     def skip_if_cannot_run_bintahoe(self):
  49         if not os.path.exists(bintahoe):
  50             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,))
  51
  52     def skip_if_cannot_daemonize(self):
  53         self.skip_if_cannot_run_bintahoe()
  54         if runtime.platformType == "win32":
  55             # twistd on windows doesn't daemonize. cygwin should work normally.
  56             raise unittest.SkipTest("twistd does not fork under windows")
  57
  58     def run_bintahoe(self, args, stdin=None, python_options=[], env=None):
  59         self.skip_if_cannot_run_bintahoe()
  60
  61         if hasattr(sys, 'frozen'):
  62             if python_options:
  63                 raise unittest.SkipTest("This test doesn't apply to frozen builds.")
  64             command = [bintahoe] + args
  65         else:
  66             command = [sys.executable] + python_options + [bintahoe] + args
  67
  68         if stdin is None:
  69             stdin_stream = None
  70         else:
  71             stdin_stream = subprocess.PIPE
  72
  73         def _run():
  74             p = subprocess.Popen(command, stdin=stdin_stream, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env)
  75             (out, err) = p.communicate(stdin)
  76             return (out, err, p.returncode)
  77         return threads.deferToThread(_run)
  78
  79
  80 class BinTahoe(common_util.SignalMixin, unittest.TestCase, RunBinTahoeMixin):
  81     def _check_right_code(self, file_to_check):
  82         root_to_check = get_root_from_file(file_to_check)
  83         if os.path.basename(root_to_check) == 'dist':
  84             root_to_check = os.path.dirname(root_to_check)
  85
  86         cwd = os.path.normcase(os.path.realpath("."))
  87         root_from_cwd = os.path.dirname(cwd)
  88         if os.path.basename(root_from_cwd) == 'src':
  89             root_from_cwd = os.path.dirname(root_from_cwd)
  90
  91         same = (root_from_cwd == root_to_check)
  92         if not same:
  93             try:
  94                 same = os.path.samefile(root_from_cwd, root_to_check)
  95             except AttributeError, e:
  96                 e  # hush pyflakes
  97
  98         if not same:
  99             msg = ("We seem to be testing the code at %r,\n"
 100                    "(according to the source filename %r),\n"
 101                    "but expected to be testing the code at %r.\n"
 102                    % (root_to_check, file_to_check, root_from_cwd))
 103
 104             root_from_cwdu = os.path.dirname(os.path.normcase(os.path.normpath(os.getcwdu())))
 105             if os.path.basename(root_from_cwdu) == u'src':
 106                 root_from_cwdu = os.path.dirname(root_from_cwdu)
 107
 108             if not isinstance(root_from_cwd, unicode) and root_from_cwd.decode(get_filesystem_encoding(), 'replace') != root_from_cwdu:
 109                 msg += ("However, this may be a false alarm because the current directory path\n"
 110                         "is not representable in the filesystem encoding. Please run the tests\n"
 111                         "from the root of the Tahoe-LAFS distribution at a non-Unicode path.")
 112                 raise unittest.SkipTest(msg)
 113             else:
 114                 msg += "Please run the tests from the root of the Tahoe-LAFS distribution."
 115                 self.fail(msg)
 116
 117     def test_the_right_code(self):
 118         self._check_right_code(srcfile)
 119
 120     def test_import_in_repl(self):
 121         d = self.run_bintahoe(["debug", "repl"],
 122                               stdin="import allmydata; print; print allmydata.__file__")
 123         def _cb(res):
 124             out, err, rc_or_sig = res
 125             self.failUnlessEqual(rc_or_sig, 0, str(res))
 126             lines = out.splitlines()
 127             self.failUnlessIn('>>>', lines[0], str(res))
 128             self._check_right_code(lines[1])
 129         d.addCallback(_cb)
 130         return d
 131
 132     def test_path(self):
 133         d = self.run_bintahoe(["--version-and-path"])
 134         def _cb(res):
 135             from allmydata import normalized_version
 136
 137             out, err, rc_or_sig = res
 138             self.failUnlessEqual(rc_or_sig, 0, str(res))
 139
 140             # Fail unless the allmydata-tahoe package is *this* version *and*
 141             # was loaded from *this* source directory.
 142
 143             required_verstr = str(allmydata.__version__)
 144
 145             self.failIfEqual(required_verstr, "unknown",
 146                              "We don't know our version, because this distribution didn't come "
 147                              "with a _version.py and 'setup.py darcsver' hasn't been run.")
 148
 149             srcdir = os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(srcfile))))
 150             info = (res, allmydata.__appname__, required_verstr, srcdir)
 151
 152             appverpath = out.split(')')[0]
 153             (appver, path) = appverpath.split(' (')
 154             (app, ver) = appver.split(': ')
 155
 156             self.failUnlessEqual(app, allmydata.__appname__, info)
 157             self.failUnlessEqual(normalized_version(ver), normalized_version(required_verstr), info)
 158             self.failUnlessEqual(path, srcdir, info)
 159         d.addCallback(_cb)
 160         return d
 161
 162     def test_unicode_arguments_and_output(self):
 163         self.skip_if_cannot_run_bintahoe()
 164
 165         tricky = u"\u2621"
 166         try:
 167             tricky_arg = unicode_to_argv(tricky, mangle=True)
 168             tricky_out = unicode_to_output(tricky)
 169         except UnicodeEncodeError:
 170             raise unittest.SkipTest("A non-ASCII argument/output could not be encoded on this platform.")
 171
 172         d = self.run_bintahoe([tricky_arg])
 173         def _cb(res):
 174             out, err, rc_or_sig = res
 175             self.failUnlessEqual(rc_or_sig, 1, str(res))
 176             self.failUnlessIn("Unknown command: "+tricky_out, out)
 177         d.addCallback(_cb)
 178         return d
 179
 180     def test_run_with_python_options(self):
 181         # -t is a harmless option that warns about tabs.
 182         d = self.run_bintahoe(["--version"], python_options=["-t"])
 183         def _cb(res):
 184             out, err, rc_or_sig = res
 185             self.failUnlessEqual(rc_or_sig, 0, str(res))
 186             self.failUnless(out.startswith(allmydata.__appname__+':'), str(res))
 187         d.addCallback(_cb)
 188         return d
 189
 190     def test_version_no_noise(self):
 191         self.skip_if_cannot_run_bintahoe()
 192
 193         from allmydata import get_package_versions, normalized_version
 194         twisted_ver = get_package_versions()['Twisted']
 195
 196         if not normalized_version(twisted_ver) >= normalized_version('9.0.0'):
 197             raise unittest.SkipTest("We pass this test only with Twisted >= v9.0.0")
 198
 199         d = self.run_bintahoe(["--version"])
 200         def _cb(res):
 201             out, err, rc_or_sig = res
 202             self.failUnlessEqual(rc_or_sig, 0, str(res))
 203             self.failUnless(out.startswith(allmydata.__appname__+':'), str(res))
 204             self.failIfIn("DeprecationWarning", out, str(res))
 205             errlines = err.split("\n")
 206             self.failIf([True for line in errlines if (line != "" and "UserWarning: Unbuilt egg for setuptools" not in line
 207                                                                   and "from pkg_resources import load_entry_point" not in line)], str(res))
 208             if err != "":
 209                 raise unittest.SkipTest("This test is known not to pass on Ubuntu Lucid; see #1235.")
 210         d.addCallback(_cb)
 211         return d
 212
 213
 214 class CreateNode(unittest.TestCase):
 215     # exercise "tahoe create-node", create-introducer,
 216     # create-key-generator, and create-stats-gatherer, by calling the
 217     # corresponding code as a subroutine.
 218
 219     def workdir(self, name):
 220         basedir = os.path.join("test_runner", "CreateNode", name)
 221         fileutil.make_dirs(basedir)
 222         return basedir
 223
 224     def run_tahoe(self, argv):
 225         out,err = StringIO(), StringIO()
 226         rc = runner.runner(argv, stdout=out, stderr=err)
 227         return rc, out.getvalue(), err.getvalue()
 228
 229     def do_create(self, kind):
 230         basedir = self.workdir("test_" + kind)
 231         command = "create-" + kind
 232         is_client = kind in ("node", "client")
 233         tac = is_client and "tahoe-client.tac" or ("tahoe-" + kind + ".tac")
 234
 235         n1 = os.path.join(basedir, command + "-n1")
 236         argv = ["--quiet", command, "--basedir", n1]
 237         rc, out, err = self.run_tahoe(argv)
 238         self.failUnlessEqual(err, "")
 239         self.failUnlessEqual(out, "")
 240         self.failUnlessEqual(rc, 0)
 241         self.failUnless(os.path.exists(n1))
 242         self.failUnless(os.path.exists(os.path.join(n1, tac)))
 243
 244         if is_client:
 245             # tahoe.cfg should exist, and should have storage enabled for
 246             # 'create-node', and disabled for 'create-client'.
 247             tahoe_cfg = os.path.join(n1, "tahoe.cfg")
 248             self.failUnless(os.path.exists(tahoe_cfg))
 249             content = fileutil.read(tahoe_cfg).replace('\r\n', '\n')
 250             if kind == "client":
 251                 self.failUnless(re.search(r"\n\[storage\]\n#.*\nenabled = false\n", content), content)
 252             else:
 253                 self.failUnless(re.search(r"\n\[storage\]\n#.*\nenabled = true\n", content), content)
 254                 self.failUnless("\nreserved_space = 1G\n" in content)
 255
 256         # creating the node a second time should be rejected
 257         rc, out, err = self.run_tahoe(argv)
 258         self.failIfEqual(rc, 0, str((out, err, rc)))
 259         self.failUnlessEqual(out, "")
 260         self.failUnless("is not empty." in err)
 261
 262         # Fail if there is a non-empty line that doesn't end with a
 263         # punctuation mark.
 264         for line in err.splitlines():
 265             self.failIf(re.search("[\S][^\.!?]$", line), (line,))
 266
 267         # test that the non --basedir form works too
 268         n2 = os.path.join(basedir, command + "-n2")
 269         argv = ["--quiet", command, n2]
 270         rc, out, err = self.run_tahoe(argv)
 271         self.failUnlessEqual(err, "")
 272         self.failUnlessEqual(out, "")
 273         self.failUnlessEqual(rc, 0)
 274         self.failUnless(os.path.exists(n2))
 275         self.failUnless(os.path.exists(os.path.join(n2, tac)))
 276
 277         # test the --node-directory form
 278         n3 = os.path.join(basedir, command + "-n3")
 279         argv = ["--quiet", command, "--node-directory", n3]
 280         rc, out, err = self.run_tahoe(argv)
 281         self.failUnlessEqual(err, "")
 282         self.failUnlessEqual(out, "")
 283         self.failUnlessEqual(rc, 0)
 284         self.failUnless(os.path.exists(n3))
 285         self.failUnless(os.path.exists(os.path.join(n3, tac)))
 286
 287         # make sure it rejects too many arguments
 288         argv = [command, "basedir", "extraarg"]
 289         self.failUnlessRaises(usage.UsageError,
 290                               runner.runner, argv,
 291                               run_by_human=False)
 292
 293         # when creating a non-client, there is no default for the basedir
 294         if not is_client:
 295             argv = [command]
 296             self.failUnlessRaises(usage.UsageError,
 297                                   runner.runner, argv,
 298                                   run_by_human=False)
 299
 300
 301     def test_node(self):
 302         self.do_create("node")
 303
 304     def test_client(self):
 305         # create-client should behave like create-node --no-storage.
 306         self.do_create("client")
 307
 308     def test_introducer(self):
 309         self.do_create("introducer")
 310
 311     def test_key_generator(self):
 312         self.do_create("key-generator")
 313
 314     def test_stats_gatherer(self):
 315         self.do_create("stats-gatherer")
 316
 317     def test_subcommands(self):
 318         # no arguments should trigger a command listing, via UsageError
 319         self.failUnlessRaises(usage.UsageError,
 320                               runner.runner,
 321                               [],
 322                               run_by_human=False)
 323
 324
 325 class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
 326               RunBinTahoeMixin):
 327     # exercise "tahoe start", for both introducer, client node, and
 328     # key-generator, by spawning "tahoe start" as a subprocess. This doesn't
 329     # get us figleaf-based line-level coverage, but it does a better job of
 330     # confirming that the user can actually run "./bin/tahoe start" and
 331     # expect it to work. This verifies that bin/tahoe sets up PYTHONPATH and
 332     # the like correctly.
 333
 334     # This doesn't work on cygwin (it hangs forever), so we skip this test
 335     # when we're on cygwin. It is likely that "tahoe start" itself doesn't
 336     # work on cygwin: twisted seems unable to provide a version of
 337     # spawnProcess which really works there.
 338
 339     def workdir(self, name):
 340         basedir = os.path.join("test_runner", "RunNode", name)
 341         fileutil.make_dirs(basedir)
 342         return basedir
 343
 344     def test_introducer(self):
 345         self.skip_if_cannot_daemonize()
 346         basedir = self.workdir("test_introducer")
 347         c1 = os.path.join(basedir, "c1")
 348         HOTLINE_FILE = os.path.join(c1, "suicide_prevention_hotline")
 349         TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
 350         INTRODUCER_FURL_FILE = os.path.join(c1, "introducer.furl")
 351         PORTNUM_FILE = os.path.join(c1, "introducer.port")
 352         NODE_URL_FILE = os.path.join(c1, "node.url")
 353         CONFIG_FILE = os.path.join(c1, "tahoe.cfg")
 354
 355         d = self.run_bintahoe(["--quiet", "create-introducer", "--basedir", c1])
 356         def _cb(res):
 357             out, err, rc_or_sig = res
 358             self.failUnlessEqual(rc_or_sig, 0)
 359
 360             # This makes sure that node.url is written, which allows us to
 361             # detect when the introducer restarts in _node_has_restarted below.
 362             config = fileutil.read(CONFIG_FILE)
 363             self.failUnlessIn('\nweb.port = \n', config)
 364             fileutil.write(CONFIG_FILE, config.replace('\nweb.port = \n', '\nweb.port = 0\n'))
 365
 366             # by writing this file, we get ten seconds before the node will
 367             # exit. This insures that even if the test fails (and the 'stop'
 368             # command doesn't work), the client should still terminate.
 369             open(HOTLINE_FILE, "w").write("")
 370             # now it's safe to start the node
 371         d.addCallback(_cb)
 372
 373         def _then_start_the_node(res):
 374             return self.run_bintahoe(["--quiet", "start", c1])
 375         d.addCallback(_then_start_the_node)
 376
 377         def _cb2(res):
 378             out, err, rc_or_sig = res
 379
 380             open(HOTLINE_FILE, "w").write("")
 381             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 382             self.failUnlessEqual(rc_or_sig, 0, errstr)
 383             self.failUnlessEqual(out, "", errstr)
 384             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 385
 386             # the parent (twistd) has exited. However, twistd writes the pid
 387             # from the child, not the parent, so we can't expect twistd.pid
 388             # to exist quite yet.
 389
 390             # the node is running, but it might not have made it past the
 391             # first reactor turn yet, and if we kill it too early, it won't
 392             # remove the twistd.pid file. So wait until it does something
 393             # that we know it won't do until after the first turn.
 394         d.addCallback(_cb2)
 395
 396         def _node_has_started():
 397             return os.path.exists(INTRODUCER_FURL_FILE)
 398         d.addCallback(lambda res: self.poll(_node_has_started))
 399
 400         def _started(res):
 401             # read the introducer.furl and introducer.port files so we can check that their
 402             # contents don't change on restart
 403             self.furl = fileutil.read(INTRODUCER_FURL_FILE)
 404             self.failUnless(os.path.exists(PORTNUM_FILE))
 405             self.portnum = fileutil.read(PORTNUM_FILE)
 406
 407             open(HOTLINE_FILE, "w").write("")
 408             self.failUnless(os.path.exists(TWISTD_PID_FILE))
 409             self.failUnless(os.path.exists(NODE_URL_FILE))
 410
 411             # rm this so we can detect when the second incarnation is ready
 412             os.unlink(NODE_URL_FILE)
 413             return self.run_bintahoe(["--quiet", "restart", c1])
 414         d.addCallback(_started)
 415
 416         def _then(res):
 417             out, err, rc_or_sig = res
 418             open(HOTLINE_FILE, "w").write("")
 419             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 420             self.failUnlessEqual(rc_or_sig, 0, errstr)
 421             self.failUnlessEqual(out, "", errstr)
 422             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 423         d.addCallback(_then)
 424
 425         # again, the second incarnation of the node might not be ready yet,
 426         # so poll until it is. This time INTRODUCER_FURL_FILE already
 427         # exists, so we check for the existence of NODE_URL_FILE instead.
 428         def _node_has_restarted():
 429             return os.path.exists(NODE_URL_FILE)
 430         d.addCallback(lambda res: self.poll(_node_has_restarted))
 431
 432         def _check_same_furl_and_port(res):
 433             self.failUnless(os.path.exists(INTRODUCER_FURL_FILE))
 434             self.failUnlessEqual(self.furl, fileutil.read(INTRODUCER_FURL_FILE))
 435             self.failUnless(os.path.exists(PORTNUM_FILE))
 436             self.failUnlessEqual(self.portnum, fileutil.read(PORTNUM_FILE))
 437         d.addCallback(_check_same_furl_and_port)
 438
 439         # now we can kill it. TODO: On a slow machine, the node might kill
 440         # itself before we get a chance to, especially if spawning the
 441         # 'tahoe stop' command takes a while.
 442         def _stop(res):
 443             open(HOTLINE_FILE, "w").write("")
 444             self.failUnless(os.path.exists(TWISTD_PID_FILE))
 445
 446             return self.run_bintahoe(["--quiet", "stop", c1])
 447         d.addCallback(_stop)
 448
 449         def _after_stopping(res):
 450             out, err, rc_or_sig = res
 451             open(HOTLINE_FILE, "w").write("")
 452             # the parent has exited by now
 453             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 454             self.failUnlessEqual(rc_or_sig, 0, errstr)
 455             self.failUnlessEqual(out, "", errstr)
 456             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 457             # the parent was supposed to poll and wait until it sees
 458             # twistd.pid go away before it exits, so twistd.pid should be
 459             # gone by now.
 460             self.failIf(os.path.exists(TWISTD_PID_FILE))
 461         d.addCallback(_after_stopping)
 462
 463         def _remove_hotline(res):
 464             os.unlink(HOTLINE_FILE)
 465             return res
 466         d.addBoth(_remove_hotline)
 467         return d
 468     test_introducer.timeout = 960
 469
 470     # 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
 471     # 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
 472
 473     def test_client_no_noise(self):
 474         self.skip_if_cannot_daemonize()
 475
 476         from allmydata import get_package_versions, normalized_version
 477         twisted_ver = get_package_versions()['Twisted']
 478
 479         if not normalized_version(twisted_ver) >= normalized_version('9.0.0'):
 480             raise unittest.SkipTest("We pass this test only with Twisted >= v9.0.0")
 481
 482         basedir = self.workdir("test_client_no_noise")
 483         c1 = os.path.join(basedir, "c1")
 484         HOTLINE_FILE = os.path.join(c1, "suicide_prevention_hotline")
 485         TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
 486         PORTNUM_FILE = os.path.join(c1, "client.port")
 487
 488         d = self.run_bintahoe(["--quiet", "create-client", "--basedir", c1, "--webport", "0"])
 489         def _cb(res):
 490             out, err, rc_or_sig = res
 491             errstr = "cc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 492             assert rc_or_sig == 0, errstr
 493             self.failUnlessEqual(rc_or_sig, 0)
 494
 495             # By writing this file, we get two minutes before the client will exit. This ensures
 496             # that even if the 'stop' command doesn't work (and the test fails), the client should
 497             # still terminate.
 498             open(HOTLINE_FILE, "w").write("")
 499             # now it's safe to start the node
 500         d.addCallback(_cb)
 501
 502         def _start(res):
 503             return self.run_bintahoe(["--quiet", "start", c1])
 504         d.addCallback(_start)
 505
 506         def _cb2(res):
 507             out, err, rc_or_sig = res
 508             errstr = "cc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 509             open(HOTLINE_FILE, "w").write("")
 510             self.failUnlessEqual(rc_or_sig, 0, errstr)
 511             self.failUnlessEqual(out, "", errstr) # If you emit noise, you fail this test.
 512             errlines = err.split("\n")
 513             self.failIf([True for line in errlines if (line != "" and "UserWarning: Unbuilt egg for setuptools" not in line
 514                                                                   and "from pkg_resources import load_entry_point" not in line)], errstr)
 515             if err != "":
 516                 raise unittest.SkipTest("This test is known not to pass on Ubuntu Lucid; see #1235.")
 517
 518             # the parent (twistd) has exited. However, twistd writes the pid
 519             # from the child, not the parent, so we can't expect twistd.pid
 520             # to exist quite yet.
 521
 522             # the node is running, but it might not have made it past the
 523             # first reactor turn yet, and if we kill it too early, it won't
 524             # remove the twistd.pid file. So wait until it does something
 525             # that we know it won't do until after the first turn.
 526         d.addCallback(_cb2)
 527
 528         def _node_has_started():
 529             return os.path.exists(PORTNUM_FILE)
 530         d.addCallback(lambda res: self.poll(_node_has_started))
 531
 532         # now we can kill it. TODO: On a slow machine, the node might kill
 533         # itself before we get a chance to, especially if spawning the
 534         # 'tahoe stop' command takes a while.
 535         def _stop(res):
 536             self.failUnless(os.path.exists(TWISTD_PID_FILE), (TWISTD_PID_FILE, os.listdir(os.path.dirname(TWISTD_PID_FILE))))
 537             return self.run_bintahoe(["--quiet", "stop", c1])
 538         d.addCallback(_stop)
 539         return d
 540
 541     def test_client(self):
 542         self.skip_if_cannot_daemonize()
 543         basedir = self.workdir("test_client")
 544         c1 = os.path.join(basedir, "c1")
 545         HOTLINE_FILE = os.path.join(c1, "suicide_prevention_hotline")
 546         TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
 547         PORTNUM_FILE = os.path.join(c1, "client.port")
 548         NODE_URL_FILE = os.path.join(c1, "node.url")
 549         CONFIG_FILE = os.path.join(c1, "tahoe.cfg")
 550
 551         d = self.run_bintahoe(["--quiet", "create-node", "--basedir", c1, "--webport", "0"])
 552         def _cb(res):
 553             out, err, rc_or_sig = res
 554             self.failUnlessEqual(rc_or_sig, 0)
 555
 556             # Check that the --webport option worked.
 557             config = fileutil.read(CONFIG_FILE)
 558             self.failUnlessIn('\nweb.port = 0\n', config)
 559
 560             # By writing this file, we get two minutes before the client will exit. This ensures
 561             # that even if the 'stop' command doesn't work (and the test fails), the client should
 562             # still terminate.
 563             open(HOTLINE_FILE, "w").write("")
 564             # now it's safe to start the node
 565         d.addCallback(_cb)
 566
 567         def _start(res):
 568             return self.run_bintahoe(["--quiet", "start", c1])
 569         d.addCallback(_start)
 570
 571         def _cb2(res):
 572             out, err, rc_or_sig = res
 573             open(HOTLINE_FILE, "w").write("")
 574             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 575             self.failUnlessEqual(rc_or_sig, 0, errstr)
 576             self.failUnlessEqual(out, "", errstr)
 577             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 578
 579             # the parent (twistd) has exited. However, twistd writes the pid
 580             # from the child, not the parent, so we can't expect twistd.pid
 581             # to exist quite yet.
 582
 583             # the node is running, but it might not have made it past the
 584             # first reactor turn yet, and if we kill it too early, it won't
 585             # remove the twistd.pid file. So wait until it does something
 586             # that we know it won't do until after the first turn.
 587         d.addCallback(_cb2)
 588
 589         def _node_has_started():
 590             return os.path.exists(NODE_URL_FILE)
 591         d.addCallback(lambda res: self.poll(_node_has_started))
 592
 593         def _started(res):
 594             # read the client.port file so we can check that its contents
 595             # don't change on restart
 596             self.portnum = fileutil.read(PORTNUM_FILE)
 597
 598             open(HOTLINE_FILE, "w").write("")
 599             self.failUnless(os.path.exists(TWISTD_PID_FILE))
 600
 601             # rm this so we can detect when the second incarnation is ready
 602             os.unlink(NODE_URL_FILE)
 603             return self.run_bintahoe(["--quiet", "restart", c1])
 604         d.addCallback(_started)
 605
 606         def _cb3(res):
 607             out, err, rc_or_sig = res
 608
 609             open(HOTLINE_FILE, "w").write("")
 610             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 611             self.failUnlessEqual(rc_or_sig, 0, errstr)
 612             self.failUnlessEqual(out, "", errstr)
 613             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 614         d.addCallback(_cb3)
 615
 616         # again, the second incarnation of the node might not be ready yet,
 617         # so poll until it is
 618         d.addCallback(lambda res: self.poll(_node_has_started))
 619
 620         def _check_same_port(res):
 621             self.failUnlessEqual(self.portnum, fileutil.read(PORTNUM_FILE))
 622         d.addCallback(_check_same_port)
 623
 624         # now we can kill it. TODO: On a slow machine, the node might kill
 625         # itself before we get a chance to, especially if spawning the
 626         # 'tahoe stop' command takes a while.
 627         def _stop(res):
 628             open(HOTLINE_FILE, "w").write("")
 629             self.failUnless(os.path.exists(TWISTD_PID_FILE), (TWISTD_PID_FILE, os.listdir(os.path.dirname(TWISTD_PID_FILE))))
 630             return self.run_bintahoe(["--quiet", "stop", c1])
 631         d.addCallback(_stop)
 632
 633         def _cb4(res):
 634             out, err, rc_or_sig = res
 635
 636             open(HOTLINE_FILE, "w").write("")
 637             # the parent has exited by now
 638             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 639             self.failUnlessEqual(rc_or_sig, 0, errstr)
 640             self.failUnlessEqual(out, "", errstr)
 641             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 642             # the parent was supposed to poll and wait until it sees
 643             # twistd.pid go away before it exits, so twistd.pid should be
 644             # gone by now.
 645             self.failIf(os.path.exists(TWISTD_PID_FILE))
 646         d.addCallback(_cb4)
 647         def _remove_hotline(res):
 648             os.unlink(HOTLINE_FILE)
 649             return res
 650         d.addBoth(_remove_hotline)
 651         return d
 652
 653     def test_baddir(self):
 654         self.skip_if_cannot_daemonize()
 655         basedir = self.workdir("test_baddir")
 656         fileutil.make_dirs(basedir)
 657
 658         d = self.run_bintahoe(["--quiet", "start", "--basedir", basedir])
 659         def _cb(res):
 660             out, err, rc_or_sig = res
 661             self.failUnlessEqual(rc_or_sig, 1)
 662             self.failUnless("does not look like a node directory" in err, err)
 663         d.addCallback(_cb)
 664
 665         def _then_stop_it(res):
 666             return self.run_bintahoe(["--quiet", "stop", "--basedir", basedir])
 667         d.addCallback(_then_stop_it)
 668
 669         def _cb2(res):
 670             out, err, rc_or_sig = res
 671             self.failUnlessEqual(rc_or_sig, 2)
 672             self.failUnless("does not look like a running node directory" in err)
 673         d.addCallback(_cb2)
 674
 675         def _then_start_in_bogus_basedir(res):
 676             not_a_dir = os.path.join(basedir, "bogus")
 677             return self.run_bintahoe(["--quiet", "start", "--basedir", not_a_dir])
 678         d.addCallback(_then_start_in_bogus_basedir)
 679
 680         def _cb3(res):
 681             out, err, rc_or_sig = res
 682             self.failUnlessEqual(rc_or_sig, 1)
 683             self.failUnless("does not look like a directory at all" in err, err)
 684         d.addCallback(_cb3)
 685         return d
 686
 687     def test_keygen(self):
 688         self.skip_if_cannot_daemonize()
 689         basedir = self.workdir("test_keygen")
 690         c1 = os.path.join(basedir, "c1")
 691         TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
 692         KEYGEN_FURL_FILE = os.path.join(c1, "key_generator.furl")
 693
 694         d = self.run_bintahoe(["--quiet", "create-key-generator", "--basedir", c1])
 695         def _cb(res):
 696             out, err, rc_or_sig = res
 697             self.failUnlessEqual(rc_or_sig, 0)
 698         d.addCallback(_cb)
 699
 700         def _start(res):
 701             return self.run_bintahoe(["--quiet", "start", c1])
 702         d.addCallback(_start)
 703
 704         def _cb2(res):
 705             out, err, rc_or_sig = res
 706             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 707             self.failUnlessEqual(rc_or_sig, 0, errstr)
 708             self.failUnlessEqual(out, "", errstr)
 709             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 710
 711             # the parent (twistd) has exited. However, twistd writes the pid
 712             # from the child, not the parent, so we can't expect twistd.pid
 713             # to exist quite yet.
 714
 715             # the node is running, but it might not have made it past the
 716             # first reactor turn yet, and if we kill it too early, it won't
 717             # remove the twistd.pid file. So wait until it does something
 718             # that we know it won't do until after the first turn.
 719         d.addCallback(_cb2)
 720
 721         def _node_has_started():
 722             return os.path.exists(KEYGEN_FURL_FILE)
 723         d.addCallback(lambda res: self.poll(_node_has_started))
 724
 725         def _started(res):
 726             self.failUnless(os.path.exists(TWISTD_PID_FILE))
 727             # rm this so we can detect when the second incarnation is ready
 728             os.unlink(KEYGEN_FURL_FILE)
 729             return self.run_bintahoe(["--quiet", "restart", c1])
 730         d.addCallback(_started)
 731
 732         def _cb3(res):
 733             out, err, rc_or_sig = res
 734             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 735             self.failUnlessEqual(rc_or_sig, 0, errstr)
 736             self.failUnlessEqual(out, "", errstr)
 737             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 738         d.addCallback(_cb3)
 739
 740         # again, the second incarnation of the node might not be ready yet,
 741         # so poll until it is
 742         d.addCallback(lambda res: self.poll(_node_has_started))
 743
 744         # now we can kill it. TODO: On a slow machine, the node might kill
 745         # itself before we get a chance too, especially if spawning the
 746         # 'tahoe stop' command takes a while.
 747         def _stop(res):
 748             self.failUnless(os.path.exists(TWISTD_PID_FILE))
 749             return self.run_bintahoe(["--quiet", "stop", c1])
 750         d.addCallback(_stop)
 751
 752         def _cb4(res):
 753             out, err, rc_or_sig = res
 754             # the parent has exited by now
 755             errstr = "rc=%d, OUT: '%s', ERR: '%s'" % (rc_or_sig, out, err)
 756             self.failUnlessEqual(rc_or_sig, 0, errstr)
 757             self.failUnlessEqual(out, "", errstr)
 758             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
 759             # the parent was supposed to poll and wait until it sees
 760             # twistd.pid go away before it exits, so twistd.pid should be
 761             # gone by now.
 762             self.failIf(os.path.exists(TWISTD_PID_FILE))
 763         d.addCallback(_cb4)
 764         return d