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
   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('allmydata.util.log.err')
  34     def test_warn_on_old_config_files(self, mocklogerr):
  35         basedir = "test_client.Basic.test_warn_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         e = self.failUnlessRaises(OldConfigError, client.Client, basedir)
  47         self.failUnlessIn(os.path.abspath(os.path.join(basedir, u"introducer.furl")), e.args[0])
  48         self.failUnlessIn(os.path.abspath(os.path.join(basedir, "no_storage")), e.args[0])
  49         self.failUnlessIn(os.path.abspath(os.path.join(basedir, "readonly_storage")), e.args[0])
  50         self.failUnlessIn(os.path.abspath(os.path.join(basedir, "debug_discard_storage")), e.args[0])
  51         for oldfile in [u'introducer.furl', 'no_storage', 'readonly_storage',
  52                         'debug_discard_storage']:
  53             warned = [ m for m in mocklogerr.call_args_list if ("Found pre-Tahoe-LAFS-v1.3 configuration file" in m[0][0] and oldfile in m[0][0]) ]
  54             self.failUnless(warned, (oldfile, mocklogerr.call_args_list))
  55
  56         for oldfile in [
  57             'nickname', 'webport', 'keepalive_timeout', 'log_gatherer.furl',
  58             'disconnect_timeout', 'advertised_ip_addresses', 'helper.furl',
  59             'key_generator.furl', 'stats_gatherer.furl', 'sizelimit',
  60             'run_helper']:
  61             warned = [ m for m in mocklogerr.call_args_list if ("Found pre-Tahoe-LAFS-v1.3 configuration file" in m[0][0] and oldfile in m[0][0]) ]
  62             self.failIf(warned, oldfile)
  63
  64     def test_secrets(self):
  65         basedir = "test_client.Basic.test_secrets"
  66         os.mkdir(basedir)
  67         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
  68                            BASECONFIG)
  69         c = client.Client(basedir)
  70         secret_fname = os.path.join(basedir, "private", "secret")
  71         self.failUnless(os.path.exists(secret_fname), secret_fname)
  72         renew_secret = c.get_renewal_secret()
  73         self.failUnless(base32.b2a(renew_secret))
  74         cancel_secret = c.get_cancel_secret()
  75         self.failUnless(base32.b2a(cancel_secret))
  76
  77     def test_reserved_1(self):
  78         basedir = "client.Basic.test_reserved_1"
  79         os.mkdir(basedir)
  80         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
  81                            BASECONFIG + \
  82                            "[storage]\n" + \
  83                            "enabled = true\n" + \
  84                            "reserved_space = 1000\n")
  85         c = client.Client(basedir)
  86         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 1000)
  87
  88     def test_reserved_2(self):
  89         basedir = "client.Basic.test_reserved_2"
  90         os.mkdir(basedir)
  91         fileutil.write(os.path.join(basedir, "tahoe.cfg"),  \
  92                            BASECONFIG + \
  93                            "[storage]\n" + \
  94                            "enabled = true\n" + \
  95                            "reserved_space = 10K\n")
  96         c = client.Client(basedir)
  97         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 10*1000)
  98
  99     def test_reserved_3(self):
 100         basedir = "client.Basic.test_reserved_3"
 101         os.mkdir(basedir)
 102         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 103                            BASECONFIG + \
 104                            "[storage]\n" + \
 105                            "enabled = true\n" + \
 106                            "reserved_space = 5mB\n")
 107         c = client.Client(basedir)
 108         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
 109                              5*1000*1000)
 110
 111     def test_reserved_4(self):
 112         basedir = "client.Basic.test_reserved_4"
 113         os.mkdir(basedir)
 114         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 115                            BASECONFIG + \
 116                            "[storage]\n" + \
 117                            "enabled = true\n" + \
 118                            "reserved_space = 78Gb\n")
 119         c = client.Client(basedir)
 120         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
 121                              78*1000*1000*1000)
 122
 123     def test_reserved_bad(self):
 124         basedir = "client.Basic.test_reserved_bad"
 125         os.mkdir(basedir)
 126         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 127                            BASECONFIG + \
 128                            "[storage]\n" + \
 129                            "enabled = true\n" + \
 130                            "reserved_space = bogus\n")
 131         c = client.Client(basedir)
 132         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 0)
 133
 134     def _permute(self, sb, key):
 135         return [ s.get_serverid() for s in sb.get_servers_for_psi(key) ]
 136
 137     def test_permute(self):
 138         sb = StorageFarmBroker(None, True)
 139         for k in ["%d" % i for i in range(5)]:
 140             sb.test_add_rref(k, "rref")
 141
 142         self.failUnlessReallyEqual(self._permute(sb, "one"), ['3','1','0','4','2'])
 143         self.failUnlessReallyEqual(self._permute(sb, "two"), ['0','4','2','1','3'])
 144         sb.servers.clear()
 145         self.failUnlessReallyEqual(self._permute(sb, "one"), [])
 146
 147     def test_versions(self):
 148         basedir = "test_client.Basic.test_versions"
 149         os.mkdir(basedir)
 150         fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
 151                            BASECONFIG + \
 152                            "[storage]\n" + \
 153                            "enabled = true\n")
 154         c = client.Client(basedir)
 155         ss = c.getServiceNamed("storage")
 156         verdict = ss.remote_get_version()
 157         self.failUnlessReallyEqual(verdict["application-version"],
 158                                    str(allmydata.__full_version__))
 159         self.failIfEqual(str(allmydata.__version__), "unknown")
 160         self.failUnless("." in str(allmydata.__full_version__),
 161                         "non-numeric version in '%s'" % allmydata.__version__)
 162         all_versions = allmydata.get_package_versions_string()
 163         self.failUnless(allmydata.__appname__ in all_versions)
 164         # also test stats
 165         stats = c.get_stats()
 166         self.failUnless("node.uptime" in stats)
 167         self.failUnless(isinstance(stats["node.uptime"], float))
 168
 169 def flush_but_dont_ignore(res):
 170     d = flushEventualQueue()
 171     def _done(ignored):
 172         return res
 173     d.addCallback(_done)
 174     return d
 175
 176 class Run(unittest.TestCase, testutil.StallMixin):
 177
 178     def setUp(self):
 179         self.sparent = service.MultiService()
 180         self.sparent.startService()
 181     def tearDown(self):
 182         d = self.sparent.stopService()
 183         d.addBoth(flush_but_dont_ignore)
 184         return d
 185
 186     def test_loadable(self):
 187         basedir = "test_client.Run.test_loadable"
 188         os.mkdir(basedir)
 189         dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
 190         fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG_I % dummy)
 191         fileutil.write(os.path.join(basedir, "suicide_prevention_hotline"), "")
 192         client.Client(basedir)
 193
 194     def test_reloadable(self):
 195         basedir = "test_client.Run.test_reloadable"
 196         os.mkdir(basedir)
 197         dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
 198         fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG_I % dummy)
 199         c1 = client.Client(basedir)
 200         c1.setServiceParent(self.sparent)
 201
 202         # delay to let the service start up completely. I'm not entirely sure
 203         # this is necessary.
 204         d = self.stall(delay=2.0)
 205         d.addCallback(lambda res: c1.disownServiceParent())
 206         # the cygwin buildslave seems to need more time to let the old
 207         # service completely shut down. When delay=0.1, I saw this test fail,
 208         # probably due to the logport trying to reclaim the old socket
 209         # number. This suggests that either we're dropping a Deferred
 210         # somewhere in the shutdown sequence, or that cygwin is just cranky.
 211         d.addCallback(self.stall, delay=2.0)
 212         def _restart(res):
 213             # TODO: pause for slightly over one second, to let
 214             # Client._check_hotline poll the file once. That will exercise
 215             # another few lines. Then add another test in which we don't
 216             # update the file at all, and watch to see the node shutdown. (to
 217             # do this, use a modified node which overrides Node.shutdown(),
 218             # also change _check_hotline to use it instead of a raw
 219             # reactor.stop, also instrument the shutdown event in an
 220             # attribute that we can check)
 221             c2 = client.Client(basedir)
 222             c2.setServiceParent(self.sparent)
 223             return c2.disownServiceParent()
 224         d.addCallback(_restart)
 225         return d
 226
 227 class NodeMaker(testutil.ReallyEqualMixin, unittest.TestCase):
 228     def test_maker(self):
 229         basedir = "client/NodeMaker/maker"
 230         fileutil.make_dirs(basedir)
 231         fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG)
 232         c = client.Client(basedir)
 233
 234         n = c.create_node_from_uri("URI:CHK:6nmrpsubgbe57udnexlkiwzmlu:bjt7j6hshrlmadjyr7otq3dc24end5meo5xcr5xe5r663po6itmq:3:10:7277")
 235         self.failUnless(IFilesystemNode.providedBy(n))
 236         self.failUnless(IFileNode.providedBy(n))
 237         self.failUnless(IImmutableFileNode.providedBy(n))
 238         self.failIf(IMutableFileNode.providedBy(n))
 239         self.failIf(IDirectoryNode.providedBy(n))
 240         self.failUnless(n.is_readonly())
 241         self.failIf(n.is_mutable())
 242
 243         n = c.create_node_from_uri("URI:LIT:n5xgk")
 244         self.failUnless(IFilesystemNode.providedBy(n))
 245         self.failUnless(IFileNode.providedBy(n))
 246         self.failUnless(IImmutableFileNode.providedBy(n))
 247         self.failIf(IMutableFileNode.providedBy(n))
 248         self.failIf(IDirectoryNode.providedBy(n))
 249         self.failUnless(n.is_readonly())
 250         self.failIf(n.is_mutable())
 251
 252         n = c.create_node_from_uri("URI:SSK:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 253         self.failUnless(IFilesystemNode.providedBy(n))
 254         self.failUnless(IFileNode.providedBy(n))
 255         self.failIf(IImmutableFileNode.providedBy(n))
 256         self.failUnless(IMutableFileNode.providedBy(n))
 257         self.failIf(IDirectoryNode.providedBy(n))
 258         self.failIf(n.is_readonly())
 259         self.failUnless(n.is_mutable())
 260
 261         n = c.create_node_from_uri("URI:SSK-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 262         self.failUnless(IFilesystemNode.providedBy(n))
 263         self.failUnless(IFileNode.providedBy(n))
 264         self.failIf(IImmutableFileNode.providedBy(n))
 265         self.failUnless(IMutableFileNode.providedBy(n))
 266         self.failIf(IDirectoryNode.providedBy(n))
 267         self.failUnless(n.is_readonly())
 268         self.failUnless(n.is_mutable())
 269
 270         n = c.create_node_from_uri("URI:DIR2:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 271         self.failUnless(IFilesystemNode.providedBy(n))
 272         self.failIf(IFileNode.providedBy(n))
 273         self.failIf(IImmutableFileNode.providedBy(n))
 274         self.failIf(IMutableFileNode.providedBy(n))
 275         self.failUnless(IDirectoryNode.providedBy(n))
 276         self.failIf(n.is_readonly())
 277         self.failUnless(n.is_mutable())
 278
 279         n = c.create_node_from_uri("URI:DIR2-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 280         self.failUnless(IFilesystemNode.providedBy(n))
 281         self.failIf(IFileNode.providedBy(n))
 282         self.failIf(IImmutableFileNode.providedBy(n))
 283         self.failIf(IMutableFileNode.providedBy(n))
 284         self.failUnless(IDirectoryNode.providedBy(n))
 285         self.failUnless(n.is_readonly())
 286         self.failUnless(n.is_mutable())
 287
 288         unknown_rw = "lafs://from_the_future"
 289         unknown_ro = "lafs://readonly_from_the_future"
 290         n = c.create_node_from_uri(unknown_rw, unknown_ro)
 291         self.failUnless(IFilesystemNode.providedBy(n))
 292         self.failIf(IFileNode.providedBy(n))
 293         self.failIf(IImmutableFileNode.providedBy(n))
 294         self.failIf(IMutableFileNode.providedBy(n))
 295         self.failIf(IDirectoryNode.providedBy(n))
 296         self.failUnless(n.is_unknown())
 297         self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
 298         self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
 299         self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)
 300
 301         # Note: it isn't that we *intend* to deploy non-ASCII caps in
 302         # the future, it is that we want to make sure older Tahoe-LAFS
 303         # versions wouldn't choke on them if we were to do so. See
 304         # #1051 and wiki:NewCapDesign for details.
 305         unknown_rw = u"lafs://from_the_future_rw_\u263A".encode('utf-8')
 306         unknown_ro = u"lafs://readonly_from_the_future_ro_\u263A".encode('utf-8')
 307         n = c.create_node_from_uri(unknown_rw, unknown_ro)
 308         self.failUnless(IFilesystemNode.providedBy(n))
 309         self.failIf(IFileNode.providedBy(n))
 310         self.failIf(IImmutableFileNode.providedBy(n))
 311         self.failIf(IMutableFileNode.providedBy(n))
 312         self.failIf(IDirectoryNode.providedBy(n))
 313         self.failUnless(n.is_unknown())
 314         self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
 315         self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
 316         self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)