src/allmydata/test/test_client.py

   1 import os, sys
   2 from twisted.trial import unittest
   3 from twisted.application import service
   4
   5 import allmydata
   6 from allmydata.node import OldConfigError, OldConfigOptionError, MissingConfigEntry
   7 from allmydata import client
   8 from allmydata.storage_client import StorageFarmBroker
   9 from allmydata.util import base32, fileutil
  10 from allmydata.interfaces import IFilesystemNode, IFileNode, \
  11      IImmutableFileNode, IMutableFileNode, IDirectoryNode
  12 from foolscap.api import flushEventualQueue
  13 import allmydata.test.common_util as testutil
  14
  15 import mock
  16
  17 BASECONFIG = ("[client]\n"
  18               "introducer.furl = \n"
  19               )
  20
  21 BASECONFIG_I = ("[client]\n"
  22               "introducer.furl = %s\n"
  23               )
  24
  25 class Basic(testutil.ReallyEqualMixin, unittest.TestCase):
  26     def test_loadable(self):
  27         basedir = "test_client.Basic.test_loadable"
  28         os.mkdir(basedir)
  29         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
  30                            BASECONFIG)
  31         client.Client(basedir)
  32
  33     @mock.patch('twisted.python.log.msg')
  34     def test_error_on_old_config_files(self, mock_log_msg):
  35         basedir = "test_client.Basic.test_error_on_old_config_files"
  36         os.mkdir(basedir)
  37         fileutil.write(os.path.join(basedir, "tahoe.cfg"),
  38                        BASECONFIG +
  39                        "[storage]\n" +
  40                        "enabled = false\n" +
  41                        "reserved_space = bogus\n")
  42         fileutil.write(os.path.join(basedir, "introducer.furl"), "")
  43         fileutil.write(os.path.join(basedir, "no_storage"), "")
  44         fileutil.write(os.path.join(basedir, "readonly_storage"), "")
  45         fileutil.write(os.path.join(basedir, "debug_discard_storage"), "")
  46
  47         e = self.failUnlessRaises(OldConfigError, client.Client, basedir)
  48         abs_basedir = fileutil.abspath_expanduser_unicode(unicode(basedir)).encode(sys.getfilesystemencoding())
  49         self.failUnlessIn(os.path.join(abs_basedir, "introducer.furl"), e.args[0])
  50         self.failUnlessIn(os.path.join(abs_basedir, "no_storage"), e.args[0])
  51         self.failUnlessIn(os.path.join(abs_basedir, "readonly_storage"), e.args[0])
  52         self.failUnlessIn(os.path.join(abs_basedir, "debug_discard_storage"), e.args[0])
  53
  54         for oldfile in ['introducer.furl', 'no_storage', 'readonly_storage',
  55                         'debug_discard_storage']:
  56             logged = [ m for m in mock_log_msg.call_args_list if
  57                        ("Found pre-Tahoe-LAFS-v1.3 configuration file" in str(m[0][0]) and oldfile in str(m[0][0])) ]
  58             self.failUnless(logged, (oldfile, mock_log_msg.call_args_list))
  59
  60         for oldfile in [
  61             'nickname', 'webport', 'keepalive_timeout', 'log_gatherer.furl',
  62             'disconnect_timeout', 'advertised_ip_addresses', 'helper.furl',
  63             'key_generator.furl', 'stats_gatherer.furl', 'sizelimit',
  64             'run_helper']:
  65             logged = [ m for m in mock_log_msg.call_args_list if
  66                        ("Found pre-Tahoe-LAFS-v1.3 configuration file" in str(m[0][0]) and oldfile in str(m[0][0])) ]
  67             self.failIf(logged, oldfile)
  68
  69     def test_secrets(self):
  70         basedir = "test_client.Basic.test_secrets"
  71         os.mkdir(basedir)
  72         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
  73                            BASECONFIG)
  74         c = client.Client(basedir)
  75         secret_fname = os.path.join(basedir, "private", "secret")
  76         self.failUnless(os.path.exists(secret_fname), secret_fname)
  77         renew_secret = c.get_renewal_secret()
  78         self.failUnless(base32.b2a(renew_secret))
  79         cancel_secret = c.get_cancel_secret()
  80         self.failUnless(base32.b2a(cancel_secret))
  81
  82     def test_nodekey_yes_storage(self):
  83         basedir = "test_client.Basic.test_nodekey_yes_storage"
  84         os.mkdir(basedir)
  85         fileutil.write(os.path.join(basedir, "tahoe.cfg"),
  86                        BASECONFIG)
  87         c = client.Client(basedir)
  88         self.failUnless(c.get_long_nodeid().startswith("v0-"))
  89
  90     def test_nodekey_no_storage(self):
  91         basedir = "test_client.Basic.test_nodekey_no_storage"
  92         os.mkdir(basedir)
  93         fileutil.write(os.path.join(basedir, "tahoe.cfg"),
  94                        BASECONFIG + "[storage]\n" + "enabled = false\n")
  95         c = client.Client(basedir)
  96         self.failUnless(c.get_long_nodeid().startswith("v0-"))
  97
  98     def test_reserved_1(self):
  99         basedir = "client.Basic.test_reserved_1"
 100         os.mkdir(basedir)
 101         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 102                            BASECONFIG + \
 103                            "[storage]\n" + \
 104                            "enabled = true\n" + \
 105                            "reserved_space = 1000\n")
 106         c = client.Client(basedir)
 107         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 1000)
 108
 109     def test_reserved_2(self):
 110         basedir = "client.Basic.test_reserved_2"
 111         os.mkdir(basedir)
 112         fileutil.write(os.path.join(basedir, "tahoe.cfg"),  \
 113                            BASECONFIG + \
 114                            "[storage]\n" + \
 115                            "enabled = true\n" + \
 116                            "reserved_space = 10K\n")
 117         c = client.Client(basedir)
 118         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 10*1000)
 119
 120     def test_reserved_3(self):
 121         basedir = "client.Basic.test_reserved_3"
 122         os.mkdir(basedir)
 123         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 124                            BASECONFIG + \
 125                            "[storage]\n" + \
 126                            "enabled = true\n" + \
 127                            "reserved_space = 5mB\n")
 128         c = client.Client(basedir)
 129         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
 130                              5*1000*1000)
 131
 132     def test_reserved_4(self):
 133         basedir = "client.Basic.test_reserved_4"
 134         os.mkdir(basedir)
 135         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 136                            BASECONFIG + \
 137                            "[storage]\n" + \
 138                            "enabled = true\n" + \
 139                            "reserved_space = 78Gb\n")
 140         c = client.Client(basedir)
 141         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
 142                              78*1000*1000*1000)
 143
 144     def test_reserved_bad(self):
 145         basedir = "client.Basic.test_reserved_bad"
 146         os.mkdir(basedir)
 147         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 148                            BASECONFIG + \
 149                            "[storage]\n" + \
 150                            "enabled = true\n" + \
 151                            "reserved_space = bogus\n")
 152         self.failUnlessRaises(ValueError, client.Client, basedir)
 153
 154     def _permute(self, sb, key):
 155         return [ s.get_longname() for s in sb.get_servers_for_psi(key) ]
 156
 157     def test_permute(self):
 158         sb = StorageFarmBroker(None, True)
 159         for k in ["%d" % i for i in range(5)]:
 160             ann = {"anonymous-storage-FURL": "pb://abcde@nowhere/fake",
 161                    "permutation-seed-base32": base32.b2a(k) }
 162             sb.test_add_rref(k, "rref", ann)
 163
 164         self.failUnlessReallyEqual(self._permute(sb, "one"), ['3','1','0','4','2'])
 165         self.failUnlessReallyEqual(self._permute(sb, "two"), ['0','4','2','1','3'])
 166         sb.servers.clear()
 167         self.failUnlessReallyEqual(self._permute(sb, "one"), [])
 168
 169     def test_versions(self):
 170         basedir = "test_client.Basic.test_versions"
 171         os.mkdir(basedir)
 172         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 173                            BASECONFIG + \
 174                            "[storage]\n" + \
 175                            "enabled = true\n")
 176         c = client.Client(basedir)
 177         ss = c.getServiceNamed("storage")
 178         verdict = ss.remote_get_version()
 179         self.failUnlessReallyEqual(verdict["application-version"],
 180                                    str(allmydata.__full_version__))
 181         self.failIfEqual(str(allmydata.__version__), "unknown")
 182         self.failUnless("." in str(allmydata.__full_version__),
 183                         "non-numeric version in '%s'" % allmydata.__version__)
 184         all_versions = allmydata.get_package_versions_string()
 185         self.failUnless(allmydata.__appname__ in all_versions)
 186         # also test stats
 187         stats = c.get_stats()
 188         self.failUnless("node.uptime" in stats)
 189         self.failUnless(isinstance(stats["node.uptime"], float))
 190
 191     def test_helper_furl(self):
 192         basedir = "test_client.Basic.test_helper_furl"
 193         os.mkdir(basedir)
 194
 195         def _check(config, expected_furl):
 196             fileutil.write(os.path.join(basedir, "tahoe.cfg"),
 197                            BASECONFIG + config)
 198             c = client.Client(basedir)
 199             uploader = c.getServiceNamed("uploader")
 200             furl, connected = uploader.get_helper_info()
 201             self.failUnlessEqual(furl, expected_furl)
 202
 203         _check("", None)
 204         _check("helper.furl =\n", None)
 205         _check("helper.furl = \n", None)
 206         _check("helper.furl = None", None)
 207         _check("helper.furl = pb://blah\n", "pb://blah")
 208
 209     @mock.patch('allmydata.util.log.msg')
 210     @mock.patch('allmydata.frontends.drop_upload.DropUploader')
 211     def test_create_drop_uploader(self, mock_drop_uploader, mock_log_msg):
 212         class MockDropUploader(service.MultiService):
 213             name = 'drop-upload'
 214
 215             def __init__(self, client, upload_dircap, local_dir_utf8, inotify=None):
 216                 service.MultiService.__init__(self)
 217                 self.client = client
 218                 self.upload_dircap = upload_dircap
 219                 self.local_dir_utf8 = local_dir_utf8
 220                 self.inotify = inotify
 221
 222         mock_drop_uploader.side_effect = MockDropUploader
 223
 224         upload_dircap = "URI:DIR2:blah"
 225         local_dir_utf8 = u"loc\u0101l_dir".encode('utf-8')
 226         config = (BASECONFIG +
 227                   "[storage]\n" +
 228                   "enabled = false\n" +
 229                   "[drop_upload]\n" +
 230                   "enabled = true\n")
 231
 232         basedir1 = "test_client.Basic.test_create_drop_uploader1"
 233         os.mkdir(basedir1)
 234         fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
 235                        config + "local.directory = " + local_dir_utf8 + "\n")
 236         self.failUnlessRaises(MissingConfigEntry, client.Client, basedir1)
 237
 238         fileutil.write(os.path.join(basedir1, "tahoe.cfg"), config)
 239         fileutil.write(os.path.join(basedir1, "private", "drop_upload_dircap"), "URI:DIR2:blah")
 240         self.failUnlessRaises(MissingConfigEntry, client.Client, basedir1)
 241
 242         fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
 243                        config + "upload.dircap = " + upload_dircap + "\n")
 244         self.failUnlessRaises(OldConfigOptionError, client.Client, basedir1)
 245
 246         fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
 247                        config + "local.directory = " + local_dir_utf8 + "\n")
 248         c1 = client.Client(basedir1)
 249         uploader = c1.getServiceNamed('drop-upload')
 250         self.failUnless(isinstance(uploader, MockDropUploader), uploader)
 251         self.failUnlessReallyEqual(uploader.client, c1)
 252         self.failUnlessReallyEqual(uploader.upload_dircap, upload_dircap)
 253         self.failUnlessReallyEqual(uploader.local_dir_utf8, local_dir_utf8)
 254         self.failUnless(uploader.inotify is None, uploader.inotify)
 255         self.failUnless(uploader.running)
 256
 257         class Boom(Exception):
 258             pass
 259         mock_drop_uploader.side_effect = Boom()
 260
 261         basedir2 = "test_client.Basic.test_create_drop_uploader2"
 262         os.mkdir(basedir2)
 263         os.mkdir(os.path.join(basedir2, "private"))
 264         fileutil.write(os.path.join(basedir2, "tahoe.cfg"),
 265                        BASECONFIG +
 266                        "[drop_upload]\n" +
 267                        "enabled = true\n" +
 268                        "local.directory = " + local_dir_utf8 + "\n")
 269         fileutil.write(os.path.join(basedir2, "private", "drop_upload_dircap"), "URI:DIR2:blah")
 270         c2 = client.Client(basedir2)
 271         self.failUnlessRaises(KeyError, c2.getServiceNamed, 'drop-upload')
 272         self.failUnless([True for arg in mock_log_msg.call_args_list if "Boom" in repr(arg)],
 273                         mock_log_msg.call_args_list)
 274
 275
 276 def flush_but_dont_ignore(res):
 277     d = flushEventualQueue()
 278     def _done(ignored):
 279         return res
 280     d.addCallback(_done)
 281     return d
 282
 283 class Run(unittest.TestCase, testutil.StallMixin):
 284
 285     def setUp(self):
 286         self.sparent = service.MultiService()
 287         self.sparent.startService()
 288     def tearDown(self):
 289         d = self.sparent.stopService()
 290         d.addBoth(flush_but_dont_ignore)
 291         return d
 292
 293     def test_loadable(self):
 294         basedir = "test_client.Run.test_loadable"
 295         os.mkdir(basedir)
 296         dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
 297         fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG_I % dummy)
 298         fileutil.write(os.path.join(basedir, "suicide_prevention_hotline"), "")
 299         client.Client(basedir)
 300
 301     def test_reloadable(self):
 302         basedir = "test_client.Run.test_reloadable"
 303         os.mkdir(basedir)
 304         dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
 305         fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG_I % dummy)
 306         c1 = client.Client(basedir)
 307         c1.setServiceParent(self.sparent)
 308
 309         # delay to let the service start up completely. I'm not entirely sure
 310         # this is necessary.
 311         d = self.stall(delay=2.0)
 312         d.addCallback(lambda res: c1.disownServiceParent())
 313         # the cygwin buildslave seems to need more time to let the old
 314         # service completely shut down. When delay=0.1, I saw this test fail,
 315         # probably due to the logport trying to reclaim the old socket
 316         # number. This suggests that either we're dropping a Deferred
 317         # somewhere in the shutdown sequence, or that cygwin is just cranky.
 318         d.addCallback(self.stall, delay=2.0)
 319         def _restart(res):
 320             # TODO: pause for slightly over one second, to let
 321             # Client._check_hotline poll the file once. That will exercise
 322             # another few lines. Then add another test in which we don't
 323             # update the file at all, and watch to see the node shutdown. (to
 324             # do this, use a modified node which overrides Node.shutdown(),
 325             # also change _check_hotline to use it instead of a raw
 326             # reactor.stop, also instrument the shutdown event in an
 327             # attribute that we can check)
 328             c2 = client.Client(basedir)
 329             c2.setServiceParent(self.sparent)
 330             return c2.disownServiceParent()
 331         d.addCallback(_restart)
 332         return d
 333
 334 class NodeMaker(testutil.ReallyEqualMixin, unittest.TestCase):
 335     def test_maker(self):
 336         basedir = "client/NodeMaker/maker"
 337         fileutil.make_dirs(basedir)
 338         fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG)
 339         c = client.Client(basedir)
 340
 341         n = c.create_node_from_uri("URI:CHK:6nmrpsubgbe57udnexlkiwzmlu:bjt7j6hshrlmadjyr7otq3dc24end5meo5xcr5xe5r663po6itmq:3:10:7277")
 342         self.failUnless(IFilesystemNode.providedBy(n))
 343         self.failUnless(IFileNode.providedBy(n))
 344         self.failUnless(IImmutableFileNode.providedBy(n))
 345         self.failIf(IMutableFileNode.providedBy(n))
 346         self.failIf(IDirectoryNode.providedBy(n))
 347         self.failUnless(n.is_readonly())
 348         self.failIf(n.is_mutable())
 349
 350         # Testing #1679. There was a bug that would occur when downloader was
 351         # downloading the same readcap more than once concurrently, so the
 352         # filenode object was cached, and there was a failure from one of the
 353         # servers in one of the download attempts. No subsequent download
 354         # attempt would attempt to use that server again, which would lead to
 355         # the file being undownloadable until the gateway was restarted. The
 356         # current fix for this (hopefully to be superceded by a better fix
 357         # eventually) is to prevent re-use of filenodes, so the NodeMaker is
 358         # hereby required *not* to cache and re-use filenodes for CHKs.
 359         other_n = c.create_node_from_uri("URI:CHK:6nmrpsubgbe57udnexlkiwzmlu:bjt7j6hshrlmadjyr7otq3dc24end5meo5xcr5xe5r663po6itmq:3:10:7277")
 360         self.failIf(n is other_n, (n, other_n))
 361
 362         n = c.create_node_from_uri("URI:LIT:n5xgk")
 363         self.failUnless(IFilesystemNode.providedBy(n))
 364         self.failUnless(IFileNode.providedBy(n))
 365         self.failUnless(IImmutableFileNode.providedBy(n))
 366         self.failIf(IMutableFileNode.providedBy(n))
 367         self.failIf(IDirectoryNode.providedBy(n))
 368         self.failUnless(n.is_readonly())
 369         self.failIf(n.is_mutable())
 370
 371         n = c.create_node_from_uri("URI:SSK:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 372         self.failUnless(IFilesystemNode.providedBy(n))
 373         self.failUnless(IFileNode.providedBy(n))
 374         self.failIf(IImmutableFileNode.providedBy(n))
 375         self.failUnless(IMutableFileNode.providedBy(n))
 376         self.failIf(IDirectoryNode.providedBy(n))
 377         self.failIf(n.is_readonly())
 378         self.failUnless(n.is_mutable())
 379
 380         n = c.create_node_from_uri("URI:SSK-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 381         self.failUnless(IFilesystemNode.providedBy(n))
 382         self.failUnless(IFileNode.providedBy(n))
 383         self.failIf(IImmutableFileNode.providedBy(n))
 384         self.failUnless(IMutableFileNode.providedBy(n))
 385         self.failIf(IDirectoryNode.providedBy(n))
 386         self.failUnless(n.is_readonly())
 387         self.failUnless(n.is_mutable())
 388
 389         n = c.create_node_from_uri("URI:DIR2:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 390         self.failUnless(IFilesystemNode.providedBy(n))
 391         self.failIf(IFileNode.providedBy(n))
 392         self.failIf(IImmutableFileNode.providedBy(n))
 393         self.failIf(IMutableFileNode.providedBy(n))
 394         self.failUnless(IDirectoryNode.providedBy(n))
 395         self.failIf(n.is_readonly())
 396         self.failUnless(n.is_mutable())
 397
 398         n = c.create_node_from_uri("URI:DIR2-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 399         self.failUnless(IFilesystemNode.providedBy(n))
 400         self.failIf(IFileNode.providedBy(n))
 401         self.failIf(IImmutableFileNode.providedBy(n))
 402         self.failIf(IMutableFileNode.providedBy(n))
 403         self.failUnless(IDirectoryNode.providedBy(n))
 404         self.failUnless(n.is_readonly())
 405         self.failUnless(n.is_mutable())
 406
 407         unknown_rw = "lafs://from_the_future"
 408         unknown_ro = "lafs://readonly_from_the_future"
 409         n = c.create_node_from_uri(unknown_rw, unknown_ro)
 410         self.failUnless(IFilesystemNode.providedBy(n))
 411         self.failIf(IFileNode.providedBy(n))
 412         self.failIf(IImmutableFileNode.providedBy(n))
 413         self.failIf(IMutableFileNode.providedBy(n))
 414         self.failIf(IDirectoryNode.providedBy(n))
 415         self.failUnless(n.is_unknown())
 416         self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
 417         self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
 418         self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)
 419
 420         # Note: it isn't that we *intend* to deploy non-ASCII caps in
 421         # the future, it is that we want to make sure older Tahoe-LAFS
 422         # versions wouldn't choke on them if we were to do so. See
 423         # #1051 and wiki:NewCapDesign for details.
 424         unknown_rw = u"lafs://from_the_future_rw_\u263A".encode('utf-8')
 425         unknown_ro = u"lafs://readonly_from_the_future_ro_\u263A".encode('utf-8')
 426         n = c.create_node_from_uri(unknown_rw, unknown_ro)
 427         self.failUnless(IFilesystemNode.providedBy(n))
 428         self.failIf(IFileNode.providedBy(n))
 429         self.failIf(IImmutableFileNode.providedBy(n))
 430         self.failIf(IMutableFileNode.providedBy(n))
 431         self.failIf(IDirectoryNode.providedBy(n))
 432         self.failUnless(n.is_unknown())
 433         self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
 434         self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
 435         self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)