src/allmydata/test/test_client.py

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